Repository files navigation

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

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

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

Note: For support please join ourDiscord.

• Java SE - 17

  Note: If you just want torun it, thenjre only is fine.

• MongoDB (recommended 4.0+)

• Proxy Daemon:mitmproxy (mitmdump, recommended),Fiddler Classic, etc.

Note: If you updated from an older version, deleteconfig.json to regenerate it.

1. Getgrasscutter.jar
   • Download fromactions orbuild the server by yourself.
2. Create aresources folder in the directory where grasscutter.jar is located and move yourBinOutput, ExcelBinOutput, Readables, Scripts, Subtitle, TextMap folders there(Check thewiki for more details how to get those.)
3. Run Grasscutter withjava -jar grasscutter.jar.Make sure mongodb service is running as well.

½. Create an account usingserver console command.

1. Redirect traffic: (choose one)

   • mitmdump:mitmdump -s proxy.py -k

     Trust CA certificate:

     ​Note: The CA certificate is usually stored in%USERPROFILE%\.mitmproxy, or you can download it fromhttp://mitm.it

     ​Double click forinstall or ...

     • Via command line (needs administration privileges)

       certutil -addstore root %USERPROFILE%\.mitmproxy\mitmproxy-ca-cert.cer

   • Fiddler Classic: Run Fiddler Classic, turn onDecrypt HTTPS traffic in (Tools -> Options -> HTTPS) and change the default port in (Tools -> Options -> Connections) to anything other than8888, and loadthis script (copy and paste the script in theFiddlerScript tab).

   • Hosts file

2. Set network proxy to127.0.0.1:8080 or the proxy port you specified.

You can also usestart.cmd to start servers and proxy daemons automatically, but you have to set up JAVA_HOME enviroment and configure thestart_config.cmd file.

Grasscutter uses Gradle to handle dependencies & building.

Requirements:

• Java SE Development Kits - 17
• Git

git clone https://github.com/Grasscutters/Grasscutter.gitcd Grasscutter.\gradlew.bat# Setting up environments.\gradlew jar# Compile

git clone https://github.com/Grasscutters/Grasscutter.gitcd Grasscutterchmod +x gradlew./gradlew jar# Compile

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

• If compiling wasn't successful, please check your JDK installation (JDK 17 and validated JDK's bin PATH variable)
• My client doesn't connect, doesn't login, 4206, etc... - Mostly your proxy daemon setup isthe issue, if usingFiddler make sure it running on another port except 8888
• Startup sequence: MongoDB > Grasscutter > Proxy daemon (mitmdump, fiddler, etc.) > Game