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

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

Quick setup guide

Note: For support please join our Discord.

Quick Start (automatic)

Windows quick start using Cultivation

• Get Java 21
• Get MongoDB Community Server

• Get game version REL5.0

• 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-21\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.

Downloading 5.0

Download Link Table

Note: Scroll down to see patch files from 4.8 to 5.0.

Download link	Package size	Decompressed package size	MD5 checksum
GenshinImpact_5.0.0.zip.001	10.0 GB	20.0 GB	1ebf5dbcbe43bebcda7a57a8d789092e
GenshinImpact_5.0.0.zip.002	10.0 GB	20.0 GB	57a67026c45d57c28e5b52e24e84cc04
GenshinImpact_5.0.0.zip.003	10.0 GB	20.0 GB	5e66ff28eaf6ba89e49f153c0f077d34
GenshinImpact_5.0.0.zip.004	10.0 GB	20.0 GB	39f014a760e27f77abed1989739c74c6
GenshinImpact_5.0.0.zip.005	10.0 GB	20.0 GB	15f9405a199afba833f18fce288b9c7f
GenshinImpact_5.0.0.zip.006	10.0 GB	20.0 GB	881432ceab27987b1297c9eefb39f192
GenshinImpact_5.0.0.zip.007	3.78 GB	7.57 GB	951f91992b428385294baf9b6c764d49
Audio_Chinese_5.0.0.zip	14.77 GB	29.56 GB	216b3e53f3c5c7e1290891696b2bbc66
Audio_English(US)_5.0.0.zip	17.23 GB	34.47 GB	ecd59f31ec48c50f9051fdad39603d67
Audio_Korean_5.0.0.zip	14.51 GB	29.04 GB	8bf09bd07413189b69a5a0512df97335
Audio_Japanese_5.0.0.zip	19.37 GB	38.76 GB	95efbd23e1bde2eb574f8090cc118109

4.8 -> 5.0 Patch FIles

Download link	Package size	Decompressed package size	MD5 checksum
game_4.8.0_5.0.0_hdiff_wZvKsUhQtnBEutrh.zip	19.52 GB	39.86	ec0cc740e01c374cd53d48219c1a4aff
audio_ko-kr_4.8.0_5.0.0_hdiff_gTmBNUAGPpXxrRKC.zip	0.60 GB	1.31 GB	64c52d4065a5d5983b37faeb9796a3eb
audio_ja-jp_4.8.0_5.0.0_hdiff_LumPhRraNOjGJMnG.zip	0.71 GB	1.63 GB	934899593f7234bec937fca98c0b0bed
audio_zh-cn_4.8.0_5.0.0_hdiff_ZZiDHvYQeHGKuFeP.zip	0.62 GB	1.35 GB	c1073373d6c7b3680217335dc346de50
audio_en-us_4.8.0_5.0.0_hdiff_vsfAECOkroqoZSqK.zip	0.74 GB	1.58 GB	b5cb77749a0e2fc0e85b6b1ee319a7e9

Building

Grasscutter uses Gradle to handle dependencies & building.

Requirements:

• Java Development Kit 21 or higher
• Git

Clone

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

Compile

Windows:

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

Linux (GNU):

chmod +x gradlew
./gradlew jar

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.

Credits

[!NOTE] Protocol definitions are dumped from many parties, but they are not stated here. Thanks for contributing!

• KCP Library - grasskcper updated with the byte_check_code