Skip to main content

Spelunky 2 Modding.

Project description

PyPi Version

modlunky2

Repository for modding interface for Spelunky 2.

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 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.2.tar.gz (7.3 kB view details)

Uploaded Source

File details

Details for the file modlunky2-0.2.tar.gz.

File metadata

  • Download URL: modlunky2-0.2.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for modlunky2-0.2.tar.gz
Algorithm Hash digest
SHA256 a9e89f7c481bcf5a611ea7d3340722d8a2a9c26e73343576f735112a6ef5aa64
MD5 b9b78368fa44934bcf8a99a96a6a0007
BLAKE2b-256 8328e45519c99ed411b35a47b75d3a59473836fa840e69ad6ed6314c24b73248

See more details on using hashes here.

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