Astral Realms Documentation Help

Configuration

AstralPrivateChest loads two files through AstralPaperPlugin#loadConfiguration/#loadEnum, both reloadable in-place via /pc reload (privatechest.reload).

config.yml

A single MainConfiguration record with one field:

Key

Type

Description

lock-item

ItemStackWrapper

The template item used both as the physical item that locks a chest and as the icon rendered as a floating display on a locked chest's face. Built fresh (and PDC-stamped) per use by LockService#buildItem — see Overview → The lock item.

Shipped default:

lock-item: material: "ia-items:lock" name: "<primary_color><bold>Cadenas" lore: - "" - " <text_color>Ce <secondary_color>cadenas <text_color>permet d'empêcher les autres" - " <text_color>joueurs d'accéder à votre <secondary_color>coffre sécurisé<text_color>." - "" - "<#26d971><bold>| Commandes</bold> <gray>(En regardant le coffre)" - " <gray>- <#e3dbcc>Ajouter un joueur : <secondary_color>/pc add 'player'" - " <gray>- <#e3dbcc>Retirer un joueur : <secondary_color>/pc remove 'player'" - " <gray>- <#e3dbcc>Liste des joueurs : <secondary_color>/pc list" - "" - "<white>%ia_img_icons:right-click% <information_color>Sécuriser un coffre"

The material here (ia-items:lock) resolves through AstralItems' item-material adapter, i.e. the base item is AstralItems' custom lock item — not a vanilla Material.

messages.yml

Loaded via loadEnum("messages.yml", PCMessages.class). Every key is a MiniMessage string. The shipped defaults are in French.

Key

Fired when

cannot-access

A non-owner/non-member/non-bypass player interacts with, or tries to break, a locked chest. Placeholders: privatechest_* (the chest's own data — see Placeholders).

not-within-town-claims

Right-clicking with the lock item on a chest outside a town claim the player belongs to.

chest-locked

Successfully locking a chest.

already-locked

Right-clicking with the lock item on a chest that is already locked. Placeholders: privatechest_*.

already-yours

Defined in the enum; not sent by any code path today (see warning below).

chest-unlocked

The owner (or privatechests.bypass) breaks their own locked chest.

no-chest-in-sight

/pc add, /pc remove, or /pc list when the player isn't looking at a chest within 7 blocks.

not-owner

/pc add//pc remove//pc list (or the coordinate variant) run by someone other than the chest's owner.

error-locking-chest

LockService#create fails — the target block isn't actually a Chest, or the PDC write fails.

not-locked

/pc add//pc remove//pc list /coordinate-/pc remove targeting a chest with no lock data.

error-unlocking-chest

Defined in the enum; not sent by any code path today — LockService#removeData failing on break simply aborts silently (onBlockBreak returns without cancelling).

cannot-lock-shop

Right-clicking with the lock item on a registered AstralPlayerShops shop block (only reachable when AstralPlayerShops is installed).

member-added

/pc add succeeds.

member-removed

/pc remove (either form) succeeds.

not-a-member

/pc remove targeting a player who isn't currently authorized.

already-a-member

/pc add targeting a player who is already authorized.

members-list-header/members-list-footer

Sent before/after the member list in /pc list.

members-list-entry

One line per authorized member in /pc list.

members-remove

Appended, clickable, to each members-list-entry line — runs /pc remove <x> <y> <z> <member>.

no-members

/pc list when authorizedUsers is empty.

no-permission-place-near

Defined in the enum; not sent by any code path today.

Last modified: 25 July 2026