Configuration
Full config breakdown for config.json — Discord bot settings, role→group mapping, and sync interval.
Table of Contents
Jump to a section
Overview
What it is, features, and goals
›
Installation
Install steps + recommended setup
›
Commands
Command list + examples
›
Permissions
Permission nodes and rank setup
›
Configurations
Config options and details
›
Tutorials
Common setups and how-to guides
›
Author & Support
Contact, bugs, feedback, links
›
Config Reference
Search + copy tools included. This page is config-focused.
Filters across all configuration sections. Use copy buttons to copy any key.
Tip: search "cooldown", "tpa", "warp", "mute", "custom."
Copy buttons use your clipboard
Config path:
mods/hydiscordranks/config.json
Copy
⚙️ Discord
| Key | Description | Example |
|---|---|---|
Discord.BotToken Copy |
Discord bot token used to query roles for linked users. | "replace-me" |
Discord.GuildId Copy |
Discord server (guild) ID where roles are checked. | "123456789012345678" |
🏷️ Rank Mapping
Map Discord role IDs into LuckPerms groups. The section is keyed by your group name (example:
vip, staff, admin).
| Key | Description | Example |
|---|---|---|
Rank Copy |
Container for role→group mappings. Each property under Rank is a group name. |
"vip": [ ... ] |
DiscordId Copy |
The Discord role ID that grants the group. | "123456789012345678" |
RankName Copy |
The LuckPerms group name to apply/remove. | "example" |
Example config:
{
"Discord": {
"BotToken": "replace-me",
"GuildId": "123456789012345678"
},
"Rank": {
"vip": [
{
"DiscordId": "123456789012345678",
"RankName": "vip"
}
],
"staff": [
{
"DiscordId": "234567890123456789",
"RankName": "staff"
}
]
},
"SyncIntervalSeconds": 60
}
⏱️ SyncIntervalSeconds
| Key | Description | Example |
|---|---|---|
SyncIntervalSeconds Copy |
How often HyDiscordRanksX syncs roles → groups (in seconds). | 60 |
Lower values sync faster but may increase Discord API usage.