Commands: Difference between revisions

From Citizens Wiki

No edit summary
(26 intermediate revisions by 2 users not shown)
Line 11: Line 11:
<br>'''Permission''' - command's permission node
<br>'''Permission''' - command's permission node
<br>'''Description''' - short description of the command
<br>'''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.)'''
'''<br>To see the list of commands on your current version of Citizens, simply type <code>/npc help</code> in-game. You can use <code>/npc help 2</code> to view page 2, and so on (switch 2 to any page number).'''
<br>To see information on a specific command, you can use <code>/npc help create</code> in-game. Change the "create" to any other command name (the example will show help for the <code>/npc create</code> command).
<br>
<br>Some commands have documentation elsewhere. Such as:
* npc skin has documentation here: [[Skins]]
<br>
<br>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 ==
== Admin Commands ==
Line 35: Line 50:
! style="width: 100%; background-color:#ADD8E6" colspan="6" | '''Help Commands'''
! style="width: 100%; background-color:#ADD8E6" colspan="6" | '''Help Commands'''
|-
|-
! style="width: 250px;" | Command !! style="width: 200px;" | Args Description !! style="width: 170px;" | Permission !! Description
! style="width: 250px;" | Command !! style="width: 200px;" | Arguments !! style="width: 170px;" | Permission !! Description
|-
|-
| /citizens help || ''(Page)'' - Page number to display || citizens.help || Show Citizens help menu
| /citizens help || ''(Page)'' - Page number to display || citizens.help || Show Citizens help menu
Line 43: Line 58:
| /trait help || ''(Page)'' - Page number to display || citizens.trait.help || Show trait help menu
| /trait help || ''(Page)'' - Page number to display || citizens.trait.help || Show trait help menu
|-
|-
| /script help || ''(Page)'' - Page number to display || citizens.script.help || Show scripting help menu
| /template help || ''(Page)'' - Page number to display || citizens.templates.help || Show template help menu
|-
| /template help || ''(Page)'' - Page number to display || citizens.template.help || Show template help menu
|-  
|-  
| /waypoints help || ''(Page)'' - Page number to display || citizens.waypoints.help || Show waypoints help menu
| /waypoints help || ''(Page)'' - Page number to display || citizens.waypoints.help || Show waypoints help menu
Line 57: Line 70:
:'''<code> /trait {traitname] </code> is now used to add traits and characters.
:'''<code> /trait {traitname] </code> is now used to add traits and characters.


More docs coming soon.
The following command list is copied from <code>/npc help</code>


{| class="wikitable collapsible" style="text-align: center; width: 100%"
{| class="wikitable collapsible" style="text-align: center; width: 100%"
Line 63: Line 76:
! style="width: 100%; background-color:#ADD8E6" colspan="7" | '''NPC Commands'''
! style="width: 100%; background-color:#ADD8E6" colspan="7" | '''NPC Commands'''
|-
|-
! style="width: 200px;" | Command !! style="width: 400px;" | Args Description !! style="width: 50px;" | Require Selected !! style="width: 50px;" | Require Ownership !! style="width: 50px;" | Require Mob Types !! style="width: 170px;" | Permission !! Description
! style="width: 200px;" | Command !! style="width: 400px;" | Arguments !! Description
{{#!:
|-
| /npc || ''None'' || Show basic NPC information
|-| /npc activationrange || <code>[range]</code> || Sets the activation range
|-
| /npc age || <code>[age] (-l(ock))</code> || Set the age of a NPC
|-
| /npc ai || <code>(true&#124;false)</code> || Sets whether the NPC should use vanilla AI
|-
| /npc allay || <code>(-d(ancing))</code> || Sets allay modifiers
|-
| /npc anchor || <code>(--save [name]&#124;--assume [name]&#124;--remove [name]) (-a) (-c)</code> || Changes/Saves/Lists NPC&#39;s location anchor(s)
|-
| /npc armorstand || <code>--visible [visible] --small [small] --gravity [gravity] --arms [arms] --baseplate [baseplate] --(body&#124;leftarm&#124;leftleg&#124;rightarm&#124;rightleg)pose [angle x,y,z]</code> || Edit armorstand properties
|-
| /npc axolotl || <code>(-d) (--variant variant)</code> || Sets axolotl modifiers
|-
| /npc bee || <code>(-s/-n) --anger anger</code> || Sets bee modifiers
|-
| /npc bossbar || <code>--style [style] --color [color] --title [title] --visible [visible] --flags [flags] --track [health &#124; placeholder]</code> || Edit bossbar properties
|-
| /npc breakblock || <code>--location [x,y,z] --radius [radius]</code> || Mine a block at the given location or cursor if not specified
|-
| /npc camel || <code>(--pose pose)</code> || Sets camel modifiers
|-
| /npc cat || <code>(-s/-n/-l) --type type --ccolor collar color</code> || Sets cat modifiers
|-
| /npc chunkload || <code>(-t(emporary))</code> || Toggle the NPC forcing chunks to stay loaded
|-
| /npc collidable || None || Toggles an NPC&#39;s collidability
|-
| /npc command, /npc cmd || <code>(add [command] &#124; remove [id] &#124; permissions [permissions] &#124; sequential &#124; random &#124; clearerror [type] (name&#124;uuid) &#124; errormsg [type] [msg] &#124; persistsequence [true&#124;false] &#124; (exp&#124;item)cost [cost]) (-s(hift)) (-l[eft]/-r[ight]) (-p[layer] -o[p]), --cooldown --gcooldown [seconds] --delay [ticks] --permissions [perms] --n [max # of uses]</code> || Controls commands which will be run when clicking on an NPC
|-
| /npc controllable, /npc control || <code>(-m(ount),-y,-n,-o(wner required))</code> || Toggles whether the NPC can be ridden and controlled
|-
| /npc copier || None || Toggle the NPC copier
|-
| /npc copy || <code>(--name newname)</code> || Copies an NPC
|-
| /npc create || <code>[name] ((-b(aby),u(nspawned),s(ilent),t(emporary)) --at [x:y:z:world] --type [type] --item (item) --trait [&#39;trait1, trait2...&#39;] --registry [registry name])</code> || Create a new NPC
|-
| /npc debug || <code>-p(aths) -n(avigation)</code> || Display debugging information
|-
| /npc despawn || <code>(id)</code> || Despawn a NPC
|-
| /npc drops || None || Edit an NPC&#39;s drops
|-
| /npc endercrystal || <code>-b(ottom)</code> || Edit endercrystal modifiers
|-
| /npc enderman || <code>-a(ngry)</code> || Set enderman modifiers
|-
| /npc equip || None || Toggle the equipment editor
|-
| /npc flyable || <code>(true&#124;false)</code> || Toggles or sets an NPC&#39;s flyable status
|-
| /npc follow || <code>(player name&#124;NPC id) (-p[rotect])</code> || Toggles NPC following you
|-
| /npc fox || <code>--type type --sleeping [true&#124;false] --sitting [true&#124;false] --crouching [true&#124;false]</code> || Sets fox modifiers
|-
| /npc frog || <code>(--variant variant)</code> || Sets frog modifiers
|-
| /npc gamemode || <code>[gamemode]</code> || Changes the gamemode
|-
| /npc glowing || <code>--color [minecraft chat color]</code> || Toggles an NPC&#39;s glowing status
|-
| /npc goat || <code>-l(eft) -r(ight) -n(either) -b(oth) horn</code> || Sets goat modifiers
|-
| /npc gravity || None || Toggles gravity
|-
| /npc gui || None || Display NPC configuration GUI
|-
| /npc hologram || <code>add [text] &#124; set [line #] [text] &#124; remove [line #] &#124; clear &#124; lineheight [height] &#124; direction [up&#124;down]</code> || Controls NPC hologram text
|-
| /npc horse, /npc donkey, /npc mule || <code>(--color color) (--type type) (--style style) (-cb)</code> || Sets horse and horse-like entity modifiers
|-
| /npc hurt || <code>[damage]</code> || Damages the NPC
|-
| /npc id || None || Sends the selected NPC&#39;s ID to the sender
|-
| /npc inventory || None || Show&#39;s an NPC&#39;s inventory
|-
| /npc item || <code>(item) (metadata) (-h(and))</code> || Sets the NPC&#39;s item
|-
| /npc jump || None || Makes the NPC jump
|-
| /npc leashable || None || Toggles leashability
|-
| /npc list || <code>(page) ((-a) --owner (owner) --type (type) --char (char) --registry (name))</code> || List NPCs
|-
| /npc llama || <code>(--color color) (--strength strength)</code> || Sets llama modifiers
|-
| /npc lookclose || <code>--range [range] -r[ealistic looking] --randomlook [true&#124;false] --randomswitchtargets [true&#124;false] --randompitchrange [min,max] --randomyawrange [min,max] --disablewhennavigating [true&#124;false]</code> || Toggle whether a NPC will look when a player is near
|-
| /npc mcow || <code>(--variant [variant])</code> || Sets mushroom cow modifiers.
|-
| /npc metadata || <code>set&#124;get&#124;remove [key] (value) (-t(emporary))</code> || Manages NPC metadata
|-
| /npc minecart || <code>(--item item_name(:data)) (--offset offset)</code> || Sets minecart item
|-
| /npc mount || <code>(--onnpc &lt;npc id&gt;) (-c (ancel))</code> || Mounts a controllable NPC
|-
| /npc moveto || <code>x:y:z:world &#124; x y z world</code> || Teleports a NPC to a given location
|-
| /npc name || <code>(-h(over))</code> || Toggle nameplate visibility, or only show names on hover
|-
| /npc ocelot || <code>(--type type) (-s(itting), -n(ot sitting))</code> || Set the ocelot type of an NPC and whether it is sitting
|-
| /npc owner || <code>[uuid&#124;SERVER]</code> || Set the owner of an NPC
|-
| /npc panda || <code>--gene (main gene) --hiddengene (hidden gene) -s(itting)</code> || Sets panda modifiers
|-
| /npc panimate || <code>[animation]</code> || Plays a player animation
|-
| /npc parrot || <code>(--variant variant)</code> || Sets parrot modifiers
|-
| /npc passive || <code>(--set [true&#124;false])</code> || Sets whether an NPC damages other entities or not
|-
| /npc path || None || Toggle the waypoint editor
|-
| /npc pathopt || <code>--avoid-water&#124;aw [true&#124;false] --stationary-ticks [ticks] --attack-range [range] --distance-margin [margin] --path-distance-margin [margin] --use-new-finder [true&#124;false]</code> || Sets an NPC&#39;s pathfinding options
|-
| /npc pathrange || <code>[range]</code> || Sets an NPC&#39;s pathfinding range
|-
| /npc pathto || <code>me &#124; here &#124; cursor &#124; [x] [y] [z]</code> || Starts pathfinding to a certain location
|-
| /npc phantom || <code>(--size size)</code> || Sets phantom modifiers
|-
| /npc pickupitems || <code>(--set [true&#124;false])</code> || Allow NPC to pick up items
|-
| /npc piglin || <code>(--dancing [true&#124;false])</code> || Sets piglin modifiers.
|-
|-
| /npc || ''None'' || Yes || Yes || No || None || Show basic NPC information
| /npc playerlist || <code>(-a,r)</code> || Sets whether the NPC is put in the playerlist
|-
|-
| /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 polarbear || <code>(-r)</code> || Sets polarbear modifiers.
|-
|-
| /npc anchor || ''anchor (--save [name]|--assume [name]|--remove [name]) (-a)'' - 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 pose || <code>(--save [name] (-d) &#124; --mirror [name] (-d) &#124; --assume [name] &#124; --remove [name] &#124; --default [name]) (-a)</code> || Manage NPC poses
|-
|-
| /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 power || None || Toggle a creeper NPC as powered
|-
|-
| /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 profession, /npc prof || <code>[profession]</code> || Set a NPC&#39;s profession
|-
|-
| /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 pufferfish || <code>(--state state)</code> || Sets pufferfish modifiers
|-
|-
| /npc create || ''[NPC Name]'' - Name to give NPC <br>''(--type [type])'' - [[Types|Mob type]] to use <br>''--trait [trait1] [trait2] ... - A list of traits to apply to the NPC || Yes || Yes || No || citizens.npc.create || Create a new NPC.
| /npc rabbittype || <code>[type]</code> || Set the Type of a Rabbit NPC
Example : <code> /npc create Jimbo Stevenson --type PIG </code>
|-
|-
| /npc despawn || ''(id)'' the ID of the NPC to despawn || Yes || Yes || No || citizens.npc.despawn || Despawn a NPC
| /npc remove, /npc rem || <code>(all&#124;id&#124;name&#124; --owner [owner] &#124; --eid [entity uuid] &#124; --world [world])</code> || Remove a NPC
|-
|-
| /npc gamemode || ''[gamemode] the gamemode to use '' || Yes || Yes || PLAYER || citizens.npc.gamemode || Sets a Player NPC's game mode.
| /npc rename || <code>[name]</code> || Rename a NPC
|-
|-
| /npc gravity || ''None'' || Yes || Yes || No || citizens.npc.gravity || Toggles gravity on the NPC.
| /npc respawn || <code>[delay]</code> || Sets an NPC&#39;s respawn delay
|-
|-
| /npc equip || ''None'' || Yes || Yes || Yes - PLAYER, PIG, SHEEP, ENDERMAN || citizens.npc.edit.equip || Toggle equipment editor. see [[Editors#Equipment_Editor|Equipment Editor]] Used for player armor, player and endermen items, sheep color/sheared, and pig saddles.
| /npc rotate || <code>(--body [yaw]) (--head [yaw]) (--pitch [pitch]) (-s(mooth))</code> || Rotate NPC
|-
|-
| /npc list || ''(-a)'' - List all NPCs <br>''(--owner (owner))'' - Owner <br>''(--type (type))'' - Mob type <br>''(--char (character))'' - Character || No || No || No || citizens.npc.list || List NPCs that match at least one of the given conditions
| /npc scoreboard || <code>--addtag [tags] --removetag [tags]</code> || Controls an NPC&#39;s scoreboard
|-
|-
| /npc lookclose || ''None'' || Yes || Yes || No || citizens.npc.lookclose || Toggle a NPC's look-close state
| /npc script || <code>--add [files] --remove [files]</code> || Controls an NPC&#39;s scripts
|-
|-
| /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 select, /npc sel || <code>[id&#124;name] (--r range) (--registry [name])</code> || Select a NPC with the given ID or name
|-
|-
| /npc mount|| ''None'' || Yes || Yes || No || citizens.npc.mount|| Mount the currently selected NPC, if it is controllable.
| /npc sheep || <code>(--color [color]) (--sheared [sheared])</code> || Sets sheep modifiers
|-
|-
| /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 shop || <code>(edit&#124;show&#124;delete) (name)</code> || NPC shop edit/show
|-
|-
| /npc path || ''None'' || Yes || Yes || No || citizens.npc.edit.path || Toggle [[Waypoints|path]] editor. Left click to add a waypoint, right click to remove, mousewheel or number keys to select individual waypoints.
| /npc shulker || <code>(--peek [peek] --color [color])</code> || Sets shulker modifiers.
|-
|-
| /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 size || <code>[size]</code> || Sets the NPC&#39;s size
|-
|-
| /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 skin || <code>(-c(lear) -l(atest)) [name] (or --url [url] or -t [uuid/name] [data] [signature])</code> || Sets an NPC&#39;s skin name. Use -l to set the skin to always update to the latest
|-
|-
| /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.<br><nowiki> ''(--save [name]|--load [name]|--remove [name)'' </nowiki> || Yes || Yes || Yes - PLAYER || citizens.pose || Changes/Stores NPC's head position based on the Player's current position.
| /npc skinlayers || <code>(--cape [true&#124;false]) (--hat [true&#124;false]) (--jacket [true&#124;false]) (--sleeves [true&#124;false]) (--pants [true&#124;false])</code> || Sets an NPC&#39;s skin layers visibility.
|-
|-
| /npc power || ''None'' || Yes || Yes || Yes - CREEPER || citizens.npc.power || Toggle whether a creeper NPC is powered
| /npc snowman || <code>(-d[erp])</code> || Sets snowman modifiers.
|-
|-
| /npc profession|| ''BLACKSMITH, LIBRARIAN, BUTCHER, FARMER, or PRIEST'' || Yes || Yes || Yes - VILLAGER|| citizens.npc.profession || Change a villager-type NPC's profession.
| /npc sound || <code>(--death [death sound&#124;d]) (--ambient [ambient sound&#124;d]) (--hurt [hurt sound&#124;d]) (-n(one)/-s(ilent)) (-d(efault))</code> || Sets an NPC&#39;s played sounds
|-
|-
| /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 spawn || <code>(id&#124;name) -l(oad chunks)</code> || Spawn an existing NPC
|-
|-
| /npc rename || ''[name]'' - New name for the NPC ||| Yes || Yes || No || citizens.npc.rename || Rename a NPC
| /npc speak || <code>[message] --target [npcid&#124;player name] --range (range to look for entities to speak to in blocks) (--type vocal_type)</code> || Says a message from the NPC
|-
|-
| /npc select || ''[id]'' - ID of the NPC to select || No || Yes || No || citizens.npc.select || Selects a NPC with the given ID
| /npc speed || <code>[speed]</code> || Sets the movement speed of an NPC as a percentage
|-
|-
| /npc size || ''[size]'' - the integer size for the slime || Yes || Yes || SLIME || citizens.npc.size || Sets a slime's size.
| /npc spellcaster || <code>(--spell spell)</code> || Sets spellcaster modifiers
|-
|-
| /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 swim || <code>(--set [true&#124;false])</code> || Sets an NPC to swim or not
|-
|-
| /npc spawn || ''[id]'' - ID of the NPC you want to spawn || Yes || Yes || No || citizens.npc.spawn || Spawn a existing NPC
| /npc target || <code>[name&#124;UUID] (-a[ggressive]) (-c[ancel])</code> || Target a given entity
|-
|-
| /npc speed|| ''[value]'' - speed multiplier| Yes || Yes || No || citizens.npc.speed|| changes the NPC's default speed multiplier. i.e. use 2 to double the normal speed.
| /npc targetable || <code>(-t(emporary))</code> || Toggles an NPC&#39;s targetability
|-
|-
| /npc text || ''None'' || Yes || Yes || No || citizens.npc.edit.text || Toggle text editor. '''Note that players need the citizens.npc.talk permission to hear NPCs!'''
| /npc text || None || Toggle the text editor
|-
|-
| /npc tphere || ''None'' || Yes || Yes || No || citizens.npc.tphere || Teleport a NPC to your location
| /npc tfish || <code>(--body color) (--pattern pattern) (--patterncolor color)</code> || Sets tropical fish modifiers
|-
|-
| /npc tp || ''None'' || Yes || Yes || No || citizens.npc.tp || Teleport to a NPC
| /npc tp || <code>(-e(xact))</code> || Teleport in front of an NPC
|-
|-
| /npc type || ''[type]'' - the new entity type || Yes || Yes || No || citizens.npc.type || Changes an NPC's mob type.
| /npc tphere || <code>(cursor) (-c(enter))</code> || Teleport a NPC to your location
|-
|-
| /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 tpto || <code>[player name&#124;npc id] [player name&#124;npc id]</code> || Teleport an NPC or player to another NPC or player
|-
|-
| /npc zombiemod || ''(-b, -v)'' - -b for baby, -v for villager || Yes || Yes || ZOMBIE || citizens.npc.zombiemodifier || Sets a zombie NPC's modifiers.
| /npc trackingrange || <code>[range]</code> || Sets the tracking range
|-
|-
|/trait || ''[trait1] [trait2] ... [traitN'' - A list of [[Characters|Traits]] to apply|| Yes || Yes || No || citizens.npc.trait.* or citizens.npc.trait.<trait-name> for per-trait permissions || Adds the [[Characters|trait type]] to the NPC. NPCs can have multiple traits.
| /npc type || <code>[type]</code> || Sets an NPC&#39;s entity type
Example: <code> /npc trait sentry </code>
|-
| /npc undo || <code>(all)</code> || Undoes the last action (currently only create/remove supported)
|-
| /npc useitem || <code>(-o(ffhand))</code> || Sets an NPC to  be using their held items
|-
| /npc villager || <code>(--level level) (--type type) (--profession profession)</code> || Sets villager modifiers
|-
| /npc vulnerable || <code>(-t(emporary))</code> || Toggles an NPC&#39;s vulnerability
|-
| /npc wander || None || Sets the NPC to wander around
|-
| /npc wither || <code>(--invulnerable [true&#124;false]) (--arrow-shield [true&#124;false])</code> || Sets wither modifiers
|-
| /npc wolf || <code>(-s(itting) a(ngry) t(amed) i(nfo)) --collar [hex rgb color&#124;name]</code> || Sets wolf modifiers
|-
|/trait || <code>[trait1] [trait2] ... [traitN]</code> - A list of [[Characters|Traits]] to apply || Adds the [[Characters|trait type]] to the NPC. NPCs can have multiple traits. Example: <code> /trait sentinel</code>
}}
|}
|}


== Script commands ==
== Denizen-added commands ==
 
The following <code>/npc</code> commands are added by [https://denizenscript.com/ Denizen] (as copied from <code>/npc help</code>).
[https://guide.denizenscript.com/guides/background/download-denizen.html Denizen can be downloaded from here.]
 
{| class="wikitable collapsible" style="text-align: center; width: 100%"
{| class="wikitable collapsible" style="text-align: center; width: 100%"
|-
|-
! style="width: 100%; background-color:#ADD8E6" colspan="7" | '''Script Commands'''
! style="width: 100%; background-color:#ADD8E6" colspan="7" | '''Denizen /NPC Commands'''
|-
! style="width: 200px;" | Command !! style="width: 400px;" | Arguments !! Description
{{#!:
|-
| /npc mirrorskin || None || Makes the NPC mirror the skin of the player looking at it.
|-
| /npc mirrorname || None || Makes the NPC mirror the name of the player looking at it.
|-
| /npc mirrorequip || None || Makes the NPC mirror the equipment of the player looking at it.
|-
| /npc stand || None || Makes the NPC stand.
|-
| /npc pushable || ''-t (-r) (--delay #)'' || Makes an NPC pushable.
|-
| /npc constant || ''--set/remove name --value constant value'' || Views/adds/removes NPC string constants.
|-
| /npc assignment || ''--set assignment_name (-r)'' || Controls the assignment for an NPC.
|-
| /npc trigger || ''[trigger name] [(--cooldown [seconds])/(--radius [radius])/(-t)]'' || Controls the various triggers for an NPC.
|-
| /npc nickname || ''[--set nickname]'' || Gives the NPC a nickname, used with a Denizen-compatible Speech Engine.
|-
| /npc sit || ''(--location x,y,z,world) (--anchor anchor_name) (-c)'' || Makes the NPC sit.
|-
| /npc sleep || ''(--location x,y,z,world) (--anchor anchor_name)'' || Makes the NPC sleep.
|-
| /npc sneak || None || Makes the NPC crouch.
|-
| /npc wakeup || None || Makes the NPC wake up.
|-
| /npc fish || ''(--location x,y,z,world) (--anchor anchor_name) (-c)'' || Makes the NPC fish, casting at the given location.
|-
|-
! style="width: 200px;" | Command !! style="width: 400px;" | Args Description !! style="width: 50px;" | Permission !! Description
| /npc stopfishing || None || Makes the NPC stop fishing.
|-
|-
| /script compile|run || ''[file] (--methods methods)'' - file is the script file in the /scripts folder to compile, methods are the methods to call || citizens.script.compile || Compiles and runs a script
| /npc invisible || None || Turns the NPC invisible.
|-
|-
| /npc health || ''--set # (-r)'' || Sets the max health for an NPC.
}}
|}
|}


== Waypoint commands ==
== Waypoint commands ==
Permissions are of the format "citizens.waypoints.xx", like "citizens.waypoints.disableteleport" for the "disableteleport" command.
{| class="wikitable collapsible" style="text-align: center; width: 100%"
{| class="wikitable collapsible" style="text-align: center; width: 100%"
|-
|-
! style="width: 100%; background-color:#ADD8E6" colspan="7" | '''Waypoint Commands'''
! style="width: 100%; background-color:#ADD8E6" colspan="7" | '''Waypoint Commands'''
|-
|-
! style="width: 200px;" | Command !! style="width: 400px;" | Args Description !! style="width: 50px;" | Permission !! Description
! style="width: 200px;" | Command !! style="width: 400px;" | Arguments !! Description
|-
|-
| /waypoints disableteleporting || ''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 disableteleport || None || 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 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.
| /waypoints provider || <code>[provider name] (-a)</code> - provider name is the provider to use (currently linear, guided and wander), use -a to get a list of all providers || Sets the waypoint provider to use when using the waypoint editor.
|-
|-
| /waypoint add || <code>[x] [y] [z] (world) (--index idx)</code> || Adds a waypoint at a point
|}
|}


Line 169: Line 366:
! style="width: 100%; background-color:#ADD8E6" colspan="7" | '''Template Commands'''
! style="width: 100%; background-color:#ADD8E6" colspan="7" | '''Template Commands'''
|-
|-
! style="width: 200px;" | Command !! style="width: 400px;" | Args Description !! style="width: 50px;" | Permission !! Description
! style="width: 200px;" | Command !! style="width: 400px;" | Arguments !! style="width: 50px;" | 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 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.

Revision as of 17:58, 31 March 2023

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 Arguments Permission Description
/citizens help (Page) - Page number to display citizens.help Show Citizens help menu
/npc help (Page) - Page number to display citizens.npc.help Show NPC help menu
/trait help (Page) - Page number to display citizens.trait.help Show trait help menu
/template help (Page) - Page number to display citizens.templates.help Show template help menu
/waypoints help (Page) - Page number to display citizens.waypoints.help 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.

The following command list is copied from /npc help

NPC Commands
Command Arguments Description
/npc None Show basic NPC information
/npc age [age] (-l(ock)) Set the age of a NPC
/npc ai (true|false) Sets whether the NPC should use vanilla AI
/npc allay (-d(ancing)) Sets allay modifiers
/npc anchor (--save [name]|--assume [name]|--remove [name]) (-a) (-c) Changes/Saves/Lists NPC's location anchor(s)
/npc armorstand --visible [visible] --small [small] --gravity [gravity] --arms [arms] --baseplate [baseplate] --(body|leftarm|leftleg|rightarm|rightleg)pose [angle x,y,z] Edit armorstand properties
/npc axolotl (-d) (--variant variant) Sets axolotl modifiers
/npc bee (-s/-n) --anger anger Sets bee modifiers
/npc bossbar --style [style] --color [color] --title [title] --visible [visible] --flags [flags] --track [health | placeholder] Edit bossbar properties
/npc breakblock --location [x,y,z] --radius [radius] Mine a block at the given location or cursor if not specified
/npc camel (--pose pose) Sets camel modifiers
/npc cat (-s/-n/-l) --type type --ccolor collar color Sets cat modifiers
/npc chunkload (-t(emporary)) Toggle the NPC forcing chunks to stay loaded
/npc collidable None Toggles an NPC's collidability
/npc command, /npc cmd (add [command] | remove [id] | permissions [permissions] | sequential | random | clearerror [type] (name|uuid) | errormsg [type] [msg] | persistsequence [true|false] | (exp|item)cost [cost]) (-s(hift)) (-l[eft]/-r[ight]) (-p[layer] -o[p]), --cooldown --gcooldown [seconds] --delay [ticks] --permissions [perms] --n [max # of uses] Controls commands which will be run when clicking on an NPC
/npc controllable, /npc control (-m(ount),-y,-n,-o(wner required)) Toggles whether the NPC can be ridden and controlled
/npc copier None Toggle the NPC copier
/npc copy (--name newname) Copies an NPC
/npc create [name] ((-b(aby),u(nspawned),s(ilent),t(emporary)) --at [x:y:z:world] --type [type] --item (item) --trait ['trait1, trait2...'] --registry [registry name]) Create a new NPC
/npc debug -p(aths) -n(avigation) Display debugging information
/npc despawn (id) Despawn a NPC
/npc drops None Edit an NPC's drops
/npc endercrystal -b(ottom) Edit endercrystal modifiers
/npc enderman -a(ngry) Set enderman modifiers
/npc equip None Toggle the equipment editor
/npc flyable (true|false) Toggles or sets an NPC's flyable status
/npc follow (player name|NPC id) (-p[rotect]) Toggles NPC following you
/npc fox --type type --sleeping [true|false] --sitting [true|false] --crouching [true|false] Sets fox modifiers
/npc frog (--variant variant) Sets frog modifiers
/npc gamemode [gamemode] Changes the gamemode
/npc glowing --color [minecraft chat color] Toggles an NPC's glowing status
/npc goat -l(eft) -r(ight) -n(either) -b(oth) horn Sets goat modifiers
/npc gravity None Toggles gravity
/npc gui None Display NPC configuration GUI
/npc hologram add [text] | set [line #] [text] | remove [line #] | clear | lineheight [height] | direction [up|down] Controls NPC hologram text
/npc horse, /npc donkey, /npc mule (--color color) (--type type) (--style style) (-cb) Sets horse and horse-like entity modifiers
/npc hurt [damage] Damages the NPC
/npc id None Sends the selected NPC's ID to the sender
/npc inventory None Show's an NPC's inventory
/npc item (item) (metadata) (-h(and)) Sets the NPC's item
/npc jump None Makes the NPC jump
/npc leashable None Toggles leashability
/npc list (page) ((-a) --owner (owner) --type (type) --char (char) --registry (name)) List NPCs
/npc llama (--color color) (--strength strength) Sets llama modifiers
/npc lookclose --range [range] -r[ealistic looking] --randomlook [true|false] --randomswitchtargets [true|false] --randompitchrange [min,max] --randomyawrange [min,max] --disablewhennavigating [true|false] Toggle whether a NPC will look when a player is near
/npc mcow (--variant [variant]) Sets mushroom cow modifiers.
/npc metadata set|get|remove [key] (value) (-t(emporary)) Manages NPC metadata
/npc minecart (--item item_name(:data)) (--offset offset) Sets minecart item
/npc mount (--onnpc <npc id>) (-c (ancel)) Mounts a controllable NPC
/npc moveto x:y:z:world | x y z world Teleports a NPC to a given location
/npc name (-h(over)) Toggle nameplate visibility, or only show names on hover
/npc ocelot (--type type) (-s(itting), -n(ot sitting)) Set the ocelot type of an NPC and whether it is sitting
/npc owner [uuid|SERVER] Set the owner of an NPC
/npc panda --gene (main gene) --hiddengene (hidden gene) -s(itting) Sets panda modifiers
/npc panimate [animation] Plays a player animation
/npc parrot (--variant variant) Sets parrot modifiers
/npc passive (--set [true|false]) Sets whether an NPC damages other entities or not
/npc path None Toggle the waypoint editor
/npc pathopt --avoid-water|aw [true|false] --stationary-ticks [ticks] --attack-range [range] --distance-margin [margin] --path-distance-margin [margin] --use-new-finder [true|false] Sets an NPC's pathfinding options
/npc pathrange [range] Sets an NPC's pathfinding range
/npc pathto me | here | cursor | [x] [y] [z] Starts pathfinding to a certain location
/npc phantom (--size size) Sets phantom modifiers
/npc pickupitems (--set [true|false]) Allow NPC to pick up items
/npc piglin (--dancing [true|false]) Sets piglin modifiers.
/npc playerlist (-a,r) Sets whether the NPC is put in the playerlist
/npc polarbear (-r) Sets polarbear modifiers.
/npc pose (--save [name] (-d) | --mirror [name] (-d) | --assume [name] | --remove [name] | --default [name]) (-a) Manage NPC poses
/npc power None Toggle a creeper NPC as powered
/npc profession, /npc prof [profession] Set a NPC's profession
/npc pufferfish (--state state) Sets pufferfish modifiers
/npc rabbittype [type] Set the Type of a Rabbit NPC
/npc remove, /npc rem (all|id|name| --owner [owner] | --eid [entity uuid] | --world [world]) Remove a NPC
/npc rename [name] Rename a NPC
/npc respawn [delay] Sets an NPC's respawn delay
/npc rotate (--body [yaw]) (--head [yaw]) (--pitch [pitch]) (-s(mooth)) Rotate NPC
/npc scoreboard --addtag [tags] --removetag [tags] Controls an NPC's scoreboard
/npc script --add [files] --remove [files] Controls an NPC's scripts
/npc select, /npc sel [id|name] (--r range) (--registry [name]) Select a NPC with the given ID or name
/npc sheep (--color [color]) (--sheared [sheared]) Sets sheep modifiers
/npc shop (edit|show|delete) (name) NPC shop edit/show
/npc shulker (--peek [peek] --color [color]) Sets shulker modifiers.
/npc size [size] Sets the NPC's size
/npc skin (-c(lear) -l(atest)) [name] (or --url [url] or -t [uuid/name] [data] [signature]) Sets an NPC's skin name. Use -l to set the skin to always update to the latest
/npc skinlayers (--cape [true|false]) (--hat [true|false]) (--jacket [true|false]) (--sleeves [true|false]) (--pants [true|false]) Sets an NPC's skin layers visibility.
/npc snowman (-d[erp]) Sets snowman modifiers.
/npc sound (--death [death sound|d]) (--ambient [ambient sound|d]) (--hurt [hurt sound|d]) (-n(one)/-s(ilent)) (-d(efault)) Sets an NPC's played sounds
/npc spawn (id|name) -l(oad chunks) Spawn an existing NPC
/npc speak [message] --target [npcid|player name] --range (range to look for entities to speak to in blocks) (--type vocal_type) Says a message from the NPC
/npc speed [speed] Sets the movement speed of an NPC as a percentage
/npc spellcaster (--spell spell) Sets spellcaster modifiers
/npc swim (--set [true|false]) Sets an NPC to swim or not
/npc target [name|UUID] (-a[ggressive]) (-c[ancel]) Target a given entity
/npc targetable (-t(emporary)) Toggles an NPC's targetability
/npc text None Toggle the text editor
/npc tfish (--body color) (--pattern pattern) (--patterncolor color) Sets tropical fish modifiers
/npc tp (-e(xact)) Teleport in front of an NPC
/npc tphere (cursor) (-c(enter)) Teleport a NPC to your location
/npc tpto [player name|npc id] [player name|npc id] Teleport an NPC or player to another NPC or player
/npc trackingrange [range] Sets the tracking range
/npc type [type] Sets an NPC's entity type
/npc undo (all) Undoes the last action (currently only create/remove supported)
/npc useitem (-o(ffhand)) Sets an NPC to be using their held items
/npc villager (--level level) (--type type) (--profession profession) Sets villager modifiers
/npc vulnerable (-t(emporary)) Toggles an NPC's vulnerability
/npc wander None Sets the NPC to wander around
/npc wither (--invulnerable [true|false]) (--arrow-shield [true|false]) Sets wither modifiers
/npc wolf (-s(itting) a(ngry) t(amed) i(nfo)) --collar [hex rgb color|name] Sets wolf modifiers
/trait [trait1] [trait2] ... [traitN] - A list of Traits to apply Adds the trait type to the NPC. NPCs can have multiple traits. Example: /trait sentinel

Denizen-added commands

The following /npc commands are added by Denizen (as copied from /npc help). Denizen can be downloaded from here.

Denizen /NPC Commands
Command Arguments Description
/npc mirrorskin None Makes the NPC mirror the skin of the player looking at it.
/npc mirrorname None Makes the NPC mirror the name of the player looking at it.
/npc mirrorequip None Makes the NPC mirror the equipment of the player looking at it.
/npc stand None Makes the NPC stand.
/npc pushable -t (-r) (--delay #) Makes an NPC pushable.
/npc constant --set/remove name --value constant value Views/adds/removes NPC string constants.
/npc assignment --set assignment_name (-r) Controls the assignment for an NPC.
/npc trigger [trigger name] [(--cooldown [seconds])/(--radius [radius])/(-t)] Controls the various triggers for an NPC.
/npc nickname [--set nickname] Gives the NPC a nickname, used with a Denizen-compatible Speech Engine.
/npc sit (--location x,y,z,world) (--anchor anchor_name) (-c) Makes the NPC sit.
/npc sleep (--location x,y,z,world) (--anchor anchor_name) Makes the NPC sleep.
/npc sneak None Makes the NPC crouch.
/npc wakeup None Makes the NPC wake up.
/npc fish (--location x,y,z,world) (--anchor anchor_name) (-c) Makes the NPC fish, casting at the given location.
/npc stopfishing None Makes the NPC stop fishing.
/npc invisible None Turns the NPC invisible.
/npc health --set # (-r) Sets the max health for an NPC.

Waypoint commands

Permissions are of the format "citizens.waypoints.xx", like "citizens.waypoints.disableteleport" for the "disableteleport" command.

Waypoint Commands
Command Arguments Description
/waypoints disableteleport None 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 Sets the waypoint provider to use when using the waypoint editor.
/waypoint add [x] [y] [z] (world) (--index idx) Adds a waypoint at a point

Template commands

Template Commands
Command Arguments 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

Characters
Text Syntax
Waypoints