Overview
Sync Discord roles into LuckPerms groups for linked players — automatic, consistent ranks across Discord and Hytale.
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
›
HyDiscordRanksX
Discord Roles → Hytale Ranks (LuckPerms) for linked players.
Filters across overview sections. Use copy buttons for commands, keys, and permissions.
Tip: search "cooldown", "tpa", "warp", "mute", "custom."
Copy buttons use your clipboard
Config path:
mods/hydiscordranks/config.json
Copy
🔗 What HyDiscordRanksX Does
HyDiscordRanksX syncs Discord roles into LuckPerms groups for linked players, so your ranks stay consistent across Discord and Hytale. If a player gains a role in Discord, they get the matching LuckPerms group in-game — and it’s removed automatically if the role is removed.
Uses HyDiscordX linking (links.json) for secure account matching.
✅ Requirements
| Dependency | Description | Where it’s used |
|---|---|---|
| HyDiscordX | Required for account linking. |
Uses: mods/HyDiscordX/links.json
Copy
|
| LuckPerms | Required for group / rank management. | Groups are assigned/removed based on Discord roles. |
More permission managers may be supported in the future — request them in Discord if you want.
✨ Features
| Feature | Description |
|---|---|
| Role → Group Mapping | Map Discord role IDs to LuckPerms group names. |
| Secure Matching | Uses HyDiscordX linked accounts (links.json) to match Discord ↔ Hytale players. |
| Reload Command | Reload config without restarting the server. |
| Force Sync | Trigger an immediate role→group sync on demand. |
| Auto-Generated Config | Creates a config with example mappings to help you get started quickly. |
⌨️ Commands (Quick)
| Command | Description |
|---|---|
/hydiscordranksx reload
Copy
|
Reloads the plugin config. |
/hydiscordranksx forcesync
Copy
|
Forces a sync of roles → ranks immediately. |
Full details live on the Commands page.
🔑 Permission (Quick)
| Permission | Description |
|---|---|
hydiscordranksx.admin
Copy
|
Allows using admin commands (reload / forcesync). |
Full details live on the Permissions page.