Installation
Install HyDiscordRanksX + dependencies, then configure role→group mappings.
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
›
Install Guide
Get role syncing running in minutes.
Filters across installation sections. Use copy buttons for paths and keys.
Tip: search "cooldown", "tpa", "warp", "mute", "custom."
Copy buttons use your clipboard
✅ Prerequisites
HyDiscordRanksX requires both HyDiscordX and LuckPerms.
| Requirement | Description | Notes |
|---|---|---|
| HyDiscordX | Account linking is required. |
Links stored in: mods/HyDiscordX/links.json
Copy
|
| LuckPerms | Group/rank management backend. | Ensure LuckPerms is installed and working before adding HyDiscordRanksX. |
📦 Install Steps
- Place the HyDiscordRanksX mod/plugin into your server’s mods folder (same place you install other mods).
- Start the server once to auto-generate the config file.
-
Open:
mods/hydiscordranks/config.jsonCopy -
Fill in your Discord
BotTokenandGuildId, then add role→group mappings. -
Reload in-game:
/hydiscordranksx reloadCopy -
Optional: force a sync immediately:
/hydiscordranksx forcesyncCopy
🧠 Tips
- Enable Discord Developer Mode to copy role IDs easily.
- LuckPerms group names must match exactly (case-sensitive depending on your setup).