diff --git a/Commands.md b/Commands.md new file mode 100644 index 0000000..2ea659c --- /dev/null +++ b/Commands.md @@ -0,0 +1,56 @@ +# Commands + +You might want to use the handbook generation command (`java -jar grasscutter.jar -handbook`) in a terminal that is in a Grasscutter installation. +It will generate the handbook (GM Handbook.txt) where you can find IDs for enemies/items/etc. + +You may want to use the gacha map generation (`java -jar grasscutter.jar -gachamap`) to generate a mapping file for the gacha record subsystem. +The file will be generated in `(resources)/gcstatic`. (otherwise, you may only see number IDs on 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 in-game, you need to append a prefix `/` or `!` to your messages. (ex. `/pos`) + +### Targeting + 1. For commands that target a player, you can specify a target UID with `@UID` as an argument in any position. + 2. If you message a valid command at another player (instead of at the "Server" virtual player), they will be the set target for that command if you haven't already set the target. + 3. If none of the above apply, it will default to the target you previously set using: `/target `. + 4. If none of the above *still* apply, 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 a permission related 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 | \ No newline at end of file