From de5035aa5a9510cc17a443bda9867d84535eac95 Mon Sep 17 00:00:00 2001 From: Shadow Date: Sun, 2 Aug 2026 15:27:37 -0500 Subject: [PATCH] docs: add prestige docs --- content/commands.mdx | 5 +- content/introduction-to-rewards.mdx | 6 +- content/meta.json | 1 + content/placeholders.mdx | 3 +- content/prestige.mdx | 94 +++++++++++++++++++++++++++++ 5 files changed, 105 insertions(+), 4 deletions(-) create mode 100644 content/prestige.mdx diff --git a/content/commands.mdx b/content/commands.mdx index bf8bf39..179fde5 100644 --- a/content/commands.mdx +++ b/content/commands.mdx @@ -15,7 +15,10 @@ Options enclosed in [] are required while options enclosed in <> are optional. Show your level and XP progress, including the XP needed for the next level. Check another member's rank by giving their name. You can also right-click a member and choose **Apps > Get User Rank**. - **`/leaderboard [type] [time]`** - Show the top members in your server, ranked by XP, messages sent, voice minutes, or XP streaks. + Show the top members in your server, ranked by XP, messages sent, voice minutes, XP streaks, or prestige. + +- **`/prestige`** + Reset your XP and increase your prestige once you meet the server's prestige requirement. See [Prestige](prestige.mdx). - **`/preferences`** Open your personal Kiai settings. Adjust notification preferences, your rank card, and other display options here. diff --git a/content/introduction-to-rewards.mdx b/content/introduction-to-rewards.mdx index e637c20..3844166 100644 --- a/content/introduction-to-rewards.mdx +++ b/content/introduction-to-rewards.mdx @@ -18,6 +18,8 @@ Manage rewards with `/rewards add`, `/rewards remove`, `/rewards list`, and `/re Every reward type accepts an optional **Required Role**. If set, a member must already hold that role to receive the reward. +When [Prestige](prestige.mdx) is enabled, every reward type also accepts a **Prestige** requirement. If set, the member must reach that prestige and level before receiving the reward. + ## Roles **Required Permissions:** @@ -96,9 +98,9 @@ When a member reaches the level, Kiai sends a signed JSON request to your endpoi ## Managing Rewards -- `/rewards list` — Lists every reward on the server, grouped by level. +- `/rewards list` — Lists every reward on the server, grouped by level and prestige when prestige is enabled. - `/rewards remove ` — Removes a single reward. -- `/rewards sync user [user]` — Re-checks and re-applies a member's role rewards to match their current level. Use this if you add or change rewards after a member has already reached that level. +- `/rewards sync user [user]` — Re-checks and re-applies a member's role rewards to match their current level and prestige. Use this if you add or change rewards after a member has already reached that level. - `/rewards sync server` — Runs the same check for every member on the server. > Leaderboard position roles are a separate feature from rewards. They track a member's live leaderboard rank rather than their level. See [Leaderboards](leaderboard.mdx). diff --git a/content/meta.json b/content/meta.json index 55e6eed..247689c 100644 --- a/content/meta.json +++ b/content/meta.json @@ -13,6 +13,7 @@ "multipliers", "denylists", "introduction-to-rewards", + "prestige", "customizing-rank-card", "unbelivaboat", "leaderboard", diff --git a/content/placeholders.mdx b/content/placeholders.mdx index a044b7e..6012b14 100644 --- a/content/placeholders.mdx +++ b/content/placeholders.mdx @@ -20,7 +20,7 @@ Not every placeholder works in every location, since some locations do not have | Location | Supported placeholders | | --- | --- | -| Level-up message | `{guild.*}`, `{user.*}`, `{level}`, `{level.new}`, `{level.old}`, `{rewards.*}` | +| Level-up message | `{guild.*}`, `{user.*}`, `{level}`, `{level.new}`, `{level.old}`, `{prestige}`, `{rewards.*}` | | XP Streak message | `{guild.*}`, `{user.*}`, `{streak}`, `{bonus}` | | XP Drop message | `{guild.*}`, `{xp}`, `{expire}` | | Custom Message reward | `{guild.*}`, `{user.*}`, `{level}`, `{level.new}`, `{level.old}` | @@ -51,6 +51,7 @@ Not every placeholder works in every location, since some locations do not have | `{level}` | 10 | Same as `{level.new}` | | `{level.old}` | 9 | The member's level before this change | | `{level.new}` | 10 | The member's level after this change | +| `{prestige}` | 2 | The member's current prestige. Level-up messages only | | `{streak}` | 7 | The member's current streak, in days. XP Streak messages only | | `{bonus}` | 15 | The bonus XP earned for the streak. XP Streak messages only | | `{expire}` | in 5 minutes | A relative time showing when a drop expires. XP Drop messages only | diff --git a/content/prestige.mdx b/content/prestige.mdx new file mode 100644 index 0000000..4baa4e2 --- /dev/null +++ b/content/prestige.mdx @@ -0,0 +1,94 @@ +--- +title: Prestige +description: Let members reset XP and continue progressing with prestige ranks. +--- + +# Prestige + +Prestige lets members reset their XP back to 0 in exchange for increasing their **prestige** count. It is useful for servers where active members reach high levels and need a longer-term progression goal. + +> Prestige is a Server Premium feature. + +--- + +## How Prestige Works + +When a member prestiges: + +- Their XP is reset to 0. +- Their prestige count increases by 1. +- Their level is recalculated from 0 XP. +- Prestige can be shown on rank cards, used in leaderboards, and used for rewards. + +Members can prestige manually with `/prestige` once they meet the XP requirement. + +If **Automatic Prestige** is enabled, Kiai will prestige members automatically when they earn enough XP. + +--- + +## Settings + +Prestige settings can be found in `/settings > Prestige`. + +- **Prestige**: Enables or disables the prestige system. +- **Automatic Prestige**: Automatically prestiges members when they reach the requirement. +- **Custom Prestige Name**: Changes the name shown for prestige on rank cards, such as `Tier` or `Ascension`. +- **Prestige Requirement Formula**: Controls how much XP is required for the next prestige. + +The default requirement formula is: + +```txt +12 * ((50 + ({prestige} * 10)) * (50 + ({prestige} * 10))) + (50 + ({prestige} * 10)) * 12 +``` + +`{prestige}` represents the member's current prestige. + +With the default formula: + +- Prestige 0 requires Level 50 worth of XP. +- Prestige 1 requires Level 60 worth of XP. +- Prestige 2 requires Level 70 worth of XP. +- Each prestige adds another 10 levels worth of XP to the requirement. + +You can use the [XP Calculator](https://kiai.app/calculator) to test prestige formulas. + +--- + +## Prestige Rewards + +When prestige is enabled, rewards can target both a prestige and a level. + +**Example:** +A role reward for **Prestige 2, Level 10** will only apply after a member has prestiged twice and reached Level 10 again. + +This lets you build reward paths that continue past the first leveling cycle. + +If **Automatic Prestige** is enabled, members prestige as soon as they reach the requirement. Rewards above that prestige's requirement level cannot be reached, so Kiai blocks those reward requirements instead of letting skipped rewards fire. + +If prestige is disabled later, Kiai preserves the stored prestige requirements on rewards. While disabled, rewards behave as level-only rewards until prestige is enabled again. + +--- + +## Prestige Leaderboard + +Use `/leaderboard` and choose **Prestige** to view members ranked by prestige and XP. + +The normal XP leaderboard also accounts for prestige when prestige is enabled, so members with a higher prestige rank appear above members with lower prestige. + +Prestige leaderboards are only available for the all-time period. + +--- + +## Level-up Message Placeholder + +Level-up messages support the `{prestige}` placeholder. Use it to show a member's current prestige in custom level-up messages. + +**Example:** + +```txt +{user} reached level {level} at prestige {prestige}! +``` + +--- + +Prestige is best for communities where members consistently reach higher levels and need a reason to keep earning XP after completing the normal progression curve.