Skip to content

Latest commit

 

History

History
93 lines (66 loc) · 5.23 KB

CONTRIBUTING.md

File metadata and controls

93 lines (66 loc) · 5.23 KB
Raw

Contributing

We welcome contributions, including from newcomers with no prior modding experience. Jorbs's Wanderer Trilogy is built from the contributions of almost 100 contributors! If you aren't sure where to start, the best place to ask is the Discord (look for the channels in the Projects that Fuel Wizardry group).

Table of contents

Resources and links

How to build from source

  1. Create an environment variable named STEAMAPPS_PATH
    • On Windows, open a Command Prompt and 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

Coordinate on Discord in #mod-char-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

Coordinate on Discord in #mod-localization-channel.

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

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