NPCs & Guide

In-game guide UI and NPC system. NPCs are saved to config; you can link them to in-world entities, attach holograms, and set what happens when players interact (open guide or run a command). Opened via /guide or (if configured) /help, or by interacting with an NPC.

Prison Guide UI

Guide UI: rules, progression, links to Mines, Pickaxe Upgrades, Rank Up, Stats. Opened via /guide or by interacting with an NPC whose interact command is guide.

NPC system

NPC definitions are stored in Config/npcs.json and loaded on every server start.

Commands: /npceditor — open NPC Editor to list, edit, or delete (no space; separate command). /npc create <name> — start creating an NPC (you will link it to an entity). /npc list — list NPCs. /npc delete <name> — remove an NPC. All require hyprisoncore.admin.
Link to entity: Place an entity with Hytale’s entity tool where you want the NPC. In the NPC Editor, create a new NPC (enter name, click Find nearby entities) or edit an existing one and click Link to entity. Select the entity from the list (within 10 blocks). The plugin applies the NPC’s display name and Use interaction to that entity so interacting opens the guide (or runs the configured command). The entity is persisted by the engine.
Interact command: When a player Uses the entity, guide opens the Prison Guide UI; other values (e.g. mine) run the corresponding command (e.g. /mine) for the player.
Hologram: You can attach a hologram to an NPC (Hologram ID in the editor). The hologram appears above the NPC. Option Hide NPC name when using hologram hides the entity’s nameplate so only the hologram text shows.

NPCs and their linked holograms spawn and are applied on server start so they persist across restarts.