Placeholders

Show collection progress on scoreboards, tab lists, action bars, and holograms with PlaceholderAPI.

These only work if PlaceholderAPI is installed. Without it, the plugin skips placeholders and everything else still works.

Server-wide totals

Placeholder	Shows
%zcollections_total_progress%	The player's total progress across every resource
%zcollections_discovered_count%	How many resources the player has discovered

Picking a resource

Every other placeholder names a resource and then a suffix. There are two ways to name the resource, and both accept the same suffixes.

By id, using the category and resource keys from categories.yml:

%zcollections_<category>_<resource>_<suffix>%

By what the player just did, so one line follows every collection without the ids being typed by hand:

%zcollections_block_<material>_<suffix>%
%zcollections_entity_<entity_type>_<suffix>%
%zcollections_fish_<material>_<suffix>%

<material> and <entity_type> are Minecraft ids in lowercase, like cobblestone, oak_log or zombie. You do not need to know which resource counts them. Cobblestone is not a resource of its own, for example: it is a target of the stone resource under mining, and %zcollections_block_cobblestone_progress% finds it anyway.

The suffixes

Suffix	Shows
_progress	Current progress
_tier	How many tiers the player has claimed
_maxtier	How many tiers the resource has in total
_next	The progress needed for the next tier, or MAX once every tier is done
_remaining	How much progress is still needed for the next tier
_percent	0 to 100 through the current tier, for a bar
_name	The resource display name, in the server language
_category	The category id the resource belongs to

Examples

By id, for the default config:

Placeholder	Shows
%zcollections_mining_diamond_progress%	Diamond progress
%zcollections_mining_diamond_next%	Diamonds needed for the next diamond tier
%zcollections_farming_wheat_percent%	How far through the current wheat tier
%zcollections_hunting_zombie_tier%	Zombie tiers claimed
%zcollections_divers_playtime_progress%	Hours played

By target, which is what you want on an action bar or a job line:

%zcollections_block_cobblestone_name%: %zcollections_block_cobblestone_progress%/%zcollections_block_cobblestone_next%

That prints something like Stone: 340/500. Swap the material for a token from whatever plugin is drawing the line, and the counter follows the player from mining to woodcutting to farming on its own.

The ids are the keys in categories.yml, not the display names. The Lumberjack oak resource has the id oak_log, so its id placeholder is %zcollections_lumberjack_oak_log_progress%.

What they return

• A progress, tier, or percent placeholder returns a number.
• A resource the player has not discovered yet returns 0.
• _next returns MAX once the last tier is reached. That word comes from placeholders.max-tier in your language file, so you can translate it.
• A material or entity that no resource counts returns nothing at all, so that part of the line just disappears instead of showing a 0 that looks like a real collection sitting empty.
• If a material is counted by two different resources, the placeholder shows the one declared first in categories.yml. Only one number fits on a line.
• A placeholder that does not match any resource id returns nothing.

One name to avoid

block, entity, and fish are used by the by-target placeholders above. If you name a category one of those, the category itself keeps working but its by-target placeholders stop resolving, and the plugin logs a warning on startup. Pick another name.

Related pages

• Categories is where category and resource ids come from.
• Installation covers optional integrations like PlaceholderAPI.