Placeholder Reference

When PlaceholderAPI is installed, EssentialsLite registers the expansion identifier essentials. Thus %essentials_<token>% is the portable form. The expansion is implemented by src/main/java/com/arkflame/essentialslite/hooks/EssentialsLitePlaceholder.java and persists across reloads.

Tokens

Token	Placeholder	Type/effect
nickname	%essentials_nickname%	Current online player's display name.
balance	%essentials_balance%	Persisted balance formatted with economy formatting.
home_count	%essentials_home_count%	Number of stored homes.
max_homes	%essentials_max_homes%	Effective permission-based home limit while online; configured default while offline.
rank	%essentials_rank%	Primary Vault permission group, or first player group fallback.
baltop_<positive-index>_name	%essentials_baltop_1_name%	Leaderboard player name at the requested 1-based position.
baltop_<positive-index>_balance	%essentials_baltop_1_balance%	Formatted leaderboard balance at the requested 1-based position.

<positive-index> must be a decimal integer greater than zero. The index is capped by baltop.placeholder-limit, whose default is 10; an index above the cap returns an empty string. Missing leaderboard entries also return an empty string. Unknown non-baltop tokens return no expansion value.

%essentials_nickname%
%essentials_balance%
%essentials_home_count%
%essentials_max_homes%
%essentials_rank%
%essentials_baltop_1_name%
%essentials_baltop_1_balance%
%essentials_baltop_10_name%

Offline Behavior

The expansion accepts OfflinePlayer values. For an offline player:

Token	Offline result
nickname	Empty string; display name requires an online player.
balance	Persisted balance, formatted using the economy formatter.
home_count	Stored home count; 0 when no home data exists.
max_homes	home.default-limit (default 1). Online permission nodes are not evaluated.
rank	Empty string; Vault group lookup requires an online player.
baltop_*	Works for offline viewers/entries because leaderboard balances are persisted.

If the plugin data provider or leaderboard service is unavailable, provider-backed values return an empty string. Balance formatting rounds to two decimal places and uses US thousands separators; whole values omit decimal places (for example 1,000 and 1,000.50).

Configuration

baltop:
  placeholder-limit: 10

The configured value is clamped to at least 1. %essentials_baltop_0_name%, negative indices, non-numeric indices, malformed forms, and indices greater than the configured limit do not resolve to an entry; capped/out-of-range requests return an empty string.

Source: EssentialsLitePlaceholder, HomeLimits, BalanceLeaderboardService, PlayerDataProvider, and EconomyFormat.