Need help? Ask on the forum, ask a fellow user or developer (join us on IRC), or contact sk89q.
Contribute to the wiki, edit this page! Register an account, or login with Facebook first.
HEY! Do you integrate (or want to) a plugin into yours? Do you help work on WE/WG/etc.? Please subscribe to our mailing list!
CommandBook
Commands
Contents |
Commands
General
| Command | Arguments | Description | Permissions |
|---|---|---|---|
| /item /i |
[-d] <item[:data][|enchantment[:level][,otherenchantment[:level]]> [amount] | Gives you an item (-d to drop items).
You can control permissions for individual items by setting up an item blacklist, whitelist, or per-item permissions. See the item permissions page. |
|
| /give | [-d] <target> <item[:data][|enchantment[:level][,otherenchantment[:level]]> [amount] | Gives you or another player an item (-d to drop items).
You can control permissions for individual items by setting up an item blacklist, whitelist, or per-item permissions. See the item permissions page. |
|
| /more | [-a] [-i] [target] | Changes the held stack to have 64 items.
|
|
| /who /list /playerlist /online /players |
[filter] | See who is online. |
|
| /motd | Show the message of the day. |
| |
| /intro | Replays server's intro.mid file. See MIDI support. |
| |
| /midi | <midi> | Plays a MIDI file. See MIDI support. |
|
| /rules | Show the rules. |
| |
| /kit | Get a list of kits that a player can use. |
| |
| /kit | <kit> [target] | Get a kit. |
|
| /setspawn | [destination] | Set the spawn location. |
|
| /time | Get the current time. |
| |
| /time now | Get the current time. |
| |
| /time -l now | Lock the time to the current time. |
| |
| /time | [-l] [world] <time> | Set the time. The time can be a number to indicate the number of ticks, names of the times of the day (sunrise, dusk, dawn, sunset, etc.), or a time string (3:44 or 5:44pm or 12am).
|
|
| /playertime | [-rsw] [target] <time> | Change the time for specific players only. This only affects what the client sees, not the server.
|
|
| /spawnmob | [-d] [-i] [-r] [-b] <mob>[|rider] [count] [destination] | Spawn a mob or several. The mob name can be a partial match. You can enter an invalid mob name and you will be listed the available types. Riders are supported in the mob argument, and special types of mobs can be made as well. See mob types.
|
|
| /weather | <'stormy'|'sunny'> [duration] [world] | Change the weather. Use -1 for a duration (optional) if you want it to be natural, or you can specify a duration in seconds. Weather is global (on over the entire world) and it snows in snowy biomes and rains in other biomes. |
|
| /thunder | <'on'|'off'> [duration] [world] | Change the thunder and lightning state. Use -1 for a duration (optional) if you want it to be natural, or you can specify a duration in seconds. Thunder won't work when it's not storming. |
|
| /biome | [target] (only matches one) | Check the biome name of the location of specified player. |
|
Teleportation
| Command | Arguments | Description | Permissions |
|---|---|---|---|
| /spawn | Teleport to spawn. |
| |
| /teleport /tp |
[target] <destination> | Teleport to a destination.
Tip: It is possible to teleport to coordinates by using /tp x,y,z (no spaces).
|
|
| /bring /tphere /summon /s |
<target> | Teleport another player to you. |
|
| /place /put |
<target> | Teleport another player to the location that you are looking at. |
|
| /return /ret |
<target> | Return back to your last location. |
|
| /call | <target> | Request a teleport from someone.
Tip: Enable this instead of commandbook.teleport.other to prevent abuse. Other players can't arbitrarily teleport you without your permission.
|
|
Homes
| Command | Arguments | Description | Permissions |
|---|---|---|---|
| /home | Teleport to specified own home in current world. |
| |
| /home | <owner> | Teleport to home of specified owner in current world. |
|
| /home | <target> <owner> | Teleport given targets to specied owner‘s home in current world. |
|
| /home | <world> <target> <owner> | Teleport targets to specied owner‘s home in given world. |
|
| /sethome | Sets own home at current position. |
| |
| /sethome | <owner> | Creates a home at current position for given player name. |
|
| /sethome | <location> <owner> | Creates a home at specified location for given player name. |
|
| /homes | Unused. |
Warps
| Command | Arguments | Description | Permissions |
|---|---|---|---|
| /warp | [world] [target] <warp> | Teleport to specified warp (name). |
|
| /setwarp | <warp> [location] | Creates a warp with given name at players location or given location. |
|
| /warps | del <warp> delete <warp> remove <warp> rem <warp> |
Removes the warp named <warp>[2] |
|
| /warps | list show |
List warps[3] |
|
Messaging
| Command | Arguments | Description | Permissions |
|---|---|---|---|
| /broadcast | <message...> | Broadcasts a message to everyone. The format of the broadcast message can be configured. |
|
| /say | <message...> | Send a message. The format of the message if console uses it can be configured. |
|
| /me | <message...> | Send an action message. |
|
| /msg /message /whisper /pm /tell |
<target> <message...> | Sends a message to a player (or console if "!" is used). |
|
| /reply /r |
<message...> | Reply to the last person that you messaged. |
|
| /mute | <target> | Mute a player. |
|
| /unmute | <target> | Unmute a player. |
|
| /afk | [status] | Sets you as afk, If another user uses /msg or /reply while you are away, it will warn them and tell them your status if given. Typing /afk again will set you as no longer being afk. |
|
Player
| Command | Arguments | Description | Permissions |
|---|---|---|---|
| /whereami /getpos /pos /where |
[target] | Get your current location. |
|
| /compass | [target] | Get your current cardinal direction. |
|
| /clear | [-a] [-s] [target] | Clears your or another player's inventory.
|
|
| /slap | [-h|-v] [-d] [-s] [target] | Slap a player.
|
|
| /slay | [-s] [target] | Slay a player.
|
|
| /rocket | [-h] [-s] [target] | Rocket a player.
|
|
| /barrage | [-s] [target] | Send a barrage of arrows from a player.
|
|
| /firebarrage | [-s] [target] | Send a barrage of fireballs from a player.
|
|
| /shock | [-s] [-k] [-a] [target] | Strikes a player with lightning.
|
|
| /thor | <target> | Give Thor's hammer. |
|
| /freeze | <target> | Stops a player from moving, talking and building. |
|
| /unthor | <target> | Revoke Thor's hammer. |
|
| /gamemode | [target] [Game mode] | Sets a player's gamemode. Currently survival or creative |
|
| /heal | [-s] [target] | Heals you or another player
|
|
Miscellaneous
| Command | Arguments | Description | Permissions |
|---|---|---|---|
| /ping | Says "Pong" back to tell you if the server is responding. | (Not applicable) | |
| /whois | <target> | Get information about a player. |
|
| /debug info | Show server information. |
| |
| /debug clock | Perform a very accurate measure of your server's clock speed to measure your server's lag. |
| |
| /cmdbook version | Show CommandBook's version. | (Not applicable) | |
| /cmdbook reload | Reloads CommandBook's configuration. |
|
Bans
| Character | Meaning |
|---|---|
| m | Minute |
| h | Hour |
| d | Day |
| w | Week |
| y | Year |
Since v2.0 CommandBook has a flexible bans system that supports temporary bans, storing ban reasons, and logging of every action.
Exemption: Players with the commandbook.bans.exempt permission cannot be banned, unless the player banning them has the commandbook.bans.exempt.override permissions and uses the ban command with the -o flag. The same applies for kicking users, replacing commandbook.bans with commandbook.kick.
Temporary bans are given by using the /ban command with the -t <time> flag, where ban length is given as a series of [number][m|h|d|w|y] split by -. The meanings of each character are given in the table to the right.
With this system, /ban -t 1h-5m platnicat would ban platnicat for one hour and five minutes.
| Command | Arguments | Description | Permissions |
|---|---|---|---|
| /kick | [-o] <target> [reason...] | Kick a player. |
|
| /ban | [-e] [-o] [-t time] <name> [reason...] | Ban a player.
|
|
| /unban | <name> [reason...] | Unban a player (exact name). |
|
| /isbanned | <name> | Checks if a player is banned (exact name). |
|
| /baninfo | <name> | Provides information about a ban for a player (exact name), if it exists |
|
| /bans load | Read bans from disk. |
| |
| /bans save | Force save bans to disk. |
|
God
This component provides godemode support for players. Players in the cb-invincible group or with the commandbook.god.auto-invincible permission will have their godmode enabled automatically on login. A player can have their godmode enabled with the /god command if the sender of the command has commandbook.god for themselves or commandbook.god.other for other players.
| Command | Arguments | Description | Permissions |
|---|---|---|---|
| /god | <target> | Enable godmode on a player |
|
| /ungod | <target> | Disable godmode on a player |
|
Parameter types
CommandBook understands advanced "parameter types". For example, you can spawn mobs at a player using /spawnmob Pig 10 nameofplayer or at the spawn location of netherworld using /spawnmob Pig 10 #spawn:netherworld. You may also use coordinates with /spawnmob Pig 10 10,64,-233. Another example is teleporting everyone near you, yourself included, to spawn with /tp #near #spawn.
Directed targets
The private message commands take a directed target.
-
!or#consolematches the console -
@<player>matches a player exactly by their name -
<filter>matches everyone whose name starts with the specified filter (will only work if there's only one match) -
*<filter>matches everyone whose name contains the specified filter (will only work if there's only one match)
Targets
With most commands, a target can include an entire group of people. You can use a number of targets, including some special ones:
-
@<player>matches a player exactly by their name -
*matches everyone (requires commandbook.targets.everyone Since v2.2.1) -
#worldmatches everyone in the same world as you (requires commandbook.targets.world.<worldname> Since v2.2.1) -
#nearmatches everyone within 30 blocks radius of you (requires commandbook.targets.near Since v2.2.1) -
<filter>matches everyone whose name starts with the specified filter -
*<filter>matches everyone whose name contains the specified filter
/rocket #nearLocations
The teleport commands let you specify a location. You can use the following.
-
<x>,<y>,<z>matches coordinates (requires the commandbook.locations.coords permission) -
~<x>,~<y>,~<z>makes coordinates relative. Only used in/tp target x y zsyntax. Any or all coordinates can be made relative, while any without ~ will be constant (requires the commandbook.locations.coords.relative permission) Since v2.2.1 -
#spawnmatches spawn (requires the commandbook.spawn permission) -
#targetmatches the first free block in the column of the block that you are looking at -
#warp:namematches a warp with the specified name.#warp:name:worldwill check a different world if per-world-warps is enabled. (requires the commandbook.locations.warp permission if you own the warp, and commandbook.locations.warp.other otherwise) Since v1.6 -
#homewill match your own home if you have one, and#home:nameand#home:name:worldwork like the#warptarget. (requires the commandbook.locations.home permission if you own the warp, and commandbook.locations.home.other otherwise) Since v1.6 - Anything else matches the location of the first target found
/tp 312,65,13/spawnmob Pig 20 #spawn:#nether/tp #near #spawnWorlds
Some commands let you specify a world.
-
#mainmatches the main world -
#normalmatches the first normal world -
#nethermatches the first Nether world -
#skyworldmatches the first Sky world Since v1.6 -
#player:<filter>matches the world of the first player target found -
<filter>matches a world by the exact name
Times
For the time command, you have several choices of specifying the time. Some example possibilities are as follows:
- 12:00 (24-hour time)
- 4pm (24-hour time)
- 5:22am (24-hour time)
- Dawn
- Sunrise
- Morning
- Day
- Midday
- Noon
- Afternoon
- Evening
- Sunset
- Dusk
- Night
- Midnight
- 12144 (number of ticks, a number between 0 and 24000)
Mobs
For the spawnmob command, additional properties can be specified for some mobs using the mob:type syntax. Since v1.6
- Wolves:
- wolf:angry - Makes the wolf aggressive
- wolf:sitting - Makes the wolf sit down
- wolf:tame - Makes the wolf tame (owner will be set to the person using the command)
- Creepers:
- creeper:powered - Gives the creeper power armor
- Sheep:
- sheep:sheared - Takes all the wool off the sheep
- sheep:<color> - Colors the sheep any dye color
- Pigs
- pig:saddled - Saddles the pig for riding
- Slimes
- slime:<number> - Sets the slime to the specified size. slime:1 is the regular tiny slime.
- Pig zombies
- pigzombie:angry - Angers the pig zombie, causing it to attack nearby players.
- pigzombie:<number> - Sets the anger level. Attacking a calm one will set it to 400. Lower numbers mean it will take less time to "calm down", longer numbers mean more time.
- Endermen
- enderman:<id:data> - Spawns the enderman with the given block in their hands.
- Snowman