ModIntegration - MarkusBordihn/BOs-Easy-NPC GitHub Wiki

Mod Integration 🔌

Easy NPC supports several useful mod integrations. This page focuses on the built-in behavior that players, map makers, and modpack authors can use in practice.

Armourer's Workshop 🎭

Armourer's Workshop can be used to style NPCs with custom visuals. This works best with humanoid-style NPCs.

Armourer's Workshop

Cobblemon ⚔️

Easy NPC includes built-in Cobblemon support. When Cobblemon is installed, a Cobblemon NPC type becomes available and can be configured like other NPCs.

Cobblemon NPC 🐾

Spawn the Cobblemon NPC with its spawn egg and then select a species in the model configuration.

Cobblemon NPC setup

Some species, especially large or heavily animated ones, may show small visual glitches because the Cobblemon renderer has different assumptions than the normal Easy NPC pipeline. Oversized species are scaled with Cobblemon's own profile scale, so the selection preview stays usable.

Gender and Shiny Variants ✨

The model list does not only contain the base species. Where Cobblemon provides them, Easy NPC also offers the female and shiny looks as separate entries, and both can be combined:

Entry Look
cobblemon:pikachu default (male) form
cobblemon:pikachu_female female form
cobblemon:pikachu_shiny shiny form
cobblemon:pikachu_female_shiny female shiny form

Type female or shiny into the search field to filter the list down to those variants. Not every species has a distinct female or shiny model - only the variants Cobblemon actually provides show up.

The same ids work with the command:

/easy_npc render set species <NPC> cobblemon:pikachu_shiny

Common Cobblemon Actions

Examples used in dialog buttons or interaction actions:

  • /openstarterscreen @initiator
  • /healpokemon @initiator
  • /openpc with Execute as player

Cobblemon starter setup Cobblemon starter dialog Cobblemon PC setup Cobblemon PC

Easy Model Entities 🧩

Easy NPC includes built-in Easy Model Entities support. This is the way to use your own Blockbench model as an NPC - with dialogs, trading, actions, and objectives - without writing a single line of Java code.

How It Fits Together 🧱

  1. Build the model in Blockbench.
  2. Export it with the Easy Model Entities Blockbench plugin. The plugin writes a ready data pack (the entity profile) and resource pack (model and textures).
  3. Install both packs, plus the Easy Model Entities mod.
  4. Spawn the Easy Model NPC with its spawn egg in Easy NPC.
  5. Open the model configuration and pick your profile.

Everything about building the model and writing profiles is documented in the Easy Model Entities wiki - this page only covers the Easy NPC side.

Selecting a Model Profile 🔍

The model list shows all active entity profiles, including everything added by data packs. The search field filters by namespace and profile name, which helps once a pack ships dozens of models.

After a /reload with changed data packs, the profile list updates automatically - no restart needed.

If your profile does not appear:

  • the data pack is not enabled (check /datapack list)
  • the profile is a block entity profile, not an entity profile - Easy NPC uses entity profiles
  • the profile failed validation; check the log for Easy Model Entities warnings

Pose Support 🕺

Unlike Doppler and Cobblemon NPCs, Easy Model NPCs support the custom pose editor for per-part rotation, position, scale, and visibility.

Models with humanoid arms and legs additionally get the default, basic, and advanced pose screens. Other body shapes only offer the custom pose editor, because the standing/sitting/sleeping poses have no meaning for them.

Model parts are matched by their bone names. Use these names in Blockbench and the pose editor recognizes the part:

head, body, left_arm, right_arm, left_leg, right_leg, front_left_leg, front_right_leg, back_left_leg, back_right_leg, left_wing, right_wing, tail, tail_fin

Parts with other names keep their automatic animation and are not editable in the pose editor. So if you want to hand-pose an arm, name the bone left_arm rather than arm_l.

The body type in the profile decides which animation set the NPC uses:

Profile body type Animates like
HUMANOID (default) Humanoid
QUADRUPED, AMPHIBIOUS, AQUATIC Quadruped
WINGED Bird
WINGED_HUMANOID Pixie
ARTHROPOD Spider
STATIC, CUBOID, FLOATING Slime

Dedicated Servers 🌐

Entity profiles are loaded server-side from data packs. The model selection list is synced to the client when the model configuration screen is opened, so no client-side data packs are required. Clients still need the Easy Model Entities mod (and any resource packs providing models and textures) to render the models.

Epic Fight 🏹

Easy NPC includes built-in Epic Fight support when the mod is present. This allows compatible NPCs to use Epic Fight combat behavior and animations.

Easy NPC with Epic Fight

Daily Rewards 🎁

Daily Rewards can be opened through an action, usually with:

/DailyRewards claim

Use Execute as player for that kind of integration command.

Daily Rewards

Simple Quests 📘

Simple Quests can also be connected through action commands, for example:

  • /simplequests show
  • /simplequests accept easy_npc:kill_example

Simple Quests

Carry On 🚫

Easy NPC entities should normally be blocked from pickup by Carry On. If needed, extend the Carry On blacklist manually:

[blacklist]
forbiddenEntities = ["...", "easy_npc:*"]
⚠️ **GitHub.com Fallback** ⚠️