NPC Click Commands
One of the common things Citizens users want is the ability to have NPCs run a command when right-clicked.
This is available within Citizens via the "/npc command" command. For details, refer to
/npc help command.
Adding Click Commands
By default, "/npc command" will run commands as the server. Use "-p" to run as the player who clicked instead.
For example: Use
/npc command add -p help to make an NPC automatically execute "/help" as the player when clicked. Note that you don't type the "/" on the command name.
To auto-fill the player name, use "<p>". To autofill the NPC ID, use "<npc>".
For example: Use
/npc command add kick <p> to make an NPC automatically kick the player when clicked.
As another common example:
/npc command add tp <p> 0 64 0 to automatically teleport the player that clicked the NPC to some coordinates (assumes the vanilla 'tp' command. If you use Essentials, use 'tppos' instead).
Note that this can be any command from minecraft or any plugin, so for example if you use Multiverse,
/npc command add mvtp <p> myworldname will use the Multiverse world teleport command.
Note as well that if you have PlaceholderAPI installed, you can use PAPI placeholders within commands. For example,
/npc command add msg <p> The current TPS is %server_tps%.
Consult PlaceholderAPI's own documentation for details on available placeholders or how to format them.
By default, anybody can click the NPC to cause a command to execute, without any permission requirement.
-p is used, it will execute as-player, meaning any permissions check the command itself has will be required for the player.
-o is used, it will execute as-op, meaning the player will be treated as if they were a server operator, and thus usually permissions won't be expected (unless you have a permissions plugin that doesn't respect op, or a protection plugin that disables op). Be warned that
-o will tend to risk side effects or performance problems.
Generally, it's best to execute as-server (don't specify
-o to use the default as-server), which will not require any permissions. You will need to use
<p> to fill in the playername wherever the command requires one.
If you want to add your own additional permissions requirement, use
--permission my.perm.here when adding the command.
A Click Command To Speak
To make an NPC command that causes an NPC to speak to the player (if you don't need the full options of the NPC command feature, just use
/npc text instead), you can do:
/npc command add "npc speak MESSAGE HERE --target <p> --id <id>"
This uses the
/npc speak command, targeted at the clicking player using
--target <p>, speaking from the clicked NPC using
--id <id>. The command needs "quotes" around it to prevent misinterpretation of the input arguments. Note that the only part of this you need to fill in yourself is the "MESSAGE HERE" part. The 'p' and 'id' bits should be left exactly as-is.
On Bungee servers, this supports the Bungee
server command, like
/npc command add -p server MyServerName. Note that this is a special case built into Citizens internally, and bypasses any normal permission requirements automatically.
Note that other bungee-proxy commands (or commands on Velocity or other proxies) will not work. Only commands that can be ran within the confines of the Spigot server instance will function. If you need to execute commands from a Bungee plugin, it is necessary for that plugin to provide a Spigot plugin with interfacing commands of its own, or to use some generic Bungee control relay like DepenizenBungee.
To remove a command, first type just
/npc command to see the list of currently attached commands with ID numbers.
If you have for example a command with ID 0, you can then type
/npc command remove 0.
By default, if you add multiple commands with
/npc command, they will all run at once.
You can instead set them to happen one at a time, either in sequential order, or in random order.
To make the commands go in order, one at a time for each click, use
/npc command sequential.
To make the commands go in a random order, but still only one at a time, use
/npc command random.
To go back to all-at-once, simply redo whichever command you used to change it (for example if you set it to sequential, just do
/npc command sequential again to disable it and go back to default).
Other ways you can control
/npc command include:
/npc command permissions x.y.zto attach temporary permissions to the player (generally don't use this, instead use
-o... or just execute as-server)
/npc command add -l somethinghereto make the command respond to left clicks (punch/attack). Note that this may not work if PvP is disabled.
/npc command add -r somethinghereto make the command respond to right clicks (standard interact).
/npc command add --n 5 somethinghereto make a command only usable a certain number of times per player (in this example, 5 usages).
/npc command add --cooldown 10 somethinghereto make the command only usable once per certain time period (in this example, 10 seconds), for each player.
/npc command add --gcooldown 10 somethinghereto make the command only usable once per certain time period (in this example, 10 seconds), globally (nobody can use the NPC again until the cooldown ends).
/npc command add --delay 40 somethinghereto make the command have a delay before it activates (in this example, 40 ticks, aka 2 seconds).
/npc command cost 50to make the command have a cost using any Vault-compatible economy plugin (in this example, $50). This will refuse to run for players that don't have enough money, and automatically take the money before executing the command for those that do have enough.
/npc command expcost 50to make the command have an experience level cost. Works similar to 'cost', but for XP levels.
/npc command itemcostto open a GUI to configure an item-cost (the player has to give the item for the command to execute).
/npc command hideErrorsto hide all error message (no permission, no money, etc.) from players.
There maybe be more options available for
/npc command not yet explained here, so type
/npc help command in-game to see any such options.
If confused, join the Citizens+Denizen shared Discord to ask for help!