Akkariin/Grasscutter
1
0
Fork 0
mirror of https://github.com/Grasscutters/Grasscutter.git synced 2025-01-07 00:42:57 +08:00
Code Issues Projects Releases Wiki Activity

Update commands

Luke H-W 2022-06-27 13:02:46 +09:30
parent 088a9d8ae6
commit cae2d6e0ba
1 changed files with 68 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

104
Commands.md

@ -18,39 +18,71 @@ Commands also work in other chat rooms, such as private/team chats. to run comma
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 \<create\|delete> \<username> [UID] | |
| broadcast | Sends a message to all the players. | b | None | broadcast \<message> | 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 \<scene id> | player.changescene |
| clear | Deletes all unequipped and unlocked lvl0 artifacts(art)/weapons(wp)/material(mat) from inventory. | | Online Player | clear \<all\|wp\|art\|mat> | player.clearinv |
| drop | Drops an item around you. | d dropitem | Online Player | drop \<itemID\|itemName> [amount] | server.drop |
| enterdungeon | Enter a dungeon by dungeon ID. | | Online Player | enterdungeon \<dungeon id> | player.enterdungeon |
| give | Gives item(s) to you or the specified player. | g item giveitem | Online Player | give \<itemId\|itemName> [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 \<artifactId> \<mainPropId> [\<appendPropId>[,\<times>]]... [level] | player.giveart |
| givechar | Gives the player a specified character. | givec | Online Player | givechar \<avatarId> | 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 \<add\|remove> \<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 \<message> | server.sendmessage |
| setfetterlevel | Sets the friendship level for your currently selected character. | setfetterlvl | Online Player | setfetterlevel \<level> | player.setfetterlevel |
| setstats | Sets a stat for your currently selected character. | stats | Online Player | setstats \<stat> \<value> | player.setstats |
| setworldlevel | Sets your world level. Relog to see proper effects. | setworldlvl | Online Player | setworldlevel \<level> | player.setworldlevel |
| spawn | Spawns some entities around you. | | Online Player | spawn \<entityId> [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 \<talentID> \<value> | player.settalent |
| team | Add, remove, or swap avatars in your current team. Index start from 1. | | Online Player | team \<add\|remove\|set> [avatarId,...] [index|first|last|index-index,...] | player.team |
| teleport | Change the player's position. | tp | Online Player | teleport \<x> \<y> \<z> [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 \<weatherID> \<climateID> | player.weather |
You can set an empty target that overrides steps 2-4 by using `@` as an argument. This is currently only useful as a special case of the
`sendmessage` command which sends to *all* players on the server, like the old `broadcast` command.
### Informational commands (no permissions)
| Commands | Description | Alias | Targeting | Usage |
| -------- | ---------------------------------------------------------------------- | ----- | ------------- | -------------- |
| list | Lists online players. | | None | list |
| help | Sends the help message or shows information about a specified command. | | None | help [command] |
| position | Sends your current coordinates. | pos | Online Player | position |
### Commands for server admins
| 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 <create\|delete> <username> [UID]` | (can only use on server console) |
| permission | Grants or removes a permission for a user. | | Player | `permission <add\|remove> <permission>` | permission |
| kick | Kicks the specified player from the server. | k | Online Player | `kick` | server.kick (only for others) |
| ban | Kicks and bans the specified player from the server. | | Player | `ban [timestamp] [reason]` | server.ban |
| unban | Unbans specified player from the server. | | Player | `unban` | server.ban |
| sendmessage | Sends a message to a player as the server. If used without a target, message all players. | say | None | `say <message>` | server.sendmessage |
| reload | Reloads the server config. | | None | `reload` | server.reload |
| stop | Stops the server. | | None | `stop` | server.stop |
### Commands that can potentially harm players
| Commands | Description | Alias | Targeting | Usage | Permission node |
| -------------- | ------------------------------------------------------------------------------------------------- | ------------------ | ------------- | ------------------------------------- | ------------------------- |
| clear | Deletes all unequipped and unlocked lvl0 artifacts(art)/weapons(wp)/material(mat) from inventory. | | Online Player | `clear <all\|wp\|art\|mat>` | player.clearinv |
| give | Gives item(s) to you or the specified player. | g item giveitem | Online Player | `give <itemId\|avatarId> [see below]` | player.give |
| resetconst | Resets currently selected (or all) character(s) to C0. Relog to see proper effects. | resetconstellation | Online Player | `resetconst [all]` | player.resetconstellation |
| setfetterlevel | Sets the friendship level for your currently selected character. | setfetterlvl | Online Player | `setfetterlevel <level>` | player.setfetterlevel |
| setprop | Sets accountwide properties. | prop | Online Player | `setprop <prop> <value>` | player.setprop |
| talent | Sets talent level for your currently selected character | | Online Player | `talent <talentID> <value>` | player.settalent |
### Commands without lasting effects
| Commands | Description | Alias | Targeting | Usage | Permission node |
| ------------ | --------------------------------------------------------------------------------------- | ----- | ------------- | ----------------------------------------------------------------- | ------------------- |
| coop | Forces someone to join the world of others. | | Online Player | `coop [host UID (default self)]` | server.coop |
| tpall | Teleports all players in your world to your position. | | Online Player | `tpall` | player.tpall |
| heal | Heals all characters in your current team. | h | Online Player | `heal` | player.heal |
| killall | Kills all entities in the current scene or specified scene of the corresponding player. | | Online Player | `killall [sceneId]` | server.killall |
| setstats | Sets a stat for your currently selected character. | stats | Online Player | `setstats <stat> <value>` | player.setstats |
| spawn | Spawns some entities around you. | | Online Player | `spawn <entityId\|itemId> [amount] [level(monster only)]` | server.spawn |
| team | Add, remove, or swap avatars in your current team. Index start from 1. | | Online Player | `team <add\|remove\|set> [avatarId,...] [index\|index-index,...]` | player.team |
| teleport | Change the player's position. | tp | Online Player | `teleport <x> <y> <z> [sceneId]` | player.teleport |
| enterdungeon | Enter a dungeon by dungeon ID. | | Online Player | `enterdungeon <dungeon id>` | player.enterdungeon |
| weather | Changes the weather. | w | Online Player | `weather [weatherID] [climate]` | player.weather |
### Give command
The `give` command now has the functionality of the old `giveall`, `giveart` and `givechar` commands.
`give` has keyword arguments `x<amount>`, `lv<level>`, `r<refinement>` and `c<constellation>` which can be used anywhere in the command, just like `@UID` can be.
`x<amount>` can also be written as `<amount>x`, and `lv<level>` can be `l<level>` or `lvl<level>`, and they can all be chained together without spaces, e.g. `lv90r5x10`.
To give all items, do `give <all|weapons|mats|avatars> [x<amount>]`. The above keyword arguments are all valid for this.
The artifact syntax is `give <artifactId> [mainPropId] [<appendPropId>[,<times>]]...`. `x<amount>` and `lv<level>` work with this, and note that this uses levels of 0-20 to match displayed in-game numbers rather than 1-21, though it won't complain if you feed it `lv21`.
### SetProp command
`prop <godmode|nostamina|unlimitedenergy> <on|off|toggle|1|0>` replaces the old `godmode`, `nostamina`, `unlimitenergy` commands.
`prop <god|ns|ue> <value>` are the shortest aliases for them.
`prop abyss 12` replaces `unlocktower`. Full syntax is `prop <abyss|abyssfloor|ut|tower|towerlevel|unlocktower> <floor to unlock>`
To set BP level: `prop <bplevel|bp|battlepass> <level>`
And world level: `prop <worldlevel|wl> <level>`
AR: `prop player_level <level>`