diff --git a/README.md b/README.md index 726494819..de1e2ce67 100644 --- a/README.md +++ b/README.md @@ -22,51 +22,23 @@ **Note**: For support please join our [Discord](https://discord.gg/T5vZU6UyeG). -### Requirements +### Quick Start (automatic) -* [Java SE - 17](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) or higher +• Get Java 17: https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html +• Get [MongoDB Community Server](https://www.mongodb.com/try/download/community) +• Get game version REL3.7 (3.7 client can be found here if you don't have it): https://github.com/MAnggiarMustofa/GI-Download-Library/blob/main/GenshinImpact/Client/3.7.0.md) - **Note:** If you just want to **run it**, then **jre** only is fine. +• Download the [latest Cultivation version](https://github.com/Grasscutters/Cultivation/releases/latest). Use the `.msi` installer. +• After opening Culivation (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-17\bin\java.exe` +• Leave all other settings on default -* [MongoDB](https://www.mongodb.com/try/download/community) (recommended 4.0+) - -* Proxy Daemon: [mitmproxy](https://mitmproxy.org/) (mitmdump, recommended), [Fiddler Classic](https://telerik-fiddler.s3.amazonaws.com/fiddler/FiddlerSetup.exe), etc. - -### Running - -**Note:** If you updated from an older version, delete `config.json` to regenerate it. - -1. Get `grasscutter.jar` - - Download from [releases](https://github.com/Grasscutters/Grasscutter/releases/latest) or [actions](https://github.com/Grasscutters/Grasscutter/actions/workflows/build.yml) or [build the server by yourself](#building). -2. Create a `resources` folder in the directory where grasscutter.jar is located and move your `BinOutput, ExcelBinOutput, Readables, Scripts, Subtitle, TextMap` folders there *(Check the [wiki](https://github.com/Grasscutters/Grasscutter/wiki) for more details how to get those.)* -3. Run Grasscutter with `java -jar grasscutter.jar`. **Make sure mongodb service is running as well.** - -### Connecting with the client - -½. Create an account in the server console using this [command](https://github.com/Grasscutters/Grasscutter/wiki/Commands#:~:text=account%20%3Ccreate|delete%3E%20%3Cusername%3E%20[UID]). - -1. Redirect traffic: (choose one only) - - mitmdump: `mitmdump -s proxy.py -k` - - - Trust CA certificate: - - - The CA certificate is usually stored in `%USERPROFILE%\.mitmproxy`, double click `mitmproxy-ca-cert.cer` to [install](https://docs.microsoft.com/en-us/skype-sdk/sdn/articles/installing-the-trusted-root-certificate#installing-a-trusted-root-certificate) or... - - - Via command line *(needs administration privileges)* - - ```shell - certutil -addstore root %USERPROFILE%\.mitmproxy\mitmproxy-ca-cert.cer - ``` - - - Fiddler Classic: Run Fiddler Classic, turn on `Decrypt HTTPS traffic` in (Tools -> Options -> HTTPS) and change the default port in (Tools -> Options -> Connections) to anything other than `8888`, load [this script](https://github.com/Grasscutters/Grasscutter/wiki/Resources#fiddler-classic-jscript) (copy and paste the script in the `FiddlerScript` tab) and click the `Save Script` button. - - - [Hosts file](https://github.com/Grasscutters/Grasscutter/wiki/Resources#hosts-file) - -2. Set network proxy to `127.0.0.1:8080` or the proxy port you specified. - -- For mitmproxy: After setting up the network proxy and installing the certificate, check http://mitm.it/ if traffic is passing through mitmproxy. - -**You can also use `start.cmd` to start servers and proxy daemons automatically, but you have to set up `JAVA_HOME` environment and configure the `start_config.cmd` file.** +• Click the small button next to launch. +• Click the launch button. +• Log in with whatever username you want. Password doesn't matter. ### Building