Skip to content

Getting Started (For Modders)

_Snowy edited this page Jun 1, 2019 · 22 revisions

Getting Started With Modding Slay The Spire

Note that this guide is for Windows users. If you're using OS X or Linux most of the tutorial will be applicable but specific file locations, etc... may be different.

Slay The Spire is written in Java. So you'll need some prior experience using the Java Programming Language or be willing to learn.

Modding tools

In order to do modding for Slay The Spire you're absolutely going to need ModTheSpire. It's also recommended that you download BaseMod to have access to an easier modding API. You can download mods from the Steam Workshop. You can also download them off Github, but they will be outdated, so please subscribe to them on Steam Workshop!

You will also need Java 8 which can be found here. Click on your OS and download it before proceeding. You cannot use any other version of Java!

Folder setup

For this tutorial we are going to be using a folder called my_mods in your Documents folder. This folder (the my_mods folder will be where you can place all your mods). For this example mod we will create an example_mod folder inside my_mods to contain all the code for this mod. Directory Structure

Now inside the my_mods folder let's go ahead and create another folder called lib (lib is short for libraries). This folder is where we'll place the dependencies for your mod. Go ahead and move the ModTheSpire.jar and BaseMod.jar that you downloaded in the last step into your lib folder. Lib Folder

Environment Setup

There are two IDEs used in modding Slay The Spire. Please use IntelliJ. You can use Eclipse, however it is very inconvenient and if you ask for advice the first thing you will be told to do is switch to IntelliJ.

  • IntelliJ Setup Tutorial: Link
  • Eclipse Setup Tutorial: Link

If you already have your IDE setup, you can skip straight to the modding here:

  • Starting Your Mod: Link

Decompile Your Game

Follow this guide to decompile Slay The Spire to (essentially) look at the game's source code.

Troubleshooting

Having problems? Check out this troubleshooting guide

Clone this wiki locally