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.
Development
If you'd like to contribute to modlunky2 here are some steps to setup your environment.
Creating VirtualEnv
In the root directory you can make a virtualenv. It will be excluded from commits by default
> python -m venv venv
Activate VirtualEnv
You'll want to activate the virtual environment whenever you're testing any commands from this package
Powershell
> venv\Scripts\activate.bat
cmd
> venv/Scripts/Activate.ps1
bash/zsh
> source venv/bin/activate
Setup
Once you have your virtual environment setup and activated you'll want to finish setting up the development environment.
> 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
1 maintainer
Metadata
1 maintainer
Release files for modlunky2 0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| modlunky2-0.3.tar.gz | 7.5 kB | Details |
Release files / modlunky2-0.3.tar.gz
| Download URL | modlunky2-0.3.tar.gz |
|---|---|
| Size | 7.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4fe8d43000b7840a3f9d0b5c8917a91ae4b20015919697ad72d5eb374003c1f2
|
|
BLAKE2b-256 checksum How to use checksums |
06dafa46caf99a38270c056e72b7552b1bac23fb415c4863c1bfd13c46964e52
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.1
|
