README.md

Jorbs Mod

Slay the Spire mod with character and game design by Jorbs and Twitch Chat.

• Design info and progress tracking: Mod Character Package spreadsheet
• Discussion and updates: Jorbs Discord channels under "Projects that Fuel Wizardry" group

Many people have contributed code and art for this mod; thanks to all the contributors listed among the mod authors.

This mod would not have been possible without the excellent documentation and guidance from all of the contributors at ModTheSpire, BaseMod, StSLib, StS-DefaultModBase, and Slay the Spire Discord #modding.

This mod aims to support both the stable and beta branches of Slay the Spire, but is primarily developed and tested against the beta branch. If you notice an incompatibility with either branch, please file an issue!

Table of contents

• How to Install
• How to build from source
• How to contribute art
• How to contribute sound effects
• How to contribute changes

How to install

1. Through Steam, install Slay the Spire
2. (optional, but recommended) Switch to the Beta branch (right click Slay the Spire in your Steam Library, Properties -> BETAS tab -> select "beta" in dropdown)
3. From the Steam Workshop, install "Mod the Spire", "BaseMod", and "StSLib"
4. Download JorbsMod.jar from the latest release:
5. Launch Mod the Spire by right clicking on Slay the Spire in your Steam Library "Play with Mods"
6. In the Mod the Spire launcher, select the "open mods folder" button
7. Copy JorbsMod.jar into this mods folder
8. Close and relaunch Mod the Spire
9. Make sure "BaseMod", "StSLib", and "JorbsMod" are all checked
10. Play!

How to build from source

1. Create an environment variable named STEAMAPPS_PATH
   • On Windows, open a Command Prompt run setx STEAMAPPS_PATH "C:\Program Files (x86)\Steam\steamapps"
   • On Mac, open ~/.bash_profile and add a line like export STEAMAPPS_PATH="~/Library/Application Support/Steam/steamapps"
   • Adjust the paths accordingly if you have installed Steam to a different location
2. Install the Oracle Java 8 JDK (not Java 9+)
3. Install IntelliJ IDEA (the free Community edition is fine)
4. Through Steam, install Slay the Spire (stable branch)
5. From the Steam Workshop, install "Mod the Spire", "BaseMod", and "StSLib"
6. Clone the repository
7. 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
8. Follow the these instructions from the StS-DefaultModBase wiki to build the mod package and debug it

How to contribute art

See the .../images/README.md file in the resources folder.

How to contribute sound effects

See the .../audio/README.md file in the resources folder.

How to contribute translations to other languages

See the .../localization/README.md file in the resources folder.

How to contribute changes

Note: if this is too complicated and you just want to send us some paint art for cards, feel free to reach out on the Jorbs Discord in #jorbs-spire-mod-char - someone there will give you a hand!

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):

   # This is where the folder for the mod code will be placed inside of.
   # This can be wherever you like; I like something short like "C:\code" or "C:\repos".
   # Don't use a path with spaces in it!
   cd C:/code
   
   # This will clone the repository into a new folder named "jorbs-spire-mod" inside the directory you picked above
   git clone --origin upstream https://github.com/dbjorge/jorbs-spire-mod.git
   cd jorbs-spire-mod
   
   # Replace "your_username" with your GitHub username!
   git remote add my_fork https://github.com/your_username/jorbs-spire-mod.git
   
   # These are "aliases", helper commands that will make it easier to use GitHub Pull Requests
   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 the usual git add * and git commit -m 'description of changes' commands to make local commits
   • If you're brand new to git, https://try.github.io has some good learning resources

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