PlaceholderAPI Placeholders

PlaceholderAPI Placeholders

uxmFarmer provides comprehensive integration with PlaceholderAPI. This page lists all available placeholders you can use in chat formats, menus, scoreboards, and other plugins.

Note

All placeholders require a Farmer UUID as the first parameter. The general format is: %uxmfarmer_<farmer_uuid>_<placeholder>% You can retrieve a farmer's UUID using the administrative command /uxmfarmer uuidof <player>.

---

1. General Farmer Placeholders

These placeholders return general information about a specific farmer.

Placeholder	Description	Example
%uxmfarmer_<uuid>_region%	Returns the ID of the region the farmer is located in.	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_region%
%uxmfarmer_<uuid>_owner%	Returns the display name of the farmer's owner (falls back to UUID if offline/null).	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_owner%
%uxmfarmer_<uuid>_sales_status%	Returns the status of the farmer's auto-sell feature (Formatted via config toggle).	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_sales_status%
%uxmfarmer_<uuid>_collecting_status%	Returns the status of the farmer's collection feature (Formatted via config toggle).	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_collecting_status%
%uxmfarmer_<uuid>_stored_xp%	Returns the amount of stored XP in the farmer (Number formatted).	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_stored_xp%
%uxmfarmer_<uuid>_total_products%	Returns the total sum of all products currently stored in the farmer.	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_total_products%

---

2. All-Time Statistics Placeholders

These placeholders display the historical cumulative statistics for a specific farmer.

Placeholder	Description	Example
%uxmfarmer_<uuid>_all_time_collected%	Total count of all items collected by the farmer since creation.	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_all_time_collected%
%uxmfarmer_<uuid>_all_time_collected_xp%	Total amount of XP collected by the farmer since creation.	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_all_time_collected_xp%
%uxmfarmer_<uuid>_all_time_sold%	Total count of all items sold from the farmer.	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_all_time_sold%
%uxmfarmer_<uuid>_all_time_sold_xp%	Total amount of XP sold from the farmer.	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_all_time_sold_xp%
%uxmfarmer_<uuid>_all_time_earned%	Total money earned from item sales (Money formatted).	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_all_time_earned%
%uxmfarmer_<uuid>_all_time_earned_xp%	Total money earned from XP sales (Money formatted).	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_all_time_earned_xp%
%uxmfarmer_<uuid>_all_time_tax%	Cumulative tax paid in total (Items tax + XP tax, money formatted).	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_all_time_tax%
%uxmfarmer_<uuid>_all_time_tax_product%	Cumulative tax paid on product/item sales (Money formatted).	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_all_time_tax_product%
%uxmfarmer_<uuid>_all_time_tax_xp%	Cumulative tax paid on XP sales (Money formatted).	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_all_time_tax_xp%

---

3. Material-Specific Production Rate and Income Placeholders

These placeholders display statistics related to production rates and financial yields, scoped to a specific Minecraft [MATERIAL].

Tip

Replace <material> with any valid Spigot Material name in uppercase (e.g., COCOA_BEANS, WHEAT, POTATO).

Placeholder	Description	Example (using Cocoa Beans)
%uxmfarmer_<uuid>_production_<material>_rate_minute%	Items produced per minute.	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_production_COCOA_BEANS_rate_minute%
%uxmfarmer_<uuid>_production_<material>_rate_hourly%	Items produced per hour.	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_production_COCOA_BEANS_rate_hourly%
%uxmfarmer_<uuid>_production_<material>_rate_daily%	Items produced per day.	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_production_COCOA_BEANS_rate_daily%
%uxmfarmer_<uuid>_production_<material>_income_minute%	Passive money generated per minute.	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_production_COCOA_BEANS_income_minute%
%uxmfarmer_<uuid>_production_<material>_income_hourly%	Passive money generated per hour.	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_production_COCOA_BEANS_income_hourly%
%uxmfarmer_<uuid>_production_<material>_income_daily%	Passive money generated per day.	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_production_COCOA_BEANS_income_daily%

---

4. Material-Specific Storage Info Placeholders

These placeholders retrieve current storage details and status parameters for a specific Minecraft [MATERIAL].

Placeholder	Description	Example (using Cocoa Beans)
%uxmfarmer_<uuid>_level_<material>%	Current upgrade level of the storage for this material.	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_level_COCOA_BEANS%
%uxmfarmer_<uuid>_amount_<material>%	Current amount of the material stored (Number formatted).	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_amount_COCOA_BEANS%
%uxmfarmer_<uuid>_capacity_<material>%	Maximum capacity of the current storage level for this material (Number formatted).	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_capacity_COCOA_BEANS%
%uxmfarmer_<uuid>_sellable_<material>%	Returns whether the material is set to be sellable (Formatted via config toggle).	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_sellable_COCOA_BEANS%
%uxmfarmer_<uuid>_collecting_<material>%	Returns whether the material is set to be collected (Formatted via config toggle).	%uxmfarmer_c7b5f25b-0a3a-4e3c-8587-974b5bdd0758_collecting_COCOA_BEANS%