Introduction
Grasscutter is a server-side simulator for an animated game that allows people to have a more enjoyable gaming experience.
Features
- Login
- Battle
- Command line monster generation
- Inventory management (backpack, characters, etc.)
- Gacha system
- Friend system
Guide
This guide is based on a 64-bit system with Windows 11 and game version 2.6. It assumes that a folder named "Grasscutter" has been created in the D drive, which will be referred to as the "working directory."
Dependencies
JDK-8u202
Download "jdk-8u202-windows-x64.exe" from the Huawei mirror source and install it. After installation, add "xxx\Java\jdk1.8.0_202\bin" to the system environment variable "PATH."
You can check if the configuration is correct by opening the command prompt and entering "java -version." If the output is:
java version "1.8.0_202"
then the configuration is correct.
Mongodb
Download the "Mongodb 5.0.7" compressed file format from the official website or directly from here. After downloading, extract it to "D:\Grasscutter\mongodb." The "D:\Grasscutter\mongodb\bin" folder should now contain the "mongod.exe" file.
Create a "db" folder in "D:\Grasscutter\mongodb" to store the database files. Open the command prompt and navigate to "D:\Grasscutter\mongodb\bin." Enter the following command to start mongodb:
mongod --dbpath "D:\Grasscutter\mongodb\db"
If there is output and it does not terminate, then this step has been configured correctly. Do not close this command prompt window and keep it running in the background.
Server
Lazy Package
Please download this file and extract it directly to "D:\Grasscutter."
Manual Operation
Build Server
Clone Project
First, you need to install git. Then, run the command prompt and navigate to "D:\Grasscutter." Enter and run the command "git clone https://github.com/Grasscutters/Grasscutter.git."
Start Building
After cloning, go to "D:\Grasscutter\Grasscutter" and perform the following steps:
- Run "gradlew.bat."
- Open a new command prompt window, enter and run "gradlew jar."
The build process will automatically complete and generate "D:\Grasscutter\Grasscutter\grasscutter.jar." This is the server-side file. Move it to "D:\Grasscutter\grasscutter.jar."
Download Resource Files
First, create a "D:\Grasscutter\resources" folder, which will be referred to as the "resource folder."
- Move the "TextMap," "Subtitle," "Readable," and "ExcelBinOutput" folders from GenshinData to the "resource folder."
- Rename the "2.5.52/Data/_BinOutput" folder from gi-bin-output to "BinOutput" and move it to the "resource folder."
- Move the "proto" folder from Grasscutter-Protos to the "resource folder."
- Move the "keys," "data," and "keystore.p12" files from Grasscutter to the "working directory."
Run
The directory structure should now be as follows:
Grasscutter
├── mongodb
│ ├── bin
│ │ └── mongod.exe
│ └── db
├── data
│ ├── Banners.json
│ └── ...
├── keys
│ ├── dispatchKey.bin
│ └── ...
├── resources
│ ├── BinOutput
│ ├── ExcelBinOutput
│ ├── proto
│ ├── Readable
│ ├── Subtitle
│ └── TextMap
├── grasscutter.jar
└── keystore.p12
Run the command prompt and navigate to the "working directory." Enter and run "java -jar grasscutter.jar -handbook," then enter and run "java -jar grasscutter.jar."
If there are no port conflicts and mongodb is also running in the background, the server-side will run normally.
After a successful run, you need to enter "account create username user_id (optional)" to create your game account.
Client
Make sure your client is the international version. You can use Snap.Genshin to switch your client version to the international version.
Download the "GrassClipper.zip" file from this Releases and extract it to any directory. Run "install.cmd" and wait for the process to finish. Then, open "GrassCutter.exe," select the game's working directory at the bottom (e.g., "D:\Program Files\Genshin Impact"), enter "127.0.0.1" at the top, and click "Run." This will open the game. When logging in, you need to enter the username you created and any password to join the test server.
Summary
The process is too complicated and currently only in a usable state (bushi).
Communication