The Legacy Voyage

Tutorials

Step-by-step guides for mapping roles to ranks and verifying syncing.

Back to HyDiscordRanksX Wiki
Table of Contents
Jump to a section
Wiki Home
📌 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 Tutorials
Copy-paste friendly examples + quick verification steps.
Filters across tutorial sections. Use copy buttons to copy paths, commands, and sample JSON.
Tip: search "cooldown", "tpa", "warp", "mute", "custom." Copy buttons use your clipboard
Config file: mods/hydiscordranks/config.json Copy
🧩 Tutorial 1 — Add a VIP Role → VIP Group
  1. In Discord: enable Developer Mode → right-click the VIP role → Copy Role ID.
  2. Open mods/hydiscordranks/config.json and add your mapping under Rank.
  3. Run /hydiscordranksx reload. Copy
  4. Run /hydiscordranksx forcesync to test immediately. Copy
Example snippet:
"Rank": {
  "vip": [
    {
      "DiscordId": "123456789012345678",
      "RankName": "vip"
    }
  ]
}
🛠️ Tutorial 2 — Staff Roles (Mod/Admin) → Multiple Groups
You can map multiple Discord roles into different LuckPerms groups. Keep each group name separate under Rank. 
"Rank": {
  "mod": [
    { "DiscordId": "222222222222222222", "RankName": "mod" }
  ],
  "admin": [
    { "DiscordId": "333333333333333333", "RankName": "admin" }
  ]
}
🔍 Tutorial 3 — Verify It’s Working
  • Confirm the player is linked via HyDiscordX (their entry should exist in mods/HyDiscordX/links.json). Copy
  • After changing roles in Discord, run /hydiscordranksx forcesync to verify immediately.
  • Check LuckPerms to confirm the group is applied to the user (exact command depends on your LuckPerms/Hytale integration).
⏱️ Tutorial 4 — Tune Sync Interval
Adjust how often the plugin syncs automatically:
Key Description Example
SyncIntervalSeconds Copy How often to sync roles → groups (seconds). Lower = faster, but more Discord polling. 60
After changing it, run: /hydiscordranksx reload.