NPC File

On this page, you will find the format of an NPC file, for editing it by hand.

Everything on this page can be set from the in-game editor. The files are only worth opening for a bulk change, or to copy NPCs between servers. Run /pnpc reload after saving them.

#Where the Files Are

Each NPC is one file in the npcs folder, named after its id. The plugin writes only the values that differ from a new NPC, so a plain NPC stays short. Anything left out of the file takes its default.

#Example

identifier: guide
display-name: '&eGuide\n&7Right-click me'
location:
  world: world
  x: 10.5
  y: 64.0
  z: -3.5
  yaw: 90.0
  pitch: 0.0
look-at-player: true
actions:
  right:
  - '[DIALOGUE]'
tags:
- spawn
dialogue:
  start: hello
  steps:
    hello:
      text:
      - '&7Welcome to the server, %player%!'
      choices:
      - text: '&aTake me to survival'
        actions:
        - '[SERVER] survival'
      - text: '&eTell me more'
        next: more
    more:
      text:
      - '&7Ask a staff member anytime.'

#Keys

Key	Description
identifier, display-name, location, enabled	The NPC itself. See Edit NPC.
engine	`ENTITY`, `MODEL_ENGINE` or `BETTERMODEL`.
entity-type	`PLAYER` or a mob, such as `ZOMBIE`.
skin	The skin, see Skins. The textures are stored here once looked up, so set a skin from the editor or `/pnpc skin` rather than typing a name here.
model	The model id and its idle and click animations, see Models.
scale, glow, look-at-player, show-in-tab, collidable, pose	See Edit NPC.
equipment	One full item per slot, see Equipment.
visibility, interaction-cooldown, block-while-running	See Edit NPC. -1 uses the default from config.yml.
actions	The `left`, `right`, `any` and `proximity` lists, see Click Actions.
proximity	See Proximity Actions.
nameplate-offset, indicator	See Nameplate & Indicator.
tags	See Tags.
emote	See Emotes.
dialogue	The start step and every step's text and choices, see Dialogues.

An NPC whose world does not exist waits for that world. An NPC with no location at all, or a file that is not valid YAML, is skipped and reported in the console.

Last updated about 2 hours ago