diff --git a/README.md b/README.md index a9e01d1b7..b051ff4f6 100644 --- a/README.md +++ b/README.md @@ -98,72 +98,11 @@ chmod +x gradlew You can find the output jar in the root of the project folder. -## Commands - -You might want to use this command (`java -jar grasscutter.jar -handbook`) in a cmd that is in the grasscutter folder. It will create a handbook file (GM Handbook.txt) where you can find the item IDs for stuff you want - -You may want to use this command (`java -jar grasscutter.jar -gachamap`) to generate a mapping file for the gacha record subsystem. The file will be generated to `GRASSCUTTER_RESOURCE/gcstatic` folder. Otherwise you may only see number IDs in the gacha record page. - -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. to run commands ingame, you need to add prefix `/` or `!` such as `/pos` - -### Targeting - 1. For commands that target a Player, you can specify a target UID with `@UID` as an argument in any position to the command. - 2. If you message a valid command at another player (instead of at the "Server" virtual player), they will be the target for that command if you didn't set one above. - 3. If none of the above, it will default to a persistent target player you previously set using the command `/target `. - 4. If none of the above, you will be the target of the command. If you are entering the command from the Server console, **it will not work!** - - Note that performing commands on other players will usually require different a permission to the base permission node. e.g. `player.give` becomes `player.give.others` if used on another player. - -| Commands | Description | Alias | Targeting | Usage | Permission node | -| -------------- | ------------------------------------------------------------------------------------------------- | ------------------ | ------------- | --------------------------------------------------------------------------- | ------------------------- | -| account | Creates an account with the specified username, and the in-game UID if specified. | | Server only | account \ \ [UID] | | -| broadcast | Sends a message to all the players. | b | None | broadcast \ | server.broadcast | -| coop | Forces someone to join the world of others. | | Online Player | coop [host UID (default self)] | server.coop | -| changescene | Switch scenes by scene ID. | scene | Online Player | changescene \ | player.changescene | -| clear | Deletes all unequipped and unlocked lvl0 artifacts(art)/weapons(wp)/material(mat) from inventory. | | Online Player | clear \ | player.clearinv | -| drop | Drops an item around you. | d dropitem | Online Player | drop \ [amount] | server.drop | -| enterdungeon | Enter a dungeon by dungeon ID. | | Online Player | enterdungeon \ | player.enterdungeon | -| give | Gives item(s) to you or the specified player. | g item giveitem | Online Player | give \ [amount] [level] [refinement] | player.give | -| giveall | Gives all items. | givea | Online Player | giveall [amount] | player.giveall | -| giveart | Gives the player a specified artifact. | gart | Online Player | giveart \ \ [\[,\]]... [level] | player.giveart | -| givechar | Gives the player a specified character. | givec | Online Player | givechar \ | player.givechar | -| godmode | Prevents you from taking damage. | | Online Player | godmode | player.godmode | -| heal | Heals all characters in your current team. | h | Online Player | heal | player.heal | -| help | Sends the help message or shows information about a specified command. | | None | help [command] | | -| kick | Kicks the specified player from the server. | k | Online Player | kick | server.kick | -| killall | Kills all entities in the current scene or specified scene of the corresponding player. | | Online Player | killall [sceneId] | server.killall | -| list | Lists online players. | | None | list | | -| permission | Grants or removes a permission for a user. | | Online Player | permission \ \ | permission | -| position | Sends your current coordinates. | pos | Online Player | position | | -| reload | Reloads the server config. | | None | reload | server.reload | -| resetconst | Resets currently selected (or all) character(s) to C0. Relog to see proper effects. | resetconstellation | Online Player | resetconst [all] | player.resetconstellation | -| restart | Restarts the current session. | | None | restart | | -| sendmessage | Sends a message to a player as the server. | say | Online Player | say \ | server.sendmessage | -| setfetterlevel | Sets the friendship level for your currently selected character. | setfetterlvl | Online Player | setfetterlevel \ | player.setfetterlevel | -| setstats | Sets a stat for your currently selected character. | stats | Online Player | setstats \ \ | player.setstats | -| setworldlevel | Sets your world level. Relog to see proper effects. | setworldlvl | Online Player | setworldlevel \ | player.setworldlevel | -| spawn | Spawns some entities around you. | | Online Player | spawn \ [amount] [level(monster only)] | server.spawn | -| stop | Stops the server. | | None | stop | server.stop | -| talent | Sets talent level for your currently selected character | | Online Player | talent \ \ | player.settalent | -| team | Add, remove, or swap avatars in your current team. Index start from 1. | | Online Player | team \ [avatarId,...] [index|first|last|index-index,...] | player.team | -| teleport | Change the player's position. | tp | Online Player | teleport \ \ \ [sceneId] | player.teleport | -| tpall | Teleports all players in your world to your position. | | Online Player | tpall | player.tpall | -| unlocktower | Unlock the all floors of abyss. | ut | Online Player | ut | player.tower | -| weather | Changes the weather. | w | Online Player | weather \ \ | player.weather | - -### Bonus - -- Teleporting - - When you want to teleport to somewhere, use the in-game marking function on Map. - - Mark a point on the map using the fish hook marking (the last one.) - - (Optional) rename the map marker to a number to override the default Y coordinate (height, default 300.) - - Confirm and close the map. - - You will see your character falling from a very high destination, exact location that you marked. +### Commands have moved to the [wiki](https://github.com/Grasscutters/Grasscutter/wiki/Commands)! # Quick Troubleshooting * If compiling wasn't successful, please check your JDK installation (JDK 17 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.) > Game +* Startup sequence: MongoDB > Grasscutter > Proxy daemon (mitmdump, fiddler, etc.) > Game