PlaceholderAPI Integration

Overview

PlumDelivery integrates with PlaceholderAPI to provide placeholders you can use in scoreboards, holograms, tab menus, chat plugins, and more.

Tips

PlaceholderAPI is optional. The plugin works perfectly without it. Install PAPI only if you want to display delivery data in other plugins.

Setup

Install PlaceholderAPI on your server
PlumDelivery automatically registers its expansion on startup
No additional commands or downloads needed

Expansion Identifier

plumdelivery

Available Placeholders

Time Placeholders

Display the remaining time for each delivery event.

Placeholder	Description	Example Output
`%plumdelivery_time_daily%`	Remaining time for daily event	`18h 42m 15s`
`%plumdelivery_time_weekly%`	Remaining time for weekly event	`5d 12h 30m`
`%plumdelivery_time_monthly%`	Remaining time for monthly event	`3w 2d 8h`
`%plumdelivery_time%`	Remaining time for monthly event (shortcut)	`3w 2d 8h`

Time Format

The time format is configured in config.yml with the time-format setting. Zero-value units are automatically stripped.

Leaderboard Placeholders

Display top player names and points for specific delivery types and categories.

Syntax

%plumdelivery_top_<type>_<category>_<index>_<value>%

Parameter	Options	Description
`<type>`	`daily`, `weekly`, `monthly`	Delivery type
`<category>`	Any category key (e.g., `farm`)	Category key from config
`<index>`	`1`, `2`, `3`, ...	Rank position (1-based)
`<value>`	`name`, `point`	What to display

Examples

Placeholder	Description	Example Output
`%plumdelivery_top_daily_farm_1_name%`	#1 daily farm player name	`Steve`
`%plumdelivery_top_daily_farm_1_point%`	#1 daily farm player points	`142`
`%plumdelivery_top_daily_farm_2_name%`	#2 daily farm player name	`Alex`
`%plumdelivery_top_daily_farm_2_point%`	#2 daily farm player points	`98`
`%plumdelivery_top_weekly_farm_1_name%`	#1 weekly farm player name	`Notch`
`%plumdelivery_top_monthly_farm_3_point%`	#3 monthly farm player points	`67`

Return Values

Condition	Return
Valid player found	Player name or point count
No player at index	`-`
Invalid delivery type	`-`
Player name unknown	`Unknown`

Usage Examples

Scoreboard (FeatherBoard / TAB)

lines:
  - "&6Daily Farming Top:"
  - "&e1. &a%plumdelivery_top_daily_farm_1_name% &7- &b%plumdelivery_top_daily_farm_1_point%"
  - "&e2. &a%plumdelivery_top_daily_farm_2_name% &7- &b%plumdelivery_top_daily_farm_2_point%"
  - "&e3. &a%plumdelivery_top_daily_farm_3_name% &7- &b%plumdelivery_top_daily_farm_3_point%"
  - ""
  - "&7Time left: &e%plumdelivery_time_daily%"

Hologram (DecentHolograms / HolographicDisplays)

lines:
  - "&6&l⭐ DELIVERY LEADERBOARD ⭐"
  - "&7Daily Farm Rankings"
  - ""
  - "&e🥇 %plumdelivery_top_daily_farm_1_name% &7- &b%plumdelivery_top_daily_farm_1_point% pts"
  - "&e🥈 %plumdelivery_top_daily_farm_2_name% &7- &b%plumdelivery_top_daily_farm_2_point% pts"
  - "&e🥉 %plumdelivery_top_daily_farm_3_name% &7- &b%plumdelivery_top_daily_farm_3_point% pts"
  - ""
  - "&7Ends in: &e%plumdelivery_time_daily%"

TAB Plugin (Header/Footer)

header:
  - "&5&lPlumDelivery"
  - "&7Daily event ends in: &e%plumdelivery_time_daily%"
footer:
  - "&7Top player: &a%plumdelivery_top_daily_farm_1_name% &7with &b%plumdelivery_top_daily_farm_1_point% &7points"

Troubleshooting

Placeholders show as raw text

Make sure PlaceholderAPI is installed and enabled
Check that PlumDelivery loaded after PAPI (check console for registration message)
Make sure the plugin you're using supports PAPI (most modern plugins do)
Try /papi parse me %plumdelivery_time_daily% to test

Placeholders return "-"

The delivery event may not be running — start it with /delivery start <type>
The category key may be wrong — check your config.yml category keys
No players may have points yet