Overview
What HyDiscordRanksX does, how syncing works, and what you need to get started.
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 Overview
Discord Roles → LuckPerms Groups for linked Hytale players.
Filters across overview sections. Use copy buttons to copy commands/paths/keys.
Tip: search "cooldown", "tpa", "warp", "mute", "custom."
Copy buttons use your clipboard
🔗 What It Does
HyDiscordRanksX keeps your community ranks consistent across Discord and Hytale by syncing Discord roles into LuckPerms groups for linked players.
- If a player gains a mapped Discord role → HyDiscordRanksX adds the matching LuckPerms group.
- If a role is removed → the matching LuckPerms group is removed automatically.
- Matching is secure because it uses HyDiscordX account links (not usernames).
✅ Requirements
| Dependency | Description | Where it’s used |
|---|---|---|
| HyDiscordX | Required for account linking (Discord ↔ Hytale). |
Uses mods/HyDiscordX/links.json
Copy
|
| LuckPerms | Required for group/rank management and assignments. | Groups are applied/removed based on your mappings. |
🧠 How Syncing Works
- Player links their account using HyDiscordX.
- HyDiscordRanksX checks the player’s Discord roles in your configured Guild.
- For each matching mapping, the plugin adds/removes the LuckPerms group.
- This repeats automatically every
SyncIntervalSeconds.
Config file:
mods/hydiscordranks/config.json
Copy
⌨️ Useful Commands
| Command | Description | Permission |
|---|---|---|
/hydiscordranksx reload Copy |
Reloads the config without restarting. | hydiscordranksx.admin Copy |
/hydiscordranksx forcesync Copy |
Forces an immediate sync (great for testing). | hydiscordranksx.admin Copy |
⚡ Common Setup Pitfalls
- Wrong
GuildId(must match the server where the roles live). - Wrong
DiscordId(role IDs are not channel IDs). - LuckPerms group name typo (must match exactly).
- Player isn’t linked yet via HyDiscordX.