ModelEngine mobs

How ModelEngine R4 models are converted and shown to Bedrock players, what you need, how to check the bridge, and the limits.

On this page

ModelEngine lets Java servers give mobs custom models and animations. NusaPack converts ModelEngine R4 models and shows them to Bedrock players through a live bridge. This page explains what you need, what Bedrock players see and how to check that it works.

What you need

RequirementDetails
ModelEngine R4Any R4 version; tested with R4.2.0. R3 uses a different API and is not supported.
BlueprintsYour models in plugins/ModelEngine/blueprints/, as .bbmodel or .blueprint.json files
ProtocolLibNeeded for the live bridge that shows the models while players play
Geyser-Spigot on the same serverAs for everything in NusaPack
convert_modelengine onOn by default; see Settings

How models are converted

ModelEngine is part of every conversion while it is switched on. When you run /npb convert:

  1. If the blueprints folder holds models, NusaPack first runs meg reload so ModelEngine regenerates its own pack. This happens before the other plugins, because Nexo and ItemsAdder can merge ModelEngine's pack into theirs.
  2. If ModelEngine does not finish in time, the result says ModelEngine did not finish regenerating in time; converting the blueprints on disk. and the conversion continues with the files as they are.
  3. The blueprints are converted into Bedrock models and added to the one Bedrock pack, together with your other content.

The result line Converted: ... then lists ModelEngine with its version, for example ModelEngine R4.2.0.

What Bedrock players see

  • Mobs with a ModelEngine model show that model on Bedrock, instead of the vanilla base mob.
  • While players play, the bridge sends each model's current state from the server, so Bedrock players see the model move and animate as the server plays it.
  • The real mob stays on the server and keeps its normal behaviour, reach and gameplay checks. Java players see no difference.

Check the ModelEngine bridge

The bridge starts with the server when Geyser-Spigot, ProtocolLib and ModelEngine R4 are all running and a converted pack exists. The startup summary then lists ModelEngine under Bridges. If ModelEngine is not R4, the console says ModelEngine bridge disabled: NusaPack needs ModelEngine R4, found ....

/npb status and the nether star in the /npb panel show a ModelEngine bridge group:

RowMeaning
Models / Bedrock viewersHow many models the pack has, and how many Bedrock players the bridge serves
Frames sentHow many updates were sent to Bedrock players, and how many were captured from the server
Modeled nearbyHow many modelled mobs are currently near Bedrock players
ProblemsRejected or oversized updates; none when all is well
GeyserHow many models and Bedrock sessions the Geyser extension reports

For the raw counters, run npb status in the console. /npb check also lists your ModelEngine version as supported (R4) or not supported, needs R4.

When changes show up

  • Adding or removing a ModelEngine mob needs one server restart after the conversion, because Geyser registers mobs only when it starts.
  • For other changes, follow the last line of /npb convert: rejoin or restart once.

Known limits

  • ModelEngine R3 is not supported.
  • Without ProtocolLib, models are converted but not shown live.
  • Mobs that use a different model plugin instead of ModelEngine show their vanilla base mob on Bedrock.
  • Updates that are too large or rejected are not shown; they are counted under Problems.
  • Geyser on a proxy or Geyser Standalone is not supported.

Next steps

Nusa product documentation · NusaPackPaper 1.21.x · Java 21

Loading the index…