Documentation

NPCs

Premium

This is part of ScriptedEssentials Premium. See what's in each edition.

NPCs let you fill a scene without needing a real player for every role. You can give them names, skins and gear, make them walk around, or record a route for them to follow.

They still use server resources. Start with a small group and check how the server handles it before spawning a large crowd, especially if they're all moving.

They're saved in npcs/npcs.json, so they come back after a restart.

All of this needs scriptedessentials.admin.

The hub (/npc)

commands
/npc

Run /npc to open the main menu. Most of the everyday settings are here, so you don't need to remember every command.

Button What it does
All NPCs Every NPC as its head. Left-click opens its editor, right-click teleports you to it
Spawn NPC Left for a random name, right to type one
Edit Mode Toggle it, shows whether it's on
Movement Puts the wander and sync commands in your chat bar to finish off
Spawn Defaults What new NPCs start with
Mass Actions Reload, hide, show or re-roll every NPC at once
All Commands Prints the full list

Opening an NPC from All NPCs gives you the full editor without turning edit mode on first.

/npc clear isn't in the menu on purpose. Removing every NPC is a typed command.

Quick start

commands
/npc spawn Steve    # spawn one where you're standing
/npc edit           # edit mode on
                    # right-click the NPC to open its editor
/npc help           # every subcommand, grouped

In this section

Page Covers
Spawning /npc spawn, mass spawn, patterns, copy and paste
Managing NPCs List, remove, hide, teleport, reload
Edit mode The editor GUI, settings, equipment, locator bar
Movement Wander, paths, recorded movement, how they behave
Armies Marching formations
Mass actions Doing things to every NPC at once
Groups Grouping NPCs and the group wand
Defaults Settings for new NPCs, death messages
Fake tab players Padding the player list

Queue mannequins are NPCs too, they just have their own page. See Queues.

Turning the system off

Set npc.enabled to false in config.yml and /npc disappears.

Diagnostics (/se npcdiag)

commands
/se npcdiag

How many NPCs you have, how many in each movement mode, and each one's id, name, location and how many players can see it.

If an NPC is missing for one player, try /npc reload <name>. If nobody can see it, check whether it's hidden and use /npc show <name> if needed. Avoid showing every NPC unless you actually want them all visible.

/npc always works (Citizens)

If Citizens or anything else also claims /npc, this plugin wins. /npc, /minecraft:npc, /citizens:npc and /scriptedessentialsapi:npc all land here.