Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.borntocraftstudio.net/llms.txt

Use this file to discover all available pages before exploring further.

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.

Download Releases

Get the latest JARs.

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.

Configuration

FieldTypeDefaultDescription
definitionRefRequiredEntity definition.
minDistanceDouble2.0Stop distance.
maxDistanceDouble4.0Start following.