Spelunky 2 Modding.
Project description
modlunky2
Repository for modding interface for Spelunky 2.
Credits
Special thanks to SciresM
, Cloppershy
, iojonmbnmb
, and Dregu
for all of the help
in making this tool a reality.
Installation
Grabbed the latest release from https://github.com/spelunky-fyi/modlunky2/releases . Copy the modlunky2.exe to your Spelunky 2 installation directory and run it. A terminal will appear with a link to webpage. It should be http://127.0.0.1:8040/ . Leave this running while you're using the modding UI.
Disclaimer
You are strongly discouraged from using any modding tools in your actual online Steam installation as to prevent unlocking achievements, corrupting your savefile and cheating in the leaderboards. You should make a copy of your game somewhere else and install Mr. Goldbergs Steam Emulator in the game directory. (TL;DR: Copy the steam_api64.dll from the zip to the offline game directory and create steam_appid.txt with the text 418530
in it.) Also block the modded installation in your firewall. If you break anything using this tool you get to keep both pieces. Do not report modding related bugs to Blitworks.
Development
If you'd like to contribute to modlunky2
here are some steps to setup your environment.
VirtualEnv
While not required, a virtualenv is a nice way to keep this projects dependencies isolated from the rest of your system. This step is optional but recommended
In the root directory you can make a virtualenv. It will be excluded from commits by default
python -m venv venv
Whenever developing the project you'll want to activate the virtualenv in your terminal. This is platform dependent and there are more comprehensive docs available here: https://docs.python.org/3/library/venv.html
:warning: If you're using PowerShell on Windows you might need to run
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
. More information on execution policy is available in the link above.
Platform | Shell | Command to activate virtual environment |
---|---|---|
POSIX | bash/zsh | $ source /bin/activate |
fish | $ source /bin/activate.fish | |
csh/tcsh | $ source /bin/activate.csh | |
PowerShell Core | $ /bin/Activate.ps1 | |
Windows | cmd.exe | C:> \Scripts\activate.bat |
PowerShell | PS C:> \Scripts\Activate.ps1 |
Setup
Once you have your virtual environment setup and activated you'll want to finish setting up the development environment.
> git clone https://github.com/spelunky-fyi/modlunky2/
> cd modlunky2
> pip install -r requirements.txt
> python setup.py develop
This will install any dependencies as well as setting up links on your path to your local source files. Once this is done
you'll be able to execute the binaries right from your path after any changes to the source without the need to build or
install anything. If you add new source files you may have to run python setup.py develop
again to make sure they're linked.
Running Locally
modlunky2 --install-dir="C:\Program Files (x86)\Steam\steamapps\common\Spelunky 2" --debug
Building Distributions
PyPI
python setup.py sdist
python -m twine upload .\dist\modlunky2-$VERSION.tar.gz
EXE
pyinstaller --clean .\pyinstaller-cli.py --add-data "src\modlunky2\static;static" --add-data "src\modlunky2\templates;templates" --name modlunky2 --onefile
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file modlunky2-0.4.1.tar.gz
.
File metadata
- Download URL: modlunky2-0.4.1.tar.gz
- Upload date:
- Size: 12.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 59e3bee1ec021fd0535df4bf1a945ad91183c260997d17994b9d4cdad9c836c2 |
|
MD5 | 1156f3bebf7966d8b771b7aefb6f828f |
|
BLAKE2b-256 | 5c161b2ab61f2e2eb8315b05562ca52dc314f0637d7f3360dc040d0de8e0b2c1 |