> For the complete documentation index, see [llms.txt](https://docs.rivaldev.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rivaldev.xyz/rival-tools/rival-harvester-hoes/placeholders.md).

# Placeholders

## 📋 PlaceholderAPI Placeholders

> **Requirements:** [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) is required for all placeholders. For updating Holograms, use [HolographicDisplays](https://dev.bukkit.org/projects/holographic-displays) with [HolographicExtension](https://www.spigotmc.org/resources/holographicextension.18461/).

***

### 💎 Essence

| Placeholder                            | Description                                      |
| -------------------------------------- | ------------------------------------------------ |
| `%rivalhoes_essence%`                  | Player's raw essence amount                      |
| `%rivalhoes_essence_formatted%`        | Player's formatted essence amount                |
| `%rivalhoes_essencetop_position%`      | Player's position on the essence leaderboard     |
| `%rivalhoes_essencetop_name_<place>%`  | Name of player at leaderboard position `<place>` |
| `%rivalhoes_essencetop_value_<place>%` | Essence value at leaderboard position `<place>`  |

***

### 🌾 Crops

{% hint style="danger" %}
**Version 2.1.2+** — Use the new unified crop balance format below instead of the individual crop placeholders
{% endhint %}

#### New Format (v2.1.2+)

```
%rivalhoes_crop_balance_{material}%
%rivalhoes_crop_balance_formatted_{material}%
```

**Examples:**

| Placeholder                             | Description                    |
| --------------------------------------- | ------------------------------ |
| `%rivalhoes_crop_balance_ALL%`          | Total balance across all crops |
| `%rivalhoes_crop_balance_WHEAT%`        | Raw wheat balance              |
| `%rivalhoes_crop_balance_BUBBLE_CORAL%` | Raw bubble coral balance       |

#### Legacy Format (Pre-2.1.2)

| Placeholder                        | Description                 |
| ---------------------------------- | --------------------------- |
| `%rivalhoes_cane%`                 | Raw Sugar Cane count        |
| `%rivalhoes_cane_formatted%`       | Formatted Sugar Cane count  |
| `%rivalhoes_potato%`               | Raw Potato count            |
| `%rivalhoes_potato_formatted%`     | Formatted Potato count      |
| `%rivalhoes_carrot%`               | Raw Carrot count            |
| `%rivalhoes_carrot_formatted%`     | Formatted Carrot count      |
| `%rivalhoes_wheat%`                | Raw Wheat count             |
| `%rivalhoes_wheat_formatted%`      | Formatted Wheat count       |
| `%rivalhoes_cocoabean%`            | Raw Cocoa Bean count        |
| `%rivalhoes_cocoabean_formatted%`  | Formatted Cocoa Bean count  |
| `%rivalhoes_netherwart%`           | Raw Nether Wart count       |
| `%rivalhoes_netherwart_formatted%` | Formatted Nether Wart count |
| `%rivalhoes_pumpkin%`              | Raw Pumpkin count           |
| `%rivalhoes_pumpkin_formatted%`    | Formatted Pumpkin count     |
| `%rivalhoes_melon%`                | Raw Melon count             |
| `%rivalhoes_melon_formatted%`      | Formatted Melon count       |
| `%rivalhoes_crops%`                | Raw total crop count        |
| `%rivalhoes_crops_formatted%`      | Formatted total crop count  |

***

***

### 🏆 Leaderboards

{% hint style="danger" %}
**Version 2.1.2+** — Use the new leaderboard system based on time options&#x20;
{% endhint %}

#### Legacy Format (Pre-2.1.2)

Replace `<crop>` with any crop name (e.g. `wheat`, `cane`) and `<place>` with a leaderboard position number.

| Placeholder                           | Description                                      |
| ------------------------------------- | ------------------------------------------------ |
| `%rivalhoes_<crop>top_name_<place>%`  | Name of the player at position `<place>`         |
| `%rivalhoes_<crop>top_value_<place>%` | Crop value at position `<place>`                 |
| `%rivalhoes_<crop>top_position%`      | The player's current position on the leaderboard |

#### New Format  (v2.1.2+)

```
%rivalhoes_croptop_name_<material>:<place>:<timerange>%
%rivalhoes_croptop_value_<material>:<place>:<timerange>%
```

| Parameter     | Description                      | Example values                         |
| ------------- | -------------------------------- | -------------------------------------- |
| `<material>`  | Crop material name               | `WHEAT`, `SUGAR_CANE`, `ALL, MATERIAL` |
| `<place>`     | Leaderboard position number      | `1`, `2`, `3`                          |
| `<timerange>` | Time periods for the leaderboard | `daily`, `weekly`, `monthly`           |

**Examples:**

| Placeholder                                     | Description                                    |
| ----------------------------------------------- | ---------------------------------------------- |
| `%rivalhoes_croptop_name_WHEAT:1:daily%`        | #1 player on the daily Wheat leaderboard       |
| `%rivalhoes_croptop_value_WHEAT:1:daily%`       | #1 value on the daily Wheat leaderboard        |
| `%rivalhoes_croptop_name_ALL:1:monthly%`        | #1 player on the monthly All Crops leaderboard |
| `%rivalhoes_croptop_value_SUGAR_CANE:3:weekly%` | #3 value on the weekly Sugar Cane leaderboard  |

***

### 🌀 Harvester Event

| Placeholder                                 | Description                                             |
| ------------------------------------------- | ------------------------------------------------------- |
| `%rivalhoes_harvesterevent_time_next%`      | Time until the next event (`m/s` format)                |
| `%rivalhoes_harvesterevent_time_long%`      | Time until the next event (`minute/second` format)      |
| `%rivalhoes_harvesterevent_time_left%`      | Time remaining in the current event (short)             |
| `%rivalhoes_harvesterevent_time_left_long%` | Time remaining in the current event (long)              |
| `%rivalhoes_harvesterevent_active%`         | Returns `true` if an event is active, `false` otherwise |
| `%rivalhoes_harvesterevent_broken%`         | Total crops farmed during the current event             |
| `%rivalhoes_harvesterevent_position%`       | Player's current position in the Harvester Event        |

***

### 🔧 Other

| Placeholder                | Description                                         |
| -------------------------- | --------------------------------------------------- |
| `%rivalhoes_is_hoe%`       | Returns `true` if the player is holding a Hoe       |
| `%rivalhoes_hoe_level%`    | Hoe level (requires Hoe in hand)                    |
| `%rivalhoes_hoe_prestige%` | Hoe prestige (requires Hoe in hand)                 |
| `%rivalhoes_hoe_xp%`       | Hoe XP (requires Hoe in hand)                       |
| `%rivalhoes_hoe_bar%`      | Hoe XP progress bar (requires Hoe in hand)          |
| `%rivalhoes_is_captcha%`   | Returns `true` if the player is in the captcha menu |