Function

Companion behavior

A Familiar flies, wanders, and follows nearby creatures. Its maximum health is controlled by FAMILIAR_HEALTH, and it is immune to fall damage.

A player can have only one Familiar at a time. When FAMILIAR_CHUNKLOADS=true, it keeps its current chunk active as it travels.

A Familiar does not reconnect to its owner after a server restart. Summon a replacement after restarting.

Surroundings reports

A loaded Familiar attempts a surroundings report every FAMILIAR_REPORT_SURROUNDINGS_TIME ticks. It may report a player, another living creature, or a block within five blocks on each axis.

Player reports include coordinates. Creature and block reports identify what was found. FAMILIAR_REPORT_SURROUNDINGS_TIME controls the interval and has a minimum of 1 tick.

By default, notable blocks are Diamond, Emerald, Lapis, and Gold ores, Bookshelves, Obsidian, Prismarine, End Portal Frames, and Ancient Debris. FAMILIAR_ACTION_BAR_MESSAGES=false sends reports to chat; true uses the action bar.

Report filter

Right-click a Familiar with a block item to report only that block type. Using an empty hand or another item clears the filter and toggles its seasonal color.

Block highlights

Notable blocks near a Familiar are outlined for its owner. FAMILIAR_INTERESTING_BLOCK_RENDER_RANGE controls the radius.

Damage response

When damaged, the Familiar may send one of its complaint messages to its owner. FAMILIAR_OUCH_CHANCE is the probability per damaging hit.

Replacement

Familiar's Garden, Recall Familiar, Familiar Exchange, and Shared Vision all operate through the currently tracked Familiar.

Configuration

SettingDefaultRangeEffect
SUMMON_FAMILIAR_MANA_COSTmahoutsukai-server.tomlfamiliarsummon familiar2000–100000000 mana per castMana cost of releasing a Summon Familiar scroll.
FAMILIAR_REPORT_SURROUNDINGS_TIMEmahoutsukai-server.tomlfamiliarsummon familiar4001–100000000 ticks between report attemptsInterval between a loaded Familiar's attempts to report its surroundings; 400 ticks is 20 seconds.
FAMILIAR_INTERESTING_BLOCK_RENDER_RANGEmahoutsukai-server.tomlfamiliarsummon familiar81–64 blocksRadius around a nearby owned Familiar in which the client outlines the default notable blocks.
FAMILIAR_HEALTHmahoutsukai-server.tomlfamiliarsummon familiar100–100000000 health pointsMaximum health assigned to Familiar entities.
FAMILIAR_OUCH_CHANCEmahoutsukai-server.tomlfamiliarsummon familiar0.30–1 probability per damaging hitChance that a damaged Familiar sends a complaint message to its owner.
FAMILIAR_ACTION_BAR_MESSAGESmahoutsukai-server.tomlfamiliarsummon familiarfalse—Sends Familiar reports and acknowledgements to the action bar when true; otherwise, it uses chat.
FAMILIAR_CHUNKLOADSmahoutsukai-server.tomlfamiliarsummon familiartrue—Keeps the chunk around an active Familiar loaded and simulated while true.