Home
This page explains how to get started with modding Slay the Spire 2 by setting up a initial project. Slay the Spire 2 is written in C# using the Godot game engine and is highly moddable. The first steps under Setup below include what you need to install and where to start.
Be aware that Slay the Spire 2 is currently in Early Access. As the game is frequently updated things are likely to change in ways that break mods. Any mods created during this period will need to be updated after each breaking change in the main game, and modding as a whole may be somewhat unstable.
This guide in a work in progress; given how new StS 2 modding is, we're actively working on making it easier to start modding.
- Adding Cards
- Adding Ancients
- Common Commands Cookbook
- Check BaseLib for anything not listed here (docs, code)
- BaseLib documentation
- Harmony documentation
- Godot getting started guide (the GDScript stuff isn't as relevant but the overview of concepts is good)
- Reading a stack trace
- The #sts2-modding channel on the Slay the Spire Discord is the best place to ask for help
If you're missing BaseLib features, check your project's NuGet dependencies and see if you're missing an update (alt+shift+7 to open in Rider).
Select an out-of-date dependency and click the arrow in a circle button to update.
You're recommended to also keep the analyzer up-to-date.