> For the complete documentation index, see [llms.txt](https://docs.txgls.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.txgls.dev/txglslifesteal/placeholders.md).

# Placeholders

MythicLifesteal includes full **PlaceholderAPI support**, allowing you to display player hearts, server stats, and leaderboards across scoreboards, chat, GUIs, and more.

***

### ❤️ Basic Player Data

| Placeholder                        | Description                         |
| ---------------------------------- | ----------------------------------- |
| `%mythiclifesteal_hearts%`         | Player’s current hearts             |
| `%mythiclifesteal_hearts_decimal%` | Hearts in decimal form (health ÷ 2) |
| `%mythiclifesteal_health%`         | Current health points               |
| `%mythiclifesteal_max_health%`     | Maximum health                      |

***

### ⚙️ Configuration Values

| Placeholder                               | Description                    |
| ----------------------------------------- | ------------------------------ |
| `%mythiclifesteal_default_hearts%`        | Default hearts for new players |
| `%mythiclifesteal_min_hearts%`            | Minimum allowed hearts         |
| `%mythiclifesteal_max_hearts%`            | Maximum allowed hearts         |
| `%mythiclifesteal_hearts_lost_on_death%`  | Hearts lost on death           |
| `%mythiclifesteal_hearts_lost_on_pvp%`    | Hearts lost on PvP death       |
| `%mythiclifesteal_hearts_gained_on_kill%` | Hearts gained on kill          |

***

### 📊 Calculations & Status

| Placeholder                                   | Description                                 |
| --------------------------------------------- | ------------------------------------------- |
| `%mythiclifesteal_hearts_above_min%`          | Hearts above minimum                        |
| `%mythiclifesteal_hearts_below_max%`          | Hearts below maximum                        |
| `%mythiclifesteal_hearts_percentage%`         | Hearts as % of max                          |
| `%mythiclifesteal_hearts_percentage_decimal%` | Percentage with decimal                     |
| `%mythiclifesteal_is_at_min%`                 | Returns `true/false` if at minimum          |
| `%mythiclifesteal_is_at_max%`                 | Returns `true/false` if at maximum          |
| `%mythiclifesteal_can_withdraw%`              | Returns `true/false` if player can withdraw |

***

### 🎨 Visual Representations

| Placeholder                        | Description                           |
| ---------------------------------- | ------------------------------------- |
| `%mythiclifesteal_hearts_bar%`     | Default heart bar (e.g. ❤❤❤❤❤❤❤❤❤❤)   |
| `%mythiclifesteal_hearts_bar_10%`  | 10-character heart bar                |
| `%mythiclifesteal_hearts_bar_20%`  | 20-character heart bar                |
| `%mythiclifesteal_hearts_bar_X%`   | Custom length heart bar *(replace X)* |
| `%mythiclifesteal_hearts_colored%` | Color-coded hearts based on value     |

***

### 🌐 Server Statistics

| Placeholder                               | Description                        |
| ----------------------------------------- | ---------------------------------- |
| `%mythiclifesteal_server_total_hearts%`   | Total hearts of all online players |
| `%mythiclifesteal_server_average_hearts%` | Average hearts of online players   |
| `%mythiclifesteal_server_players_online%` | Number of online players           |

***

### 🏆 Leaderboards

| Placeholder                                | Description                   |
| ------------------------------------------ | ----------------------------- |
| `%mythiclifesteal_leaderboard_position%`   | Player’s leaderboard position |
| `%mythiclifesteal_leaderboard_top_player%` | Top player name               |
| `%mythiclifesteal_leaderboard_top_hearts%` | Top player’s hearts           |
| `%mythiclifesteal_leaderboard_player_1%`   | 1st place player              |
| `%mythiclifesteal_leaderboard_hearts_1%`   | 1st place hearts              |
| `%mythiclifesteal_leaderboard_player_X%`   | Xth place player *(1–10)*     |
| `%mythiclifesteal_leaderboard_hearts_X%`   | Xth place hearts *(1–10)*     |

***

### 👥 Other Players

| Placeholder                            | Description                          |
| -------------------------------------- | ------------------------------------ |
| `%mythiclifesteal_player_PlayerName%`  | Specific player’s hearts             |
| `%mythiclifesteal_compare_PlayerName%` | Heart difference with another player |

***

### 💡 Notes

* Requires **PlaceholderAPI**
* Placeholders can be used in:
  * Scoreboards
  * Chat formats
  * GUIs
  * Holograms
