Skip to content

Development

ShrineFox edited this page Aug 6, 2024 · 2 revisions

Using the Mod Menu Builder

The following instructions were taken from Coilsnake's DEVELOPMENT.md

Windows

  1. Install:
    1. Python 3.9 (64-bit version)
    2. Visual C++ 2019 Build Tools
      • Select "C++ build tools" under the "Workloads" tab and make sure these are ticked:
        1. MSVC v140 - VS 2015 C++ x64/x86 build tools
        2. Windows 10 SDK
  2. Find a path that exists on your computer similar to C:\Program Files (x86)\Windows Kits\10\bin\10.0.19041.0\x86 and add it to your system environment variables.
  3. Follow the 'Generic' instructions below.
  4. In commands beginning with python3 use just python instead.

Generic

  1. Using your favorite git client, clone the CoilSnake repository.
  2. Open the command line and cd to your local CoilSnake git repository's main directory.
  3. C:\Python39\python.exe -m pip install pip==18.1
  4. Install dependencies:
    • C:\Python39\python.exe -m setup develop
  5. Build additional coilsnake dependencies:
    • C:\Python39\python.exe -m setup build

CoilSnake is now installed in development mode. After making code changes to the source, run your code by launching CoilSnake's GUI or CLI:

`C:\Python39\python.exe -m script/gui.py`
# or...
`C:\Python39\python.exe -m script/cli.py`

Creating a standalone executable

Note: The steps for creating a standalone executable are currently unmaintained and likely broken for systems other than 64-bit Windows.

  1. Follow the steps above to build CoilSnake for your system.
  2. Install pyinstaller:
    • C:\Python39\python.exe -m pip install pyinstaller
  3. In the CoilSnake source directory, build the CoilSnake executable:
    • C:\Python39\python.exe -m setup_exe.py
  4. Run the output file under the 'dist' directory.

Final Notes

  1. Following these instructions should result in an executable appearing at: C:\Python39\Scripts\coilsnake_cli.exe.
  2. When you clone the EarthBound-Mod-Menu repository and open Builder\EBModMenu.sln in Visual Studio, you can replace the .lnk files in the Builder\Dependencies folder with your own 6 MB expanded ROM (made using Coilsnake GUI), your emulator (i.e. SNES9x), and the coilsnake_cli.exe.
  3. Run the program and it should generate a ROM patched with the Mod Menu if everything was successful.

Clone this wiki locally