Grasscutters/Grasscutter

Attention: We always welcome contributors to the project. Before adding your contribution, please carefully read our Code of Conduct.

Current features

Logging in
Combat
Friends list
Teleportation
Gacha system
Co-op partially works
Spawning monsters via console
Inventory features (receiving items/characters, upgrading items/characters, etc)

Note: For support please join our Discord.

Get Java 17
Get MongoDB Community Server
Get game version REL4.0.x (If you don't have a 4.0.x client, you can find it here and open any of the links to download it): 4.0.x Client-github 4.0.x Client-cloud drive
Download the latest Cultivation version. Use the .msi installer.
After opening Cultivation (as admin), press the download button in the upper right corner.
Click Download All-in-One
Click the gear in the upper right corner
Set the game Install path to where your game is located.
Set the Custom Java Path to C:\Program Files\Java\jdk-17\bin\java.exe
Leave all other settings on default
Click the small button next to launch.
Click the launch button.
Log in with whatever username you want. Password can be anything.

Grasscutter uses Gradle to handle dependencies & building.

Requirements:

git clone --recurse-submodules https://github.com/Grasscutters/Grasscutter.git
cd Grasscutter

Note: Handbook generation may fail on some systems. To disable the handbook generation, append -PskipHandbook=1 to the gradlew jar command.

Windows:

.\gradlew.bat # Setting up environments
.\gradlew jar

Linux (GNU):

chmod +x gradlew
./gradlew jar

With Gradle:

./gradlew generateHandbook

With NPM:

cd src/handbook
npm install
npm run build

You can find the output jar in the root of the project folder.

For a list of common issues and solutions and to ask for help, please join our Discord server and go to the support channel.