Skip to content

Latest commit

 

History

History
46 lines (39 loc) · 1.83 KB

README.md

File metadata and controls

46 lines (39 loc) · 1.83 KB

⛏ Jan's Survival Tools

A minimal server mod that includes some useful features for vanilla-like survival servers

Installation

  1. Download and run the Fabric installer.
  2. Download the mod jar from the releases page and move it to the mods folder (.minecraft/mods).

Contributing

  1. Clone the repository 
    git clone https://github.com/jan-dt/SurvivalTools.git
cd SurvivalTools
  2. Generate the Minecraft / Fabric source code 
    ./gradlew genSources
    • Note: on Windows, use gradlew rather than ./gradlew.
  3. Import the project into your preferred IDE.
    1. If you use IntelliJ (the preferred option), you can simply import the project as a Gradle project.
    2. If you use Eclipse, you need to ./gradlew eclipse before importing the project as an Eclipse project.
  4. Edit the code
  5. After testing in the IDE, build a JAR to test whether it works outside the IDE too 
    ./gradlew build
    The mod JAR may be found in the build/libs directory
  6. Create a pull request so that your changes can be integrated into the mod
    • Note: for large / breaking contributions, create an issue before creating a pull request

License

All files in this repository are licensed under the Mozilla Public License 2.0 (also available at https://www.mozilla.org/en-US/MPL/2.0/), unless stated otherwise.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed under the MPL-2.0 license as stated above.