**Note**: For support please join the [Discord server](https://discord.gg/T5vZU6UyeG).
**Note**: For support please join the [Discord server](https://discord.gg/T5vZU6UyeG).
# Current features
# Current features
* Logging in
* Logging in
* Spawning monsters via console
* Spawning monsters via console
* Combat
* Combat
* Inventory features (recieving items/characters, upgrading items/characters, etc)
* Inventory features (recieving items/characters, upgrading items/characters, etc)
* Co-op does work, but movement is kind of buggy and some player ults do not spawn properly
* Co-op does work, but movement is kind of buggy and some player ults do not spawn properly
* Friends list
* Friends list
* Gacha system
* Gacha system
# Running the server and client
# Running the server and client
### Prerequisites
### Prerequisites
* JDK-8u202 ([mirror link since Oracle required an account to download old builds](https://mirrors.huaweicloud.com/java/jdk/8u202-b08/))
* JDK-8u202 ([mirror link since Oracle required an account to download old builds](https://mirrors.huaweicloud.com/java/jdk/8u202-b08/))
* Mongodb (recommended 4.0+)
* Mongodb (recommended 4.0+)
* Fiddler Classic
* Proxy daemon: mitmproxy (mitmdump, recommended), Fiddler Classic, etc.
### Starting up the server (Assuming you are on Windows)
### Starting up the server (Assuming you are on Windows)
1. Setup compile environment `gradlew.bat`
1. Setup compile environment `gradlew.bat`
2. Compile the server with `gradlew jar`
2. Compile the server with `gradlew jar`
3. Create a folder named `resources` in your server directory, you will need to copy `BinOutput` and `ExcelBinOutput` folders which you can get from a repo like [https://github.com/Dimbreath/GenshinData](https://github.com/Dimbreath/GenshinData) into your resources folder.
3. Create a folder named `resources` in your server directory, you will need to copy `BinOutput`, `ExcelBinOutput` folders and `TextMap*.json` which you can get from a repo like [https://github.com/Dimbreath/GenshinData](https://github.com/Dimbreath/GenshinData) into your resources folder.
4. Run the server with `java -jar grasscutter.jar`. Make sure mongodb is running as well.
4. Run the server with `java -jar grasscutter.jar`. Make sure mongodb is running as well.
### Connecting with the client
### Connecting with the client
½. Create an account using command below
½. Create an account using command below
1. Run Fiddler and turn on `Decrypt https traffic` in setting
1. Run a proxy daemon:
2. Set your hosts file to redirect at least api-account-os.hoyoverse.com and dispatchosglobal.yuanshen.com to your dispatch server ip. Or use Fiddler with script from [https://github.lunatic.moe/fiddlerscript](https://github.lunatic.moe/fiddlerscript)(Recommended for beginners)
- mitmdump: `mitmdump -s proxy.py --ssl-insecure`
3. If you're using Fiddler, change the default port there (Tools -> Options -> Connections) to anything other than 8888, otherwise the server won't boot.
- Fiddler Classic: Run Fiddler Classic, turn on `Decrypt https traffic` in setting and change the default port there (Tools -> Options -> Connections) to anything other than `8888`, load [this script](https://github.lunatic.moe/fiddlerscript).
4. yoink
- hosts: Redirect at least `api-account-os.hoyoverse.com` and `dispatchosglobal.yuanshen.com` to your dispatch server ip.
2. Set network proxy to `127.0.0.1:8080` or the proxy port you specified.
`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.
4. yoink
### In-Game commands
* or you can use `run.cmd` to start Server & Proxy daemon with one click
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.
### Server console commands
`!spawn [monster id] [level] [amount]`
`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.
`!give [item id] [amount]`
### In-Game commands
`!drop [item id] [amount]`
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.
`!killall`
`!spawn [monster id] [level] [amount]`
`!godmode` - Prevents you from taking damage
`!give [item id] [amount]`
`!resetconst` - Resets the constellation level on your current active character, will need to relog after using the command to see any changes.
`!drop [item id] [amount]`
`!sethp [hp]`
`!killall`
`!clearartifacts` - Deletes all unequipped and unlocked level 0 artifacts, **including yellow rarity ones** from your inventory
`!godmode` - Prevents you from taking damage
### Quick Troubleshooting
`!resetconst` - Resets the constellation level on your current active character, will need to relog after using the command to see any changes.
* If compiling wasnt successful, please check your JDK installation (must be JDK 8 and JDK's bin PATH variable is correct)
* My client doesn't connect, doesn't login, 4206, etc... - Mostly your fiddler is the issue, make sure it running on another port except 8888
`!sethp [hp]`
* Startup sequence: Mongodb > The server > Fiddler > Client
* If `4206` error constantly prompt up, try to use [jdk-8u202-b08](https://mirrors.huaweicloud.com/java/jdk/8u202-b08/) instead of other versions of JDK
`!clearartifacts` - Deletes all unequipped and unlocked level 0 artifacts, **including yellow rarity ones** from your inventory
### Quick Troubleshooting
* If compiling wasnt successful, please check your JDK installation (must be JDK 8 and JDK's bin PATH variable is correct)
* My client doesn't connect, doesn't login, 4206, etc... - Mostly your fiddler is the issue, make sure it running on another port except 8888
* Startup sequence: Mongodb > The server > Proxy daemon (mitmdump, fiddler, etc.) > Client
* If `4206` error constantly prompt up, try to use [jdk-8u202-b08](https://mirrors.huaweicloud.com/java/jdk/8u202-b08/) instead of other versions of JDK
Jaida Wu <mlgmxyysd@meowcat.org>