Jorbs Mod

Slay the Spire mod based on Jorbs' Mod Character Package spreadsheet. Not official.

Based on StS-DefaultModBase.

Discussion in the #jorbs-spire-mod-char channel in the Jorbs Discord.

How to install

1. Through Steam, install Slay the Spire (stable branch)
2. From the Steam Workshop, install "Mod the Spire", "BaseMod", and "StSLib"
3. Download JorbsMod.jar from the latest release (https://github.com/dbjorge/sts-jorbs-mod/releases)
4. Launch Mod the Spire by right clicking on Slay the Spire in your Steam Library "Play with Mods"
5. In the Mod the Spire launcher, select the "open mods folder" button
6. Copy JorbsMod.jar into this mods folder
7. Close and relaunch Mod the Spire
8. Make sure "BaseMod", "StSLib", and "JorbsMod" are all checked
9. Play!

How to build from source

1. Install the Oracle Java 8 JDK (not Java 9+)
2. Install IntelliJ IDEA (the free Community edition is fine)
3. Through Steam, install Slay the Spire (stable branch)
4. From the Steam Workshop, install "Mod the Spire", "BaseMod", and "StSLib"
5. Clone the repository
6. Open the project in IntelliJ IDEA:
   1. Choose "Import Project"
   2. Choose the repository folder
   3. Select "Maven"
   4. Press next a few times, all other settings can be left at defaults
7. Create a file named settings.xml in a folder named .m2 in your home directory. On Windows, you can open your home directory by typing %USERPROFILE% in File Explorer. Paste the following content (or, if settings.xml already exists, extend it). Replace the Steam installation path if you've installed Steam somewhere else!:

   <settings>
     <profiles>
       <profile>
         <id>inject-local-paths</id>
         <properties>
           <Steam.path>C:/Program Files/Steam/steamapps</Steam.path>
           <STS.jar.path>${Steam.path}/common/SlayTheSpire/desktop-1.0.jar</STS.jar.path>
         </properties>
       </profile>
     </profiles>
    
     <activeProfiles>
       <activeProfile>inject-local-paths</activeProfile>
     </activeProfiles>
   </settings>

8. Follow the these instructions from the StS-DefaultModBase wiki to build the mod package and debug it

How to contribute changes

This project uses GitHub Pull Requests to handle merging contributed changes. If you're new to using GitHub or Pull Requests, here's the TL;DR for the workflow I like to use:

First-time setup

1. Create your own fork of this repository by clicking the "Fork" button at the top right of this page (you'll need a GitHub account)
2. Install Git
3. From a command prompt, run the following (replace your_username with your GitHub username):

   cd C:/path/to/code
   
   git clone --origin upstream https://github.com/dbjorge/jorbs-spire-mod.git
   cd jorbs-spire-mod
   
   git remote add my_fork https://github/your_username/jorbs-spire-mod.git
   
   git config --global alias.newfeature "!git checkout master && git pull && git checkout -b"
   git config --global alias.pushtofork "!git push --set-upstream my_fork HEAD"

Each time you want to start a new feature/contribution...

1. (recommended) Discuss your idea on the Discord #jorbs-spire-mod-char channel first, to make sure noone else is already working on the same thing
2. Run git newfeature my-cool-feature-name
3. Make your code changes, build and test locally
4. Use git add * and git commit -m 'description of changes' to make local commits

When you're ready to submit your changes to be reviewed and merged...

1. Run git pushtofork from your feature branch
2. Create a Pull Request on GitHub