Grasscutters/Grasscutter
3
0
Fork 0
mirror of https://github.com/Melledy/Grasscutter.git synced 2024-11-26 03:42:55 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #109 from xmplay/xmplay-readme

Browse Source 
fix typos and grammar in README.md
This commit is contained in:
Magix 2022-04-23 16:28:31 -04:00 committed by GitHub
commit a945c2188f
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -10,10 +10,10 @@ A WIP server reimplementation for *some anime game* 2.3-2.6
* Inventory features (recieving items/characters, upgrading items/characters, etc) * Inventory features (recieving items/characters, upgrading items/characters, etc)
* Gacha system * Gacha system
* Friends list * Friends list
* Co-op *partially* work * Co-op *partially* works
# Quick setup guide # Quick setup guide
### Note ### Note
* If you update from an older version, delete `config.json` for regeneration * If you updated from an older version, delete `config.json` to regenerate it.
### Prerequisites ### Prerequisites
* Java 16 * Java 16
@ -21,9 +21,9 @@ A WIP server reimplementation for *some anime game* 2.3-2.6
* Proxy daemon: mitmproxy (mitmdump, recommended), Fiddler Classic, etc. * Proxy daemon: mitmproxy (mitmdump, recommended), Fiddler Classic, etc.
### Starting up Grasscutter server (Assuming you are on Windows) ### Starting up Grasscutter server (Assuming you are on Windows)
1. Setup compile environment `gradlew.bat` 1. Setup the compile environment with `gradlew.bat`
2. Compile Grasscutter with `gradlew jar` 2. Compile Grasscutter with `gradlew jar`
3. Create a folder named `resources` in your Grasscutter directory, bring your `BinOutput` and `ExcelBinOutput` folders into it *(Check the wiki for more details how to get those.)* 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. 4. Run Grasscutter with `java -jar grasscutter.jar`. Make sure mongodb service is running as well.
### Connecting with the client ### Connecting with the client
@ -54,26 +54,26 @@ There is a dummy user named "Server" in every player's friends list that you can
`killall` `killall`
`setworldlevel [level]` - Relog to see effects properly `setworldlevel [level]` - Changes your world level, relog to see effects properly
`godmode` - Prevents you from taking damage `godmode` - Prevents you from taking damage
`resetconst` - Resets the constellation level on your current active character, will need to relog after using the command to see any changes. `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 current character's specified stat. `setstats [stats] [amount]` - Changes the currently selected character's specified stat.
`clearartifacts` - Deletes all unequipped and unlocked level 0 artifacts, **including yellow rarity ones** from your inventory `clearartifacts` - Deletes all unequipped and unlocked level 0 artifacts, **including 5-star rarity ones** from your inventory
`pos` - Gets your current coordinate. `pos` - Gets your current coordinates.
`weather [weather id] [climate id]` - Changes the current weather. `weather [weather id] [climate id]` - Changes the current weather.
*More commands will be updated in the [wiki](https://github.com/Melledy/Grasscutter/wiki/).* *More commands will be updated in the [wiki](https://github.com/Melledy/Grasscutter/wiki/).*
### Bonus ### Bonus
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. 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.
# Quick Troubleshooting # Quick Troubleshooting
* If compiling wasn't successful, please check your JDK installation (must be JDK 8 and validated JDK's bin PATH variable) * 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 * 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
* Startup sequence: Mongodb > Grasscutter > Proxy daemon (mitmdump, fiddler, etc.) > Client * Startup sequence: Mongodb > Grasscutter > Proxy daemon (mitmdump, fiddler, etc.) > Client