Companion
Official compatibility
| Element | Reference |
|---|---|
TypeWriter | Required. Use the official TypeWriter release supported by the extension release. |
| Related extensions | Install the related extensions listed on this page before using entries that depend on them. |
The Companion Extension allows players to have persistent companions that follow them around the world, supporting both NPCs and ModelEngine entities.
- Source Code — View source on GitHub.
- Official release v0.8 — Download the published JAR.
Features
- Summoning — Spawn NPC or ModelEngine entities.
- Follow/Wait — Toggle following behavior.
- Teleportation — Companions follow between worlds.
- Animations — Walk/Idle animations support.
Entries
- Entities — Invocation: Spawn companion.
- Actions — Follow Mode: Toggle state. Interact: Click handler.
- Facts — Is Active: Check status.
User guide
- 1. Trigger Actions — Use action entries to interact with the extension: companion_follow_mode, companion_interact. Trigger them from commands, NPCs, events, or other entries. → companion_follow_mode → companion_interact
Configuration
| Field | Type | Default | Description |
|---|---|---|---|
definition | Ref | Required | Entity definition. |
minDistance | Double | 2.0 | Stop distance. |
maxDistance | Double | 4.0 | Start following. |
Troubleshooting
The extension is not visible
Check that the installed release matches the supported TypeWriter release and that the related extensions listed in the compatibility section are present.
An entry is missing
In the Typewriter Web panel, use the Search bar or the + button to find or create the entry with its exact identifier. Entry IDs and field names are case-sensitive; do not translate them.
The entry saves but nothing happens
Check that the entry is connected to the trigger, command, objective, event, or menu interaction required by its type. Test with optional permissions and criteria removed, then add them back one at a time.
An integration does not work
Verify the dependency and version shown in the extension card, then check the server log for the first error. Do not replace a missing dependency with a similarly named plugin unless the extension source explicitly supports it.