From Citizens Wiki
Revision as of 20:03, 14 April 2020 by Mcmonkey (Talk | contribs)

Jump to: navigation, search

Read below for detailed command documentation. For more info on per-type commands and permissions, see its corresponding page.

[] - Mandatory
() - Optional

Command - command's syntax
Args Description - description of the command's arguments
Require Selected - whether the command requires an NPC to be selected
Require Ownership - whether the commands requires you to be the owner of the NPC
Require Mob Types - whether the command requires an NPC to be a certain mob type(s)
Permission - command's permission node
Description - short description of the command

Commands not listed here

There are quite a few commands that are not listed here, mainly for reasons of maintenance order (the wiki isn't updated all that often, but the actual commands list is updated regularly.)
To see the list of commands on your current version of Citizens, simply type /npc help in-game. You can use /npc help 2 to view page 2, and so on (switch 2 to any page number).

To see information on a specific command, you can use /npc help create in-game. Change the "create" to any other command name (the example will show help for the /npc create command).

Some commands have documentation elsewhere. Such as:

  • npc skin has documentation here: Skins

There are also many commands that are added by other traits. see Characters

Adding Click Commands

If you're looking for a way to add automatically ran commands when you click an NPC, that's explained at NPC_Commands.

Admin Commands

Commands used for administration of Citizens.

Admin Commands
Command Permission Description
/citizens citizens.admin Show basic plugin information
/citizens reload citizens.admin Reload Citizens
/citizens save citizens.admin Save NPCs and configuration

Help Commands

Commands used in-game to show the help screen.

Help Commands
Command Args Description Permission Description
/citizens help (Page) - Page number to display Show Citizens help menu
/npc help (Page) - Page number to display Show NPC help menu
/trait help (Page) - Page number to display Show trait help menu
/script help (Page) - Page number to display Show scripting help menu
/template help (Page) - Page number to display Show template help menu
/waypoints help (Page) - Page number to display Show waypoints help menu

NPC Commands

General commands used for all NPCs.

NOTE: '/npc trait' has been replaced, there is a new set of commands for adding, removing and copying traits.

/trait {traitname] is now used to add traits and characters.

More docs coming soon.

NPC Commands
Command Args Description Require Selected Require Ownership Require Mob Types Permission Description
/npc None Yes Yes No None Show basic NPC information
/npc age [adult, baby, integer, -l] - Adult sets as adult, baby as baby, age integer specifies an exact age, -l toggles whether the age is locked Yes Yes Yes - COW, SHEEP, CHICKEN, PIG, VILLAGER, OCELOT, WOLF citizens.npc.age Modify a NPC's age
/npc anchor anchor (--save [name], --assume [name], --remove [name]) (-a)(-c) - saves a location as an 'anchor' which can be assumed via assume [name] Yes Yes No citizens.npc.anchor Changes/saves/lists NPC's location anchors
/npc behaviour behaviour [scripts] (-r) -- scripts is a comma separated list of script file names to look for, -r flag removes them from the NPC. Yes Yes No citizens.npc.behaviour Adds and removes behaviours from an NPC. A behaviour is a script file that is executed and adds 'goals' to the NPC which can run every tick. These can do anything you can program/think of!
/npc controllable None Yes Yes No citizens.npc.controllable.[npc type name] Toggles the NPC's controllable status. Controllable NPCs can be right clicked to be mounted and controlled with WASD. Ghasts, Blazes and Endersragons can be flown by left clicking once mounted to pause/unpause flying.
/npc copy (--name NewName) -- new name is the name of the copied NPC. Yes Yes No citizens.npc.copy Create a new NPC from the currently selected NPC, copying all traits.
/npc create [NPC Name] - Name to give NPC
(--type [type]) - Mob type to use
--trait [trait1] [trait2] ... - A list of traits to apply to the NPC
Yes Yes No citizens.npc.create.mobtype or citizens.npc.create.* Create a new NPC.

Example : /npc create Jimbo Stevenson --type PIG

/npc despawn (id) the ID of the NPC to despawn Yes Yes No citizens.npc.despawn Despawn a NPC
/npc gamemode [gamemode] the gamemode to use Yes Yes PLAYER citizens.npc.gamemode Sets a Player NPC's game mode.
/npc gravity None Yes Yes No citizens.npc.gravity Toggles gravity on the NPC.
/npc equip None Yes Yes Yes - PLAYER, PIG, SHEEP, ENDERMAN citizens.npc.edit.equip Toggle equipment editor. see Equipment Editor Used for player armor, player and endermen items, sheep color/sheared, and pig saddles.
/npc list (-a) - List all NPCs
(--owner (owner)) - Owner
(--type (type)) - Mob type
(--char (character)) - Character
No No No citizens.npc.list List NPCs that match at least one of the given conditions
/npc lookclose None Yes Yes No citizens.npc.lookclose Toggle a NPC's look-close state
/npc moveto --x [x] --y [y] --z [z] --world [world] Yes Yes No citizens.npc.moveto The NPC's current location is taken as the base location. Value arguments are used to modify this base.
/npc mount None Yes Yes No citizens.npc.mount Mount the currently selected NPC, if it is controllable.
/npc owner (name) - Name of the new owner, set as "server" if you want Citizens Admins (players with "citizens.admin" permission) to be owner Yes Yes No citizens.npc.owner Sets the owner of a NPC
/npc path None Yes Yes No citizens.npc.edit.path Toggle path editor. Left click to add a waypoint, right click to remove, mousewheel or number keys to select individual waypoints.
/npc pathrange [range] - New range for the NPC Yes Yes No citizens.npc.pathfindingrange Set the range in number of blocks in which the NPC can find a path.
/npc playerlist None Yes Yes PLAYER citizens.npc.playerlist Toggles an NPC as a 'real' player, so that it will be more recognised by other plugins, will keep chunks loaded and crops ticking.
/npc pose (-a) - Sets the position of the NPC's head to the current position of the Player's head. Useful for setting where NPCs are specifically looking post-creation.
''(--save [name]|--load [name]|--remove [name)''
Yes Yes Yes - PLAYER citizens.pose Changes/Stores NPC's head position based on the Player's current position.
/npc power None Yes Yes Yes - CREEPER citizens.npc.power Toggle whether a creeper NPC is powered
/npc profession BLACKSMITH, LIBRARIAN, BUTCHER, FARMER, or PRIEST Yes Yes Yes - VILLAGER citizens.npc.profession Change a villager-type NPC's profession.
/npc remove (all) - Will remove all NPCs Yes (Not if "all" is used) Yes No citizens.npc.remove, (citizens.admin.remove.all) Remove a NPC
/npc rename [name] - New name for the NPC Yes Yes No citizens.npc.rename Rename a NPC
/npc select [id] - ID of the NPC to select No Yes No Selects a NPC with the given ID
/npc size [size] - the integer size for the slime Yes Yes SLIME citizens.npc.size Sets a slime's size.
/npc skeletontype [type] - 0 or NORMAL for normal, 1 or WITHER for wither skeleton Yes Yes SKELETON citizens.npc.skeletontype Changes a Skeleton NPC's type (currently between WITHER and NORMAL)
/npc spawn [id] - ID of the NPC you want to spawn Yes Yes No citizens.npc.spawn Spawn a existing NPC
/npc speed Yes Yes No citizens.npc.speed changes the NPC's default speed multiplier. i.e. use 2 to double the normal speed.
/npc text None Yes Yes No citizens.npc.edit.text Toggle text editor. Note that players need the permission to hear NPCs!
/npc tphere None Yes Yes No citizens.npc.tphere Teleport a NPC to your location
/npc tp None Yes Yes No Teleport to a NPC
/npc type [type] - the new entity type Yes Yes No citizens.npc.type Changes an NPC's mob type.
/npc vulnerable None Yes Yes No citizens.npc.vulnerable Toggles whether the NPC can take damage and die, and whether monsters will target it when it is on the player list
/npc zombiemod (-b, -v) - -b for baby, -v for villager Yes Yes ZOMBIE citizens.npc.zombiemodifier Sets a zombie NPC's modifiers.
/trait [trait1] [trait2] ... [traitN - A list of Traits to apply Yes Yes No citizens.npc.trait.* or citizens.npc.trait.<trait-name> for per-trait permissions Adds the trait type to the NPC. NPCs can have multiple traits.

Example: /trait sentry

Waypoint commands

Waypoint Commands
Command Args Description Permission Description
/waypoints disableteleport None citizens.waypoints.disableteleport Stops NPCs from automatically teleporting the end of their path if they get stuck (NOTE: might be removed at some point).
/waypoints provider [provider name] (-a) - provider name is the provider to use (currently linear, guided and wander), use -a to get a list of all providers citizens.waypoints.provider Sets the waypoint provider to use when using the waypoint editor.

Template commands

Template Commands
Command Args Description Permission Description
/template apply [template name] (id1 id2...) - takes the name of the template and an optional list of IDs to apply it to citizens.templates.apply Applies the given templates to the NPC.
/template create [template name] (-o) - takes the name of the generated template, -o sets it to override citizens.templates.create Generates a template from the selected NPC and saves it to the templates.yml file.

See Also

Text Syntax