User Documentation - MarkusBordihn/BOs-Easy-NPC GitHub Wiki

User Documentation 🌍

Easy NPC lets you build configurable NPCs directly in game for maps, quests, servers, and modpacks. This page is the best starting point if you want to know what the mod can do and where each feature is documented.

Getting Started

For most setups you will want the full Bundle, or Core + Config UI. See Installation if you still need to set up the mod.

Open the main NPC screen with the Easy NPC wand, by right-clicking an NPC while sneaking, or with:

/easy_npc configure <NPC>

Configuration screen

The main screen shows the NPC UUID, type, owner, home position, health, and the available editor sections.

Appearance 🎨

Use these pages when you want to change how an NPC looks:

  • Types - Standard NPCs, raw NPCs, and Cobblemon NPCs
  • Skins - Default, player, remote, and custom skins
  • CustomModels - Custom rendering and model replacement
  • Equipment - Armor, held items, and player heads
  • Pose - Built-in and custom poses
  • Position - Model part offsets
  • Rotation - Body and model-part rotation
  • Scaling - Full-model and per-part scaling

Interactions 💬

Use these pages when the NPC should do something:

  • Dialogs - Basic, yes/no, and advanced dialogs with priorities and conditions
  • Trading - None, basic, advanced, and custom trading setups
  • Actions - Commands, dialog actions, distance actions, scoreboard actions, and trade actions
  • Objectives - Follow, attack, look, and related behavior
  • Attributes - Base and combat-related stats
  • Progression - XP and level-based progression

Presets, Commands, and Server Setup 🧰

  • Preset - Import, export, and preset formats
  • Commands - Server commands and maintenance commands
  • Permissions - Feature access, command levels, and security rules
  • Spawner - Spawner block behavior and settings
  • Delete - Safe removal notes and links
  • Backup - Automatic backup behavior

Integrations and Special Cases 🔌

Resource Pack Notes 🖼️

Some UI textures can be replaced with a normal resource pack.

  • Dialog textures are documented on Dialogs
  • Config screen backgrounds can be overridden from:
    • assets/easy_npc_config_ui/textures/gui/config_screen/background.png
    • assets/easy_npc_config_ui/textures/gui/config_screen/background_small.png
⚠️ **GitHub.com Fallback** ⚠️