Grasscutter README

The project's README from github.com/Grasscutters/Grasscutter. As one markdown file: README.md.

Grasscutter

Documentation GitHub release (latest by date) GitHub GitHub last commit GitHub Workflow Status
Discord - Grasscutter

EN | 简中 | 繁中 | FR | ES | HE | RU | PL | ID | KR | FIL/PH | NL | JP | IT | VI

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

Current features

Foreward

Grasscutter beyond the latest release will have no handholding in terms of instructions.

Grasscutter has not been actively maintained and currently (as of January 12th, 2025) only works up to version REL4.0.1 (introduction to Fontaine). If you have a beta version/unofficial version of Grasscutter, this guide should theoretically still work, however, we will not provide official support these versions. You can still try your luck in the Discord if you are stuck, but please don't act entitled.

Quick setup guide

Note: For support please join our Discord.

Quick Start (automatic)

Building

Grasscutter uses Gradle to handle dependencies & building.

Requirements:

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

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
Compiling the Handbook (Manually)

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.

Troubleshooting

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

Grasscutter (Grasscutters/Grasscutter)

Searching Database…

What is this?Grasscutter is a self-hosted server software reimplementation for a certain anime game: you run your own private game server and play on it with the game's own client.
Is this the game itself, or just the server it connects to?Just the server half. You still need a real REL4.0.x game client; the Cultivation launcher takes your existing game install and points it at the server.
How do I get a private server up and running?Easiest path: install Java 17 and MongoDB, grab a REL4.0.x client, then use the Cultivation launcher (.msi, run as admin) - set the game and Java paths and hit launch. You can also build the server jar yourself with Gradle (JDK 17+, Git).
What do I need to have installed before it will run?Java 17, MongoDB Community Server, and a matching 4.0.x game client. Versions cannot be mixed - you must download the Grasscutter build that matches your client version.
Will it work with the latest version of the game?No. The project is no longer actively maintained and, as of January 12th, 2025, only supports game versions up to REL4.0.1 (the Fontaine update).
Is it Windows-only, or can I host the server on Linux too?The server builds and runs on both Windows and GNU/Linux, and the repo ships Docker support. Only the client-side Cultivation launcher is a Windows .msi.
What actually works in the game once the server is up?Login, combat, friends list, teleportation, the gacha system, spawning monsters via the server console, and inventory features (receiving and upgrading items and characters) all work; co-op only partially works.
Do I need to register an account to log in?No. You log in with whatever username you want, and the password can be anything.
Can I run the server in Docker?Yes - the repository ships Docker support alongside the standard Java/Gradle setup, so the server can run as a container instead of a plain Java process.
What are similar projects?gost, mongo, Chat2DB, flyway, spider-flow, chat, Signal-Server, dtm
Size
99.1 MB
Stars
16.8K
Age
4y
Commits · 90 Days