# ⚙️ NPC Engines

Seven engines are available, each with a section below. The engine is picked per NPC, from **NPC Engine** on its own [settings](../README.md#edit-an-npc). An engine whose plugin is missing is marked **Not installed** and cannot be picked.

<figure><img src="../../../.gitbook/assets/edit-npc/engine.png" alt="" width="563"><figcaption><p>Edit NPC (NPC Engine)</p></figcaption></figure>

## Flying Head

This engine is a floating player head with no body, drawn by the plugin itself, so nothing else has to be installed. It is the lightest of the seven and the only one that can be animated without a model.

### Texture Url

With this option, you can set which skin the head wears, either from a texture url or from a player username.

<figure><img src="../../../.gitbook/assets/flying-head/texture-url.png" alt="" width="563"><figcaption><p>Flying Head (Texture Url)</p></figcaption></figure>

### Animation Mode

With this option, you can make the head move on its own instead of hanging still. **Helix** spins it around the spot it stands on, **Unstable** shakes it in place, and **None** leaves it still.

<figure><img src="../../../.gitbook/assets/flying-head/animation-mode.png" alt="" width="563"><figcaption><p>Flying Head (Animation Mode)</p></figcaption></figure>

### Hologram Static

With this option, you can decide whether the hologram stays where the NPC stands or rides along with the head. Leaving it static is what keeps the text readable while an animation is running.

<figure><img src="../../../.gitbook/assets/flying-head/hologram-static.png" alt="" width="563"><figcaption><p>Flying Head (Hologram Static)</p></figcaption></figure>

### Model Offset

With this option, you can raise or lower the head from where the NPC stands. It moves only the head, so it is separate from the [hologram](../README.md#npc-hologram) height offset.

<figure><img src="../../../.gitbook/assets/flying-head/model-offset.png" alt="" width="563"><figcaption><p>Flying Head (Model Offset)</p></figcaption></figure>

### Look Close

With this option, you can make the head turn towards the nearest player instead of facing the direction it was placed in.

<figure><img src="../../../.gitbook/assets/flying-head/look-close.png" alt="" width="563"><figcaption><p>Flying Head (Look Close)</p></figcaption></figure>

## Huge Item

This engine turns any item into the NPC, drawn by the plugin itself, so nothing else has to be installed. It is listed as Item in the engine picker.

### Display Item

With this option, you can choose the item the NPC is made of. Drag one out of your inventory onto the slot; custom model data is kept, so a resource pack item works as well as a vanilla one, and the same item is what the NPC shows in the editor lists.

<figure><img src="../../../.gitbook/assets/huge-item/display-item.png" alt="" width="563"><figcaption><p>Huge Item (Display Item)</p></figcaption></figure>

### Model Offset

With this option, you can raise or lower the item from where the NPC stands. It moves only the item, so it is separate from the [hologram](../README.md#npc-hologram) height offset.

<figure><img src="../../../.gitbook/assets/huge-item/model-offset.png" alt="" width="563"><figcaption><p>Huge Item (Model Offset)</p></figcaption></figure>

## Entity

This engine uses a normal Minecraft mob as the NPC, drawn by the plugin itself, so nothing else has to be installed.

### NPC Engine

Shared by every Entity NPC and set in **Editor > Settings**. Switching it respawns the npcs right away.

| Engine | Description |
| --- | --- |
| Built-in | The default, spawns the mob in the world |
| PhoenixNPCs | Hands the mob to PhoenixNPCs, selectable only while it is installed |

With PhoenixNPCs, the mob type, look close, scale, glow and click actions carry over; entity properties do not. If PhoenixNPCs is removed, the plugin falls back to Built-in and logs a warning. The other engines are not affected.

### Entity Type

With this option, you can pick which mob the NPC is. Changing it resets the properties below, since every mob has its own set.

<figure><img src="../../../.gitbook/assets/entity/entity-type.png" alt="" width="563"><figcaption><p>Entity (Entity Type)</p></figcaption></figure>

### Entity Properties

With this option, you can change the extra properties of the chosen mob. Which ones appear depends entirely on the mob: a cat has a variant, a wolf has a variant and a collar colour, a slime has neither and says so instead of opening a list. Changing the [Entity Type](#entity-type) resets whatever was chosen here, since the values of one mob mean nothing to another.

<figure><img src="../../../.gitbook/assets/entity/entity-properties.png" alt="" width="563"><figcaption><p>Entity (Entity Properties)</p></figcaption></figure>

#### Variant

With this option, you can pick which kind of the mob the NPC is: the colour of a sheep or a llama, the breed of a cat, a rabbit or a fox, the biome coat of a cow, a pig or a chicken, the profession skin of a villager. The list is read from the server itself, so a variant added by a newer Minecraft version shows up without an update here.

<figure><img src="../../../.gitbook/assets/entity-properties/variant.png" alt="" width="563"><figcaption><p>Entity Properties (Variant)</p></figcaption></figure>

#### Age

With this option, you can make the NPC a baby instead of an adult. It appears for every mob that can be a baby at all, on top of whatever other properties that mob has.

<figure><img src="../../../.gitbook/assets/entity-properties/age.png" alt="" width="563"><figcaption><p>Entity Properties (Age)</p></figcaption></figure>

#### Collar

With this option, you can set the collar colour of a wolf. It is the one property that is not a variant, so a wolf shows it next to its own variant list.

### Look Close

With this option, you can make the mob turn towards the nearest player instead of facing the direction it was placed in.

<figure><img src="../../../.gitbook/assets/entity/look-close.png" alt="" width="563"><figcaption><p>Entity (Look Close)</p></figcaption></figure>

## Citizens

> **Warning:**
This option requires [Citizens](https://www.spigotmc.org/resources/citizens.13811/) to be installed.

This engine hands the NPC to Citizens, so it is a real player-shaped npc with a skin, and everything Citizens itself adds on top keeps working.

### Skin

With this option, you can set the skin the NPC wears. Left-click takes a MineSkin url, right-click a player username, and shift + left-click a player uuid. All three are looked up online, so a username or uuid that Mojang does not know is refused with the reason.

<figure><img src="../../../.gitbook/assets/citizens/skin.png" alt="" width="563"><figcaption><p>Citizens (Skin)</p></figcaption></figure>

### Look Close

With this option, you can make the NPC turn towards the nearest player instead of facing the direction it was placed in.

<figure><img src="../../../.gitbook/assets/citizens/look-close.png" alt="" width="563"><figcaption><p>Citizens (Look Close)</p></figcaption></figure>

## Model Engine

> **Warning:**
This option requires [ModelEngine](https://mythiccraft.io/index.php?pages/official-modelengine4-download/) installed.

This engine uses a ModelEngine model as the NPC, so anything you can build in Blockbench can stand in the lobby and play its own animations.

### Model Name

With this option, you can pick one of the models ModelEngine has loaded. An NPC left on **unknown** shows a "Setup the model" marker in the world instead of a model.

<figure><img src="../../../.gitbook/assets/model-engine/model-name.png" alt="" width="563"><figcaption><p>Model Engine (Model Name)</p></figcaption></figure>

### Idle Animation

With this option, you can loop an animation while the NPC is standing there. The list is the animations of the chosen model, so picking the model comes first.

<figure><img src="../../../.gitbook/assets/model-engine/idle-animation.png" alt="" width="563"><figcaption><p>Model Engine (Idle Animation)</p></figcaption></figure>

### Interaction Animation

With this option, you can play an animation once when a player clicks the NPC. It runs alongside the [actions](../README.md#edit-an-npc) of that click, not instead of them.

<figure><img src="../../../.gitbook/assets/model-engine/interaction-animation.png" alt="" width="563"><figcaption><p>Model Engine (Interaction Animation)</p></figcaption></figure>

### Look Close

With this option, you can make the model turn towards the nearest player instead of facing the direction it was placed in.

<figure><img src="../../../.gitbook/assets/model-engine/look-close.png" alt="" width="563"><figcaption><p>Model Engine (Look Close)</p></figcaption></figure>

## Fancy NPCs

> **Warning:**
This option requires [FancyNpcs](https://modrinth.com/plugin/fancynpcs) to be installed.

This engine hands the NPC to FancyNpcs, so it is a real player-shaped npc with a skin. It is listed as Fancy NPCS in the engine picker.

### Skin

With this option, you can set the skin the NPC wears, either from a raw skin texture value or from a player uuid.

<figure><img src="../../../.gitbook/assets/fancy-npcs/skin.png" alt="" width="563"><figcaption><p>Fancy NPCs (Skin)</p></figcaption></figure>

### Look Close

With this option, you can make the NPC turn towards the nearest player instead of facing the direction it was placed in.

<figure><img src="../../../.gitbook/assets/fancy-npcs/look-close.png" alt="" width="563"><figcaption><p>Fancy NPCs (Look Close)</p></figcaption></figure>

## Better Model

> **Warning:**
This option requires [BetterModel](https://modrinth.com/plugin/bettermodel) to be installed.

This engine uses a BetterModel model as the NPC, so a model you have built in Blockbench can stand in the lobby and play its own animations.

### Model

With this option, you can pick one of the models BetterModel has loaded. An NPC left on **unknown** shows a "Setup the model" marker in the world instead of a model.

<figure><img src="../../../.gitbook/assets/better-model/model.png" alt="" width="563"><figcaption><p>Better Model (Model)</p></figcaption></figure>

### Idle Animation

With this option, you can loop an animation while the NPC is standing there. The list is the animations of the chosen model, so picking the model comes first.

<figure><img src="../../../.gitbook/assets/better-model/idle-animation.png" alt="" width="563"><figcaption><p>Better Model (Idle Animation)</p></figcaption></figure>

### Interaction Animation

With this option, you can play an animation once when a player clicks the NPC. It runs alongside the [actions](../README.md#edit-an-npc) of that click, not instead of them.

<figure><img src="../../../.gitbook/assets/better-model/interaction-animation.png" alt="" width="563"><figcaption><p>Better Model (Interaction Animation)</p></figcaption></figure>

### Look Close

With this option, you can make the model turn towards the nearest player instead of facing the direction it was placed in.

<figure><img src="../../../.gitbook/assets/better-model/look-close.png" alt="" width="563"><figcaption><p>Better Model (Look Close)</p></figcaption></figure>

Source: https://www.phoenixplugins.com/docs/phoenix-lobby/featues/npcs/npc-engines