Home

ModTheSpire is a tool to load external mods for Slay the Spire without modifying the base game files, along with allowing mods the ability to patch their own code into the game's code.

Playing Mods

To use ModTheSpire to play a mod

1. Ensure you have Java 8 installed.
2. Download the latest release of ModTheSpire.
3. Place ModTheSpire.jar inside your Slay the Spire installation directory. It should be alongside desktop-1.0.jar.
   1. Note: On Mac, there's no desktop-1.0.jar file in the installation directory. Still put ModTheSpire.jar there.
4. Create a mods directory inside your Slay the Spire installation directory.
5. Place any mods inside the mods directory.

SlayTheSpire/
    mods/
        Mod1.jar
        Mod2.jar
    desktop-1.0.jar
    ModTheSpire.jar
    ...

6. Run ModTheSpire.jar with Java 8.
7. (Optional) Run ModTheSpire through SlayTheSpire.exe.
   1. Rename desktop-1.0.jar to SlayTheSpire.jar.
   2. Rename ModTheSpire.jar to desktop-1.0.jar.
   3. Run SlayTheSpire.exe or run Slay the Spire through Steam.

Writing Mods

There are two ways to mod Slay the Spire using ModTheSpire: Replacing game files and patching. Patching is the preferred method.

Replacing Game Files

Replacing game files is the simpler way to mod, but any mods using this method are incompatible with any other mod and unable to be loaded at the same time as any other mod.

ModTheSpire will search for file and classes in mods before searching the base game. This means if a mod includes a file with the same name and path as a file in the base game, the mod's file will be used instead.

Patching

Patching allows you to inject code anywhere into the game's code. See SpirePatch for detailed information on writing patches.