Wiki Release: 2026.09.8 · UltimateClans: 9.1.4 · Documentation branch: 9 · Home

Home#

Home adds multiple clan home locations with GUI, unlock/permission rules and teleport/create/delete management. The pages in this section explain what players see in-game, what administrators need to configure, the normal setup flow, and the most common problems you may need to diagnose.

Compatibility#

Component version: 1.2
Documentation release: 2026.09.8
Minimum UltimateClans version: 9.0.0

What you can do with it#

Use the clan home command/GUI to create a home at the current location when the clan and role have permission
List/view homes, teleport to one, and delete obsolete locations
Configure maximum/unlock requirements and special permissions before exposing multiple homes

How it works#

Home lifecycle#

The Home module lets clans create persistent named teleport locations. Creation validates the member role, world/region restrictions and unlock/limit rules, then stores the location. Teleport/list/view/delete work against that saved set. Ally-home views are separate from ownership and can be restricted by configuration.

First setup#

Before enabling the feature for players, review these installed files:

chat.yml
commands.yml
config.yml
gui.yml
language/Lang_EN.yml
language/Lang_ES.yml

Recommended in-game workflow#

Use the clan home command/GUI to create a home at the current location when the clan and role have permission.
List/view homes, teleport to one, and delete obsolete locations.
Configure maximum/unlock requirements and special permissions before exposing multiple homes.

This feature is mainly automatic or accessed through the parent plugin/GUI, so it does not need a large standalone command tree.

GUI areas#

The installed GUI configuration contains screens/sections such as:

General.clan_delhome_confirm
General.clan_allyhome
General.clan_homes
General.listhomes
General.anvil_home_create

What administrators should configure#

Test safe teleport and disabled world/region behavior.
If Anvil/text input is used by the GUI, keep the matching Anvil module/version available.

Configuration map#

config.yml — Config (date_format_short, Home, special_permissions, Icon, Permissions, Unlocker)
chat.yml — Chat (clanhomecreate)

The Configuration page lists the available paths and defaults from the installed configuration, with notes on what each area controls.

Before going live#

Back up the component data/configuration.
Start the server and confirm the component is detected without startup errors.
Test with a non-OP player and the lowest clan role that should have access.
Exercise the complete flow once, including the failure/deny path, not only the happy path.
Restart the server and verify that persistent state survives.
If the network is multiserver, repeat the test from a second node and verify storage/synchronization.

Troubleshooting quick reference#

Symptom	Likely cause	What to check
Home cannot be created	Limit, unlock requirement, permission, world/region restriction or invalid location	Check Home limits/unlocker and member role permission.
Teleport is denied	Cooldown/cost/safety/world restriction applies	Review the configured teleport rules and destination.
GUI rename/input does not open	Anvil/input implementation unavailable	Confirm Anvil module compatibility and startup logs.

For a longer diagnostic flow, open the Troubleshooting page for this component.