Skip to content

Commit 747daea

Browse files
committed
docs: add documentation for Voxy leveling system and command reference
1 parent f837b62 commit 747daea

1 file changed

Lines changed: 68 additions & 0 deletions

File tree

docs/Voxy/v1/Features/Leveling.mdx

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Leveling
3+
description: Player experience, levels, and progress bars
4+
order: 13
5+
---
6+
7+
# Leveling
8+
9+
Voxy includes a complete leveling system that awards players experience (XP), levels them up, displays configurable progress bars, and executes rewards upon reaching specific levels.
10+
11+
## Overview
12+
13+
The leveling model manages each player's level and their current XP towards the next level.
14+
A player's progression is calculated dynamically based on an experience formula.
15+
Server administrators can also configure how the progress is displayed using **Bar Styles** and **Level Formats**.
16+
17+
### Experience Formula
18+
19+
The experience required to reach the next level is calculated using a mathematical expression.
20+
By default, the formula is:
21+
```text
22+
1250 * (<level> ^ 2) + (6250 * <level>) - 7500
23+
```
24+
*(Where `<level>` is the player's current level).*
25+
26+
You can modify this formula via the settings, along with defining the server's **max level** (default `500`).
27+
28+
## Bar Styles
29+
30+
Progress bars visually represent a player's XP progress. You can define multiple bar styles and choose which one to display.
31+
A bar style consists of:
32+
- **Size**: Total length of the progress bar (e.g., 20 characters).
33+
- **Bar Character**: The symbol used to draw the bar (e.g., `` or ``).
34+
- **Done Prefix**: The formatting (color/style) applied to the completed portion.
35+
- **Progress Prefix**: The formatting applied to the single character representing current progress.
36+
- **Remaining Prefix**: The formatting applied to the unfilled portion of the bar.
37+
38+
### Default Styles
39+
Voxy provides two default styles out of the box:
40+
- `bar`: Uses the `` character (Size: 20).
41+
- `box`: Uses the `` character (Size: 10).
42+
43+
## Level Formats
44+
45+
You can customize how a level is displayed in text or chat by setting **Level Formats**.
46+
A format allows you to define a `displayFormat` and a `chatDisplayFormat` (e.g., `&7[☆ {level}]`).
47+
48+
Formats are tied to specific levels. When displaying a player's level, Voxy finds the format assigned to their current level or the nearest format below it.
49+
50+
## Level Rewards
51+
52+
Rewards can be configured to trigger automatically when a player reaches a specific level.
53+
A single `LevelReward` consists of multiple actions, which can include giving items, executing commands, sending messages, or granting currency.
54+
55+
## Commands
56+
57+
Staff can manage a player's levels and XP, as well as configure the entire system through an in-game GUI.
58+
59+
| Command | Syntax | Description |
60+
|---------|--------|-------------|
61+
| `setlevel` | `/level setlevel <player> <amount>` | Sets player level |
62+
| `addlevel` | `/level addlevel <player> <amount>` | Adds levels to player |
63+
| `setexp` | `/level setexp <player> <amount>` | Sets exact experience |
64+
| `addexp` | `/level addexp <player> <amount>` | Adds experience |
65+
| `addrandomexp` | `/level addrandomexp <player> <min> <max>` | Adds random experience |
66+
| `settings` | `/level settings` | Opens the leveling settings GUI |
67+
68+
*(Requires the `voxy.admin` permission).*

0 commit comments

Comments
 (0)