From b285b8f364d6578f86c4703d4b15c4ed140185be Mon Sep 17 00:00:00 2001 From: Oliver Date: Tue, 25 Nov 2025 14:33:37 +0100 Subject: [PATCH] docs: Add built in placeholders of FancyCore --- docs/src/fancycore/api/api.yml | 2 +- docs/src/fancycore/api/placeholders.md | 2 +- .../fancycore/placeholders/placeholders.md | 14 ++++++++++++++ docs/src/fancycore/placeholders/player.md | 19 +++++++++++++++++++ 4 files changed, 35 insertions(+), 2 deletions(-) create mode 100644 docs/src/fancycore/placeholders/placeholders.md create mode 100644 docs/src/fancycore/placeholders/player.md diff --git a/docs/src/fancycore/api/api.yml b/docs/src/fancycore/api/api.yml index f9bb072b..d5b03a54 100644 --- a/docs/src/fancycore/api/api.yml +++ b/docs/src/fancycore/api/api.yml @@ -1,2 +1,2 @@ icon: code -order: 6 \ No newline at end of file +order: 7 \ No newline at end of file diff --git a/docs/src/fancycore/api/placeholders.md b/docs/src/fancycore/api/placeholders.md index 48b18e1d..3b3e8431 100644 --- a/docs/src/fancycore/api/placeholders.md +++ b/docs/src/fancycore/api/placeholders.md @@ -3,7 +3,7 @@ icon: dot order: 7 --- -# Placeholders API +# Placeholder API FancyCore includes a Placeholders API that allows you to create and manage custom placeholders for use in various plugins. diff --git a/docs/src/fancycore/placeholders/placeholders.md b/docs/src/fancycore/placeholders/placeholders.md new file mode 100644 index 00000000..ef929e0e --- /dev/null +++ b/docs/src/fancycore/placeholders/placeholders.md @@ -0,0 +1,14 @@ +--- +order: 8 +icon: paste +--- + +# Placeholders + +FancyCore provides a set of built-in placeholders that can be used in various parts of the system. +You can use placeholders in almost any text field within FancyCore. +FancyCore also offers an API for creating and parse placeholders programmatically, read more about it in the [API documentation](../api/placeholders.md). + +## Built-in Placeholders + +* [Player related placeholders](player.md) \ No newline at end of file diff --git a/docs/src/fancycore/placeholders/player.md b/docs/src/fancycore/placeholders/player.md new file mode 100644 index 00000000..cbc7cbf6 --- /dev/null +++ b/docs/src/fancycore/placeholders/player.md @@ -0,0 +1,19 @@ +--- +icon: dot +title: Player +--- + +# Player placeholders + +| Name | Identfier | Description | Examples outputs | +|------------------------------------------|---------------------------|------------------------------------------------------------|----------------------------------------| +| Player balance (formatted) | `player_balance` | Displays the player's current balance (formatted) | "0", "123", "123.45", "13,123.97" | +| Player balance (raw) | `player_balance_raw` | Displays the player's current balance (raw) | "0", "123", "123.45", "13123.9417" | +| Player chat color (hex) | `player_chat_color` | Displays the player's chat color in hex format | "#FF0000", "#00FF00", "#0000FF" | +| Player first time joined | `player_first_joined` | Displays the date and time the player first joined | "2023-01-01 12:00:00" | +| Player first time joined (raw timestamp) | `player_first_joined_raw` | Displays the raw timestamp of when the player first joined | "1672531200" | +| Player name | `player_name` | Displays the player's name | "Simon", "OliverHD" | +| Player nickname | `player_nickname` | Displays the player's nickname | "Oli" | +| Player play time (formatted) | `player_play_time` | Displays the player's total play time (formatted) | "0s", "5m 30s", "2h 15m" | +| Player play time (ms) | `player_play_time_ms` | Displays the player's total play time in milliseconds | "0", "330000", "8100000" | +| Player UUID | `player_uuid` | Displays the player's UUID | "9b605d04-5a59-4353-bba3-2ddf570eb38a" | \ No newline at end of file