A server software reimplementation for a certain anime game.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
Thoronium 0fc578a243
Fix Cooking Compound Retrieval (#2039)
20 hours ago
.github Fix CONTIBUTING typo in protect_files.yml 3 months ago
gradle/wrapper Update gradle wrapper (closes #1076) 3 months ago
lib Remove ``java-express``. Add javalin as dependency 5 months ago
src Fix Cooking Compound Retrieval (#2039) 20 hours ago
.editorconfig Introduce a new arguments parser (#1629) 6 months ago
.gitattributes Introduce a new arguments parser (#1629) 6 months ago
.gitignore Replace protos with generated protos 6 months ago
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 9 months ago
CONTRIBUTING.md Update banners (closes #1760) 5 months ago
LICENSE Change LICENSE to GNU Affero 9 months ago
README.md added IT redeirect on all ReadME and typo fix (#1954) 2 months ago
README_HE.md added IT redeirect on all ReadME and typo fix (#1954) 2 months ago
README_NL.md added IT redeirect on all ReadME and typo fix (#1954) 2 months ago
README_es-ES.md added IT redeirect on all ReadME and typo fix (#1954) 2 months ago
README_fil-PH.md added IT redeirect on all ReadME and typo fix (#1954) 2 months ago
README_fr-FR.md added IT redeirect on all ReadME and typo fix (#1954) 2 months ago
README_id-ID.md Formalizing and changing untranslated words (#1973) 2 months ago
README_it-IT.md Added it-IT translaton (#1946) 3 months ago
README_ja-JP.md added IT redeirect on all ReadME and typo fix (#1954) 2 months ago
README_ko-KR.md added IT redeirect on all ReadME and typo fix (#1954) 2 months ago
README_pl-PL.md added IT redeirect on all ReadME and typo fix (#1954) 2 months ago
README_ru-RU.md added IT redeirect on all ReadME and typo fix (#1954) 2 months ago
README_zh-CN.md added IT redeirect on all ReadME and typo fix (#1954) 2 months ago
README_zh-TW.md added IT redeirect on all ReadME and typo fix (#1954) 2 months ago
build.gradle Revert "Add the `lombok` Gradle plugin & run `delombok`" 3 weeks ago
format_whitespace.py Fix lint commit reference 6 months ago
gradlew Update gradle wrapper (closes #1076) 3 months ago
gradlew-jar.bat Debug system (#1894) 3 months ago
gradlew.bat Update gradle wrapper (closes #1076) 3 months ago
install.sh Added support for arch linux 9 months ago
install_without_dependencies.sh Update install_without_dependencies.sh 6 months ago
keystore.p12 Update the keystore 10 months ago
manage_languages.py Stop language linter from fighting the main linter on \n 6 months ago
plugin-schema.json Add `loadAfter` plugin setting 8 months ago
proxy.py Censorship 8 months ago
proxy_config.py Allow overriding config with ENV (#506) 9 months ago
settings.gradle Initial commit 10 months ago
start.cmd fix java search in start.cmd 8 months ago
start_config.cmd fix java search in start.cmd 8 months ago

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

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)

Quick setup guide

Note: For support please join our Discord.

Requirements

Running

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

  1. Get grasscutter.jar
  2. Create a resources folder in the directory where grasscutter.jar is located and move your BinOutput, ExcelBinOutput, Readables, Scripts, Subtitle, TextMap folders there (Check the wiki for more details how to get those.)
  3. Run Grasscutter with java -jar grasscutter.jar. Make sure mongodb service is running as well.

Connecting with the client

½. Create an account in the server console using this command.

  1. Redirect traffic: (choose one only)

    • mitmdump: mitmdump -s proxy.py -k

      • Trust CA certificate:

        • The CA certificate is usually stored in %USERPROFILE%\.mitmproxy, double click mitmproxy-ca-cert.cer to install or...

        • Via command line (needs administration privileges)

          certutil -addstore root %USERPROFILE%\.mitmproxy\mitmproxy-ca-cert.cer
          
    • Fiddler Classic: Run Fiddler Classic, turn on Decrypt HTTPS traffic in (Tools -> Options -> HTTPS) and change the default port in (Tools -> Options -> Connections) to anything other than 8888, load this script (copy and paste the script in the FiddlerScript tab) and click the Save Script button.

    • Hosts file

  2. Set network proxy to 127.0.0.1:8080 or the proxy port you specified.

  • For mitmproxy: After setting up the network proxy and installing the certificate, check http://mitm.it/ if traffic is passing through mitmproxy.

You can also use start.cmd to start servers and proxy daemons automatically, but you have to set up JAVA_HOME environment and configure the start_config.cmd file.

Building

Grasscutter uses Gradle to handle dependencies & building.

Requirements:

Windows
git clone https://github.com/Grasscutters/Grasscutter.git
cd Grasscutter
.\gradlew.bat # Setting up environments
.\gradlew jar # Compile
Linux
git clone https://github.com/Grasscutters/Grasscutter.git
cd Grasscutter
chmod +x gradlew
./gradlew jar # Compile

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

Commands have moved to the wiki!

Quick Troubleshooting

  • If compiling wasn't successful, please check your JDK installation (Make sure its JDK 17 or higher and validated JDK's bin PATH variable).
  • My client doesn't connect, doesn't login, 4206, etc... - Mostly your proxy daemon setup is the issue. If you're using Fiddler, change the default port to anything other than 8888.
  • Startup sequence: MongoDB > Grasscutter > Proxy Daemon (mitmdump, fiddler, etc.) > Game