Home

Welcome to the default guide for making StS mods.

The Default Mod Base is an over-commented 'tutorial/start-from' mod for those wishing to make mods from more than a completely empty canvas, and less than a complicated, pre-existing mod with many parts. It's also for those who just want to reference it's code while learning to mod StS from scratch (you can learn that via the BaseMod wiki)

---

What the Default Mod Base includes:

1. A character (the Default) with a complete Spriter animation;
2. A minimal set of cards (1 of each type and rarity, as well as a few extra for displaying unique variables);
3. Minimal set of relics:
   • Energy;
   • Buff (Strength);
   • Bottled;
   • Clickable;
4. A 33 line SpirePatch with 182 lines of comments explaining it;
5. An orb;
6. A ? room event;
7. A character specific, and a non-character specific potion;
8. Extra bits and bops such as:
   • A spreadsheet of the number of cards in the basegame classes by type/cost/rarity;
   • PSD files for the cardbacks/char/energy orb/etc;
   • A GitHub branch with a small kotlin x java implementation example (java seems to be necessary for SpirePatches to work);
   • A Branch with pre-deleted items to start mods that exclusively add:
     • Relics
     • TODO: Events
     • TODO: Base-Class Cards
   • Uncommented, clonable "quickstart" branch; (very slightly out of date though you'll have to do auto-load for cards yourself it's just a pain to update for me)

---

Gettings Started:

Step 1: Setting Up Your Integrated Development Environment and the Default Mod Base