From 480b95c62330aa561606b4924a7c091467fe1a0b Mon Sep 17 00:00:00 2001 From: lunaticwhat Date: Mon, 18 Apr 2022 16:00:25 +0700 Subject: [PATCH] overhauled readme.md --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f7b74cdd2..02ce70c63 100644 --- a/README.md +++ b/README.md @@ -16,18 +16,21 @@ A WIP server emulator for Genshin Impact 2.3-2.6 * Java 8 JDK * Mongodb (recommended 4.0+) -### Starting up the server -1. Compile the server with `./gradlew jar` -2. Create a folder named `resources` in your server directory, you will need to copy `BinData` 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. Run the server with `java -jar grasscutter.jar`. Make sure mongodb is running as well. +### Starting up the server (Assuming you are on Windows) +1. Setup compile environment `gradlew.bat` +2. Compile the server with `gradlew jar` +3. Create a folder named `resources` in your server directory, you will need to copy `BinData` 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. +4. Run the server with `java -jar grasscutter.jar`. Make sure mongodb is running as well. ### Connecting with the client -1. If you are using the provided keystore, you will need to install and have [Fiddler](https://www.telerik.com/fiddler) running. Make sure fiddler is set to decrypt https traffic. -2. Set your hosts file to redirect at least `api-account-os.hoyoverse.com` and `dispatchosglobal.yuanshen.com` to your dispatch server ip. +½. Create an account using command below +1. Run Fiddler and turn on `Decrypt https traffic` in setting +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) +3. yoink ### Server console commands -`/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. +`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. ### In-Game 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. @@ -47,3 +50,8 @@ There is a dummy user named "Server" in every player's friends list that you can `!sethp [hp]` `!clearartifacts` - Deletes all unequipped and unlocked level 0 artifacts, **including yellow rarity ones** from your inventory + +### 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 > Fiddler > Client \ No newline at end of file