Configuration

This document describes the structure and parameters of the configuration file. This file is used to customize the behavior of the application. It is in JSON format.

General Structure

The configuration file is organized into several main sections:

Buttons: Defines buttons displayed to the user.
LogoUrl: Specifies the URL of the logo.
MaxPlayerSlots: Defines the maximum number of player slots.
MaxQueueSlots: Defines the maximum number of queue slots.
ConnectMessageLength: How long it will show the "connecting" message.
Grace: Configures grace period settings.
Reserve: Configures reserved slots.
Limiter: Configures rate limiting.
Vanity: Configures user status settings.
QueueRanks: Defines settings for different queue ranks.
Commands: Configures command permissions.
Discord: Configures Discord integration.
Debug: Enables or disables debug mode.

Section Details

Here's a detailed breakdown of each section:

Buttons

This section is an array of button objects. Each object defines a button that will be displayed to the user.

Text (string, required): The text displayed on the button.
Url (string or false, required): The URL that the button will link to. If set to false, the button will not link to any page.

Color (string or null, optional): The color of the button. Example values: "red", "green" or null for default. Only support red or green color scheme.

"Buttons": [
    { "Text": "Store", "Url": "https://xceedrp.tebex.io/", "Color": null },
    { "Text": "Queue List", "Url": false, "Color": "red" },
    { "Text": "Discord", "Url": "https://discord.gg/EVP6VRedPT", "Color": "green" }
]

LogoUrl

This section specifies the URL of the logo image.

LogoUrl (string or null, required): The URL of the logo image. (600x60) Null disables it
```
"LogoUrl": "https://i.ibb.co/dwrbrJ25/image-1.png"
```

MaxPlayerSlots

MaxPlayerSlots (integer or null): The maximum number of player slots allowed on the server. If set to null uses your servers set max players in your cfg.
```
"MaxPlayerSlots": null
```

MaxQueueSlots

MaxQueueSlots (integer): The maximum number of players allowed in the queue.
```
 "MaxQueueSlots": 500,
```

ConnectMessageLength

ConnectMessageLength (integer): How long it will show the "connecting" message.
```
"ConnectMessageLength": 10,
```

Grace

This section configures the crash/disconnect grace period, Gives players who crash extra priority.

Enabled (boolean, required): Enables or disables the grace period.
PriorityPoints (integer, required): The number of priority points required to use the grace period.

Time (integer, required): The duration of the grace period in seconds.

"Grace": {
    "Enabled": true,
    "PriorityPoints": 10000,
    "Time": 180
}

Reserve

This section configures reserved slots, which can be setup as a "VIP" queue or just slots that are saved for people with a reserve.

Enabled (boolean, required): Enables or disables reserved slots.
Slots (integer, required): The number of reserved slots.

ReserveSkipPrio (boolean, required): Determines if reserved players bypass the priority queue.

"Reserve": {
    "Enabled": true,
    "Slots": 10,
    "ReserveSkipPrio": false
}

Limiter

This section configures rate limiting to prevent spam.

SpamLimit (integer, required): The maximum number of actions allowed within the specified time.
SpamResetTime (integer, required): The time in seconds after which the spam count resets.
```
"Limiter": {
    "SpamLimit": 5,
    "SpamResetTime": 60
}
```

Vanity

This section configures the vanity URL feature. (Discord user status)

UseCheck (boolean, required): Enables or disables the vanity URL check.
VanityUrl (string, required): The vanity URL.

PriorityPoints (integer, required): The number of priority points granted for having the vanity URL.

"Vanity": {
    "UseCheck": true,
    "VanityUrl": ".gg/XceedRP",
    "PriorityPoints": 2500
}

QueueRanks

This section defines the settings for different queue ranks. Each rank is defined by a unique key (e.g., "owner", "admin").

[rank_name] (object): An object representing a queue rank.

id (string, required): The ID associated with the rank (e.g., a Discord role ID).
priority (integer, required): The priority of the rank. Higher values mean higher priority in the queue.
reserved (boolean, required): Indicates whether this rank has access to reserved slots.
require (boolean, required): Indicates if this rank is required.

"QueueRanks": {
    "owner": {
        "id": "1214233028470243358",
        "priority": 100000,
        "reserved": true,
        "require": false
    },
    "admin": {
        "id": "1214220667428278342",
        "priority": 2000,
        "reserved": true,
        "require": false
    },
    "allowlist": {
        "id": "1216073024097488946",
        "priority": 0,
        "reserved": false,
        "require": true
    }
}

Commands

This section configures permissions for commands.

Perm (string): The permission required to use commands (e.g., a group or role).
```
"Commands": {
    "Perm": "group.admin"
}
```

Discord

This section configures Discord Bot integration.

BotToken (string): The Discord bot token.

GuildID (string): The Discord guild (server) ID.

"Discord": {
    "BotToken": "TOKEN HERE",
    "GuildID": "1206736099460911124"
}

Debug

Debug (boolean): Enables or disables debug mode.
```
"Debug": false
```

PreviousInstallation NextCommands

Last updated 3 months ago