When a user posts a new thread in the forum. | Variable | Description | | ----------- | ---------------------- | | \{username} | Username | | \{title} | Title | | \{url} | The URL of the thread. | * **Credits Purchased**
When a user purchases credits. | Variable | Description | | ----------- | ----------- | | \{username} | Username | | \{credit} | Amount | | \{credit} | Currency | * **Product Purchased**
When a user purchases a product. | Variable | Description | | ----------- | ------------- | | \{username} | Username | | \{product} | Product Name | | \{category} | Category Name | | \{price} | Price | | \{credit} | Currency | | \{quantity} | Quantity | * **Community Goal Reached**
When a community goal is reached. | Variable | Description | | -------- | ----------- | | \{goal} | Goal Amount | * **Support Ticket Opened**
When a user opens a new support ticket. | Variable | Description | | ----------------- | ---------------------- | | \{username} | Username | | \{title} | Title | | \{category} | Category Name | | \{message} | Message | | \{dashboard\_url} | The URL of the ticket. | * **Support Ticket Answered**
When a support ticket is answered. | Variable | Description | | ----------------- | ---------------------- | | \{username} | Username | | \{title} | Title | | \{category} | Category Name | | \{message} | Message | | \{dashboard\_url} | The URL of the ticket. | * **Support Ticket Replied**
When a support ticket is replied. | Variable | Description | | ----------------- | ---------------------- | | \{username} | Username | | \{title} | Title | | \{category} | Category Name | | \{message} | Message | | \{dashboard\_url} | The URL of the ticket. | * **Blog Post Published**
When a new blog post is published. | Variable | Description | | ------------ | -------------------- | | \{username} | Username | | \{title} | Title | | \{content} | Content | | \{category} | Category Name | | \{thumbnail} | Post Thumbnail | | \{url} | The URL of the post. | * **Blog Post Commented**
When a user comments on a blog post | Variable | Description | | ----------------- | ----------------------- | | \{username} | Username | | \{comment} | Comment | | \{title} | Title | | \{url} | The URL of the post. | | \{dashboard\_url} | The URL of the comment. | * **Wheel of Fortune Won**
When a user wins a prize from the Wheel of Fortune | Variable | Description | | ----------- | --------------------- | | \{username} | Username | | \{name} | Wheel of Fortune Name | | \{award} | Award Name | * **Application Submitted**
When a user submits an application | Variable | Description | | ----------------- | --------------------------- | | \{username} | Username | | \{form\_title} | Form Title | | \{dashboard\_url} | The URL of the application. | * **Changelog Published**
When a staff publishes a new changelog | Variable | Description | | ----------- | ------------------------- | | \{username} | Username | | \{title} | Changelog Title | | \{url} | The URL of the changelog. | # Google Analytics Source: https://docs.leaderos.net/integrations/google-analytics Collect and analyze data from your website with Google Analytics. ### How to set up Google Analytics? 1. Go to **Dashboard > Settings > Modules** and enable the **Google Analytics** module. 2. Go to [Google Analytics](https://analytics.google.com/) and sign in with your Google account. 3. Click on `Admin` in the bottom left corner. 4. Click on `Create Account`. 5. Fill in the required fields and click on `Next`. 6. Choose **"Web"** as the platform. 7. Enter your website URL and name to set up data stream and click on `Create stream`. 8. Copy the **"Measurement ID"**. 9. Go to your website and **Dashboard > Settings > System Settings**. 10. Enable the **Google Analytics** option and paste the **"Measurement ID"**. You can learn more about Google Analytics by visiting their [website](https://analytics.google.com/). ### Video Tutorial # RCON Source: https://docs.leaderos.net/integrations/rcon You can send commands to your game console using RCON. This allows your website to communicate directly with your game server to execute commands, deliver items, and manage players automatically.
| Links the in-game account with the website. |
| /discord-sync | Generates a link for Discord account synchronization. |
| /credits | Shows your current credit balance. |
| /credits show | Shows the credit balance of a specific player. |
| /credits send | Sends credits to another player. |
| /credits set | Sets a player's credits to a specific amount. |
| /credits add | Adds a specific amount of credits to a player. |
| /credits remove | Removes a specific amount of credits from a player. |
### Permissions
| Command | Permission |
| :--------------- | :-------------------------- |
| /leaderos | `leaderos.help` |
| /leaderos reload | `leaderos.reload` |
| /ai \ | `leaderos.ai` |
| /verify \ | `leaderos.verify` |
| /discord-sync | `leaderos.discord.sync` |
| /credits | `leaderos.credit.see` |
| /credits show | `leaderos.credit.see.other` |
| /credits send | `leaderos.credit.send` |
| /credits set | `leaderos.credit.set` |
| /credits add | `leaderos.credit.add` |
| /credits remove | `leaderos.credit.remove` |
### How do I find my API Key?
You can find your API key by navigating to **Dashboard > Settings > API**.
If you do not see an API key on that page, click the **"Reset"** button to generate a new one.
### How do I find my Server Token?
When you add a server with the "LeaderOS Connect" type via **Dashboard > Store > Servers**, the system will generate and display your server token.
### How to create a new server?
1. Go to **Dashboard > Store > Servers > Add**.
2. Select "LeaderOS Connect" as the console type.
3. Fill in the remaining server details.
4. Click the "Create" button.
5. You will be redirected to the plugin instructions page containing your token.
![LeaderOS Connect Server]()
## How to regenerate the Server Token?
1. Go to **Dashboard > Store > Servers** and edit the relevant server.
2. Click the "Reset" button.
3. Replace the `server-token` value in your `modules.yml` file with the new token.
![Images]()
## How to check my console connection?
First, install the LeaderOS plugin and configure the `connect` module in both `config.yml` and `modules.yml`. Once completed, start your server. When the console connection is established successfully, you will see a confirmation log in your server console.
![Images]()
## Server token is not generating or is empty?
This issue usually occurs because your API key is not synced with the LeaderOS systems. To resolve this, follow these steps:
* Go to **Dashboard > Settings > API** and reset your API key.
* Go to **Dashboard > Store > Servers** and regenerate your server token.
### Unblocking API for sites using Cloudflare
If you are using Cloudflare, it may block your API system and prevent player logins. In this case, follow the steps below to whitelist the API system in Cloudflare:
1. Log in to your Cloudflare dashboard.
2. Navigate to **Cloudflare > Security > Security Rules > Create Rule > Custom Rules**.
3. Create a rule that matches the configuration shown in the image below.
![Cloudflare Custom Role]()
# AuthMe
Source: https://docs.leaderos.net/plugins/minecraft/authme
AuthMe Integration synchronises the player accounts that are registered to your Minecraft Server with the website.
AuthMe and your website's MySQL database server **must be the same**!
Before connecting AuthMe with your website, make sure you are using the latest official version of AuthMe. For the latest official version of AuthMe, visit: [https://www.spigotmc.org/resources/authmereloaded.6269/](https://www.spigotmc.org/resources/authmereloaded.6269/)
### How can I set up AuthMe for LeaderOS?
Find **DataSource** section in the config.yml and replace the following values with your MySQL database information.
AuthMe and the website need to use the same database connection. If you connect them to different databases, synchronization between the website and in-game cannot be achieved.
```yaml theme={null}
DataSource:
backend: MYSQL
caching: false
mysqlHost: REPLACE_WITH_HOST_IPV4
mysqlPort: 3306
mysqlUseSSL: false
mysqlUsername: REPLACE_WITH_USERNAME
mysqlPassword: REPLACE_WITH_PASSWORD
mysqlDatabase: REPLACE_WITH_DATABASE_NAME
mysqlTablename: Accounts
```
# LeaderOS Auth
Source: https://docs.leaderos.net/plugins/minecraft/leaderos-auth
Provides in-game login/register operations via the LeaderOS API
## Download
[https://www.spigotmc.org/resources/leaderos-auth.127863/](https://www.spigotmc.org/resources/leaderos-auth.127863/)
## Source Code
[https://github.com/leaderos-net/minecraft-leaderos-auth](https://github.com/leaderos-net/minecraft-leaderos-auth)
## Features
* Enables in-game login/register operations directly via the LeaderOS API.
* Works without a database connection. If you are experiencing database connectivity issues, this plugin is the perfect solution.
* Seamless integration with LeaderOS.
* Compatible with Velocity, Bungeecord, and Spigot/Paper.
* Provides secure and stable authentication.
* A modern alternative to AuthMe and LimboAuth.
## Installation Summary
**If you are using Velocity, install only the Velocity JAR.**
* Fill in the `url` and `api-key` fields in `config.yml`.
**If you are using Bungeecord, install both the Bungeecord JAR and the Spigot/Paper JAR.**
* Install the Spigot/Paper JAR on your Auth/Lobby server.
* Fill in the `auth-server` field in the Bungeecord `config.yml`.
* Fill in the `url` and `api-key` fields in the Spigot/Paper `config.yml`.
**If you are not using any proxy system (Standalone), install only the Spigot/Paper JAR.**
* Fill in the `url` and `api-key` fields in `config.yml`.
**Important fields in config.yml:**
* You can set the `lang` value to `en` to enable English language support (or `tr` for Turkish).
* The `url` value must be your website's URL. Example: `https://myserver.com`
* The `api-key` is the key found on your website under **Dashboard > Settings > API**.
If you are using Cloudflare, you must also perform the following step: [Unblocking API for sites using Cloudflare](/plugins/minecraft/leaderos-auth#unblocking-api-for-sites-using-cloudflare)
## Usage with Velocity
With the Velocity version, you can set up authentication without needing a dedicated "fake lobby" server. When a user joins, they are directed to a virtual Limbo server generated by the proxy for login/registration. Once authenticated, the player is redirected to the main server.
### Velocity Requirements
* Velocity 3.4 b520 or higher.
* LimboAPI 1.1.27.
### Installation for Velocity
1. Download the plugin and upload the **Velocity JAR** to your Velocity server's `plugins` folder.
2. Restart the Velocity server.
3. Once the server restarts, open `plugins/leaderosauth/config.yml`. Fill in the `url` and `api-key` fields:
* `url`: Enter your website's URL. Example: `https://myserver.com`
* `api-key`: Enter your website's API key. You can find this in **Dashboard > Settings > API**.
4. Restart the Velocity server again to complete the installation.
*Note: When using the Velocity method, you do not need to install the plugin on your Spigot/Paper servers. Installing the Velocity version is sufficient.*
## Usage with Bungeecord
The Bungeecord version is designed for security. It requires a Spigot/Paper server to handle the actual login/registration process; it does not work by installing it solely on Bungeecord. The purpose of this version is to prevent users from connecting to the lobby with an admin account and executing commands like `/server` before logging in.
If you are using Bungeecord, you absolutely must use this plugin. Otherwise, malicious users could connect to your lobby with an admin username and use commands like /server to bypass authentication, potentially harming your server.
Using only the Bungeecord JAR is not enough. You must also install the plugin on a Spigot/Paper server (your auth lobby).
### Installation for Bungeecord
1. Download the plugin and upload the **Bungeecord JAR** to your Bungeecord server's `plugins` folder.
2. Restart the Bungeecord server.
3. Once the server restarts, open `plugins/LeaderOS-Auth/config.yml` and set the `auth-server` field to the name of the Spigot/Paper server where auth will take place (e.g., `auth_lobby`).
4. Restart the Bungeecord server again.
5. Install the Spigot/Paper version of the plugin on the server designated for authentication. Details on this installation can be found in the section below.
## Usage with Spigot/Paper
You need to install this version on the server where players will log in. If you are using Bungeecord, you must install both this version (on the backend server) and the Bungeecord version (on the proxy).
### Installation for Spigot/Paper
1. Download the plugin and upload the **Spigot/Paper JAR** to your server.
2. Restart your server.
3. Once the server restarts, open `plugins/LeaderOS-Auth/config.yml`. Fill in the `url` and `api-key` fields:
* `url`: Enter your website's URL. Example: `https://myserver.com`
* `api-key`: Enter your website's API key. You can find this in **Dashboard > Settings > API**.
* `send-after-auth`: If you want to redirect the player to a different server after a successful login/register, set this to `true` and specify the `server` name. Example: `lobby`
## config.yml
### Velocity
```yaml theme={null}
# Main settings
settings:
# Plugin language (e.g., en, tr)
lang: en
# Your website URL
url: https://myserver.com
# You can get the API key from Dashboard > Settings > API
api-key: 123456789abcdefghjklmnb
# Debug mode
# Available modes:
# DISABLED: Disables debug messages
# ENABLED: Shows all debug messages
# ONLY_ERRORS: Shows only error messages
debug-mode: ONLY_ERRORS
# Should session system be enabled?
# If enabled, players joining from the same IP won't be asked for a password again. Recommended: false.
session: false
# If the player is not registered on the site, they cannot join. Enable this if you only want registration via the website.
kick-non-registered: false
# Kick player if they enter the wrong password.
kick-on-wrong-password: true
# Kick player if they haven't logged in within 60 seconds.
auth-timeout: 60
# Cooldown in seconds for commands like /login and /register
command-cooldown: 3
# Minimum allowed password length (can be set to 4 or higher).
min-password-length: 5
# List of commands that will be used to log in
login-commands:
- login
- log
- l
- giris
- giriş
# List of commands that will be used to register
register-commands:
- register
- reg
- kayit
- kayıt
# Disallowed passwords. Simple and easily guessable passwords should be added here.
unsafe-passwords:
- '123456'
- password
- qwerty
- '123456789'
- help
- sifre
- '12345'
- asd123
- qwe123
```
### Bungeecord
```yaml theme={null}
# Main settings
settings:
# Debug mode
# Available modes:
# DISABLED: Disables debug messages
# ENABLED: Shows all debug messages
# ONLY_ERRORS: Shows only error messages
debug-mode: ONLY_ERRORS
# Enter the name of the server where login/register operations will take place.
auth-server: auth_lobby
# Which commands are whitelisted during the login/register phase?
allowed-commands:
- login
- log
- l
- giris
- giriş
- register
- reg
- kaydol
- kayit
- kayıt
```
### Spigot/Paper
```yaml theme={null}
# Main settings
settings:
# Plugin language
lang: en
# Your website URL
url: https://myserver.com
# You can get the API key from Dashboard > Settings > API
api-key: 123456789abcdefghjklmnb
# Debug mode
# Available modes:
# DISABLED: Disables debug messages
# ENABLED: Shows all debug messages
# ONLY_ERRORS: Shows only error messages
debug-mode: ONLY_ERRORS
# Should session system be enabled?
# If enabled, players joining from the same IP won't be asked for a password again. Recommended: false.
session: false
# Forces the player into survival mode upon joining.
force-survival-mode: true
# If the player is not registered on the site, they cannot join. Enable this if you only want registration via the website.
kick-non-registered: false
# Kick player if they enter the wrong password.
kick-on-wrong-password: true
# Kick player if they haven't logged in within 60 seconds.
auth-timeout: 60
# Cooldown in seconds for commands like /login and /register
command-cooldown: 3
# Minimum allowed password length (can be set to 4 or higher).
min-password-length: 5
# If enabled, the player is sent to another server after successful login/registration.
send-after-auth:
# Set to true to enable.
enabled: true
# If enabled: true, the player is sent to this server after auth.
server: lobby
# Which commands are whitelisted during the login/register phase?
allowed-commands:
- login
- log
- l
- giris
- giriş
- register
- reg
- kaydol
- kayit
- kayıt
# Disallowed passwords. Simple and easily guessable passwords should be added here.
unsafe-passwords:
- '123456'
- password
- qwerty
- '123456789'
- help
- sifre
- '12345'
- asd123
- qwe123
```
## Unblocking API for sites using Cloudflare
If you are using Cloudflare, it may block your API system and prevent player logins. In this case, follow the steps below to whitelist the API system in Cloudflare:
1. Log in to your Cloudflare dashboard.
2. Navigate to Cloudflare > Security > Security Rules (WAF) > Create Rule > Custom Rules.
3. Create a rule that matches the configuration shown in the image below.
![Cloudflare Custom Role]()
# LeaderOS Connect
Source: https://docs.leaderos.net/plugins/minecraft/leaderos-connect
It securely delivers commands to your game server when a purchase is made. Compatible with Bukkit, Spigot, Paper, Bungeecord, and Velocity.
**LeaderOS Connect is a module of the LeaderOS plugin. With this module, it securely sends commands to the game when a purchase is made on your website.**
Only the unexecuted commands for a purchased product can be sent. The command status is rechecked on your game server before execution, ensuring security. Even if someone with malicious intent obtains login credentials, they cannot send unauthorized commands.
### RCON vs LeaderOS Connect?
| Feature | LeaderOS Connect | RCON |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- |
| Secure | ✅ | ❌ |
| Requires Ports to be open | You do not need to open a port. | You have to open the port. This may create a security vulnerability. |
| Command Sending | Only the unexecuted commands for a purchased product can be sent. The status of these commands is verified on the server side. | Anyone with access to the connection credentials can send any command they want. |
* 🏆 **Winner:** LeaderOS Connect Module
## How can I set up LeaderOS Connect Module?
1. Install and configure LeaderOS plugin on your Minecraft server. [How can I set up LeaderOS plugin?](/integrations/leaderos-plugin#installation)
2. Enable "Connect" module in modules.yml.
3. Enter your "Server Token" for Connect module in modules.yml.
## How can I create Server Token?
You can add a new server with the console type LeaderOS Connect or set the console type of existing servers to LeaderOS Connect.
### How can I do this by creating a new server?
1. Go to **Dashboard > Store > Servers > Add**
2. Select "LeaderOS Connect" as the console type.
3. Fill the other server fields.
4. Click the "Create" button.
5. You will be redirected to the plugin instruction page.
![LeaderOS Connect Server]()
### How can I generate a server token for an existing server?
1. Go to **Dashboard > Store > Servers** and edit a server.
2. Select "LeaderOS Connect" as the console type.
3. Click the "Save Changes" button.
4. You will be redirected to the plugin instruction page.
![LeaderOS Connect Server]()
## How can regenerate my server token?
1. Go to **Dashboard > Store > Servers** and edit a server.
2. Click the "Reset" button.
3. Replace the "server-token" field in the "modules.yml" file with the new one.
![Images]()
## How can I check my console connection?
First, install the LeaderOS plugin and configure the connect module. After completing these steps, run your server. You can check the console connection. When the console connection is successful, you'll see a log in your server console.
![Images]()
# LeaderOS Plugin
Source: https://docs.leaderos.net/plugins/minecraft/leaderos-plugin
We currently support Bukkit, Spigot, Bungeecord, Velocity. Offer features such as Web Store, Bazaar, Credits and ensure product delivery after purchase. It's completely [Open Source!](https://github.com/leaderos-net/leaderos-discord-bot)
* **Download:**
[https://www.spigotmc.org/resources/leaderos-net-official-plugin.105496/](https://www.spigotmc.org/resources/leaderos-net-official-plugin.105496/)
* **Source Code:**
[https://github.com/leaderos-net/leaderos-plugin](https://github.com/leaderos-net/leaderos-plugin)
### Which Minecraft server platforms do you support?
We currently support **Bukkit**, **Spigot**, **Paper**, **Bungeecord** and **Velocity**.
### Features
* **Verify:** Links a player's Minecraft account to their website account using a unique code provided by the website.
* **Discord Sync:** With a simple command, this feature verifies your Discord account and syncs it with your server's website, enabling role and name syncing. Additionally, it allows users to log in to the website using their Discord credentials, streamlining user management and enhancing the integration of your server with Discord.
* **Webstore:** This feature enables players to access and make in-game purchases from the website's store directly within the game, providing a convenient and seamless shopping experience.
* **Bazaar:** Players can list in-game items for sale on the website, allowing them to earn website credits by selling items to other players. This feature creates a virtual marketplace, fostering an in-game economy and promoting player-to-player trading.
* **Donations GUI:** This feature opens a menu on the website that lists donations made, providing a convenient way to show contributions to your server.
* **Credits:** This feature allows players to manage and see the credits, offering a user-friendly commands for credit management.
* **Vouchers:** This feature enables players to convert their website credits into vouchers that can be used as a trading instrument in the game. Players can transfer these vouchers to others or use them in in-game transactions, adding flexibility to the in-game economy.
* **Placeholders:** Enhance your server's functionality with placeholders that can display dynamic information, such as user email, credits, donations...
### Installation
1. Download and install the LeaderOS plugin jar and restart your server.
2. Enter your Website URL and API Key into config.yml. [How to find API key?](/integrations/leaderos-plugin#how-can-i-find-my-api-key)
3. Restart your server.
### Commands
| Commands | Description |
| :-------------------------------- | :----------------------------------------------------- |
| /leaderos | Shows all of the commands. |
| /leaderos reload | Reloads configrations. |
| /verify \ | Verifies Minecraft account in game. |
| /discord-sync | Generates a discord account sync link. |
| /webstore | Shows the webshop menu. |
| /webstore buy \ | Buys a product via command. |
| /webstore category \ | Opens the specified category. |
| /webbazaar | Opens the bazaar storage menu. |
| /webbazaar add | Adds the item held to the bazaar storage. |
| /donations | Opens the donations menu. |
| /donations update | Updates the donations data. |
| /credits | Shows your current credit amount. |
| /credits send | Sends a player credit. |
| /credits set | Sets a players credit to the specified amount. |
| /credits add | Adds a player the specified amount of credits. |
| /credits remove | Removes the specified amount of credits from a player. |
| /creditvoucher give | Gives the player a credit voucher. |
| /creditvoucher create | Creates a credit voucher from your own credit. |
| /leaderos-cache update \ | Updates the user cache. |
### Permissions
| Command/Action | Permission |
| :------------------------------- | :-------------------------- |
| /leaderos | `leaderos.help` |
| /leaderos reload | `leaderos.reload` |
| /verify \ | `leaderos.verify` |
| /discord-sync | `leaderos.discord.sync` |
| /webstore | `leaderos.webstore.open` |
| /webstore buy \ | `leaderos.webstore.buy` |
| /webbazaar | `leaderos.bazaar.open` |
| /webbazaar add | `leaderos.bazaar.add` |
| /donations | `leaderos.donations.open` |
| /donations update | `leaderos.donations.update` |
| /credits | `leaderos.credit.see` |
| /credits \ | `leaderos.credit.see.other` |
| /credits send | `leaderos.credit.send` |
| /credits set | `leaderos.credit.set` |
| /credits add | `leaderos.credit.add` |
| /credits remove | `leaderos.credit.remove` |
| /creditvoucher give | `leaderos.voucher.give` |
| /creditvoucher create | `leaderos.voucher.create` |
| /leaderos-cache update \ | `leaderos.cache.update` |
| Using Vouchers | `leaderos.voucher.use` |
### Recommended Default Permissions
* `leaderos.verify`
* `leaderos.discord.sync`
* `leaderos.webstore.open`
* `leaderos.webstore.buy`
* `leaderos.bazaar.open`
* `leaderos.bazaar.add`
* `leaderos.donations.open`
* `leaderos.credit.see`
* `leaderos.credit.send`
* `leaderos.voucher.use`
* `leaderos.voucher.create`
### Placeholders
| Placeholder | Description | |
| :----------------------------------------------------- | :--------------------------------------------------------------------- | ------------------------------- |
| %leaderos-cache\_credit% | Displays the player's credit amount. | |
| %leaderos-cache\_email% | Displays the player's email. | |
| %leaderos-cache\_creation\_ip% | Displays the player's registeration IP | |
| %leaderos-cache\_creation\_date% | Displays the player's registeration date | |
| %leaderos-communitygoal\_is\_active% | Returns whether there is an active community goal or not. (true/false) | |
| %leaderos-communitygoal\_currency% | | Currency of the community goal. |
| %leaderos-communitygoal\_total\_raised% | Total amount raised for the community goal. | |
| %leaderos-communitygoal\_goal\_amount% | Goal amount of the community goal. | |
| %leaderos-communitygoal\_percentage\_achieved% | Percentage achieved of the community goal. | |
| %leaderos-communitygoal\_progress\_bar% | Progress bar of the community goal. | |
| %leaderos-donations\_username\_latest\_\% | Donor username of the donation. (\: 1-10) (Latest) | |
| %leaderos-donations\_amount\_latest\_\% | Amount of the donation. (\: 1-10) (Latest) | |
| %leaderos-donations\_username\_top-alltime\_\% | Donor username of the donation. (\: 1-10) (Top All Time) | |
| %leaderos-donations\_amount\_top-alltime\_\% | Amount of the donation. (\: 1-10) (Top All Time) | |
| %leaderos-donations\_username\_top-annual\_\% | Donor username of the donation. (\: 1-10) (Top Annual) | |
| %leaderos-donations\_amount\_top-annual\_\% | Amount of the donation. (\: 1-10) (Top Annual) | |
| %leaderos-donations\_username\_top-monthly\_\% | Donor username of the donation. (\: 1-10) (Top Monthly) | |
| %leaderos-donations\_amount\_top-monthly\_\% | Amount of the donation. (\: 1-10) (Top Monthly) | |
| %leaderos-donations\_username\_top-daily\_\% | Donor username of the donation. (\: 1-10) (Top Daily) | |
| %leaderos-donations\_amount\_top-daily\_\% | Amount of the donation. (\: 1-10) (Top Daily) | |
### How can I find my API Key?
You can find your API key from **Dashboard > Settings > API**.
If you don't see any API key in this page, please click the **"Reset"** button to generate an API Key.
### How can I find my Server Token?
You can follow the instructions at [this link](/integrations/leaderos-connect)
### How can I find my Bazaar Server ID?
You can find your Bazaar Server ID from **Dashboard > Misc > Bazaar > Servers**
Do not enter the leading **"#"** symbol. Enter only the number!
![Bazaar Server ID]()
### How can I enable Show In-Game?
Go to **Dashboard > Servers/Products/Product Categories** page and press the edit button and enable the **"Show In Game"** option. Now you will be able to configure options like "Title, Lore, Icon" in the game.
### Unblocking API for sites using Cloudflare
If you are using Cloudflare, it may block your API system and prevent player logins. In this case, follow the steps below to whitelist the API system in Cloudflare:
1. Log in to your Cloudflare dashboard.
2. Navigate to **Cloudflare > Security > Security Rules > Create Rule > Custom Rules**.
3. Create a rule that matches the configuration shown in the image below.
![Cloudflare Custom Role]()
# LimboAuth
Source: https://docs.leaderos.net/plugins/minecraft/limbo-auth
LimboAuth fork is compatible with the LeaderOS database design.
### Source Code (Our fork)
* [https://github.com/leaderos-net/LimboAuth](https://github.com/leaderos-net/LimboAuth)
### How can I set up LimboAuth for LeaderOS?
Find database section in the config.yml and enter your database credentials.
LimboAuth and the website need to use the same database connection. If you connect them to different databases, synchronization between the website and in-game cannot be achieved.
```yaml theme={null}
database:
storage-type: MYSQL
host: REPLACE_WITH_HOST_IPV4:3306
user: REPLACE_WITH_USERNAME
password: REPLACE_WITH_PASSWORD
database: REPLACE_WITH_DATABASE_NAME
```
# WebSender
Source: https://docs.leaderos.net/plugins/minecraft/websender
* You can send commands to your game console using WebSender.
### Download the plugin
[https://www.spigotmc.org/resources/websender-send-command-with-php-bungee-and-bukkit-support.33909](https://www.spigotmc.org/resources/websender-send-command-with-php-bungee-and-bukkit-support.33909)
The ports you use with WebSender must be open on both your web hosting and game server VPS.
### Installation
Please replace `PORT` with a port number not in use by another service (don't enter your Minecraft server port), and `PASSWORD` with a secure password.
```yml config.yml theme={null}
socketPort: PORT
socketPassword: PASSWORD
senderPrefix: '[WebSender]'
wrongPassword: Incorrect password, please enter it carefully.
wrongData: Please check PHP variables.
succesfullyLogin: Login is successful.
consoleInfo: 'true'
commandPermission: websender.admin
nothavePerm: You not have permission!
pluginReloaded: Websender reloaded!
```
# LeaderOS Connect
Source: https://docs.leaderos.net/plugins/rust/leaderos-connect
Connect your Rust server to LeaderOS, enabling you to execute commands on your server directly from the website.
## Download
[https://www.leaderos.net/plugin/rust](https://www.leaderos.net/plugin/rust)
## Source Code
[https://github.com/leaderos-net/rust-leaderos-connect](https://github.com/leaderos-net/rust-leaderos-connect)
## Installation
1. [Download](https://www.leaderos.net/plugin/rust) the `LeaderosConnect.cs` file.
2. Upload the `LeaderosConnect.cs` file to the `plugins` folder in your server directory.
3. Restart your Rust server to initialize the plugin.
4. Configure the plugin by editing the `LeaderosConnect.json` file located in the `/config` directory.
* **Website Url**: The URL of your LeaderOS website (e.g., `https://yourwebsite.com`).
* **Api Key**: Your LeaderOS API key. You can find this under `Dashboard > Settings > API`.
* **Server Token**: Your server token. You can find this under `Dashboard > Store > Servers > Your Server > Server Token`.
* **Debug Mode**: Set to `true` to enable debug logs, or `false` to disable them.
* **Check Player Online**: Set to `true` to verify if players are online before sending commands, or `false` to skip this check.
5. Restart your Rust server again to apply the configuration changes.
## Admin Commands
* `/leaderos.status` - Displays the current LeaderOS connection status.
* `/leaderos.reconnect` - Reconnects to the LeaderOS socket server.
* `/leaderos.debug` - Toggles debug mode on or off.
# LeaderOS Connect
Source: https://docs.leaderos.net/plugins/unturned/leaderos-connect
Connect your Unturned server to LeaderOS, enabling you to execute commands on your server directly from the website.
## Download
[https://www.leaderos.net/plugin/unturned](https://www.leaderos.net/plugin/unturned)
## Source Code
[https://github.com/leaderos-net/unturned-leaderos-connect](https://github.com/leaderos-net/unturned-leaderos-connect)
## Requirements
Unturned server with [RocketMod](https://github.com/RocketMod/Rocket) installed
## Installation
1. [Download `LeaderosConnect.dll`](https://www.leaderos.net/plugin/unturned)
2. Upload it to your server:
```
/Rocket/Plugins/LeaderosConnect.dll
```
3. Start the server once to generate the config file, then stop it
4. Edit the config file at:
```
/Rocket/Plugins/LeaderosConnect/LeaderosConnect.configuration.xml
```
```xml theme={null}
https://yourdomain.com
YOUR_API_KEY
YOUR_SERVER_TOKEN
false
true
```
5. Start the server
## Configuration
| Field | Description |
| ------------------- | ---------------------------------------------------------------------------------------------------- |
| `WebsiteUrl` | The URL of your LeaderOS website (e.g., `https://yourwebsite.com`). |
| `ApiKey` | Your LeaderOS API key. Find it on `Dashboard > Settings > API` |
| `ServerToken` | Your server token. Find it on `Dashboard > Store > Servers > Your Server > Server Token` |
| `DebugMode` | Set to `true` to enable debug logging, or `false` to disable it. |
| `CheckPlayerOnline` | Set to `true` to check if players are online before sending commands, or `false` to skip this check. |
## Commands
| Command | Description |
| --------------------- | ----------------------------------------------- |
| `/leaderos.status` | Displays the status of the LeaderOS connection. |
| `/leaderos.reconnect` | Reconnects to the LeaderOS socket server |
| `/leaderos.debug` | Toggles debug mode on/off |
All commands require admin privileges.
# API
Source: https://docs.leaderos.net/settings/api
Learn how to configure the API of your website.
If you are looking for the API documentation, please visit the [Developer API documentation](https://developer.leaderos.net).
### How to disable the API?
Go to **Dashboard > Settings > API**. You can disable the API by toggling the API Status switch.
### How to reset the API key?
Go to **Dashboard > Settings > API**. You can reset the API key by clicking the **"Reset"** button. You will be redirected to the leaderos.net login page. After logging in, you will be redirected back to the API settings page with the new API key.
# Currencies
Source: https://docs.leaderos.net/settings/currencies
Users from all over the world can make purchases on your website and view your store in their own currency.
When "Auto Update" is enabled, the currency is updated every 24 hours by fetching its current value from our API server.
## How can I fix the currency rate?
Disabling **"Auto Update"** and changing the **"Rate"** value will fix the currency rate to the entered value and prevent it from being updated by the auto-updater.
## How can I change the Default Currency?
Find the currency you want to make the default from the list and click **"Set Default"**.
![Image]()
# Email Templates
Source: https://docs.leaderos.net/settings/email-templates
Customize the email templates that are sent to your users.
SMTP settings must be configured to send emails. Otherwise you cannot use features and modules that use the SMTP system. Learn more about the [SMTP system](/settings/smtp).
## How to customize email templates?
1. Go to **Settings** > **Email Templates**.
2. Choose the email template you want to customize.
3. You can customize the template using the editor.
## How to change the logo?
1. Go to **Settings** > **Email Templates**.
2. Choose the email template you want to customize.
3. Select the logo and click on the **Image** button.
![Image]()
4. Go to [ImgBB](https://imgbb.com) to upload your logo.
![Image]()
5. Visit the uploaded image link.
![Image]()
6. Right-click on the image and select **Copy Image Address**.
![Image]()
7. Paste the image link in the Source field and save.
![Image]()
8. The logo will be updated in the email template.
![Image]()
# General Settings
Source: https://docs.leaderos.net/settings/general
Learn how to configure the general settings of your website.
You can configure the following general settings for your website:
* **Website URL:** The URL of your website. This field is important for using the whole website.
* **Website Name:** The name of your website.
* **Site Title:** The title of your website.
* **Server IP:** The IP address of your server like `play.hypixel.net`.
* **Server Version:** The version of your server like `1.16`.
* **Google Tags:** The Google tags for your website. You can add tags by typing a tag name and pressing the `Enter` key. Also you can remove a tag by clicking on the tag.
* **Google Description:** The Google description for your website. This description will be shown in the search results.
* **Facebook URL:** The URL of your Facebook page. This field is optional and you can leave it empty.
* **Twitter (X) URL:** The URL of your Twitter (X) page. This field is optional and you can leave it empty.
* **Instagram URL:** The URL of your Instagram page. This field is optional and you can leave it empty.
* **YouTube URL:** The URL of your YouTube page. This field is optional and you can leave it empty.
* **Discord URL:** The URL of your Discord server. This field is optional and you can leave it empty.
* **TikTok URL:** The URL of your TikTok page. This field is optional and you can leave it empty.
* **Email:** The contact email of your website. This field is optional and you can leave it empty.
* **Phone:** The contact phone of your website. This field is optional and you can leave it empty.
* **WhatsApp:** The contact WhatsApp of your website. This field is optional and you can leave it empty.
* **About us:** The about text of your website. This field is optional and you can leave it empty.
* **Rules:** The rules text of your website. You can use HTML tags in this field.
* **Support Message Template:** The support message template of your website. You can use the following placeholders in this field:
* `%username%`: The username of the support message sender.
* `%servername%`: The server name.
* `%serverip%`: The server IP.
* `%serverversion%`: The server version.
* `%message%`: The message of the support message sender.
* **Favicon Logo:** The favicon logo of your website. This logo will be shown in the browser tab. After changing the favicon logo, you need to clear the browser cache to see the changes by pressing `Ctrl + F5` keys.
# Languages & Translations
Source: https://docs.leaderos.net/settings/languages
Users from all over the world can visit your website and view it in their own language.
## How can I change the Default Language?
Find the language you want to make the default from the list and click **"Set Default"**.
![Image]()
## How can I translate a language?
Find the language you want to make the default from the list and click **"Translate"**.
![Image]()
## How can I add a new Language?
Click the **"Add Language"** button and fill in the fields. After adding it, you can translate it.
# Modules
Source: https://docs.leaderos.net/settings/modules
Learn how to configure the Modules of your website.
You can manage the modules of your website by going to the **"Modules"** section of the **Settings** page. Here you can enable or disable modules, and configure their settings.
### Enabling and Disabling Modules
You can enable or disable a module by clicking on the toggle switch next to the module name. When a module is enabled, the switch will be blue, and when it is disabled, the switch will be grey.
# Coinbase
Source: https://docs.leaderos.net/settings/payment-methods/coinbase
This method is only for Coinbase Commerce users. [See the details](https://www.coinbase.com/commerce)
| Settings | Description |
| ------------------------- | ----------------------------------- |
| API Key | Coinbase > Settings > Security |
| Webhook Shared Secret Key | Coinbase > Settings > Notifications |
## How can I get API Credentials?
* Go to Coinbase > Settings > Security to create an API key.
![Image]()
* Go to Coinbase > Settings > Notifications to setup Webhook.
![Image]()
![Image]()
![Image]()
![Image]()
# Cryptomus
Source: https://docs.leaderos.net/settings/payment-methods/cryptomus
| Settings | Description |
| --------------- | ---------------------------------------------------- |
| Merchant ID | Cryptomus > Business > Merchants > Merchant Settings |
| Payment API Key | Cryptomus > Business > Merchants > Merchant Settings |
## How can I get API Credentials?
* Go to **Cryptomus > Business > Merchants > Merchant Settings** to get your **Merchant ID** and **Payment API Key**.
![Image]()
![Image]()
![Image]()
# Payment Methods
Source: https://docs.leaderos.net/settings/payment-methods/index
Learn how to configure payment methods that allow you to monetize your server.
## How to add a payment method?
Go to **Dashboard > Settings > Payment Methods**. Find the payment provider that suits you best and configure it by clicking on the **"Edit"** button. You can add a payment method by providing the following information:
* **Payment Method:** The name of the payment method.
* **Title:** The title that will be displayed to the user.
* **Currency:** The currency that will be used for the payment. If you select a currency that is different from the default currency, the price will be converted to the selected currency.
* **Order:** The order in which the payment method will be displayed.
* **Status:** The status of the payment method. If disabled, the payment method will not be displayed.
## How to configure a payment method?
After enabling the payment method, please provide the necessary data as requested by the payment provider. You can obtain this data, including the API key, by contacting the provider directly.
Once you have this data, you can find detailed information about the integration of the relevant provider in our documentation.
## How to use Tebex as a payment method?
There are two different ways to monetize your server with Tebex on LeaderOS.
### Method 1: Tebex Store Module
Tebex Store module is the fastest and easiest way to monetize with Tebex on LeaderOS. You can find detailed information about the Tebex Store module [here](/integrations/tebex-store).
### Method 2: Tebex Checkout Payment Method
This method is for large servers with high annual revenue. To use this method, you will be reviewed by Tebex and if deemed appropriate, you can use Tebex Checkout. You can find detailed information about the Tebex Checkout payment method [here](/settings/payment-methods/tebex-checkout).
# Manual Payment
Source: https://docs.leaderos.net/settings/payment-methods/manual-payment
You can request users to make payments according to the instructions you have specified using the Manual Payment system. For example, you can write the necessary instructions for local bank transfer in the description of this payment method.
### Example Content
```txt theme={null}
Dear valued customer,
Thank you for choosing our services. To complete your order (Order ID: {order_id}) and ensure a seamless process, please follow the manual payment instructions below:
Payment Method: Bank Transfer
Recipient: [Your Company Name]
Bank: [Your Bank Name]
IBAN: [Example IBAN: XX12 XXXX 1234 5678 9012 3456 7890]
Amount: {price} USD
Important Steps:
- Transfer the Payment: Please initiate a bank transfer for the specified amount to the provided IBAN.
- Include Order ID: In the payment details, ensure to include your Order ID ({order_id}) to correctly link the payment to your order.
Once the payment is successfully completed, kindly open a support ticket by contacting our customer support team or through our online support portal. This will enable us to promptly verify your payment and process your order efficiently.
Thank you for your cooperation. We appreciate your business.
Best regards,
[Your Company Name]
Customer Support Team
```
### How can I complete the order?
When users place an order with Manual Payment, it's set to "Waiting" status. After you've checked and approved the payment, simply click the "Complete Order" button in the Dashboard. This marks the order status as "Successful," and the order will be delivered to the user.
![Image]()
# Mercado Pago
Source: https://docs.leaderos.net/settings/payment-methods/mercado-pago
* Go to **Settings > Payment Methods** page, and fill in the fields.
| Settings | Description |
| ------------ | ---------------------------------------- |
| Access Token | MercadoPaog > Credentials (Checkout Pro) |
| Country | Choose the country of your account. |
## How can I get Access Token?
* Go to Mercado Pago > Credentials to get Access Token for Checkout Pro
* [https://www.mercadopago.com.br/mlb/account/credentials](https://www.mercadopago.com.br/mlb/account/credentials)
Don't forget to activate live mode.
![Image]()
# Mollie
Source: https://docs.leaderos.net/settings/payment-methods/mollie
You can get payments from Paysafecard, Klarna, Apple Pay, GiroPay, iDEAL, and more! [See the list](https://www.mollie.com/growth/payment-methods-guide)
* Go to Settings > Payment Methods page, and fill in the fields.
| Settings | Description |
| ----------- | ------------------------------ |
| **API Key** | Mollie > Developers > API Keys |
## How can I get API credentials?
* Go to Mollie > Developers > API Keys to get API Key
![Image]()
# Paymentwall
Source: https://docs.leaderos.net/settings/payment-methods/paymentwall
* Go to Settings > Payment Methods page, and fill in the fields.
| Settings | Description |
| ----------- | --------------------------- |
| Project Key | Project Settings > Settings |
| Secret Key | Project Settings > Settings |
| Widget ID | Project Settings > Widgets |
## How can I get API Credentials?
* Go to Paymentwall > Project Settings > Settings to get Project Key and Secret Key
![Image]()
![Image]()
Change your Pingback URL and add the Custom Pingback parameter.
Use same name and value! Name: custom, Value: OWN
![Image]()
# PayPal Checkout
Source: https://docs.leaderos.net/settings/payment-methods/paypal-checkout
This method is only for Paypal Business users.
If you are a PayPal Personel user, check [this guide](/payment-methods/paypal)
* Go to `Settings > Payment Methods` page, and fill in the fields.
| Settings | Description |
| :------------------ | ----------------------------- |
| **Client ID** | Client ID of your app. |
| **Client Secret** | Client Secret of your app. |
| **Webhook ID** | Webhook ID of your app. |
| Test Mode (Sandbox) | Only enable it while testing. |
## How can I get API credentials?
* Go to PayPal Developer Dashboard > App & Credentials and Create App
[https://developer.paypal.com/dashboard/applications/live](https://developer.paypal.com/dashboard/applications/live)
#### Get Client ID and Secret
![Image]()
#### Add Webhook and get Webhook ID
![Image]()
![Image]()
![Image]()
# PayPal (Legacy)
Source: https://docs.leaderos.net/settings/payment-methods/paypal-legacy
To receive payments through PayPal, you only need your email address.
* Go to `Settings > Payment Methods` page, and fill in the fields.
| Settings | Description |
| ------------------- | ----------------------------- |
| PayPal Email | Your Email |
| Test Mode (Sandbox) | Only enable it while testing. |
# PayU
Source: https://docs.leaderos.net/settings/payment-methods/payu
* Go to Settings > Payment Methods page, and fill in the fields.
| Settings | Description |
| ------------------ | ---------------------------------- |
| Merchant Key | Payment Gateway > Key Salt Details |
| Merchant Salt (v1) | Payment Gateway > Key Salt Details |
## How can I get Merchant Key and Salt?
* Go to PayU > Payment Gateway to get Merchant Key and Salt.
* [https://payu.in/business/payment-gateway](https://payu.in/business/payment-gateway)
![Image]()
# Stripe
Source: https://docs.leaderos.net/settings/payment-methods/stripe
* Go to Settings > Payment Methods page, and fill in the fields.
| Settings | Description |
| -------------------------- | ------------------------------ |
| **Stripe Publishable Key** | Stripe > Developers > API Keys |
| **Stripe Secret Key** | Stripe > Developers > API Keys |
| **Stripe Webhook Key** | Stripe > Developers > Webhooks |
## How can I get API credentials?
* To access Stripe API information, go to Stripe **Dashboard > Developers > API** Keys page.
* [https://dashboard.stripe.com/apikeys](https://dashboard.stripe.com/apikeys)
* Copy both Publishable Key and Secret Key, then enter it to the required fields in your website.
![Image]()
* We've got all the information required to charge players, but now we must configure the Webhook options.
* To add a Webhook, go to **Stripe Dashboard > Developers > Webhooks** page and press to **"Add Endpoint"** button.
* [https://dashboard.stripe.com/webhooks](https://dashboard.stripe.com/webhooks)
![Image]()
![Image]()
![Image]()
* Our Stripe Webhook Key is now generated. From the Signing Secret section, press the Reveal button and copy the key. Then, paste that into Stripe API Webhook Key field on your website.
![Image]()
# Tebex Checkout
Source: https://docs.leaderos.net/settings/payment-methods/tebex-checkout
Accept payments worldwide without chargeback hassles!
Tebex Checkout has 2 requirements for eligibility and use:
* Your business must have a minimum revenue of \$60,000 over the last 12 months.
* Your business is registered in the US/UK/EU/Israel Regions.
If you not meet these requirements, you can use [Tebex Store](/integrations/tebex-store) instead.
Please remember that Tebex Store and Tebex Checkout are different systems. Before using Tebex Checkout, make sure to create a Tebex Checkout project on Tebex.
[https://creator.tebex.io/webstores/tebex-checkout/create](https://creator.tebex.io/webstores/tebex-checkout/create)
Go to **Settings > Payment Methods** page, and fill in the fields.
| Settings | Description |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Username | Tebex Checkout Username [https://creator.tebex.io/payment-methods/settings](https://creator.tebex.io/payment-methods/settings) |
| API Key | Tebex Checkout API Key [https://creator.tebex.io/payment-methods/settings](https://creator.tebex.io/payment-methods/settings) |
| Secret Key | Webhook Secret Key [https://creator.tebex.io/webhooks/endpoints](https://creator.tebex.io/webhooks/endpoints) |
## How can I setup Tebex Checkout?
1. Go to [Tebex > Payments > Checkout Settings](https://creator.tebex.io/payment-methods/settings)
2. Find Checkout API Key section and copy to clipboard your **"Username"** and **"API Key"**.
3. Go to [Tebex > Integrations > Webhooks > Endpoints](https://creator.tebex.io/webhooks/endpoints)
4. Copy the "Secret Key".
![Images]()
5. Enter the copied Username, API Key, and Secret Key into Dashboard > Payment Settings > Tebex Checkout page, and click the "Save Changes" button. **Do not proceed to the next step without saving these changes!**
6. Now, you need to setup Webhook to process payments. Click the **"Add Endpoint"** on Webhook Endpoints page.
7. Enter your Endpoint URL and check the "Payment Completed" type. **Please replace "yourwebsite.com" with your actual website address.**
* **Endpoint URL:** `https://yourwebsite.com/callback/tebex_checkout`
* **Webhook Types:** `Payment Completed`
![Images]()
# SEO Configuration
Source: https://docs.leaderos.net/settings/seo
The SEO Settings page allows you to optimize the SEO parameters for each individual page on your website.
On the left side, you can select the desired page, and on the right, you can customize the following inputs:
* **Title:** Define a concise and impactful title for the selected page. This title serves as the main heading that appears in search engine results.
* **Description:** Craft a brief and informative description of the content on the selected page. This description provides a summary that may appear in search engine snippets.
* **Image:** Specify an image relevant to the content of the selected page. This image can enhance the visual appeal and attractiveness when shared on social media platforms or in search results.
Optimizing these SEO settings for each page contributes to improved visibility and search engine ranking for your website.
# SMTP (Mail)
Source: https://docs.leaderos.net/settings/smtp
Through SMTP, you can use some features such as Email Confirmation, Password Reset, Purchase Emails.
SMTP settings must be configured to send emails. Otherwise you cannot use features and modules that use the SMTP system.
**The SMTP settings page allows you to configure the parameters necessary for your email sending functionality. Below are the input fields with brief explanations of their purposes:**
* **SMTP Server:** Enter the address of your SMTP (Simple Mail Transfer Protocol) server. This is the server responsible for sending your emails.
* **SMTP Port:** Specify the port number used by your SMTP server. Common values include 25, 587, and 465, depending on the security configuration.
* **SMTP Security (SSL/TLS):** Choose the security protocol for your SMTP connection. Options include SSL (Secure Sockets Layer) or TLS (Transport Layer Security) to encrypt the communication between your server and the SMTP server.
* **SMTP Sender Email Address:** Provide the email address from which your system will send emails. This is the address that will appear as the sender of the emails.
* **SMTP Username:** Enter the username associated with the SMTP server. This is used to authenticate your server with the SMTP server. Usually, this is the same as the email address.
* **SMTP Password:** Enter the password associated with the SMTP server. This ensures secure access to the SMTP server for sending emails.
* Ensure the accuracy of these settings to enable seamless communication with your SMTP server for effective email delivery.
If you're looking for a free SMTP service compatible with the provided SMTP settings, here are a few recommendations:
* **LeaderOS Web Hosting SMTP Service (Recommended!)**
* SendPulse
* Zoho Mail
* Yandex Mail
* Godaddy Email
## How can I setup/configure LeaderOS Web Hosting SMTP service?
1. Log in to your cPanel.
![Image]()
2. Go to **cPanel > Email > Email Accounts** and click on the **Create** button.
![Image]()
3. Create an email account. For example: [noreply@yourdomain.com](mailto:noreply@yourdomain.com)
![Image]()
4. Go to **Dashboard > Settings > SMTP** and enter SMTP settings.
![Image]()
5. You can test the connection by clicking on the "Check Connection" button.
![Image]()
If you are using an external DNS service, like Cloudflare, you must add DKIM, SPF and MX records. [How to add DKIM and SPF records to Cloudflare?](/settings/smtp#how-to-add-dkim-and-spf-records-to-cloudflare)
### LeaderOS Web Hosting SMTP Values:
* **SMTP Server:** Your cPanel hostname. `(Example cpanel-de-c1.leaderos.net)`
* **SMTP Port:** `465`
* **SMTP Security:** `SSL`
* **SMTP Sender Email Address:** The Email address you created. `(Example noreply@yourdomain.com)`
* **SMTP Username:** The same email as the "Sender Email Address". `(Example noreply@yourdomain.com)`
* **SMTP Password:** The password you set for the email account.
### How to add DKIM and SPF records to Cloudflare?
1. Login to your cPanel.
![Image]()
2. Go to **cPanel > Domains > Zone Editor > Manage**
![Image]()
3. Find and copy the SPF record. The SPF value starts with **"v=spf1"**.
![Image]()
4. Find and copy the DKIM record. The DKIM value starts with **"v=DKIM1;"**.
![Image]()
5. Go to **Cloudflare > DNS** and add **SPF, DKIM and MX** records by clicking on the **Add Record** button.
**To add SPF record:**
* Type: TXT
* Name: @
* Content: SPF value you copied.
![Image]()
**To add DKIM record:**
* Type: TXT
* Name: default.\_domainkey
* Content: DKIM value you copied.
![Image]()
**To add MX record:**
* Type: MX
* Name: @
* Content: Your cpanel hostname. `(Example cpanel-de-c1.leaderos.net)`
![Image]()
6. Your DNS records should look like this.
![Image]()
# System Settings
Source: https://docs.leaderos.net/settings/system
Learn how to configure the system settings of your website.
You can configure the following system settings for your website:
* **Timezone:** Set the timezone for your website. This will be used to display the correct time on your website.
* **Update Notification:** Enable or disable the update notification for your website.
* **DEBUG Mode:** Enable or disable the debug mode for your website. This is useful for debugging purposes.
* **Allow Custom Avatar Upload:** Enable or disable the option for users to upload custom avatars. If enabled, users will be able to upload their own avatars. If disabled, users will have default avatars.
* **Email Change Verification:** Enable or disable email change verification for users. If enabled, users must confirm the email change from their existing email address before they can use the new email address.
* **Avatar API:** Choose the API to use for fetching avatars. You can change this setting if your current API is not working.
* **Online API:** Choose the API to use for fetching number of online on your server. You can change this setting if your current API is not working.
* **Password Hashing:** Choose the hashing algorithm to use for hashing passwords. We currently support `bcrypt`, `md5` and `sha256`.
* **HTTPS Redirect (SSL):** Enable or disable HTTPS redirect for your website. If enabled, all requests to your website will be redirected to HTTPS. Do not enable this feature if you do not have an SSL certificate installed on your server or if you are using Cloudflare SSL.
* **Maintenance Mode:** Enable or disable maintenance mode for your website. If enabled, your website will be in maintenance mode and only administrators will be able to access it.
* **Registration:** Enable or disable registration for your website. If disabled, users will not be able to register on your website.
* **Force Default Language:** Enable or disable the force default language for your website. If enabled, the default language will be used for all visitors. It is recommended to enable this feature if you only provide services in one language.
* **Credit Packages:** Enable or disable credit packages for your website. If enabled, users will be able to purchase credits as a package. Learn more about credit packages [here](/using-leaderos/store/credit-packages).
* **Only allow purchases with Credits:** Enable or disable the option to purchase items only with credits. If enabled, users will have to purchase credits before they can purchase items from the store.
* **Remove .00 from money:** Enable or disable the option to remove `.00` from money. If enabled, `.00` will be removed from money values. For example, `10.00` will be displayed as `10`.
* **Credit Text:** Set the text to display for credits on your website. This text will be displayed on the website wherever credits are mentioned. If you leave this field empty, the default text `credit(s)` in translated language will be used.
* **Players Can Send Credits to Each Other:** Enable or disable the option for players to send credits to each other. If enabled, players will be able to send credits to each other.
* **Players Can Send Gifts to Each Other:** Enable or disable the option for players to send gifts to each other. If enabled, players will be able to send gifts to each other.
* **Bestseller Products:** Enable or disable the option to show bestseller products on the store.
* **Featured Products:** Enable or disable the option to show featured products on the shopping cart. It is recommended to enable this feature if you want to promote specific products.
* **Store Redirection:** Enable or disable the option to redirect users to external store links. For example, if you have a store on another website like Tebex, you can redirect users to that store when they click on the store link.
* **Cashback:** Enable or disable the option to give cashback to users when they purchase items from the store. If enabled, users will receive a percentage of the purchase amount as cashback. Cashback will be added to the user's account as credits.
* **Bazaar Commission:** This will be the commission you will take from the player bazaar sales. For example, if you set the commission to 10%, players who sell an item for 100 credits will receive 90 credits after the sale. A commission of 10 credits will be burned.
* **Show Terms Checkbox in Checkout:** Enable or disable the option to show terms checkbox in the checkout page. If enabled, users will have to agree to the terms and conditions before they can purchase items from the store.
* **Allow Comments:** Enable or disable comments for your website. If disabled, users will not be able to comment on all existing and new posts.
* **Bonus Credit:** Enable or disable the option to give bonus credits to users when they purchase credits. If enabled, users will receive a percentage of the purchase amount as bonus credits. Bonus credits will be added to the user's account as credits. For example, if you set the bonus credit to 10, users who purchase 100 credits will receive 10 bonus credits.
* **Minimum Payment Amount:** Set the minimum payment amount for your website. If the total amount is less than the minimum payment amount, users will be unable to make purchases from the store.
* **Maximum Payment Amount:** Set the maximum payment amount for your website. If the total amount is more than the maximum payment amount, users will be unable to make purchases from the store.
* **Register Limit:** Set the maximum number of registrations per IP address. If the number of registrations exceeds the limit, users will be unable to register on your website.
* **Maximum Active Support Tickets Allowed:** Set the maximum number of active support tickets allowed per user. If the number of active support tickets exceeds the limit, users will be unable to create new support tickets.
* **Username Validation Pattern:** Set a regular expression (regex) to define the format allowed for usernames. For example, `^[a-zA-Z0-9_]{3,16}$` specifies that usernames can only contain letters, numbers, and underscores and must be between 3 and 16 characters long. By editing this value, you can make it compatible with systems like GeyserMC. [How to allow usernames with `*` for GeyserMC](/faq#how-to-allow-usernames-with-for-geysermc)
# Updates
Source: https://docs.leaderos.net/settings/updates
Learn how to update your website or theme.
### How to update your website?
To update your website, go to **Dashboard > Settings > Updates**. If there is a new version available, you will see an update button. Click on the button to update your website.
If you sure that there is a new version available but you don't see the update button, you can try to check for updates manually. To do that, click on the **"Check for Updates"** button.
### How to disable update notifications?
If you don't want to see the update notifications, go to **Dashboard > Settings > System Settings** and disable the **"Update Notifications"** option.
### How to see the changelog?
Go to **Dashboard > Settings > Updates**, you will see the changelogs in the **Changelog** section.
### How to check for updates?
The last version check is cached for 24 hours. If you want to check for updates manually, you can click on the **"Check for Updates"** button.
### How to update your theme?
After you updating your website, you may also need to update your theme. To update your theme, go to **Dashboard** > **Appearance** > **Themes**. If there is a new version available, you will see an update button. Click on the button to update your theme.
# System Requirements
Source: https://docs.leaderos.net/system-requirements
In the below, you can see the system requirements for running the LeaderOS. Please make sure that your server meets the requirements before installing the LeaderOS. If you have any questions, please contact us via the support page.
Currently, LeaderOS is **not compatible with PHP 8**. We are working on it and will release a new version as soon as possible.
## Requirements
* PHP 7.4
* MySQL >= 5.6 (MariaDB v10 Recommended)
* Ioncube Loader 10 (PHP extension)
* pdo (PHP extension)
* zip (PHP extension)
* json (PHP extension)
* curl (PHP extension)
* mbstring (PHP extension)
* fileinfo (PHP extension) (Optional)
* eval() function must be enabled
* max\_input\_vars (php.ini settings) must be at least 10000
* allow\_url\_fopen (php.ini settings) must be enabled
* upload\_max\_filesize (php.ini settings) must be at least 64M
* post\_max\_size (php.ini settings) must be at least 64M
## Recommended "php.ini" Settings
```ini theme={null}
allow_url_fopen=On
short_open_tag=On
upload_max_filesize=128M
post_max_size=128M
max_input_vars=10000
memory_limit=512M
max_execution_time=600
max_input_time=600
```
## Recommended Hosts
LeaderOS can be hosted on any shared hosting for your budget.
Alternatively, you can use our budget friendly hosting service for full compatibility, high performance and super fast support.
* [LeaderOS Hosting](https://www.leaderos.net/account/web-hosting) (100% Compatible)
* Namecheap
# Account Linking
Source: https://docs.leaderos.net/using-leaderos/account-linking
Enable users to link third-party accounts such as Discord, Steam, and more.
## How can I enable account linking on my website?
To enable Account Linking, follow these steps:
1. Go to **Dashboard > Settings > Modules** and enable the Account Linking module.
![Image]()
2. In **Dashboard > Settings > Account Linking**, you can select which providers you want to allow.
![Image]()
3. Users can now link their accounts using the providers you enabled from the **Profile > Linked Accounts** page.
![Image]()
4. Users can also log in using the accounts they have linked.
![Image]()
## Which providers does the Account Linking module support?
* Discord
* Steam
* Minecraft
* Xbox
* Cfx.re
* Roblox
* In-Game Verification
## Using Linked Accounts in the Store
You can make account linking mandatory when a player purchases a product from your store. This allows you to obtain new variables related to the user. For example, on an Online Mode Minecraft server, you can require the user to link their Minecraft account to access the UUID of the linked Minecraft account and use this variable during command execution.
To do this, follow these steps:
1. Ensure the Account Linking module is enabled.
2. Create or edit a product from **Dashboard > Store > Products**.
* In the Restrictions section, select the required account providers for "Required Linked Accounts". The user will not be able to purchase the product without linking the selected accounts.
![Image]()
* When you select these providers, you will see new variables in your "Variables" table. These variables contain information about the linked accounts. For example, if you require linking a Minecraft account, you can use the UUID of the linked Minecraft account (%minecraft\_uuid%) during command execution.
![Image]()
# Announcements
Source: https://docs.leaderos.net/using-leaderos/announcements
You can share important announcements about your server updates.
### How to add Announcements?
Go to **Dashboard > Misc > Announcements > Add New**. You can add a new announcement by providing the following information:
* **Title**: The title of the announcement.
* **Link**: The link to redirect when the announcement is clicked.
![Image]()
### How to disable Announcements?
Go to **Dashboard > Settings > Modules** and disable the Announcements module.
# Ban Management
Source: https://docs.leaderos.net/using-leaderos/ban-management
You can block players from the site, support and comments temporarily/lifetime.
## Banning Options
There are multiple options to ban a user:
* **Banning from Website:** If you ban a user from the website, the user loses access to the website.
* **Banning from Support:** If you ban a user from the support tickets, the user will not be able to create or reply to support tickets anymore.
* **Banning from Comments:** If you ban a user from the comments, the user will not be able to send replies to blog posts.
## How can I ban a user?
Go to Dashboard > Ban > Ban User page.
* **Username:** The username of the player you want to ban.
* **Category:** The user will be banned from the selected category.
* **Reason:** The reason for the ban. You can choose one of the predefined categories.
* **Duration:** You can ban the user permanently or temporarily.
# Categories
Source: https://docs.leaderos.net/using-leaderos/blog/categories
Organize your blog posts by category.
### How to create a category?
Go to **Dashboard > Content Management > Blog > Categories > Add New**. You can add a blog category by providing the following information:
* **Title:** The name of the category.
### How to assign a category to a blog post?
Go to **Dashboard > Content Management > Blog > Posts**. Click on the post you want to assign a category to. In the post editor, you can assign a category by selecting it from the **Category** section.
# Blog Comments
Source: https://docs.leaderos.net/using-leaderos/blog/comments
Players can leave comments on blog posts to share their thoughts and feedback.
### How does the blog comments feature work?
Users can leave comments on blog posts to share their thoughts and feedback. First, the user must be logged in to leave a comment. Once logged in, the user can scroll to the bottom of the blog post and type their comment in the text box. After typing the comment, the user can click the "Post Comment" button to submit the comment. However, the comment will not be visible until it has been approved by staff.
### How do I approve comments?
To approve comments, staff members can navigate to **Dashboard > Content Management > Blog > Comments**. From there, staff members can view all pending comments and choose to approve or reject them. Approved comments will be visible on the blog post for all users to see.
### Can I delete comments?
Yes, staff members can delete comments if necessary. To delete a comment, staff members can navigate to **Dashboard > Content Management > Blog > Comments** and click the "Delete" button next to the comment they wish to remove.
### Can I disable comments on a blog post?
Yes, staff members can disable comments on a blog post if necessary. To disable comments, staff members can navigate to **Dashboard > Content Management > Blog > Posts** and click the "Edit" button next to the blog post they wish to modify. From there, staff members can uncheck the **"Allow Comments"** checkbox to disable comments on that blog post.
# Posts
Source: https://docs.leaderos.net/using-leaderos/blog/posts
Share server updates, news, and cool stuff with ease. Stay connected with your players and come together in the comments!
Blog Posts are important for SEO. It helps to increase the visibility of your website on search engines.
### How to create a blog post?
Go to **Dashboard > Content Management > Posts > Add New**. You can add a blog post by providing the following information:
* **Title:** The title of the blog post.
* **Category:** The category of the blog post.
* **Content:** The content of the blog post. You can use HTML tags to format the content.
* **Allow Comments:** You can enable or disable comments on the blog post.
* **Tags:** The tags of the blog post. You can add tags by typing a tag name and pressing the `Enter` key. Also you can remove a tag by clicking on the tag.
* **Image:** The image that will be displayed as the featured image of the blog post.
Before creating a post, you need to create a category. You can create a category by going to **Dashboard > Content Management > Blog > Categories > Add New**.
### How to see the post on your website?
After creating a post, you can see it on **Dashboard > Content Management > Posts**. You can click on the **"View"** button to see the post on your website.
# Changelog
Source: https://docs.leaderos.net/using-leaderos/changelog
Share changelog with your players and keep them informed about the updates.
### Using Changelog
1. Enable the Changelog module from **Dashboard > Settings > Modules**.
![Image]()
2. Create/edit update tags from **Dashboard > Content Management > Changelog > Tags**.
* **Name:** Tag name
* **CSS:** You can write custom CSS for the tag and change its design.
![Image]()
3. Add update notes from **Dashboard > Content Management > Changelog > Add New**.
* **Title:** Title of the update note
* **Content:** Details of the update content. You can add multiple notes here.
* **Tag:** Specify which tag the update note belongs to, such as Fix, New, Improvement.
* **Content:** Explain the update note in detail. Supports HTML.
![Image]()
![Image]()
### Adding Changelog link to Header Menu
Click the "Add New Item" button on the **Dashboard > Appearance > Header Menu** page. In the window that opens, select "Changelog" as the "Page Type" and click the "Add" button.
![Image]()
# Cookie Consent (GPSR)
Source: https://docs.leaderos.net/using-leaderos/cookie-consent
With GPDR compliant Cookie Consent Banner, you can inform your visitors about legal requirements and ask for their consent.
### How to enable Cookie Consent Banner?
Go to **Dashboard > Settings > Modules** and enable the **Cookie Consent** module.
![Image]()
![Image]()
# Credits
Source: https://docs.leaderos.net/using-leaderos/credits
Enable using credits on your website. Your players can buy credits and use them on your website.
### How does Credits work?
Credits are a virtual currency that users can use to buy items on your website. You can enable Credits on your website and allow users to buy credits using real money.
You can also enable Cashback, which allows users to get a percentage of the credits they spent back.
Users can also send credits to other users.
### How to disable credits?
Go to **Dashboard > Settings > Modules**. Find the **Credits** module and click on the **Enable/Disable** button.
### How to force purchases to be paid only with credits?
Go to **Dashboard > Settings > System Settings**. Find the **"Only allow purchases with Credits"** setting and enable it.
### How to enable Credit Packages?
Credit Packages are predefined packages that users can buy. Go to **Dashboard > Settings > System Settings**. Find the **"Credit Packages"** setting and enable it. Then, go to **Dashboard > Store > Credit Packages** and create your packages. Learn more about Credit Packages [here](/using-leaderos/store/credit-packages).
### How to enable cashback?
Cashback is a feature that allows users to get a percentage of the credits they spent back. Go to **Dashboard > Settings > System Settings**. Find the **"Cashback"** setting and enable it. Then, go to **Dashboard > Store > Cashback** and create your cashback rules.
### How to disable sending credits?
Go to **Dashboard > Settings > System Settings**. Find the **"Players Can Send Credits to Each Other"** setting and disable it.
### How to send credits to a user?
Go to **Dashboard > User Management > Actions > Send Credits**. You can send credits to a user by providing the following information:
* **Username:** The username of the user you want to send credits to.
* **Amount:** The amount of credits you want to send.
* **Is Earnings?:** If you want to send earnings to the user, enable this option. If you enable this option, the amount will appear as earnings in the statistics.
# Custom Forms
Source: https://docs.leaderos.net/using-leaderos/custom-forms
Create custom forms (e.g. Contact) and collect data from your users with ease.
### How to create a custom form?
You can create a custom form on **Dashboard > Forms > Custom Forms > Add New**.
* **Title:** The title of the form.
* **Description:** The description of the form. You can use HTML tags to format the description.
* **Questions:** You can add questions to the form. You can add the following types of questions:
* **Short Text:** A single line text input.
* **Long Text:** A multi-line text input.
* **Single-Select:** A single-select dropdown. You can add options by separating them with a comma.
* **Multi-Select:** A multi-select dropdown. You can add options by separating them with a comma.
**Example to create a Contact Form:**
![Image]()
### How to see the custom form on your website?
After creating a custom form, you can see it on **Dashboard > Forms > Custom Forms**. You can click on the **"View"** button to see the form on your website.
### How to add a custom form to Header Menu?
After creating a custom form and copying the URL, you can add it to the Header Menu on **Dashboard > Appearance > Header**.
### How to see the data collected from custom forms?
You can see the data collected from custom forms on **Dashboard > Forms > Submissions**.
# Custom Page
Source: https://docs.leaderos.net/using-leaderos/custom-pages
Create custom pages with using HTML editor.
### How to create a custom page?
Go to **Dashboard > Content Management > Pages > Add New**. You can add a custom page by providing the following information:
* **Title:** Enter the title of the page.
* **Slug:** Enter the slug of the page. It will be used in the URL. For example, if you enter `about-us`, the URL of the page will be `https://yourdomain.com/about-us`.
* **Content:** You can add the content of the page using the HTML editor.
### How to see the custom page on your website?
After creating a custom page, you can see it on **Dashboard > Content Management > Pages**. You can click on the **"View"** button to see the page on your website.
### How to hide the custom page?
You can hide the custom page by clicking on the **"Edit"** button and changing the **Is Active?** status to **No**.
### How to add a custom page to Header Menu?
After creating a custom form and copying the URL, you can add it to the Header Menu on **Dashboard > Appearance > Header**.
# Custom Profile Fields
Source: https://docs.leaderos.net/using-leaderos/custom-profile-fields
Add custom fields for user profiles.
### How to add custom field?
Go to **Dashboard > User Management > Custom Fields**. You can add a custom field by providing the following information:
* **Name:** The name of the custom field.
* **Description:** A short description of the custom field.
* **Type:** The type of the custom field. You can choose from the following types:
* **Text:** A single line text field.
* **Number:** A number field.
* **Is Public:** Whether the custom field is public or not. If the custom field is public, it will be visible to all users. If the custom field is not public, it will only be visible to the user itself and staff.
* **Is Required:** Whether the custom field is required or not. If the custom field is required, the user will have to provide a value for it when creating or updating their profile.
![Image]()
![Image]()
# Download Center
Source: https://docs.leaderos.net/using-leaderos/download-center
Upload your files to the download center and share them with your users.
### How to add a file to the download center?
Go to **Dashboard > Misc > Download Center > Add New**.
You can add a file by providing the following information:
* **Name**: The name of the file.
* **Download URL**: The URL of the file.
* **Description**: A short description of the file. You can use HTML tags in the description.
# Email Verification
Source: https://docs.leaderos.net/using-leaderos/email-verification
Email verification is a feature that allows users to verify their email address before they can use it on your website. This feature is useful for preventing spam and ensuring that users provide a valid email address.
## How to enable Email Verification?
Enable the email verification module on **Dashboard > Settings > Modules**. Then, go to **Dashboard > Settings > SMTP** to configure the SMTP settings. [Learn more about SMTP settings](/settings/smtp).
# Categories
Source: https://docs.leaderos.net/using-leaderos/forum/categories
Organize your forum with categories. You can create categories, subcategories, and nest them as deep as you want.
### How to create a category?
Go to **Dashboard > Content Management > Forum > Categories > Add New**. You can add a forum category by providing the following information:
* **Name:** The name of the category.
* **Description:** A short description of the category. You can use HTML in the description.
* **Parent Category:** If you want to create a subcategory, select the parent category here.
* **Order:** The order of the category. The category with the lowest order will be displayed first.
* **Icon/Image:** You can upload an icon for the category. The icon will be displayed on the forum page.
* **Forum Permissions:** You can set permissions for each role. You can set permissions for viewing the forum, creating threads, creating replies, and moderating the forum.
### How to set permissions for a category?
To set permissions for a category, go to **Dashboard > Content Management > Forum > Categories**. Edit the category you want to set permissions for. You can set permissions for each role. Here are the permissions you can set for a category:
* **Can view forum?**: If you disable this, users in this role won't be able to view the category.
* **Can create threads?**: If you disable this, users in this role won't be able to create topics in this category.
* **Can create replies?**: If you disable this, users in this role won't be able to reply to threads in this category.
* **Can moderate forum?**: If you enable this, users in this role will be able to moderate threads in this category. It means they have full control over the threads in this category.
Guests are users who are not logged in. You can set permissions for guests as well, but they can't create threads or reply to threads. They can only view the threads.
![Image]()
# Threads
Source: https://docs.leaderos.net/using-leaderos/forum/threads
Your players can chat and discuss topics within the different categories you create. Also, don't forget to decorate your user flags with the custom roles!
Forum allows your players to create threads and share their ideas with each other. You can create multiple categories and subcategories within the forum. Additionally, you can view latest threads, replies and online members on the sidebar.
### How does the forum work?
**Threads:** Threads are the main topics of discussion. Players can create threads within the categories you create.
**Replies:** Players can reply to threads to share their thoughts and ideas.
**Categories:** Categories are the main sections of the forum. You can create multiple categories and subcategories within the forum.
**Locking Threads:** You can lock threads to prevent users from posting new replies.
**Pinning Threads:** You can pin threads to keep them at the top of the category.
After creating a category, users can create threads within that category. Users can also reply to threads created by other users.
You can set permissions for each category. You can set permissions to allow only certain roles to view, create threads, and reply to threads within a category.
### How to set permissions for a category?
Learn more about setting permissions for a category [here](/using-leaderos/forum/categories).
### How to pin a thread?
Pinning a thread will keep it at the top of the category. To pin a thread, click on the **Pin** button at the top of the thread.
### How to lock a thread?
Locking a thread will prevent users from posting new replies to the thread. To lock a thread, click on the **Lock** button at the top of the thread.
### How to design role badges?
You can design role badges to display custom roles for your users. To design role badges, go to **Dashboard > User Management > Roles**. Click on the **Edit** button next to the role you want to design a badge for. You can change the **Badge CSS** to design the role badge.
You can find an example role badge CSS code [here](/using-leaderos/roles#example-css-code-for-a-role).
![Image]()
### How to change username styles?
You can change the username styles to display custom roles for your users. To change username styles, go to **Dashboard > User Management > Roles**. Click on the **Edit** button next to the role you want to change the username style for. You can change the **Username CSS** to change the username style.
You can find an example username CSS code [here](/using-leaderos/roles#example-css-code-for-a-role).
![Image]()
### How to design avatar borders?
You can design avatar borders to display custom roles for your users like Hypixel forum. To design avatar borders, go to **Dashboard > Appearance > Custom CSS**. You can add the following CSS code to add an avatar frame to a role:
Please replace `ROLE_ID` with the role class you want to add the avatar frame to. To find the role id of a role, go to **Dashboard > User Management > Roles** and click the **"Edit"** button next to the role.
```css theme={null}
.avatar-ROLE_ID {
position: relative;
width: 74px;
height: 74px;
display: inline-block;
}
.avatar-ROLE_ID::after {
content: '';
position: absolute;
top: -5px;
left: -5px;
right: -5px;
bottom: -2px;
background: url('https://hypixel.net/styles/hypixel-v2/images/avatar-frames/vip.png') no-repeat center center;
background-size: cover;
z-index: 2;
}
```
![Image]()
# Gamemodes
Source: https://docs.leaderos.net/using-leaderos/games
An important page for HUB servers where you can inform your players about the games on your server.
### How to add a gamemode?
Go to **Dashboard > Misc > Gamemodes > Add New**. You can add a slide by providing the following information:
* **Title**: The title of the gamemode.
* **Content**: A brief description of the gamemode.
* **Image**: A thumbnail image of the gamemode.
![Image]()
![Image]()
# Articles
Source: https://docs.leaderos.net/using-leaderos/help-center/articles
Help your players find problem solutions with the articles you have prepared on your website.
### How to create an article?
Go to **Dashboard > Support & Help > Articles > Add New**. You can add an article by providing the following information:
* **Title:** The title of the article.
* **Topic:** The topic of the article.
* **Content:** The content of the article. You can use HTML tags to format the content.
* **Order:** The order of the article in the list.
Before creating an article, you need to create a topic. You can create a topic on **Dashboard > Support & Help > Topics > Add New**.
### How to see the article on your website?
After creating a article, you can see it on **Dashboard > Support & Help > Articles**. You can click on the **"View"** button to see the article on your website.
### How to see feedbacks on the article?
You can see the feedbacks on the article on **Dashboard > Support & Help > Articles**. Helpfulness percentage is calculated by the number of likes and dislikes. Values are shown as Like/Dislike in the list.
# Topics
Source: https://docs.leaderos.net/using-leaderos/help-center/topics
Organize your Help Center articles by topics. Topics are like categories or tags that help your users find the information they need.
### How to create a topic?
Go to **Dashboard > Support & Help > Topics > Add New**. You can add a topic by providing the following information:
* **Title:** The title of the topic.
* **Order:** The order in which the topic should appear in the list of topics.
* **Description:** A brief description of the topic. You can use HTML tags to format the content.
* **Image/Icon:** An image or icon that represents the topic.
### How to see the topic on your website?
After creating a topic, you can see it on **Dashboard > Support & Help > Topics**. You can click on the **"View"** button to see the topic on your website.
### How to assign an article to a topic?
While creating or editing an article, you can assign it to a topic by selecting the topic in the **Topic** section.
# Leaderboards
Source: https://docs.leaderos.net/using-leaderos/leaderboards
Player statistics are taken from the databases you add and sorting is done. Players can search in leaderboard.
### What are the supported plugins for the leaderboard?
We exclusively offer support for MySQL databases at present. Furthermore, the functionality does not extend to relational tables. As an illustration, it does not accommodate scenarios where user and statistics data are stored in separate tables.
We recommend you to use the leaderboard module with [AjLeaderBoards](https://www.spigotmc.org/resources/ajleaderboards.85548/) plugin.
### How to create a leaderboard with AjLeaderBoards data?
1. Install the AjLeaderBoards plugin on your server. Learn more about the plugin [here](https://wiki.ajg0702.us/ajLeaderboards/).
2. Connect the plugin to the database you created. Open the **cache\_storage.yml** file in the AjLeaderBoards plugin folder. Change the method to `mysql` and enter your database information.
```yaml theme={null}
method: mysql
# You only need to touch these settings if you are using mysql
ip: MYSQL_SERVER_IP:3306
username: MYSQL_USERNAME
password: MYSQL_PASSWORD
database: MYSQL_DATABASE
```
3. Have your players data by using the /ajlb add %placeholder% command on AjLeaderBoards plugin.
4. Go to **Dashboard > Misc > Leaderboards > Add New**. You can add a new leaderboard by providing the following information:
* **Title:** Enter the title of the leaderboard.
* **MySQL Server IP:** Enter the IP address of the MySQL server.
* **MySQL Server Port:** Enter the port of the MySQL server. (Default: 3306)
* **MySQL Database Name:** Enter the name of the MySQL database.
* **MySQL Username:** Enter the username of the MySQL database.
* **MySQL Password:** Enter the password of the MySQL database.
* **MySQL Table Name:** Enter the table name created by AjLeaderBoards plugin. Usually starts with `ajlb_`. You can find the table name in the MySQL database.
* **MySQL Username Column:** `namecache`
* **MySQL Sorter Column:** `value`
* **Data Limit:** You can choose how many data you want to show on the leaderboard.
* **Table Columns:** You can add the columns you want to show on the leaderboard.
* **Title:** Enter the title of the column.
* **Database Column Name:** `value`
ajLeaderboards does not save data for OP players in MySQL. Therefore, the data of OP players will not be shown on the leaderboard. If you testing the ajLeaderboards plugin, deop yourself.
![Image]()
![Image]()
![Image]()
### How to create a leaderboard with other plugins data?
Firstly, check if the plugin you are using supports MySQL databases. If the plugin supports MySQL databases, you can create a leaderboard by following the steps below:
1. Create a MySQL database.
2. Connect your plugin to the database. You can connect your plugin to the database by changing the configuration file of the plugin.
3. Add the data of your players to the database.
4. Go to **Dashboard > Misc > Leaderboards > Add New**. You can add a new leaderboard by providing the following information:
* **Title:** Enter the title of the leaderboard.
* **MySQL Server IP:** Enter the IP address of the MySQL server.
* **MySQL Server Port:** Enter the port of the MySQL server. (Default: 3306)
* **MySQL Database Name:** Enter the name of the MySQL database.
* **MySQL Username:** Enter the username of the MySQL database.
* **MySQL Password:** Enter the password of the MySQL database.
* **MySQL Table Name:** Enter the table name created by the plugin. You can find the table name in the MySQL database.
* **MySQL Username Column:** Enter the column name that stores the player's username.
* **MySQL Sorter Column:** Enter the column name that stores the player's statistics.
* **Data Limit:** You can choose how many data you want to show on the leaderboard.
* **Table Columns:** You can add the multiple columns you want to show on the leaderboard by clicking the **Add Column** button.
* **Title:** Enter the title of the column.
* **Database Column Name:** Enter the MySQL table column name that stores the player's statistics.
![Image]()
![Image]()
![Image]()
# Bazaar Logs
Source: https://docs.leaderos.net/using-leaderos/logs/bazaar-logs
Learn how to use the Bazaar Logs.
The following data is stored about the logs:
* **User**: The user who performed the action.
* **Item**: The item that was affected by the action.
* **Price:** The price of the item.
* **Status**: The status of the item. Available types are: `Sell`, `Buy`.
* **IP Address**: The IP address of the user who performed the action.
* **Date**: The date and time the action was performed.
# Chest Logs
Source: https://docs.leaderos.net/using-leaderos/logs/chest-logs
Learn how to view and manage the logs of the Chest module.
The following data is stored about the logs:
* **User**: The user who performed the action.
* **Product**: The product that the user performed the action on.
* **Category**: The category of the product.
* **Action**: The action performed by the user.
* **Delivery**: The user has delivered the product.
* **Gift to User**: The user has received the product as a gift from another user.
* **Gift from User**: The user has gifted the product to another user.
* **IP Address**: The IP address of the user who performed the action.
* **Date**: The date and time the action was performed.
Click the **"View"** button if you want to see the products delivery details.
# Command Logs
Source: https://docs.leaderos.net/using-leaderos/logs/command-logs
Learn how to view and manage command logs.
The following data is stored about the logs:
* **Command**: The specific command that was executed.
* **Server**: The server where the command was run.
* **Identifier**: The identifier indicating which user the command was sent for (for example, username).
* **Type**: The type associated with the command (for example, order, account linking reward, etc.).
* **Status**: The status of the command
* **Success**: The command was sent successfully.
* **Failed**: An error occurred while sending the command.
* **Sending**: The command is in the process of being sent. If it cannot be sent within 1 minute, it is marked as "Timeout".
* **Timeout**: The command timed out while being sent.
* **Pending**: The command is queued and waiting to be sent.
* **Date**: The date and time the command was sent.
Failed or timed-out commands can be retried by clicking the "Resend" button.
# Coupon Logs
Source: https://docs.leaderos.net/using-leaderos/logs/coupon-logs
Learn how to view and manage coupon logs.
The following data is stored about the logs:
* **User**: The user who used the coupon.
* **Coupon**: The coupon code used.
* **IP Address**: The IP address of the user who used the coupon.
* **Date**: The date and time the coupon was used.
# Creator Code Logs
Source: https://docs.leaderos.net/using-leaderos/logs/creator-code-logs
Learn how to view and manage creator code logs.
The following data is stored about the logs:
* **User**: The user who used the creator code.
* **Creator**: The creator who created the code.
* **Code**: The creator code used.
* **Discount**: The amount of discount applied.
* **Shared Revenue**: The amount of revenue shared with the creator.
* **Order**: The order associated with the creator code.
* **Date**: The date and time the creator code was used.
# Credit Purchase Logs
Source: https://docs.leaderos.net/using-leaderos/logs/credit-purchase-logs
Learn about the Credit Purchase Logs.
The following data is stored about the logs:
* **User**: The user who purchased the credits.
* **IP Address**: The IP address of the user who purchased the credits.
* **Date**: The date and time the credits were purchased.
# Credit Usage Logs
Source: https://docs.leaderos.net/using-leaderos/logs/credit-usage-logs
Learn about the Credit Usage Logs.
The following data is stored about the logs:
* **User**: The user who performed the action.
* **Amount**: The amount of credits performed in the action.
* **Action**: The action performed in the dashboard. Available actions are:
* **Usage:** The user used credits.
* **Charge:** The user charged credits.
* **Transfer to User:** The user transferred credits to another user.
* **Transfer from User:** The user received credits from another user.
* **Fortune Wheel Game (Ticket):** The user played the fortune wheel game.
* **Fortune Wheel Game (Prize):** The user won credits from the fortune wheel game.
* **Bazaar (Purchase):** The user buy an item from the bazaar.
* **Bazaar (Sale):** The user sold an item from the bazaar.
* **IP Address**: The IP address of the user who performed the action.
* **Date**: The date and time the action was performed.
# Dashboard Logs
Source: https://docs.leaderos.net/using-leaderos/logs/dashboard-logs
Operations made in the dashboard are logged. You can see the action, user, ip address and date of the log.
The following data is stored about the logs:
* **Action**: The action that was performed.
* **Data:** The data that was affected by the action in JSON format.
* **User**: The user who performed the action.
* **IP Address**: The IP address of the user who performed the action.
* **Date**: The date and time the action was performed.
**Hover over the orange icons** to get detailed information about the log.
![Image]()
# Fortune Wheel Logs
Source: https://docs.leaderos.net/using-leaderos/logs/fortune-wheel-logs
Learn how to view the logs of the fortune wheel game.
The following data is stored about the logs:
* **User**: The user who played the wheel game.
* **Fortune Wheel**: The name of the wheel game.
* **Award:** The award that the user won.
* **IP Address**: The IP address of the user who played the wheel game.
* **Date**: The date and time the user played the wheel game.
Click the **"View"** button if you want to see the awards delivery details.
# Gift Logs
Source: https://docs.leaderos.net/using-leaderos/logs/gift-logs
Learn how to view the logs of gifts sent on your website.
The following data is stored about the logs:
* **User**: The user who sent the gift.
* **Receiver**: The user who received the gift.
* **IP Address**: The IP address of the user who sent the gift.
* **Date**: The date and time the gift was sent.
Click the **"View"** button if you want to see the gifts sent.
# Permissions
Source: https://docs.leaderos.net/using-leaderos/permissions
Permissions are the actions that a user can perform on the website. You can create custom roles with the permissions set by you within the website.
Here are permissions that you can set for a role or a user:
* **Super Admin:** Grants full access and control to manage all aspects of LeaderOS, including the customization, configuration, and administration of website modules and settings.
* **View Dashboard:** Provides the ability to access the LeaderOS Dashboard.
Without the "View Dashboard" permission, any other permission granted will not be functional.
* **View Stats:** Allows users to access and review statistical data, including monthly reports, payments, donations, and other relevant metrics.
* **Manage Users:** Enables the management of player and administrative accounts, including setting roles, permissions, and access levels within the LeaderOS environment.
Users with the "Manage Users" permission cannot edit a user with higher permissions.
* **Manage Applications:** Permits the administration of staff applications within the system, including the ability to approve, reject, or modify application settings.
* **Manage Bans:** Authorizes the user to enforce or lift bans, controlling which users are prohibited from accessing certain features or the system entirely.
* **Manage Bazaar:** Offers functionalities to oversee a player-driven marketplace, facilitating trade and economy interactions among players on the server.
* **Manage Announcements:** Allows for creating, updating, and deleting announcements, ensuring that players are informed about news, updates, and important events.
* **Manage Downloads:** Enables control over the distribution of downloadable content such as mods, maps, and resource packs directly through the server’s website.
* **Manage Games:** Grants the ability to manage and promote server’s game modes, including setting descriptions, rules, and player guides for each game mode offered.
* **Manage Gifts:** Provides the ability to create, distribute, and manage gift codes, offering players rewards, incentives, credits, and promotional items.
* **Manage Help Center:** Empowers administrators to create and maintain a comprehensive help center or knowledge base, guiding players through FAQs and how-to articles.
* **Manage Leaderboards:** Authorizes the setup and management of in-game leaderboards, showcasing top players and encouraging competitive play.
* **Manage Wheel Of Fortune:** Enables the creation and management of a Wheel of Fortune feature, adding an interactive and fun element for players to engage with.
* **Manage Blog:** Permits the publication and management of blog posts, allowing the server to share updates, news, and engaging content with the community.
* **View Notifications:** Allows administrators to view system notifications, keeping them informed about crucial system actions, user activities, and other alerts.
* **Manage Pages:** Grants the ability to create, modify, and delete web pages within the system, controlling the site's structure and content.
* **Manage Payments:** Provides tools to manage and oversee the server's financial transactions, including donations, purchases, and other revenue-generating activities.
* **Manage Roles:** Permits the definition and modification of user roles, specifying what permissions each role contains for finer access control.
Users who have the "Manage Roles" permission are unable to edit a user with a higher role.
* **Manage Servers:** Provides the ability to manage the game servers required for product delivery and executing commands.
* **Manage Settings:** Enables administrators to configure global settings for the LeaderOS platform, tailoring the system to the server's specific requirements and preferences.
* **Manage Slider:** Grants the ability to create and manage homepage sliders, effectively highlighting key features, events, or news directly on the server’s website.
* **Manage Store:** Provides comprehensive tools for managing a web store, facilitating the sale of items, ranks, and other goods for monetization purposes.
* **Manage Support:** Provides management ability to support. Can manage support tickets, categories, quick answers.
* **Manage Support Tickets:** Provides the ability to see and reply to support messages. It does not have administrative level access, such as managing categories.
* **Manage Themes:** Allows for the customization and management of the website's visual themes, aligning the server's branding and aesthetic appeal.
* **Manage Updates:** Permits the management of LeaderOS updates, ensuring that the platform and its modules are up-to-date with the latest features and security enhancements.
* **Manage Logs:** Enables accessing and reviewing system logs, essential for troubleshooting, monitoring activities, and maintaining the integrity of the server's website.
* **Manage Gaming Night:** Offers tools to organize special gaming night events, creating unique and time-limited opportunities for player engagement and monetization.
* **Manage Forum:** Provides capabilities to set up and moderate a forum, fostering community discussions, feedback, and player interaction in a structured environment.
* **Manage Custom Forms:** Allows for the creation and management of custom forms for contact, feedback, and other interactions, enhancing communication and data collection.
* **Manage Modules:** Grants full control over the activation, configuration, and management of LeaderOS modules, tailoring the server’s website to meet the community's needs.
* **Manage Votes:** Provides the ability to manage voting links on various websites.
* **Manage Suggestions:** Enables the collection, review, and management of player suggestions, contributing to continuous improvement and community-driven development.
* **Manage Community Goals:** Allows setting and monitoring of community goals, encouraging collective player efforts towards common objectives, boosting engagement, and fostering a sense of achievement.
### Which permission has access to which pages?
| Permission | Pages |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Super Admin | `All Pages` |
| View Dashboard | `Dashboard > Overview` |
| View Stats | `Dashboard > Misc > Stats` |
| Manage Users | `Dashboard > User Management > Users`
`Dashboard > User Management > Staff` |
| Manage Applications | `Dashboard > Forms > Application Forms`
`Dashboard > Forms > Applications` |
| Manage Bans | `Dashboard > User Management > Bans` |
| Manage Bazaar | `Dashboard > Misc > Bazaar > Items`
`Dashboard > Misc > Bazaar > Servers`
`Dashboard > Misc > Bazaar > Custom Item Images` |
| Manage Announcements | `Dashboard > Misc > Announcements` |
| Manage Downloads | `Dashboard > Misc > Download Center` |
| Manage Games | `Dashboard > Misc > Gamemodes` |
| Manage Gifts | `Dashboard > Store > Gifts` |
| Manage Help Center | `Dashboard > Support & Help > Help Center > Articles`
`Dashboard > Support & Help > Help Center > Topics` |
| Manage Leaderboards | `Dashboard > Misc > Leaderboards` |
| Manage Wheel Of Fortune | `Dashboard > Misc > Fortune Wheel` |
| Manage Blog | `Dashboard > Content Management > Blog > Posts`
`Dashboard > Content Management > Blog > Categories`
`Dashboard > Content Management > Blog > Comments` |
| View Notifications | `Dashboard > Notifications` |
| Manage Pages | `Dashboard > Content Management > Pages` |
| Manage Payments | `Dashboard > Settings > Payment Methods`
`Dashboard > Store > Payments` |
| Manage Roles | `Dashboard > User Management > Roles` |
| Manage Servers | `Dashboard > Store > Game Servers` |
| Manage Settings | `Dashboard > Settings > General`
`Dashboard > Settings > System`
`Dashboard > Settings > API`
`Dashboard > Settings > Currencies`
`Dashboard > Settings > Languages`
`Dashboard > Settings > SEO`
`Dashboard > Settings > SMTP`
`Dashboard > Settings > Discord Bot`
`Dashboard > Settings > Discord Webhook` |
| Manage Slider | `Dashboard > Misc > Slider` |
| Manage Store | `Dashboard > Store > Store > Products`
`Dashboard > Store > Store > Categories`
`Dashboard > Store > Store > Coupons`
`Dashboard > Store > Store > Orders`
`Dashboard > Store > Store > Payments`
`Dashboard > Store > Store > VIP Tables`
`Dashboard > Store > Store > Bulk Discount`
`Dashboard > Store > Store > Credit Packages`
|
| Manage Support | `Dashboard > Support & Help > Support > Tickets`
`Dashboard > Support & Help > Support > Categories`
`Dashboard > Support & Help > Support > Quick Answers` |
| Manage Support Tickets | `Dashboard > Support & Help > Support > Tickets` |
| Manage Themes | `Dashboard > Appearance > Themes`
`Dashboard > Appearance > Theme Settings`
`Dashboard > Appearance > Theme Editor`
`Dashboard > Appearance > Header`
`Dashboard > Appearance > Custom CSS` |
| Manage Updates | `Dashboard > Updates` |
| Manage Logs | `Dashboard > Logs` |
| Manage Gaming Night | `Dashboard > Store > Gaming Night` |
| Manage Forum | `Dashboard > Content Management > Forum > Threads`
`Dashboard > Content Management > Forum > Categories` |
| Manage Custom Forms | `Dashboard > Forms > Custom Forms`
`Dashboard > Forms > Submissions` |
| Manage Modules | `Dashboard > Settings > Modules` |
| Manage Votes | `Dashboard > Misc > Votes` |
| Manage Suggestions | `Dashboard > Misc > Suggestions`
`Dashboard > Misc > Suggestions > Categories` |
| Manage Community Goals | `Dashboard > Store > Community Goals` |
# Player Bazaar
Source: https://docs.leaderos.net/using-leaderos/player-bazaar
Players can sell their in-game items for store credits. You can also charge a commission for the player market sales.
### How can players sell items in the player bazaar?
To sell items in the player bazaar, players should follow these steps:
1. Place the desired item into their bazaar storage using the **"/webbazaar"** command in-game.
2. Subsequently, they can view and list the items for sale directly from their bazaar storage on the website.
Summary, use the **"/webbazaar"** command in-game, put the items in the bazaar storage, and list them for sale on the website.
### How to use purchased items?
Purchased items will be stored in the player's bazaar storage. Players can access their purchased items in-game by using the **"/webbazaar"** command.
### How to cancel sales and return items to your bazaar storage?
To cancel a sale and return items to the bazaar storage, players can:
1. Navigate to the product editing page and click on "Remove from Bazaar" to cancel the sale.
2. Access the bazaar storage and retrieve the returned items in-game using the **"/webbazaar"** command.
### How can players buy items from the player bazaar?
Players can buy items on Bazaar page on the website. They can search for items by name, category, or price range. Once they find the item they want to buy, they can click on the "Buy" button to purchase the item.
### How to take commission from player bazaar sales?
Go to **Dashboard > Settings > System** and set the **"Bazaar Commission (%)** to the desired percentage. This will be the commission you will take from the player bazaar sales. For example, if you set the commission to 10%, players who sell an item for 100 credits will receive 90 credits after the sale. A commission of 10 credits will be burned.
# Popup
Source: https://docs.leaderos.net/using-leaderos/popup
Shows a popup screen to visitors when they visit the website.
### How to use Popup?
Enable the popup module on **Dashboard > Settings > Modules**. Then, go to **Dashboard > Misc > Popup** to configure the popup settings. You can set the popup link, and image.
# Punishments
Source: https://docs.leaderos.net/using-leaderos/punishments
You can share Bans, Kicks, Mutes and Warnings tables on your website. This data is taken from the LiteBans or AdvancedBan plugin.
#### What are the supported Ban plugins?
We currently support **LiteBans** and **AdvancedBan**.
#### How can I set up Punishments module?
1. Install a supported Ban plugin on your Minecraft server. [What are the supported Ban plugins?](#what-are-the-supported-ban-plugins)
2. Connect the Ban plugin to a MySQL server.
* [How to connect LiteBans to a MySQL server?](#how-to-connect-litebans-to-a-mysql-server)
* [How to connect AdvancedBan to a MySQL server?](#how-to-connect-advancedban-to-a-mysql-server)
3. Go to **Dashboard > Settings > Punishments** and select a supported Ban plugin.
4. You can connect to the same MySQL server with the website or a different one. If you want to use the different MySQL server, enter the credentials for this server.
![Images]()
![Images]()
### How to connect LiteBans to a MySQL server?
1. Install LiteBans on your Minecraft server.
2. Open the **config.yml** file in the LiteBans folder.
3. Find the **sql** section and enter your MySQL credentials.
* Change the **driver** to `MySQL`.
* Enter your MySQL server ip, database name, username, and password.
```yaml theme={null}
sql:
# H2, MySQL, MariaDB, and PostgreSQL are supported database drivers.
driver: MySQL
## MySQL/PostgreSQL settings ##
# If using H2, the database will be stored in the LiteBans plugin folder,
# and most of these settings won't apply.
# Database server address.
address: MYSQL_SERVER_IP:3306
# Database name, username and password.
database: 'litebans'
username: ''
password: ''
```
4. Restart your server.
### How to connect AdvancedBan to a MySQL server?
1. Install AdvancedBan on your Minecraft server.
2. Open the **config.yml** file in the AdvancedBan folder.
3. Set true the **UseMySQL** option.
4. Find the **MySQL** section and enter your MySQL credentials.
* Change the **driver** to `MySQL`.
* Enter your MySQL server ip, database name, username, and password.
```yaml theme={null}
UseMySQL: true
MySQL:
IP: MYSQL_SERVER_IP
DB-Name: MYSQL_DATABASE_NAME
Username: MYSQL_USERNAME
Password: MYSQL_PASSWORD
Port: 3306
```
5. Restart your server.
# Roles
Source: https://docs.leaderos.net/using-leaderos/roles
Create custom roles with the permissions set by you within the website. You can set these roles manually to the user or when a purchase is made in-store.
### How to create a role?
Go to **Dashboard > User Management > Roles > Add New**. You can add a role by providing the following information:
* **Name:** Enter the name of the role.
* **Priority:** Enter the priority of the role. The role with the highest priority will be given preference.
* **Username CSS:** Write CSS code for the role's username.
* **Badge CSS:** Write CSS code for the role's badge.
* **Is Staff Role:** Enable this option if you want to make this role a staff role.
* **Permissions:** If you enable the "Is Staff Role" option, you can set the permissions for the staff role. You can learn more about permissions [here](/using-leaderos/permissions).
Use **"!important"** in the CSS code to override the default CSS. For example, **"color: red !important;"**
![Image]()
#### Example CSS code for a role
**For Username:**
```css theme={null}
color: #ff0000 !important;
```
**For Badge:**
```css theme={null}
color: #fff !important;
background: linear-gradient(90deg, rgba(2,0,36,1) 0%, rgba(121,9,9,1) 0%, rgba(255,0,0,1) 100%) !important;
```
**Preview:**
![Image]()
### How to add avatar border to a role?
You can design avatar borders to display custom roles for your users like Hypixel forum. To design avatar borders, go to **Dashboard > Appearance > Custom CSS**. You can add the following CSS code to add an avatar frame to a role:
Please replace `ROLE_ID` with the role class you want to add the avatar frame to. To find the role id of a role, go to **Dashboard > User Management > Roles** and click the **"Edit"** button next to the role.
```css theme={null}
.avatar-ROLE_ID {
position: relative;
width: 74px;
height: 74px;
display: inline-block;
}
.avatar-ROLE_ID::after {
content: '';
position: absolute;
top: -5px;
left: -5px;
right: -5px;
bottom: -2px;
background: url('https://hypixel.net/styles/hypixel-v2/images/avatar-frames/vip.png') no-repeat center center;
background-size: cover;
z-index: 2;
}
```
![Image]()
# Slider
Source: https://docs.leaderos.net/using-leaderos/slider
You can share important announcements about your server with images.
### How to add a slider?
Go to **Dashboard > Misc > Slider > Add New**. You can add a slide by providing the following information:
* **Title**: The title of the slide.
* **Description**: The description of the slide.
* **Link**: The link to redirect when the slide is clicked.
* **Image**: The image of the slide.
**Example Slider:**
![Image]()
### How to disable the slider?
Go to **Dashboard > Settings > Modules** and disable the Slider module.
# Staff
Source: https://docs.leaderos.net/using-leaderos/staff
You can create a page for your staffs and share it publicly.
![Image]()
# Staff Applications
Source: https://docs.leaderos.net/using-leaderos/staff-applications
With our application system you can receive new staff applications with your website and review their applications.
### How to create a Staff Application Form?
You can create a custom form on **Dashboard > Forms > Applications Forms > Add New**.
* **Title:** The title of the form.
* **Description:** The description of the form. You can use HTML tags to format the description.
* **Re-Appliable:** If you enable this option, users can submit the form multiple times.
* **Questions:** You can add questions to the form. You can add the following types of questions:
* **Short Text:** A single line text input.
* **Long Text:** A multi-line text input.
* **Single-Select:** A single-select dropdown. You can add options by separating them with a comma.
* **Multi-Select:** A multi-select dropdown. You can add options by separating them with a comma.
**Example to create a Application Form:**
![Image]()
### How to review application submissions?
You can review application submissions on **Dashboard > Forms > Applications**. You can click on the **"View"** button to see the details of the submission.
You can accept or reject the submission by clicking on the **"Accept"** or **"Reject"** button.
If you reject a submission and the form is re-appliable, the user can submit the form again.
### How to see the application form on your website?
After creating a application form, you can see it on **Dashboard > Forms > Applications Forms**. You can click on the **"View"** button to see the form on your website.
### How to add a application form to Header Menu?
After creating a application form and copying the URL, you can add it to the Header Menu on **Dashboard > Appearance > Header**.
# Stats
Source: https://docs.leaderos.net/using-leaderos/stats
On the Advanced Statistics page, you can view the data on your website in a detailed and meaningful way. You can select a date range with the date filtering feature.
You can switch between statistics pages.
![Image]()
### Overview
![Image]()
### Monthly Report
Statistics for the current month are available for viewing.
![Image]()
### Payment
Statistics about payments within the selected date range can be viewed.
![Image]()
![Image]()
![Image]()
### Donors
You can access statistics regarding users who have made donations to your server.
![Image]()
![Image]()
# Bulk Discount
Source: https://docs.leaderos.net/using-leaderos/store/bulk-discount
Set discounts for multiple products at once in your store.
### How to make a discount for multiple products at once?
Go to **Dashboard > Store > Bulk Discount**. You can set discounts for multiple products at once in your store by providing the following information:
* **Discount Status:** Enable or disable the discount.
* **Discount (%):** Enter the discount percentage.
* **Duration Status:** You can apply either a Permanent or a Temporary discount.
* **Permanent:** The discount will be applied permanently.
* **Temporary:** You can set the end date for the discount. The discount will be applied until the end date.
* **Products:** You can set the discount for all products or select specific products.
* **All Products:** The discount will be applied to all products.
* **Specific Products:** Select the products for which you want to set the discount. It is feasible to simultaneously choose multiple items and conduct a search by product name. You can also choose whole categories to apply the discount to every product in that category.
![Image]()
You can choose whole categories to apply the discount to every product in that category.
# Categories
Source: https://docs.leaderos.net/using-leaderos/store/categories
Categories are used to organize products in your store and make it easier for customers to find what they are looking for.
### How to create a category?
Go to **Dashboard > Store > Categories > Add New**. You can add a category by providing the following information:
* **Name:** The name of the category.
* **Parent Category:** You can create a hierarchy of categories by selecting a parent category. There is no limit to the number of levels you can create.
* **Image:** You can upload an image to represent the category.
* **General Tab:**
* **Priority:** You can set the priority of the category.
* **Visibility Tab:**
* **Show in Store:** You can choose to show or hide the category in the store.
* **Only Show If Customer Has Purchased Product:** You can choose to show the category only if the customer has purchased a specific product.
* **Minecraft GUI Tab:**
* **Show in Game:** You can choose to show or hide the category in the game.
* **GUI Title:** You can set a title for the category in the game.
* **GUI Description:** You can set a description (lore) for the category in the game.
* **GUI Item:** You can select an item to represent the category in the game.
* **GUI Item Model ID:** You can set a custom model ID for the GUI item.
* **Cumulative Tab:**
* **Is Cumulative Category?:** You can choose to make the category cumulative. Learn more about cumulative categories [here](/using-leaderos/store/categories#how-does-cumulative-category-work).
### How does cumulative category work?
The cumulative category option streamlines the upgrade process for clients, enabling them to move from their current product to a higher-tier one by simply paying the difference in cost between the two products. This system plays a crucial role in establishing a tiered framework among our products, accommodating both lifetime and temporary products.
Understanding the Cumulative Categories System:
* **For Lifetime Products**: If a customer has bought a product with lifetime access **(Product A) for \$10** and decides to upgrade to a higher-tier product **(Product B) priced for \$30**, they simply **pay the difference**, which is **\$20**.
* **For Temporary Products:** The upgrade process for customers with temporary products considers the remaining time and the initial purchase price. For example, if a **\$15 product has 10 days remaining on a 30-day period**, and the customer wishes to **upgrade to a \$30 product**, a proportionate discount is applied. In this scenario, a **\$5 discount** reflects the value of the remaining time, so the customer would **pay \$25 to upgrade**.
It is important to keep in mind that the history of product purchases is meticulously tracked with the cumulative categories feature. This ensures that customers who have previously bought a product within this tiered system qualify for a discounted upgrade price in the future. Impressively, this discount remains valid indefinitely for lifetime products and is proportionately calculated for term-based products, guaranteeing that all customers can advantageously utilize it beyond the initial period.
To activate this feature for products, simply enable the cumulative option on the category editing screen.
# Community Goals
Source: https://docs.leaderos.net/using-leaderos/store/community-goals
Community goals allow your community to back your project in a unique way. When users buy a product, it contributes to the community goal.
To motivate your community to reach the targeted earnings, you can display a counter. You can turn this feature on or off anytime, complete the event when achieved, or set it to automatically reset upon completion. You can configure by providing the following information:
* **Is Active?:** You can toggle the status of Community Goals
* **Title:** Title to be displayed in the store.
* **Description:** Description to be displayed in the store.
* **Current:** The current amount of collected.
* **Goal:** The target amount to be collected.
* **Is repeatable?:** If the goal is reached, the counter resets. If disabled, the event ends when the goal is reached.
* **Game Server Commands:** Optional commands to be executed on your game server when the goal is reached.
**Example Community Goals view in the store:**
* **Title:** Community Goals
* **Description:** Help us to reach our goal!
* **Current:** \$75
* **Goal:** \$100
![Image]()
# Coupons
Source: https://docs.leaderos.net/using-leaderos/store/coupons
Create exclusive discount coupons for your store.
### How does coupon work?
Coupons are a great way to offer discounts to your customers. You can create coupons with a specific discount percentage and minimum order amount. Customers can apply the coupon code at checkout to avail the discount.
### How to create a coupon?
Go to **Dashboard > Store > Coupons > Add New**. You can add a coupon by providing the following information:
* **Coupon Code**: Enter a unique coupon code.
* **Duration:** You can apply either a Permanent or a Temporary duration. If you select Temporary, you will need to specify the end date and time from the calendar.
* **Limit:** You can set a limit on the number of codes that can be used. If you don't want to set a limit, you can select **Unlimited**.
* **Discount (%)**: Enter the discount percentage.
* **Minimum Order Amount**: Enter the minimum order amount for the coupon to be valid.
* **Products:** You can choose to apply the discount to all products or specific products.
* **All Products:** Select this option to apply the discount to all products.
* **Specific Products:** Select this option to apply the discount to specific products. You can search for products by name and add them to the list.
Each user can use a coupon only once.
### How to view coupon logs?
Go to **Dashboard > Logs > Coupon Logs**. Learn more about coupon logs [here](/using-leaderos/logs/coupon-logs).
# Creator Codes
Source: https://docs.leaderos.net/using-leaderos/store/creator-codes
Share revenue with your creators for every sale they make.
### How does creator code work?
Creator codes are unique codes that you can create for your creators. When a customer uses a creator code when making a purchase, the customer receives a discount, and the creators receive a percentage of the sale as site credit. This is a great way to incentivize creators to promote your products and increase sales.
### How to create a creator code?
Go to **Dashboard > Store > Creator Codes > Add New**. You can add a creator code by providing the following information:
* **Creator**: Search and select the creator from the list.
* **Code**: Enter a unique code for the creator.
* **Discount (%)**: Enter the discount percentage.
* **Revenue Share (%)**: Enter the revenue share percentage.
### How to view creator code logs?
Go to **Dashboard > Logs > Creator Code Logs**. Learn more about creator codes logs [here](/using-leaderos/logs/creator-code-logs).
# Credit Packages
Source: https://docs.leaderos.net/using-leaderos/store/credit-packages
Create predefined credit packages. Encourage users to purchase more credits by offering discounts and bonus credits.
### How to enable Credit Packages?
Go to **Dashboard > Settings > System Settings** and enable the **Credit Packages** setting. After enabling the setting, you can add credit packages on the **Dashboard > Store > Credit Packages** page.
### How to create a Credit Package?
Go to **Dashboard > Store > Credit Packages > Add New**. You can add a credit package by providing the following information:
* **Title**: The title of the credit package.
* **Price**: The price of the credit package.
* **Bonus Credits**: The bonus credits that the user will receive when purchasing the credit package.
* **Description**: The description of the credit package.
* **Image**: The image of the credit package.
* **Price Tab:**
* **Price:** The price of the credit package.
* **Discount Status:** Enable this setting to provide a discount on the credit package. If you enable this setting, you will need to provide the following information:
* **Discounted Price:** The discounted price of the credit package.
* **Discount Duration Status:** You can apply either a Permanent or a Temporary discount. If you select the Temporary discount, you will need to provide the following information:
* **Discount Duration:** Choose an end date and time for the discount from the calendar.
* **Stock Tab:**
* **Stock Status:** Enable this setting to manage the stock of the credit package. If you enable this setting, you will need to provide the following information:
* **Stock:** The stock of the credit package.
### How to see the Credit Packages on the website?
You can see the credit packages on the **Buy Credits** page. Go to **yourwebsite.com/credit/buy** page to see the credit packages.
![Image]()
Download our [Free Store Icon Pack](https://www.spigotmc.org/resources/leaderos-free-store-icon-pack.105497/) to get this and other sample product images.
### How to disable Credit Packages?
Go to **Dashboard > Settings > System Settings** and disable the **Credit Packages** setting.
# Game Servers
Source: https://docs.leaderos.net/using-leaderos/store/game-servers
Learn how to send commands to game servers.
### How to add a game server to send commands?
After purchasing a product, you can send commands to the game server. To add a game server, go to **Dashboard > Store > Game Servers > Add New**. You can add a game server by following the steps below:
* **Name:** Enter the name of the game server.
* **Server IP:** Enter the IP address of the game server.
* **Server Port:** Enter the port of the game server.
* **Console Type:** Select the console type of the game server. You can choose between RCON, Websender, Websend and LeaderOS Connect (recommended).
* **RCON:** RCON is a protocol that allows you to send commands to the game server. Learn more about using RCON [here](/integrations/rcon).
* **Console Password:** Enter the RCON password you set in the game server configuration.
* **Console Port:** Enter the RCON port you set in the game server configuration.
* **Websender:** Websender is a plugin that allows you to send commands to the game server. Learn more about using Websender [here](/integrations/websender).
* **Console Password:** Enter the Websender password you set in the plugin configuration.
* **Console Port:** Enter the Websender port you set in the plugin configuration.
* **LeaderOS Connect:** LeaderOS Connect is a LeaderOS plugin module that allows you to securely send commands to the game server. Learn more about using LeaderOS Connect [here](/integrations/leaderos-connect).
You can check console connection after configuring the integration by clicking on the **"Check Console Connection"** button.
### How to link a game server to a product?
After adding a game server, you can link it to a product. To link a game server to a product, go to **Dashboard > Store > Products > Edit Product > Commands**. Select the game server for the added commands in the product.
### How to fix the "Connection failed" error?
If you encounter a "Connection failed" error while adding a game server, you can check the following:
* Check your Website URL on **Dashboard > Settings > General**. Make sure it is correct.
* Check the IP address and port of the game server you entered.
* Check your console integration settings. Make sure the console password and port are correct.
* If you are using RCON, Websend or Websender, make sure firewall rules are set up correctly. You have to open the port you set in the game server configuration or plugin configuration on your game server and web server.
* Please make sure that the game server is running and the console is enabled.
* If you are using LeaderOS Connect, make sure the LeaderOS Connect plugin is installed on your game server and the LeaderOS Connect module is enabled.
# Gaming Night
Source: https://docs.leaderos.net/using-leaderos/store/gaming-night
Encourage your players to shop in the store with limited stock items for a set amount of time.
### How to configure Gaming Night event?
Go to **Dashboard > Store > Gaming Night**. You can configure the following settings for the Gaming Night event:
* **Day:** Select the day of the week when the event will be held.
* **Start Time:** Set the start time of the event.
* **End Time:** Set the end time of the event.
* **Products:** Select the products that will be available for purchase during the event. You can set the stock and discounted price of each product that will be available for purchase.
![Image]()
### How does Gaming Night event work?
During the Gaming Night event, players will be able to shop in the store with limited stock items for a set amount of time. Players can purchase the products available during the event at a discounted price. The products available for purchase during the event will have limited stock, so players will need to act fast to get the items they want.
![Image]()
### How to add a Gaming Night to Header Menu?
After configuring the Gaming Night event, you can add a link to the event in the header menu of your website. To do this, go to **Dashboard > Appearance > Header**. Create a new menu item and select Gaming Night as the link type.
### How to share the Gaming Night event with players?
You can share the Gaming Night event with players by sending them a notification or email with the details of the event. You can also promote the event on social media or other channels to encourage players to participate.
# Gifts
Source: https://docs.leaderos.net/using-leaderos/store/gifts
Provide gifts to your users by having them claim a gift code.
### How does Gifts work?
Create and distribute gift codes for your users. You can create gifts as either Credits or Products, set a limit on the number of codes and to specify expiration dates for them.
### How to create a gift?
Go to **Dashboard > Store > Gifts > Add New**. You can add a gift by providing the following information:
* **Code:** The code that users will use to claim the gift.
* **Type:** The type of gift you want to create. It can be either Credits or Products.
* **Product:** If you select this type, you will need to select a product from the dropdown list.
* **Credits:** If you select this type, you will need to specify the credits amount.
* **Duration:** You can apply either a Permanent or a Temporary duration. If you select Temporary, you will need to specify the end date and time from the calendar.
* **Limit:** You can set a limit on the number of codes that can be claimed. If you don't want to set a limit, you can select **Unlimited**.
### How do users claim a gift?
Users can claim a gift by going to **Gift Page (yourwebsite.com/gift)** and entering the gift code in the **Claim Gift** section. If the gift code is valid, the gift will be added to the user's account.
# Orders
Source: https://docs.leaderos.net/using-leaderos/store/orders
Learn how to view and manage orders in your store.
### How can I see order details?
Go to **Dashboard > Store > Orders**. Click on the order number to view the order details.
* **Order Number:** The unique number assigned to the order.
* **Products:** The products included in the order.
* **Product Name:** The name of the product.
* **Category:** The category to which the product belongs.
* **Quantity:** The quantity of each product included in the order.
* **Total:** The total amount for each product. This is calculated by multiplying the quantity by the price of the product.
* **Status:** The current status of the order. An order can have one of the following statuses:
* **Success:** The order has been completed successfully.
* **Waiting:** The order is waiting for payment. This status is set when the payment method is set to "Manual" and the user has not yet paid for the order.
* **Error:** The order not completed due to an error.
* **User:** The user who placed the order.
* **Payment Method:** The payment method used to pay for the order.
* **Total:** The total amount of the order.
* **Discount:** The discount applied to the order.
* **Credit:** The credit applied to the order.
* **Coupon:** The coupon applied to the order.
* **Date:** The date and time the order was placed.
### How to complete an order placed with the "Manual" payment method?
If an order is placed with the "Manual" payment method, the user will need to make the payment manually. Once the payment is received, you can complete the order by following these steps:
1. Go to **Dashboard > Store > Orders**.
2. Find the order you want to complete and click on the order number to view the order details.
3. Click on the **Complete Order** button.
After completing the order, the status will be updated to "Success" and the products will be delivered to the user.
### How to create a order manually?
If you want to create an order manually for a user, you can follow these steps:
1. Go to **Dashboard > Store > Orders**.
2. Click on the **Add New** button.
3. Fill in the order details:
* **Products:** Add the products you want to include in the order.
* **Product:** Select the product you want to add to the order.
* **Quantity:** Enter the quantity of the product you want to add.
* **Unit Price:** Enter the unit price of the product. This price will be entered automatically based on the product you select, but you can change it if needed.
* **Total:** Enter the total amount for the order. This amount will be reflected in your revenue statistics. If you do not want it to be reflected, enter 0.00.
* **User:** Select the user for whom you want to create the order.
* **Status:** Set the status of the order.
* **Success:** The order has been completed successfully. The products will be delivered to the user immediately.
* **Waiting:** The order is waiting for approval. The products will be delivered to the user once the order is completed. [How to complete an order in "Waiting" status?](#how-to-complete-an-order-placed-with-the-manual-payment-method)
# Products
Source: https://docs.leaderos.net/using-leaderos/store/products
Products are the heart of your web store, delivered via game server commands after purchase. You can also offer special access and roles on your website and Discord.
### Listing Types in the Dashboard for Products
Two listing types are available:
* **Default Listing:** Products are listed in a tree view in the default listing.
To change the order of products or categories, simply drag and drop them using the drag handle (three-line icon).
* **Table Listing:** Products are listed in a table view in the table listing.
### How to create a product?
Go to **Dashboard > Store > Products > Add New**. You can add a product by providing the following information:
* **Name:** The name of the product.
* **Category:** The category to which the product belongs.
* **Description:** A brief description of the product.
* **Image:** An image that represents the product. You can choose from our free image library or upload your own.
* **General Tab:**
* **Show in Store:** Enable this option to display the product in the store.
* **Is featured product?:** Enable this option to mark the product as featured. Featured products are displayed on the Checkout page.
* **Give Role:** Select a role to give to the user when they purchase the product.
* **Priority:** The priority of the product in the store. The product with the highest priority will be displayed first.
* **Duration Status:** There are three options available:
* **Lifetime:** The buyer will have the product forever.
* **Temporary:** The buyer will have the product for a limited time. You can set the duration in days.
* **One Time:** The buyer will have the product for a single use.
* **Pricing Tab:**
* **Price:** The price of the product.
* **Discount:** Enable this option to offer a discount on the product.
* **Discounted Price:** The discounted price of the product.
* **Discount Duration Status:** You can apply either a Permanent or a Temporary discount. If you select the Temporary discount, you will need to provide the following information:
* **Discount Duration:** Choose an end date and time for the discount from the calendar.
* **Limiting Tab:**
* **Stock:** Enable this option to limit the stock of the product.
* **Stock Quantity:** The quantity of the product in stock.
* **Restrictions Tab:**
* **Required Products:** You can set the products that are required to purchase this product.
* **Only require the customer to have purchased one product from the selected list**: Enable this option to require the customer to have purchased only one product from the selected list. If you disable this option, the customer will need to have purchased all the products from the selected list. If you don't select required product, this option will be useless.
* **Variabes Tab:**
* **Variables:** You can select the variables you created on the Dashboard > Store > Variables page for this product. It supports multiple variable selection.
* **Minecraft GUI Tab:**
* **Show in Game:** You can choose to show or hide the category in the game.
* **GUI Title:** You can set a title for the category in the game.
* **GUI Description:** You can set a description (lore) for the category in the game.
* **GUI Item:** You can select an item to represent the category in the game.
* **GUI Item Model ID:** You can set a custom model ID for the GUI item.
* **Commands:** The commands that will be executed when the product is purchased. You can add multiple commands by clicking the **Add** button.
* **Command:** The command that will be executed. To replace the player's name in the command, use `%username%`.
* **Server:** The server on which the command will be executed.
### How to order products or categories?
You can order products or categories by dragging and dropping them using the drag handle (three-line icon).
You cannot change a product's category by dragging it into a different category. Instead, go to the product's edit page.
![Image]()
# Variables
Source: https://docs.leaderos.net/using-leaderos/store/variables
Custom variables are used to collect additional information from customers when purchasing a specific product.
### What is the Variable Feature?
The variable feature allows you to create custom fields for your products, enabling you to gather additional information from customers during the purchasing process. These variables are presented to the customer when they add the product to their cart and are used to customize the order.
For instance, if you create a VIP product and add a variable called "Color," customers will be prompted to select their preferred color when purchasing the product. If certain colors have additional charges, those fees are automatically added to the total cart price. The `%color%` variable in server commands is then dynamically replaced with the customer's selected color.
In the example images below, a variable named "Color" was created and assigned to the VIP product. The "White" option is free, while "Blue" and "Red" have additional costs. Once the purchase is finalized, the `%color%` variable in the server command is replaced with the selected color value.
![Image]()
![Image]()
![Image]()
### How to create a variable?
Navigate to **Dashboard > Store > Variables > Add New**. You can add a new variable by providing the following details:
* **Identifier**: Assign a unique identifier for the variable. You can use this identifier in product commands later, e.g., `%color%`.
* **Name**: Enter the name of the variable. This will be displayed to the user.
* **Description**: Provide a description explaining the purpose of the variable.
* **Type**: Select the type of variable. Options are Text, Number, or Dropdown.
* **Text**: Prompt the user to enter a text value.
* **Number**: Prompt the user to enter a numeric value.
* **Dropdown**: Present the user with a list of predefined options.
* **Options**: If the type is Dropdown, define the options here.
* **Name**: Enter the name of the option.
* **Value**: Enter the value for the option. This value is used in product commands. For example, if you set the value to `red`, the `%color%` variable in product commands will be processed as `red`. A command like `say Color: %color%` will be sent to the server as `say Color: red`.
* **Price**: Enter the price of the option. This price is added to the product's base price. For instance, if the VIP product costs \$10 and the "Red" color option adds \$5, the total price in the cart will be \$15.
### How to assign a variable to a product?
Navigate to **Dashboard > Store > Products > Edit Product**. In the product editing page, click on the **Variables** tab. On the opened page, click the **Add Variable** button to assign a variable. The assigned variables will be requested from the user when they add the product to their cart, and the order will be processed accordingly.
### How to use a variable’s value in commands?
In the commands section of the product editing page, use variables in the format `%identifier%`. For example, if you created a variable with the identifier `color`, you can use it in commands as `%color%`. The variable in the command will be replaced with the value entered by the user and sent to the server.
![Image]()
When the commands are configured as shown in the example image and the "Red" color is selected, the server will receive the command:
`say hello LeaderOS, you selected the red color!`
# VIP Table
Source: https://docs.leaderos.net/using-leaderos/store/vip-table
Create tables in store that compare each VIP features and help your players decide better while purchasing VIP.
### How to create a VIP Table?
To begin, create a category and VIP products in your store. If you have not yet created a VIP product, follow the steps [here](/using-leaderos/store/products).
After creating the VIP products, go to **Dashboard > Store > VIP Tables > Add New**. You can add a VIP table by providing the following information:
* **Category:** Choose a category to create a VIP table for. The VIP table will be featured on the store page of the selected category.
* **Products:** Select the VIP products that you want to compare in the table. You can select only the VIP products that belong to the selected category.
* **Features:** Add the features that you want to compare in the table. You can add multiple features by clicking on the **Add** button. You can also move the features up and down by dragging the **Move** icon. To remove a feature, click on the **Remove** icon.
* **Feature:** Enter the feature that you want to compare. You can add descriptions for each feature by clicking on the **+ Add Description** button.
* **Value:** Enter the value of the feature for each VIP product. You can use HTML tags in fields. To add check icon, use "+" and for cross icon, use "-".
You can add separator columns by leaving the feature's values empty.
![Image]()
![Image]()
### How to add separator columns?
To add separator columns, leave the feature's values empty.
![Image]()
![Image]()
### How to see the VIP Table on the store page?
After creating the VIP table, it will be displayed on the store page of the selected category. You can also view the VIP table by going to **Dashboard > Store> VIP Tables** and clicking on the **View** button.
# Suggestions
Source: https://docs.leaderos.net/using-leaderos/suggestions
Get suggestions from your players and manage them with your team.
### How to use the suggestions feature?
To use the suggestions feature, you need to create a suggestion category. Once you have created a suggestion category, users can submit suggestions under that category. You can view and manage suggestions from the **Dashboard > Misc > Suggestions** section.
Users can submit suggestions, vote on existing suggestions,n view the suggestions and sort them by the number of votes. You can also view the details of a suggestion, including the number of votes, comments, and the user who submitted the suggestion.
With the suggestions feature, you can get feedback from your players and improve your server based on their suggestions.
### How to create a suggestion category?
Go to **Dashboard > Misc > Suggestions > Categories > Add New**. You can add a suggestion category by providing the following information:
* **Name**: The name of the suggestion category.
# Categories
Source: https://docs.leaderos.net/using-leaderos/support/categories
Categorize your support tickets and collect different data from users with category-specific custom fields.
### How to create a support category?
Go to **Dashboard > Support & Help > Tickets > Categories > Add New**. You can add a category by providing the following information:
* **Name:** The name of the category.
* **Permissions Tab:** You can select the roles that can view and manage tickets of this category.
* Only roles with **"Manage Support Tickets"** permission can be edited in the permission table.
* You can also see the roles with **"Super Admin"** and **"Manage Support"** permissions in this table, but you cannot edit the permissions of the roles with these permissions.
* You cannot see roles in this table except roles with **"Super Admin"**, **"Manage Support"** and **"Manage Support Tickets"** permissions.
* Users with the **"Manage Support Tickets"** permission that you define for the user will automatically have all category-specific permissions.
* When you add a new role with **"Manage Support Tickets"** permission, it will not have category-specific permissions. Therefore, you will need to edit this category again for each new role you add.
![Image]()
* **Custom Fields Tab:** You can add multiple custom fields that are specific to this category by clicking on the "Add" button. These fields will be displayed when a user selects this category while submitting a ticket.
* **Field Label:** The label of the custom field.
* **Field Type:** The type of the custom field. It can be a short text, long text, single select, multi-select.
* **Short Text:** A single line text field.
* **Long Text:** A multi-line text field.
* **Single Select:** A dropdown field where users can select only one option. You can add multiple options separated by a comma.
* **Multi-Select:** A dropdown field where users can select multiple options. You can add multiple options separated by a comma.
![Image]()
### How do custom fields work?
When a user selects a category while submitting a ticket, the custom fields of that category will be displayed on the ticket submission form. The user will have to fill in these fields to submit the ticket.
![Image]()
# Quick Answers
Source: https://docs.leaderos.net/using-leaderos/support/quick-answers
Using Quick Answers you increase the speed of your support team by providing them with a list of predefined answers to common questions.
### How to create a Quick Answer?
Go to **Dashboard > Support & Help > Support > Quick Answers > Add New**. You can add a quick answer by providing the following information:
* **Title:** The title of the quick answer.
* **Content:** The content of the quick answer. You can use HTML tags to format the content.
### How to use a Quick Answer?
When you are replying to a ticket, you can use a quick answer by clicking on the **Quick Answer** select box. A list of quick answers will appear, and you can select the one you want to use.
Before selecting a quick answer, the quick answer select box will look like this:
![Image]()
After selecting a quick answer, the content of the quick answer will be added to the reply box.
![Image]()
# Tickets
Source: https://docs.leaderos.net/using-leaderos/support/tickets
Manage your support tickets with your team and help your players.
### Ticket Statuses
* **Open**: The ticket is open and waiting for a response.
* **Closed**: The ticket is closed and no longer accepting responses. You can reopen the ticket by replying.
* **Answered**: The ticket has been answered by the support team.
* **User-Reply**: The ticket has been replied by the user and waiting for a response from the support team.
#### How to add a new ticket status?
Currently, you can't add a new ticket status. We may add this feature in the future.
### How to filter tickets by status?
Go to **Dashboard > Support & Help > Support > Tickets**. You can filter tickets by status by clicking on the status filter dropdown.
![Image]()
### How to change ticket message template?
Go to **Dashboard > Settings > General Settings**. You can change the ticket message template by editing the **"Support Message Template"** field. You can use the following placeholders in this field:
* `%username%`: The username of the support message sender.
* `%servername%`: The server name.
* `%serverip%`: The server IP.
* `%serverversion%`: The server version.
* `%message%`: The message of the support message sender.
### How to prevent spams?
You can use Google reCAPTCHA integration to prevent spams. Learn more about how to integrate Google reCAPTCHA [here](/integrations/google-recaptcha).
### How to close a ticket?
Go to **Dashboard > Support & Help > Support > Tickets**. You can close a ticket by clicking on the **"Close"** button.
![Image]()
Also, you can close a ticket in the ticket page by clicking on the **"Close"** button.
![Image]()
### How to delete a ticket reply?
Go to **Dashboard > Support & Help > Support > Tickets**. You can delete a ticket reply by clicking on the **"Delete"** button.
![Image]()
### How to delete a ticket?
Go to **Dashboard > Support & Help > Support > Tickets**. You can delete a ticket by clicking on the **"Delete"** button.
![Image]()
Also, you can delete a ticket in the ticket page by clicking on the **"Delete"** button.
![Image]()
### How to delete selected tickets?
Go to **Dashboard > Support & Help > Support > Tickets**. You can delete selected tickets by selecting the tickets and clicking on the **"Delete Selected"** button.
![Image]()
### How to ban a user from support?
Go to **Dashboard > User Management > Actions > Ban User**. You can ban a user from support by selecting the **"Support"** option.
# URL Redirects
Source: https://docs.leaderos.net/using-leaderos/url-redirects
Redirects are used to redirect users from one URL to another.
### How to create a redirect?
Go to **Dashboard > Misc > URL Redirects > Add Redirect**. You can create a redirect by specifying the following fields:
* **Redirect From**: The URL visited before being redirected.
* **Redirect To**: The URL to which you want to redirect the user.
#### Example URL Redirect
The user visits `https://example.com/discord` and you want to redirect them to `https://discord.gg/XXXXX`. In this case, you will set the following values:
* **Redirect From**: `/discord`
* **Redirect To**: `https://discord.gg/XXXXX`
![Image]()
# Users
Source: https://docs.leaderos.net/using-leaderos/users
Manage users and staff, view their activities, and more.
### How to search for a user?
Go to **Dashboard > User Management > Users**. Here you can search for a user by their username, email, or user ID.
### How to see user activities?
Go to **Dashboard > User Management > Users**. Search for the user and click on the **Actions > View Profile** button. Here you can see the user's activities. You can see the following activities of a user:
* **Stats:** Shows the user's leaderboard stats.
* **Orders:** Shows the user's order history.
* **Chest:** Shows the user's chest items.
* **Tickets:** Shows support tickets opened by the user.
* **Credit Activities:** Shows the user's credit activities.
* **Wheel of Fortune Activities:** Shows the user's wheel of fortune activities.
* **Gift Activities:** Shows the user's gift activities.
* **Chest Activities:** Shows the user's chest activities.
* **Bazaar Activities:** Shows the user's bazaar activities.
* **Applications:** Shows the applications submitted by the user.
### How to add roles/permissions to a user?
Go to **Dashboard > User Management > Users > Edit User**. Here you can assign roles and permissions to the user.
If you want to give a permission to a user without giving a role, you can choose the permission from the **Permissions** section. You can learn more about permissions [here](/using-leaderos/permissions).
You need to give **"View Dashboard"** permission to the user to access the dashboard. Without this permission, the user will not be able to access the dashboard.
### How to add a temporary role to a user?
Go to **Dashboard > User Management > Users > Edit User**. Select the role from the **Roles** section and click the **"Clock"** icon. You can set the expiry date for the role here.
![Image]()
![Image]()
### How to see user's temporary roles?
Go to **Dashboard > User Management > Users > Edit User**. Here you can see the user's temporary roles in the **Roles** section. You can also see the expiry date of the role by hovering over the **"Clock"** icon.
![Image]()
### How to list and manage staff members?
Go to **Dashboard > User Management > Staff** to view the list of staff members.
### How to ban/unban a user?
Go to **Dashboard > User Management > Actions > Ban User**. Here you can ban/unban a user. Learn more about [banning users](/using-leaderos/ban-management).
### How to send credits to a user?
Go to **Dashboard > User Management > Actions > Send Credits**. Here you can send credits to a user. Learn more about [sending credits](/using-leaderos/credits).
You can only send credits to a user if the Credits module is enabled.
### How to give a item to a user?
Go to **Dashboard > User Management > Actions > Send Chest Item**. Here you can give a chest item to a user.
You can only give a chest item to a user if the Chest module is enabled.
# Vote
Source: https://docs.leaderos.net/using-leaderos/vote
You can share voting links with your players and encourage them to vote for your server.
The Vote Link Addition page facilitates the process of adding vote links to your website. To add a vote link, enter the name and the URL of the voting site you wish to direct users to.
### How to add a Vote link?
Go to **Dashboard > Misc > Vote > Add New**. You can add a vote link by providing the following information:
* **Name:** Input the name or label associated with the voting site. This name will be displayed on your website, providing users with a recognizable reference to the voting destination.
* **Link:** Enter the URL of the voting site to which users will be directed when clicking the associated link. Ensure the URL is accurate and directs users to the intended voting page.
![Image]()
### How to edit the Vote page description?
Go to **Dashboard > Settings > General Settings**. You can edit the description of the Vote page in the **Vote Description** field. You can use HTML tags to format the text.
# Wheel of Fortune Game
Source: https://docs.leaderos.net/using-leaderos/wheel-of-fortune
Your players can have a chance to win the product/credit you have set from your site. This game, which creates great excitement for your players, is only available in our software.
### How to add a Wheel of Fortune Game?
Go to **Dashboard > Misc > Fortune Wheel > Add New**. You can add a fortune wheel by providing the following information:
* **Title:** Enter the title of the fortune wheel.
* **Price Status:** Select the price status of the fortune wheel. You can select either **Free** or **Paid**.
* **Price:** If you have selected the price status as **Paid**, enter the price of the fortune wheel.
* **Re-Spin Period (in hours):** If you have selected the price status as **Free**, enter the re-spin period in hours.
* **Awards:** When the wheel is spun, the player can win one of the awards you have set. You can add awards by clicking on the **Add Award** button. For each award, you need to provide the following information:
* **Title:** Enter the title of the award.
* **Chance:** Enter the chance of winning the award. The chance should be a number between 0.01 and 100. You can enter decimal numbers.
* **Color:** Select the color of the award or enter hex code.
* **Type:** Select the type of the award. You can select either **Product**, **Credit** or **Pass**.
![Image]()
### How to see the Fortune Wheel Game?
After adding the fortune wheel, you can see the fortune wheel on the frontend by going to **Dashboard > Misc > Fortune Wheel**. You can see the list of fortune wheels you have added. Click on the **View** button to see the fortune wheel on the frontend.
### How to Play?
On the Fortune Wheel page, the player clicks on the **Spin** button to spin the wheel. The player can see the price status of the wheel on the screen.
After the wheel is spun, the player can win one of the awards you have set. The player can see the award won on the screen.
There are some rules for the player to play the game:
* If the price status is **Free**, the player can spin the wheel for free after the re-spin period.
* If the price status is **Paid**, the player needs to pay with the credits to spin the wheel.
![Image]()
### How to change the image in the center of the wheel?
Connect to your server via FTP (or cPanel > File Manager) and navigate to `/apps/main/public/assets/img/extras` and replace the `lottery-bg.png` file with your image.