.github/workflows | ||
data | ||
gradle/wrapper | ||
Grasscutter-Protos@dd17415b71 | ||
keys | ||
lib | ||
src/main | ||
.gitignore | ||
.gitmodules | ||
build.gradle | ||
GM_Handbook.txt | ||
gradlew | ||
gradlew.bat | ||
keystore.p12 | ||
LICENSE | ||
proxy_config.py | ||
proxy.py | ||
README.md | ||
settings.gradle | ||
start_config.cmd | ||
start.cmd |
Grasscutter
A WIP server reimplementation for some anime game 2.3-2.6
Documentation: Grasscutter Wiki
Note: For support please join the Discord server.
Current features
- Logging in
- Combat
- Spawning monsters via console
- Inventory features (recieving items/characters, upgrading items/characters, etc)
- Gacha system
- Friends list
- Co-op partially works
Quick setup guide
Note
- If you updated from an older version, delete
config.json
to regenerate it.
Prerequisites
- Java 16
- Mongodb (recommended 4.0+)
- Proxy daemon: mitmproxy (mitmdump, recommended), Fiddler Classic, etc.
Starting up Grasscutter server (Assuming you are on Windows)
- Setup the compile environment with
gradlew.bat
- Compile Grasscutter with
gradlew jar
- Create a folder named
resources
in your Grasscutter directory, move yourBinOutput
andExcelBinOutput
folders there (Check the wiki for more details on how to get those.) - Run Grasscutter with
java -jar grasscutter.jar
. Make sure mongodb service is running as well.
Connecting with the client
½. Create an account using server console command below
- Run a proxy daemon: (choose either one)
- mitmdump:
mitmdump -s proxy.py -k --allow-hosts ".*\.yuanshen\.com|.*\.mihoyo\.com|.*\.hoyoverse\.com"
- Fiddler Classic: Run Fiddler Classic, turn on
Decrypt https traffic
in setting and change the default port there (Tools -> Options -> Connections) to anything other than8888
, and load this script. - Hosts file
- mitmdump:
- Trust CA certificate:
- mitmdump:
certutil -addstore root %USERPROFILE%\.mitmproxy\mitmproxy-ca-cert.cer
- mitmdump:
- Set network proxy to
127.0.0.1:8080
or the proxy port you specified. - yoink
- or you can use
start.cmd
to start Server & Proxy daemon with one click
Grasscutter commands
There is a dummy user named "Server" in every player's friends list that you can message to use commands. Commands also work in other chat rooms, such as private/team chats.
account create [username] {playerid}
- Creates an account with the specified username and the in-game uid for that account. The playerid parameter is optional and will be auto generated if not set.
spawn [monster id] [level] [amount]
give [item id] [amount] [level]
givechar [avatar id] [level]
drop [item id] [amount]
killall
setworldlevel [level]
- Changes your world level, relog to see effects properly
godmode
- Prevents you from taking damage
resetconst
- Resets the constellation level on your currently selected character, will need to relog after using the command to see any changes.
setstats [stats] [amount]
- Changes the currently selected character's specified stat.
clearartifacts
- Deletes all unequipped and unlocked level 0 artifacts, including 5-star rarity ones from your inventory
pos
- Gets your current coordinates.
weather [weather id] [climate id]
- Changes the current weather.
More commands will be updated in the wiki.
Bonus
When you want to teleport somewhere, use the in-game marking function on the Map, click Confirm. You will see your character falling from a very high spot at the exact location you marked.
Quick Troubleshooting
- If compiling wasn't successful, please check your JDK installation (must be JDK 8 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 make sure it's running on a port other than 8888
- Startup sequence: Mongodb > Grasscutter > Proxy daemon (mitmdump, fiddler, etc.) > Client