Running

Prerequisites

• MongoDB
• JDK8u202

Starting the Server

If you haven't already, download a release JAR from releases or build the server yourself.

1. Run java -jar grasscutter.jar
   1. This will create additional directories in your working directory.
2. Copy the following files to the following directories:
   1. GenshinData -> resources/TextMap, resources/Subtitle, resources/Readable & resources/ExcelBinOutput
   2. gi-bin-output -> resources/BinOutput (do this for the version of Genshin Impact you're running)
   3. Protobuf Files -> resources/proto (do this for the version of Genshin Impact you're running)
   4. Keys -> keys
   5. Game Data -> data
   6. The Keystore File -> keystore.p12
   7. Note: If you are running in the project's root directory (ie. you cloned the repo from GitHub and you are running the server in that folder), these files will be already be present.
3. Run java -jar grasscutter.jar -handbook
   1. This is required for using names -> IDs in commands.
   2. This setup is optional and can be skipped.
4. Run java -jar grasscutter.jar
   1. (kinda obvious but) Leave this running in the background.
5. Continue to Connecting

Connecting

Note: This works for connecting to external servers as well.

Prerequisites

• Fiddler Classic (or another proxy to redirect web traffic)

1. Run your web traffic proxy (eg. Fiddler)
2. Route all traffic going to HoYoVerse/MiHoYo servers to the server host.
3. Launch Genshin Impact and have fun!

Traffic Route Map

api-os-takumi.mihoyo.com -> (redirect to the server host)
hk4e-api-os-static.mihoyo.com -> (redirect to the server host)
hk4e-sdk-os.mihoyo.com -> (redirect to the server host)
dispatchosglobal.yuanshen.com -> (redirect to the server host)
osusadispatch.yuanshen.com -> (redirect to the server host)
account.mihoyo.com -> (redirect to the server host)
log-upload-os.mihoyo.com -> (redirect to the server host)
dispatchcntest.yuanshen.com -> (redirect to the server host)
devlog-upload.mihoyo.com -> (redirect to the server host)
webstatic.mihoyo.com -> (redirect to the server host)
log-upload.mihoyo.com -> (redirect to the server host)
hk4e-sdk.mihoyo.com -> (redirect to the server host)
api-beta-sdk.mihoyo.com -> (redirect to the server host)
api-beta-sdk-os.mihoyo.com -> (redirect to the server host)
cnbeta01dispatch.yuanshen.com -> (redirect to the server host)
dispatchcnglobal.yuanshen.com -> (redirect to the server host)
cnbeta02dispatch.yuanshen.com -> (redirect to the server host)
sdk-os-static.mihoyo.com -> (redirect to the server host)
webstatic-sea.mihoyo.com -> (redirect to the server host)
hk4e-sdk-os-static.hoyoverse.com -> (redirect to the server host)
webstatic-sea.hoyoverse.com -> (redirect to the server host)
sdk-os-static.hoyoverse.com -> (redirect to the server host)
api-account-os.hoyoverse.com -> (redirect to the server host)
hk4e-sdk-os.hoyoverse.com -> (redirect to the server host)
uspider.yuanshen.com -> (redirect to the server host)