Skip to main content

Spelunky 2 Modding.

Project description

PyPi Version


Repository for modding interface for Spelunky 2.


Special thanks to SciresM, Cloppershy, iojonmbnmb, and Dregu for all of the help in making this tool a reality.


Download the latest version of modlunky2.exe to your Spelunky 2 installation directory.


Follow the instructions in the Modlunky 2 Wiki.


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.


If you'd like to contribute to modlunky2 here are some steps to setup your environment.


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:

: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/
csh/tcsh $ source /bin/activate.csh
PowerShell Core $ /bin/Activate.ps1
Windows cmd.exe C:> \Scripts\activate.bat
PowerShell PS C:> \Scripts\Activate.ps1


Once you have your virtual environment setup and activated you'll want to finish setting up the development environment.

> pip install -r requirements.txt
> pip install -r requirements-dev.txt
> python 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 develop again to make sure they're linked.

Running Locally


Building Distributions


python sdist
python -m twine upload .\dist\modlunky2-$VERSION.tar.gz


The default pyinstaller from pip seems prone to false detection from antivirus so you need to build your own version per


pyinstaller.exe modlunky2.spec

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

modlunky2-0.13.4.tar.gz (1.3 MB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page