diff --git a/docs/tasks/rank-system-deployment/rank-structure.md b/docs/tasks/rank-system-deployment/rank-structure.md new file mode 100644 index 0000000..cfcfabf --- /dev/null +++ b/docs/tasks/rank-system-deployment/rank-structure.md @@ -0,0 +1,313 @@ +# Firefrost Gaming — Rank Structure Reference + +**Version:** 2.0 +**Updated:** 2026-03-29 +**Updated By:** Chronicler #47 +**Changes from v1.0:** Removed Fire/Frost from prefix text (color carries path), removed emojis (not supported in Minecraft chat), added Admin/Mod staff ranks, added full LuckPerms permission command list for implementation. + +--- + +## Color Reference + +| Rank | Hex Color | Notes | +|------|-----------|-------| +| Admin | `#A855F7` | Trinity purple — all three Trinity members share this | +| Mod | `#9E9E9E` | Staff gray | +| The Awakened | `#FFFFFF` | White | +| Fire path (all tiers) | `#FF3D00` | Deep orange/red | +| Frost path (all tiers) | `#00E5FF` | Electric cyan | +| Founder | `#FFD600` | Amber gold | + +--- + +## Full Rank Hierarchy + +``` +default (no subscription — no server access) + └── awakened ($1 one-time) + ├── fire_elemental ($5/mo) + │ └── fire_knight ($10/mo) + │ └── fire_master ($15/mo) + │ └── fire_legend ($20/mo) + │ └── founder ($499 lifetime) + └── frost_elemental ($5/mo) + └── frost_knight ($10/mo) + └── frost_master ($15/mo) + └── frost_legend ($20/mo) + └── founder ($499 lifetime) + +Staff (parallel track — not subscriber ranks): + mod + admin ← Michael (frostystyle), Meg (gingerfury), Holly (unicorn20089) +``` + +**Founder** inherits from BOTH `fire_legend` AND `frost_legend` simultaneously. + +--- + +## Chat Prefixes + +| Group | Prefix Text | Color | +|-------|-------------|-------| +| `admin` | `[Admin]` | `#A855F7` | +| `mod` | `[Mod]` | `#9E9E9E` | +| `awakened` | `[The Awakened]` | `#FFFFFF` | +| `fire_elemental` | `[Elemental]` | `#FF3D00` | +| `frost_elemental` | `[Elemental]` | `#00E5FF` | +| `fire_knight` | `[Knight]` | `#FF3D00` | +| `frost_knight` | `[Knight]` | `#00E5FF` | +| `fire_master` | `[Master]` | `#FF3D00` | +| `frost_master` | `[Master]` | `#00E5FF` | +| `fire_legend` | `[Legend]` | `#FF3D00` | +| `frost_legend` | `[Legend]` | `#00E5FF` | +| `founder` | `[Founder]` | `#FFD600` | + +The path (Fire vs Frost) is communicated entirely through color. No text label needed. + +--- + +## Permissions Per Tier + +### Homes + +| Group | Max Homes | +|-------|-----------| +| default | 0 | +| awakened | 1 | +| fire/frost_elemental | 5 | +| fire/frost_knight | 10 | +| fire/frost_master | 20 | +| fire/frost_legend | 35 | +| founder | 50 | + +### Chunk Claims (FTB Chunks) + +| Group | Max Claimed | Max Force Loaded | +|-------|-------------|-----------------| +| default | 0 | 0 | +| awakened | 0 | 0 | +| fire/frost_elemental | 25 | 0 | +| fire/frost_knight | 49 | 4 | +| fire/frost_master | 100 | 9 | +| fire/frost_legend | 121 | 16 | +| founder | 225 | 81 | + +### Random Teleport (/rtp) + +| Group | Cooldown | +|-------|----------| +| awakened | No access | +| fire/frost_elemental | 60 minutes | +| fire/frost_knight | 30 minutes | +| fire/frost_master | 15 minutes | +| fire/frost_legend | 10 minutes | +| founder | No cooldown | + +--- + +## Full LuckPerms Permission Commands + +Run these in-game or via console after LuckPerms is installed and MySQL backend is configured. + +### Create Groups + +``` +/lp creategroup default +/lp creategroup awakened +/lp creategroup fire_elemental +/lp creategroup frost_elemental +/lp creategroup fire_knight +/lp creategroup frost_knight +/lp creategroup fire_master +/lp creategroup frost_master +/lp creategroup fire_legend +/lp creategroup frost_legend +/lp creategroup founder +/lp creategroup mod +/lp creategroup admin +``` + +### Set Group Inheritance + +``` +/lp group awakened parent add default +/lp group fire_elemental parent add awakened +/lp group frost_elemental parent add awakened +/lp group fire_knight parent add fire_elemental +/lp group frost_knight parent add frost_elemental +/lp group fire_master parent add fire_knight +/lp group frost_master parent add frost_knight +/lp group fire_legend parent add fire_master +/lp group frost_legend parent add frost_master +/lp group founder parent add fire_legend +/lp group founder parent add frost_legend +``` + +### Set Chat Prefixes + +``` +/lp group admin meta setprefix 100 "&x&A&8&5&5&F&7[Admin] " +/lp group mod meta setprefix 90 "&x&9&E&9&E&9&E[Mod] " +/lp group awakened meta setprefix 10 "&f[The Awakened] " +/lp group fire_elemental meta setprefix 20 "&x&F&F&3&D&0&0[Elemental] " +/lp group frost_elemental meta setprefix 20 "&x&0&0&E&5&F&F[Elemental] " +/lp group fire_knight meta setprefix 30 "&x&F&F&3&D&0&0[Knight] " +/lp group frost_knight meta setprefix 30 "&x&0&0&E&5&F&F[Knight] " +/lp group fire_master meta setprefix 40 "&x&F&F&3&D&0&0[Master] " +/lp group frost_master meta setprefix 40 "&x&0&0&E&5&F&F[Master] " +/lp group fire_legend meta setprefix 50 "&x&F&F&3&D&0&0[Legend] " +/lp group frost_legend meta setprefix 50 "&x&0&0&E&5&F&F[Legend] " +/lp group founder meta setprefix 60 "&x&F&F&D&6&0&0[Founder] " +``` + +**Note:** Hex colors in LuckPerms use `&x&R&R&G&G&B&B` format (each hex digit separated). Requires a chat formatting plugin that supports hex colors (e.g. EssentialsX Chat, ChatControlRed, or similar) running on MC 1.16+. + +### Set Permissions — Awakened + +``` +/lp group awakened permission set ftbessentials.home true +/lp group awakened permission set ftbessentials.sethome true +/lp group awakened permission set ftbessentials.home.limit.1 true +/lp group awakened permission set ftbchunks.max_claimed.0 true +/lp group awakened permission set ftbchunks.max_force_loaded.0 true +``` + +### Set Permissions — Fire Elemental + +``` +/lp group fire_elemental permission set ftbessentials.home.limit.5 true +/lp group fire_elemental permission set ftbessentials.rtp true +/lp group fire_elemental permission set ftbessentials.rtp.cooldown.3600 true +/lp group fire_elemental permission set ftbchunks.max_claimed.25 true +/lp group fire_elemental permission set ftbchunks.max_force_loaded.0 true +``` + +### Set Permissions — Frost Elemental + +``` +/lp group frost_elemental permission set ftbessentials.home.limit.5 true +/lp group frost_elemental permission set ftbessentials.rtp true +/lp group frost_elemental permission set ftbessentials.rtp.cooldown.3600 true +/lp group frost_elemental permission set ftbchunks.max_claimed.25 true +/lp group frost_elemental permission set ftbchunks.max_force_loaded.0 true +``` + +### Set Permissions — Fire Knight + +``` +/lp group fire_knight permission set ftbessentials.home.limit.10 true +/lp group fire_knight permission set ftbessentials.rtp.cooldown.1800 true +/lp group fire_knight permission set ftbchunks.max_claimed.49 true +/lp group fire_knight permission set ftbchunks.max_force_loaded.4 true +``` + +### Set Permissions — Frost Knight + +``` +/lp group frost_knight permission set ftbessentials.home.limit.10 true +/lp group frost_knight permission set ftbessentials.rtp.cooldown.1800 true +/lp group frost_knight permission set ftbchunks.max_claimed.49 true +/lp group frost_knight permission set ftbchunks.max_force_loaded.4 true +``` + +### Set Permissions — Fire Master + +``` +/lp group fire_master permission set ftbessentials.home.limit.20 true +/lp group fire_master permission set ftbessentials.rtp.cooldown.900 true +/lp group fire_master permission set ftbchunks.max_claimed.100 true +/lp group fire_master permission set ftbchunks.max_force_loaded.9 true +``` + +### Set Permissions — Frost Master + +``` +/lp group frost_master permission set ftbessentials.home.limit.20 true +/lp group frost_master permission set ftbessentials.rtp.cooldown.900 true +/lp group frost_master permission set ftbchunks.max_claimed.100 true +/lp group frost_master permission set ftbchunks.max_force_loaded.9 true +``` + +### Set Permissions — Fire Legend + +``` +/lp group fire_legend permission set ftbessentials.home.limit.35 true +/lp group fire_legend permission set ftbessentials.rtp.cooldown.600 true +/lp group fire_legend permission set ftbchunks.max_claimed.121 true +/lp group fire_legend permission set ftbchunks.max_force_loaded.16 true +``` + +### Set Permissions — Frost Legend + +``` +/lp group frost_legend permission set ftbessentials.home.limit.35 true +/lp group frost_legend permission set ftbessentials.rtp.cooldown.600 true +/lp group frost_legend permission set ftbchunks.max_claimed.121 true +/lp group frost_legend permission set ftbchunks.max_force_loaded.16 true +``` + +### Set Permissions — Founder + +``` +/lp group founder permission set ftbessentials.home.limit.50 true +/lp group founder permission set ftbessentials.rtp true +/lp group founder permission set ftbessentials.rtp.bypass true +/lp group founder permission set ftbchunks.max_claimed.225 true +/lp group founder permission set ftbchunks.max_force_loaded.81 true +``` + +### Set Permissions — Mod + +``` +/lp group mod permission set minecraft.command.kick true +/lp group mod permission set minecraft.command.ban true +/lp group mod permission set minecraft.command.unban true +/lp group mod permission set minecraft.command.mute true +/lp group mod permission set ftbessentials.rtp.bypass true +/lp group mod permission set ftbessentials.home.limit.20 true +/lp group mod permission set ftbchunks.max_claimed.100 true +/lp group mod permission set ftbchunks.max_force_loaded.9 true +``` + +### Set Permissions — Admin + +``` +/lp group admin permission set * true +``` + +**Note:** `* true` gives Admin full permissions on the server. Apply with caution — only Trinity members should hold this rank. + +### Assign Trinity Members to Admin + +``` +/lp user frostystyle parent add admin +/lp user gingerfury parent add admin +/lp user unicorn20089 parent add admin +``` + +### Assign Holly's Builder Access (immediate — before full rollout) + +``` +/lp user unicorn20089 parent add admin +``` + +--- + +## Important Notes for Implementation + +**Hex color support:** The `&x&R&R&G&G&B&B` format requires a chat formatting plugin. Vanilla Minecraft chat won't render hex colors without one. Confirm your chat plugin supports it before running prefix commands. + +**FTB Chunks/Essentials:** These mods read LuckPerms group names directly from the config files (`ftbchunks.snbt`, `ftbessentials.snbt`). The permission nodes above cover the LuckPerms side — you also need to update those config files per server to match the limits in the tables above. + +**MySQL sync:** Once LuckPerms is on the MySQL backend, running these commands on any one server applies them across the entire network. No need to run on each server individually. + +**Cooldown inheritance:** Higher tiers override lower cooldown values via inheritance. LuckPerms uses the most specific (highest priority) value, so a Knight's 1800s cooldown overrides Elemental's 3600s automatically. + +--- + +## Revision History + +| Version | Date | Author | Changes | +|---------|------|--------|---------| +| 1.0 | 2026-02-08 | Michael | Initial structure (in archive/luckperms-structure.md) | +| 2.0 | 2026-03-29 | Chronicler #47 | Removed Fire/Frost from prefix text, removed emojis, added Admin/Mod ranks, full permission command list added |