kobting / protemplate Goto Github PK

This is an example character template for the more experienced Slay the Spire modder.
It contains the basics of an empty character, as well as:
- Improved X cost action framework (Alchyr)
- General action use wizard for any effects (GK + my own stuff)
- Lambda power support (mine)
- AbstractRelic, Power and Card with improved image loading and other shortcuts (alchyr + mine)
- AbstractCard comes with secondary variable and secondary damage (me + Kio)
- Automatic card recoloring (me + Mayhem)
- Hopefully more! Let me know if there's something you'd want added!!

Setup guide:
1. Clone the project with Github, preferably downloading with Github Desktop to make it so IntelliJ integration is easy!
2. Go into your pom.xml, and change the path to your steam installation, the artifactId, version number, name, description, and modID fields inside of that.
3. Rename the mod's Resources folder. (the folder under the "resources" folder, initially named todomodResources. The change needs to match your mod ID, plus "Resources". IE: if your modid is "blah", "blahResources".)
4. In the modded character file, go to the Enums section at the bottom and change the PlayerClass and CardColor enums. They're also annotated with TODOs.
5. In the main mod file, change the modID to match the modID field in your pom.xml.

6+. You'll probably want to rename your character in the CharStrings file to start off. From there, it's just making the mod of your dreams!