Grasscutters/Grasscutter-Docs
1
0
Fork 0
mirror of https://github.com/Grasscutters/Grasscutter-Docs.git synced 2024-11-23 04:29:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
master
Grasscutter-Docs/docs/Contributing.md
KingRainbow44 a2635d177c
Begin writing new documentation
2023-05-26 00:04:10 -04:00

2.5 KiB
Raw Permalink Blame History

Contributing to Grasscutter

See this for the contributor code of conduct.
You must agree to these terms before contributing to this project.

Prerequisites

Anything in bold is required to have.
Everything else is a recommendation.

  • Java (JDK) 17 - Required for compiling Grasscutter.
    • Greater versions of Java might work, but are unsupported.
  • MongoDB Server - Required for storing Grasscutter's data.
    • MongoDB Compass is recommended for managing the database.
    • You can use a MongoDB cloud database.
  • Gradle 7.0+ - Required for compiling Grasscutter.
    • You can also use the Gradle wrapper found when cloning the project.
  • A text editor/IDE for viewing/editing source code
  • A semi-decent knowledge of general software development.

Understanding Branches

Grasscutter currently has 2 primary branches:

  • development - This is the more stable branch of Grasscutter.
    • This receives mainly version updates and major bug fixes.
  • unstable - This is the wild west of Grasscutter.
    • This receives all updates, including experimental features and bug fixes.
    • This branch is not recommended for production use.

When you make a contribution, if you have a minor fix, please make a pull request to development.
If you have a major fix, such as a rewrite of a system or a new feature, please make a pull request to unstable.

Building

With IntelliJ IDEA

It is recommended to change your settings to the following:

  • Build and run using: IntelliJ IDEA
  • Run tests using: IntelliJ IDEA

Afterwards, you can use IntelliJ's artifact build system to create a JAR file.

If you are actively working on a feature, consider creating a new profile for an Application.
If ran in Debug with HotswapAgent, you can make changes to the code mostly without restarting the server.

With Gradle

You can use the Gradle wrapper to build Grasscutter.
To do this, run the following command in the root directory of the project:

gradlew jar