Troubleshooting

Table of Contents Playing With Mods Are you on the beta branch of Slay the Spire? Do you have the latest version of ModTheSpire and BaseMod? Do you have the latest version of Slay the Spire? Is it Thursday or Friday (Or sometimes Saturday)? Are your folders set up correctly for mods? Are you starting the game with the script? Developing Mods Did you package your mod into a .jar file? Are you trying to recompile the decompiled source code? Did you follow the troubleshooting steps for playing with mods?

Playing With Mods

Are you on the beta branch of Slay the Spire?

Switch out of beta mode

Both ModTheSpire and BaseMod do not officially support beta. Since almost all mods rely on one or both of these mods, there is no guarantee that the mod(s) you are playing with will work on beta.

Do you have the latest version of ModTheSpire and BaseMod?

The latest releases for ModTheSpire and BaseMod can be found here and here.

Do you have the latest version of Slay the Spire?

Update through Steam.

Is it Thursday or Friday (Or sometimes Saturday)?

Check if all of the mods you are playing with (especially BaseMod) have been updated for the latest patch of Slay the Spire.

The developers of Slay the Spire release a weekly patch every Thursday. The patch often breaks something in BaseMod, ModTheSpire, or the mod(s) you are trying to play with. It takes time to update mods, so have patience while the mod developers update their mods to be compatible with the latest patch.

Are you a developer? Consider creating a pull request to make the mod compatible with the latest patch.

Are your folders set up correctly for mods?

Your folder setup should look something like this:

SlayTheSpire/
    mods/
        Mod1.jar
        Mod2.jar
    desktop-1.0.jar
    ModTheSpire.jar
    MTS.cmd (if on PC)
    MTS.sh (if on Linux)
    ...

or this, if you're on Mac:

SlayTheSpire/
    SlayTheSpire.app/
        Contents/
            Info.plist
            MacOS/
                run.sh
            Resources/
                mods/
                    mod1.jar
                    mod2.jar
                desktop-1.0.jar
                ModTheSpire.jar
                MTS.sh

Are you starting the game with the script?

Start Slay the Spire with MTS.cmd if you are playing on PC and MTS.sh if you are playing on Linux.

Developing Mods

This is a troubleshooting guide to help solve some of the most common issues when developing your first mod. If you are not developing a mod and are simply trying to play Slay the Spire with mods, read the Playing With Mods section above.

If you are looking for a tutorial on writing your first mod, check out this tutorial to get started and this page for a more details about how mods work.

All of the steps in the Playing With Mods section apply as well.

Did you package your mod into a .jar file?

You should be packaging your mod into a .jar file and placing that .jar file into the mods folder where you play Slay the Spire.

You can package your mod through the command line with mvn package or through built in tools in IntelliJ or Eclipse.

Are you trying to recompile the decompiled source code?

Don't.

Follow the instructions on how to package your mod with Maven in the tutorial.

Did you follow the troubleshooting steps for playing with mods?

Those start at the top of the page. All of those steps apply as well.