Astral Realms Documentation Help

Placeholders

AstralLeaderboards registers one root placeholder plus three chainable object namespaces. All-time is the implicit default window: %leaderboards_<id>_entries% and %leaderboards_<id>_playerEntry% read the ALL_TIME bucket directly (kept for backwards compatibility), while _allTime/_weekly/_monthly give an explicit view into any of the three windows.

leaderboards_<id> (root)

%leaderboards_<id>% resolves a configured leaderboard by its id (from config.yml) and returns the leaderboard object below — it must be chained with a sub-key.

leaderboard_* (a configured Entry)

Placeholder

Description

%leaderboards_<id>_id%

The leaderboard id, echoed back.

%leaderboards_<id>_suffix%

The configured suffix component, or nothing if unset.

%leaderboards_<id>_sort%

"DESC" or "ASC".

%leaderboards_<id>_display%

Chains into the configured display ItemStack (_name, _lore, _material, …).

%leaderboards_<id>_entries%

List of entry objects — the current all-time top N, iterate in a menu layout.

%leaderboards_<id>_playerEntry%

The viewing player's own all-time entry, or nothing if the placeholder context isn't a player or the player has no entry.

%leaderboards_<id>_allTime%

Chains into a period view scoped to ALL_TIME (see below).

%leaderboards_<id>_weekly%

Chains into a period view scoped to WEEKLY.

%leaderboards_<id>_monthly%

Chains into a period view scoped to MONTHLY.

Period-view sub-keys

%leaderboards_<id>_weekly%/_monthly%/_allTime% resolve a LeaderboardViewPlaceholder, which must itself be chained:

Placeholder

Description

%leaderboards_<id>_weekly_period%

The period name, e.g. "WEEKLY".

%leaderboards_<id>_weekly_leaderboard%

Chains back into the leaderboard object above (_display, _suffix, …).

%leaderboards_<id>_weekly_entries%

List of entry objects for that window's current bucket (e.g. this ISO week).

%leaderboards_<id>_weekly_playerEntry%

The viewing player's entry for that window, or nothing.

Substitute _monthly/_allTime for the other windows — same sub-keys.

entry_* (a LeaderboardEntry, one player's standing on one leaderboard/period)

Placeholder

Description

%entry_id%

The player's UUID.

%entry_player%

Chains into a MinecraftPlayer (network-aware name/skin lookup).

%entry_leaderboard%

The leaderboard id string.

%entry_period%

The entry's period bucket key, e.g. "all", "2026-W29", "2026-07".

%entry_score%

The raw double score.

%entry_formattedScore%

The score rendered through the leaderboard's format-type (see Configuration).

%entry_suffix%

The leaderboard's configured suffix, resolved per-entry.

%entry_position%

1-based rank within the current top N.

%entry_date%

Chains into a TimePlaceholder (_remaining, _format, …) for updatedAt.

Example — weekly kills leaderboard menu

layout: - "%leaderboards_kills_weekly_entries%" name: "<gold>#%entry_position%</gold> <white>%entry_player_name%" lore: - "<gray>%entry_formattedScore% kills"
Last modified: 25 July 2026