Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 2.18 KB

README.md

File metadata and controls

41 lines (30 loc) · 2.18 KB
Raw

Create Steam 'n' Rails



Discord Banner 3

Create Steam 'n' Rails is an addon mod for Create that aims to extend Create's train and steam systems. Current features include custom tracks, semaphores, and conductors.

Contributing (for team members):

  1. Create a new branch for your feature (named 1.18/<feat>)
  2. Write your feature
  3. Make a pull request
  4. Have somebody review it, and merge

Contributing (for community members):

  1. Open an issue clearly describing the feature you want to implement
  2. Don't start writing your feature until a core dev recommends you to
  3. Fork the repository (if you haven't already), and make a branch for your feature
  4. Happy coding!
  5. Open a pull request, preferably linking to your issue - include your Discord username, and those of the people who helped you, so you can get the contributor role
  6. (For core devs) at least 2 core devs should approve before merging - probably have discussion in Discord first as well.

Datagen:

Make sure to set the following environment variable when running datagen.

DATAGEN=TRUE

Commit Tricks:

  • Include [ci skip] in your commit message to skip the automatic preview build you can use this for example if the change you made is very minor, and not worth a preview, or if you are just fixing a typo in the README, etc.

License

Steam 'n' Rails is licensed under the MIT license. See LICENSE for more information.

Certain sections of the code are from the Create mod, which is licensed under the MIT license. See Create's license for more information.

Some datafixer code is from the Quilt Standard Libraries, which is licensed under the Apache-2.0 license. See QSL's license for more information.

Most of the code for spy conductors is from Security Craft, which is licensed under the MIT license. See Security Craft's license for more information.