From 6666fef81a895f3951ae0cadcc05e899965d856d Mon Sep 17 00:00:00 2001 From: Wansn <2632324507@qq.com> Date: Mon, 25 Apr 2022 10:53:36 +0800 Subject: [PATCH] Update README.md --- README.md | 166 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 115 insertions(+), 51 deletions(-) diff --git a/README.md b/README.md index a95bf8b1d..009d76800 100644 --- a/README.md +++ b/README.md @@ -1,80 +1,144 @@ -# Grasscutter -A WIP server reimplementation for *certain anime game* 2.3-2.6 +![Grasscutter](https://socialify.git.ci/Grasscutters/Grasscutter/image?description=1&font=KoHo&forks=1&issues=1&language=1&name=1&owner=1&pattern=Circuit%20Board&pulls=1&stargazers=1&theme=Light) +
Documention GitHub release (latest by date) GitHub GitHub last commit GitHub Workflow Status
-We always welcome contributors to the project. Before adding your contribution, please carefully read our [Code of Conduct](https://github.com/Grasscutters/Grasscutter/blob/stable/CONTRIBUTING.md). +
Discord - Grasscutter
+ +**Attention:** We always welcome contributors to the project. Before adding your contribution, please carefully read our [Code of Conduct](https://github.com/Grasscutters/Grasscutter/blob/stable/CONTRIBUTING.md). + +## Current features -**Documentation**: [Grasscutter Wiki](https://github.com/Melledy/Grasscutter/wiki/) -**Note**: For support please join the [Discord server](https://discord.gg/T5vZU6UyeG). -# Current features * Logging in * Combat -* Spawning monsters via console -* Inventory features (receiving 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. +* Teleportation +* Gacha system +* Co-op *partially* work +* Spawning monsters via console +* Inventory features (recieving items/characters, upgrading items/characters, etc) + +## Quick setup guide + +**Note:** for support please join our [Discord]() + +### Requirements + +* Java - SE ([mirror link](https://github.com/adoptium/temurin16-binaries/releases/tag/jdk-16.0.2+7) since Oracle required an account to download old builds) + + **Note:** If you just want to **run it**, then **jre** is fine + +* MongoDB (recommended 4.0+) -### Prerequisites -* Java SE Development Kit 16 -* Mongodb (recommended 4.0+) * Proxy daemon: mitmproxy (mitmdump, recommended), Fiddler Classic, etc. -### Starting up Grasscutter server (Assuming you are on Windows) -1. Setup the compile environment with `gradlew.bat` -2. Compile Grasscutter with `gradlew jar` -3. Create a folder named `resources` in your Grasscutter directory, move your `BinOutput` and `ExcelBinOutput` folders there *(Check the wiki for more details on how to get those.)* -4. Run Grasscutter with `java -jar grasscutter.jar`. Make sure mongodb service is running as well. +### Running + +**Note:** If you update from an older version, delete `config.json` for regeneration + +1. Get `grasscutter.jar` + - Download from [actions](https://nightly.link/Grasscutters/Grasscutter/workflows/build/stable/Grasscutter.zip) + - [Build by yourself](#Building) +2. Create a `resources` folder in the directory where grasscutter.jar is located and bring your `BinOutput` and `ExcelBinOutput` folders into it *(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 using *server console command* below -1. 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 than `8888`, and load [this script](https://github.lunatic.moe/fiddlerscript). - - [Hosts file](https://github.com/Melledy/Grasscutter/wiki/Running#traffic-route-map) -2. Trust CA certificate: - - mitmdump: `certutil -addstore root %USERPROFILE%\.mitmproxy\mitmproxy-ca-cert.cer` + +½. Create an account using [server console command](#Commands). + +1. Redirect traffic: (choose one) + - mitmdump: `mitmdump -s proxy.py -k` + + Trust CA certificate: + + ​ **Note:**The CA certificate is usually stored in `% USERPROFILE%\ .mitmproxy`, or you can download it from `http://mitm.it` + + ​ Double click for [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 + + ```shell + certutil -addstore root %USERPROFILE%\.mitmproxy\mitmproxy-ca-cert.cer + ``` + + - 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`, and load [this script](https://github.lunatic.moe/fiddlerscript). + + - [Hosts file](https://github.com/Melledy/Grasscutter/wiki/Running#traffic-route-map) + 2. Set network proxy to `127.0.0.1:8080` or the proxy port you specified. -4. *yoink* -* or you can use `start.cmd` to start Server & Proxy daemon with one click +**you can also use `run.cmd` to start servers and proxy daemons automatically** -# 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. +### Building -`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. +Grasscutter uses Gradle to handle dependencies & building. -`spawn [monster id] [level] [amount]` +**Requirements:** -`give [item id] [amount] [level]` +- Java Development Kits - 8u202 +- Git -`givechar [avatar id] [level]` +##### Windows -`drop [item id] [amount]` +```shell +git clone https://github.com/Grasscutters/Grasscutter.git +cd Grasscutter +.\gradlew.bat # Setting up environments +.\gradlew jar # Compile +``` -`killall` +##### Linux -`setworldlevel [level]` - Changes your world level, relog to see effects properly +```bash +git clone https://github.com/Grasscutters/Grasscutter.git +cd Grasscutter +chmod +x gradlew +./gradlew jar # Compile +``` -`godmode` - Prevents you from taking damage +You can find the output jar in the root of the project folder -`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. +## Commands -`clearartifacts` - Deletes all unequipped and unlocked level 0 artifacts, **including 5-star rarity ones** from your inventory +| Commands | Usage | Permission node | Availability | description | Alias | +| -------------- | ------------------------------------------------- | ------------------------- | ------------ | ------------------------------------------------------------ | ----------------------------------------------- | +| account | account [uid] | | Server only | Creates an account with the specified username and the in-game uid for that account. The uid will be auto generated if not set. | | +| broadcast | broadcast | server.broadcast | Both side | Sends a message to all the players. | b | +| changescene | changescene | player.changescene | Client only | Switch scenes by scene ID. | scene | +| clearartifacts | clearartifacts | player.clearartifacts | Client only | Deletes all unequipped and unlocked level 0 artifacts, including yellow rarity ones from your inventory. | clearart | +| clearweapons | clearweapons | player.clearweapons | Client only | Deletes all unequipped and unlocked weapons, including yellow rarity ones from your inventory. | clearwpns | +| drop | drop [amount] | server.drop | Client only | Drops an item around you. | `d` `dropitem` | +| give | give [player] [amount] [level] | player.give | Both side | Gives item(s) to you or the specified player. | `g` `item` `giveitem` | +| givechar | givechar [level] | player.givechar | Both side | Gives the player a specified character. | givec | +| godmode | godmode [uid] | player.godmode | Client only | Prevents you from taking damage. | | +| heal | heal | player.heal | Client only | Heal all characters in your current team. | h | +| help | help [command] | | Both side | Sends the help message or shows information about a specified command. | | +| kick | kick | server.kick | Both side | Kicks the specified player from the server. (WIP) | k | +| killall | killall [playerUid] [sceneId] | server.killall | Both side | Kill all entities in the current scene or specified scene of the corresponding player. | | +| list | list | | Both side | List online players. | | +| permission | permission | * | Both side | Grants or removes a permission for a user. | | +| position | position | | Client only | Get coordinates. | pos | +| reload | reload | server.reload | Both side | Reload server config | | +| resetconst | resetconst [all] | player.resetconstellation | Client only | Resets the constellation level on your current active character, will need to relog after using the command to see any changes. | resetconstellation | +| restart | | | Both side | Restarts the current session | | +| say | say | server.sendmessage | Both side | Sends a message to a player as the server | `sendservmsg` `sendservermessage` `sendmessage` | +| setfetterlevel | setfetterlevel | player.setfetterlevel | Client only | Sets your fetter level for your current active character | setfetterlvl | +| setstats | setstats | player.setstats | Client only | Set fight property for your current active character | stats | +| setworldlevel | setworldlevel | player.setworldlevel | Client only | Sets your world level (Relog to see proper effects) | setworldlvl | +| spawn | spanw [level] [amount] | server.spawn | Client only | Spawns an entity near you | | +| stop | stop | server.stop | Both side | Stops the server | | +| talent | talent | player.settalent | Client only | Set talent level for your current active character | | +| teleport | teleport | player.teleport | Client only | Change the player's position. | tp | +| weather | weather | player.weather | Client only | Changes the weather | w | -`pos` - Gets your current coordinates. +### Bonus -`weather [weather id] [climate id]` - Changes the current weather. - -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. - -*More commands will be updated in the [wiki](https://github.com/Melledy/Grasscutter/wiki/).* +When you want to teleport to somewhere, use the ingame marking function on Map, click Confirm. You will see your +character falling from a very high destination, exact location that 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 + +* 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 using + Fiddler make sure it running on another port except 8888 * Startup sequence: Mongodb > Grasscutter > Proxy daemon (mitmdump, fiddler, etc.) > Client