** ?️ UltimateRanks - 完整文档
概述
描述
UltimateRanks 是一款面向运行 Paper 1.21+ 的 Minecraft 服务器的下一代权限组管理插件。与传统仅允许玩家拥有单一权限组的插件不同,UltimateRanks 引入了一种革命性的 混合系统,允许玩家 同时拥有多个权限组,并选择其中一个作为在聊天和标签页列表中 主动显示 的权限组。
UltimateRanks 基于现代 Java 21 特性和 Paper API 构建,通过异步数据库操作、智能缓存以及美观的基于 GUI 的权限组管理界面,提供卓越的性能。
为何选择 UltimateRanks?
| 功能 |
传统插件 |
UltimateRanks |
| 多权限组 |
❌ 仅限一个权限组 |
✅ 无限权限组 |
| 权限叠加 |
❌ 仅单个权限组的权限 |
✅ 所有拥有的权限组均生效 |
| 视觉自定义 |
❌ 固定显示 |
✅ 可选择显示的活跃权限组 |
| GUI 管理 |
⚠️ 基础或无 |
✅ 美观的分页 GUI |
| RGB 颜色 |
⚠️ 支持有限 |
✅ 完整的 MiniMessage 支持 |
| 性能 |
⚠️ 同步操作 |
✅ 100% 异步数据库 |
| LuckPerms 同步 |
⚠️ 替换或冲突 |
✅ 无缝集成 |
目标受众
- 网络服务器(Network):管理复杂的权限组层级(VIP + Builder + Staff)
- RPG 服务器:职业权限组 + 成就权限组 + 捐赠者权限组
- 创造服务器:建造者角色 + 主题权限组 + VIP 等级
- 生存服务器:进度权限组 + 捐赠者特权 + 特殊活动
- 监狱服务器:矿坑权限组 + Prestige + VIP 套餐
功能
? 核心功能
- 多权限组所有权系统
- 玩家可以同时拥有 无限个权限组
- 同时拥有 VIP + Builder + Helper
- 所有权限组贡献权限(累加系统)
- 权限组之间零冲突
示例:
玩家拥有:[Member, VIP, Builder]
权限 = Member + VIP + Builder (合并)
活跃显示 = VIP (在聊天中显示)
- 活跃显示权限组选择
- 选择在聊天前缀/后缀中显示的权限组
- 通过交互式 GUI 在拥有的权限组之间切换
- 实时刷新,无需重新连接
- 保留来自其他权限组的所有权限
- 美观的分页 GUI
- 简洁直观的权限组选择菜单
- 视觉状态:Active(发光)、Owned(可用)、Locked(不可用)
- 每页 28 个权限组,导航流畅
- GUI 中直接显示过期计时器
- 支持资源包的自定义图标
- 高级权限系统
- 双模式运行:
- 独立模式(Standalone Mode):内置 Bukkit 权限系统
- LuckPerms 模式:与 LuckPerms API 完全集成
- 自动检测可用系统
- 聚合所有拥有权限组的权限
- 支持通配符(例如
essentials.*)
- 支持否定权限(例如
-essentials.fly)
- 过期与时间管理
- 临时权限组,自动过期
- 灵活的时间格式:
30d、7d、1w、1mo、1y、permanent
- 自动清理过期的权限组
- 过期前的警告通知
- GUI 中的可视化倒计时
- 完整的 MiniMessage 支持
- RGB 颜色:
<FF5555>text</color>
- 渐变:
<gradient:gold:yellow>VIP</gradient>
- 格式化:
<bold>、<italic>、<underline>
- 悬停事件和点击动作
- 旧版颜色代码转换
- 高性能数据库
- SQLite:零配置,非常适合小型服务器
- MySQL:HikariCP 连接池,适用于大型网络
- 100% 异步操作(零服务器卡顿)
- 事务支持以确保数据完整性
- 自动架构管理
- 智能缓存系统
- 在线玩家的内存缓存
- 亚毫秒级查找时间
- 自动缓存失效
- 线程安全的并发操作
? 视觉功能
聊天格式化
之前:
<Player> Hello!
之后:
[VIP] Player ★: Hello!
格式:
{prefix} + {player} + {suffix} + : + {message}
GUI 状态
| 状态 |
视觉效果 |
描述 |
| Active |
? 发光物品 |
当前装备的权限组 |
| Owned |
✅ 普通图标 |
点击以装备 |
| Locked |
? 障碍方块 |
未拥有 |
权限组显示示例
╔══════════════════════════════╗
║ My Ranks ║
╠══════════════════════════════╣
║ ║
║ [? VIP] (Active) ║
║ Click to keep equipped ║
║ Duration: Permanent ║
║ ║
║ [✅ Builder] ║
║ Click to equip ║
║ Expires in: 15 days ║
║ ║
║ [? MVP] (Locked) ║
║ You don't own this rank ║
║ ║
╚══════════════════════════════╝
? 技术功能
架构
- SOLID 原则:单一职责、接口隔离
- 设计模式:策略、构建器、仓储、单例
- 依赖注入:代码整洁,易于测试
- 分层分离:模型、管理器、数据库、GUI、命令
性能指标
数据库操作:
✅ 加载玩家数据:~5ms (SQLite), ~3ms (MySQL)
✅ 保存玩家数据:~8ms (SQLite), ~4ms (MySQL)
✅ 权限组切换:~2ms (缓存命中)
内存使用:
✅ 插件基础占用:~5MB
✅ 每位玩家(已缓存):~2KB
✅ GUI 打开时:+8KB
可扩展性:
✅ 支持 1,000+ 并发玩家
✅ 已测试 100+ 权限组
✅ 零 Tick 卡顿(100% 异步)
线程安全
- 用于玩家缓存的并发哈希表
- 用于异步操作的 CompletableFuture
- 同步数据库事务
- 权限组切换中无竞态条件
? 集成功能
LuckPerms 集成
- 自动同步:UltimateRanks ⟷ LuckPerms 群组
- 回退支持:无论是否安装 LuckPerms 均可工作
- 群组创建:自动创建缺失的 LuckPerms 群组
- 权限继承:尊重 LuckPerms 的层级结构
PlaceholderAPI 支持
可用占位符:
%ultimateranks_prefix% → 当前等级前缀
%ultimateranks_suffix% → 当前等级后缀
%ultimateranks_rank_displayname% → 等级显示名称
%ultimateranks_rank_id% → 等级 ID
%ultimateranks_rank_weight% → 等级权重
%ultimateranks_total_ranks% → 拥有的等级总数
聊天插件兼容性
- ✅ EssentialsX Chat
- ✅ ChatControl
- ✅ VentureChat
- ✅ 任何使用 PlaceholderAPI 的插件
安装
要求
- Minecraft 服务器: Paper 1.21+ (或 Purpur/Pufferfish)
- Java 版本: Java 21+
- 可选依赖项:
- LuckPerms 5.4+ (用于高级权限管理)
- PlaceholderAPI 2.11+ (用于占位符变量)
快速安装
-
下载
从 Releases 页面下载 UltimateRanks-1.0.0.jar
-
安装
放入 plugins 文件夹
cp UltimateRanks-1.0.0.jar /path/to/server/plugins/
-
首次启动
启动服务器以生成配置文件
java -jar paper.jar
等待出现以下信息: "[UltimateRanks] ✓ UltimateRanks enabled successfully"
停止服务器
stop
-
配置
编辑生成的配置文件
nano plugins/UltimateRanks/config.yml
nano plugins/UltimateRanks/ranks.yml
-
重启
再次启动服务器
java -jar paper.jar
验证
控制台输出(成功):
[UltimateRanks] ═══════════════════════════════
[UltimateRanks] UltimateRanks v1.0.0
[UltimateRanks] Advanced Rank Management
[UltimateRanks] ═══════════════════════════════
[UltimateRanks] Loading configuration files...
[UltimateRanks] ✓ Configuration loaded
[UltimateRanks] Connecting to database...
[UltimateRanks] ✓ Database connected (SQLite)
[UltimateRanks] Initializing managers...
[UltimateRanks] ✓ Loaded 10 ranks
[UltimateRanks] ✓ Managers initialized
[UltimateRanks] Initializing permission system...
[UltimateRanks] ✓ LuckPerms detected - Using LuckPerms handler
[UltimateRanks] Registering event listeners...
[UltimateRanks] ✓ Event listeners registered
[UltimateRanks] Registering commands...
[UltimateRanks] ✓ Commands registered
[UltimateRanks] ✓ PlaceholderAPI integration enabled
[UltimateRanks] ✓ UltimateRanks enabled successfully in 245ms
[UltimateRanks] ✓ Permission Mode: LuckPerms
配置
主配置文件 (config.yml)
数据库选择
database:
type: sqlite 选项: sqlite, mysql
GUI 自定义
gui:
menu-title: '<gradient:gold:yellow>My Ranks</gradient>'
items-per-page: 28
refresh-interval: 100 刻 (ticks)
聊天格式化
chat:
enabled: true
format: '{prefix}{player}{suffix}: {message}'
allow-colors: true
过期管理
expiration:
auto-cleanup: true
cleanup-interval: 30 分钟
notify-on-expiration: true
warn-before-expiration: 24 小时
权限系统
permissions:
mode: auto 选项: auto, standalone, luckperms
apply-on-join: true
refresh-on-change: true
等级定义 (ranks.yml)
ranks:
vip:
weight: 10 层级关系(数值越高,等级越高)
display_name: '<gold>VIP</gold>' 在 GUI/消息中显示的名称
prefix: '<gradient:yellow:gold>[VIP]</gradient> '
suffix: ''
gui_icon: GOLD_INGOT GUI 中显示的图标
custom_model_data: 0 资源包支持
permissions:
- 'essentials.fly'
- 'essentials.heal'
- 'ultimateranks.chat.color'
MySQL 配置
database:
type: mysql
mysql:
host: localhost
port: 3306
database: ultimateranks
username: root
password: 'your_password'
pool-size: 10
parameters: '?useSSL=false&autoReconnect=true'
? 从零创建等级 - 完整指南
? 快速概览
在哪里创建等级: plugins/UltimateRanks/ranks.yml
流程:
- 定义等级结构
- 设置权重(层级)
- 选择颜色/前缀
- 添加权限节点
- 选择 GUI 图标
- 重载插件
? 逐步教程
步骤 1:打开 ranks.yml
进入服务器文件夹
cd plugins/UltimateRanks/
编辑 ranks.yml
nano ranks.yml
或者使用 Notepad++/VSCode
步骤 2:基础等级结构
ranks:
your_rank_name: 唯一标识符(小写,无空格)
weight: 10 数字(数值越高,重要性越高)
display_name: '<gold>Display Name</gold>' 玩家看到的名称
prefix: '<gold>[Prefix]</gold> ' 聊天前缀
suffix: '' 聊天后缀(可选)
gui_icon: GOLD_INGOT 菜单中显示的物品
custom_model_data: 0 用于资源包(0 = 禁用)
permissions: 该等级赋予的权限列表
- 'permission.node.1'
- 'permission.node.2'
? 示例:创建你的第一个等级
让我们从头创建一个 "Supporter" 等级:
ranks:
supporter:
weight: 5 低阶(高于默认等级)
display_name: '<gradient:green:lime>Supporter</gradient>'
prefix: '<gradient:green:lime>[Supporter]</gradient> '
suffix: ' <green>♥</green>'
gui_icon: EMERALD 绿色绿宝石物品
custom_model_data: 0
permissions:
- 'essentials.spawn' 基本传送点
- 'essentials.sethome' 设置家
- 'essentials.home' 传送到家
- 'essentials.back' 返回死亡地点
保存文件,然后在游戏中执行:
/rank reload
/rank grant YourName supporter
命令与权限
命令
| 命令 |
描述 |
权限 |
使用示例 |
/rank menu |
打开等级 GUI |
ultimateranks.menu |
/rank menu |
/rank set <玩家> <等级> |
设置主要等级 |
ultimateranks.admin.set |
/rank set Steve vip |
/rank grant <玩家> <等级> [时间] |
添加等级 |
ultimateranks.admin.grant |
/rank grant Steve builder 30d |
/rank remove <玩家> <等级> |
移除等级 |
ultimateranks.admin.remove |
/rank remove Steve vip |
/rank reload |
重新加载配置 |
ultimateranks.admin.reload |
/rank reload |
命令别名
/rank → /ranks, /ur
menu → gui, open
remove → take, revoke
reload → rl
权限层级
ultimateranks.* (所有权限)
├── ultimateranks.use (基本访问权限)
├── ultimateranks.menu (GUI 访问权限)
└── ultimateranks.admin.* (管理员命令)
├── ultimateranks.admin.set
├── ultimateranks.admin.grant
├── ultimateranks.admin.remove
└── ultimateranks.admin.reload
特殊权限
| 权限 |
描述 |
默认值 |
ultimateranks.chat.color |
在聊天中使用颜色代码 |
false |
ultimateranks.bypass.expiration |
等级永不过期 |
op |
ultimateranks.notify.expiration |
接收过期警告 |
true |
使用指南
为玩家
打开等级菜单
1. 输入:/rank menu
2. GUI 将显示所有可用的等级
3. 点击任意已拥有的等级以装备它
4. 你的聊天前缀会立即更新
理解等级状态
? 发光物品 = 当前激活
→ 这是你的展示等级
→ 在聊天和标签页列表中显示
✅ 普通物品 = 已拥有但未激活
→ 点击可切换至此等级
→ 你仍拥有其权限
? 屏障 = 锁定
→ 你未拥有此等级
→ 请联系工作人员授予
检查过期时间
打开 /rank menu 并悬停在任意已拥有的等级上:
[VIP]
✅ 点击以装备
持续时间:25 天,14 小时
权重:10
对于管理员
设置等级
1. 在 ranks.yml 中定义等级
ranks:
premium:
weight: 20
display_name: '<gradient:aqua:blue>Premium</gradient>'
prefix: '<gradient:aqua:blue>[Premium]</gradient> '
suffix: ' <aqua>★</aqua>'
gui_icon: DIAMOND
permissions:
- 'essentials.*'
- 'worldedit.selection.*'
2. 重新加载配置
/rank reload
3. 授予玩家
永久等级
/rank grant PlayerName premium
30 天等级
/rank grant PlayerName premium 30d
1 周等级
/rank grant PlayerName premium 1w
管理玩家等级
查看玩家等级
玩家可通过 /rank menu 查看自己的等级
管理员使用数据库或缓存检查
重置玩家等级
移除所有等级并设置为默认
/rank set PlayerName default
临时 VIP 促销
授予玩家 7 天的 VIP 权限
/rank grant PlayerName vip 7d
玩家将在到期前 24 小时收到通知
Rank 在 7 天后自动移除
**多重 Rank 分配**
```bash
玩家可以同时拥有 VIP + Builder + Helper
/rank grant PlayerName vip
/rank grant PlayerName builder
/rank grant PlayerName helper
所有三个 Rank 均授予权限
玩家可通过 GUI 选择聊天中显示的 Rank
常见工作流程
新玩家设置
1. 玩家加入 → 自动获得 "default" Rank
2. 玩家捐赠 → 授予 VIP
/rank grant PlayerName vip
3. 玩家申请成为 builder → 授予 builder
/rank grant PlayerName builder
玩家现在拥有:default + vip + builder(所有权限)
玩家可选择 "vip" 或 "builder" 用于聊天显示
员工晋升
晋升为 Helper(保留 VIP)
/rank grant PlayerName helper
玩家保留 VIP 特权 + 获得员工权限
可在 GUI 中切换 [VIP] 和 [Helper] 前缀
季节性活动
万圣节活动 - 30 天
/rank grant * halloween 30d
所有在线玩家获得 halloween Rank
活动结束后自动过期
占位符
PlaceholderAPI 集成
所有占位符均可与任何支持 PlaceholderAPI 的插件配合使用(DeluxeChat、FeatherBoard 等)
| 占位符 |
输出 |
示例 |
%ultimateranks_prefix% |
当前 Rank 前缀 |
[VIP] |
%ultimateranks_suffix% |
当前 Rank 后缀 |
★ |
%ultimateranks_rank_displayname% |
Rank 显示名称 |
VIP |
%ultimateranks_rank_id% |
Rank 标识符 |
vip |
%ultimateranks_rank_weight% |
Rank 权重 |
10 |
%ultimateranks_total_ranks% |
拥有的总 Rank 数 |
3 |
使用示例
DeluxeChat 格式
formats:
default:
format: '%ultimateranks_prefix%%player_name%%ultimateranks_suffix%: %message%'
输出: [VIP] Steve ★: Hello!
Tab 列表 (TAB 插件)
header: |
&6Server Name
&e%ultimateranks_prefix%%player_name%
记分板 (FeatherBoard)
board:
title: '&6&lServer'
lines:
- '&7Rank: %ultimateranks_rank_displayname%'
- '&7Weight: %ultimateranks_rank_weight%'
- '&7Total Ranks: %ultimateranks_total_ranks%'
告示牌
[Shop]
仅限 VIP
%ultimateranks_rank_displayname%
需要
常见问题解答
一般问题
Q: UltimateRanks 与其他 Rank 插件有何不同?
A: UltimateRanks 允许玩家同时拥有多个 Rank,并选择聊天中显示哪一个。传统插件强制“仅一个 Rank”——我们提供来自所有 Rank 的全部权限,同时让玩家自定义外观。
Q: 这会取代 LuckPerms 吗?
A: 不会!UltimateRanks 与 LuckPerms 集成。使用 LuckPerms 进行复杂的权限设置,而使用 UltimateRanks 进行视觉 Rank 管理和 GUI 系统。两者可无缝协同工作。
问:我可以在不使用 LuckPerms 的情况下使用此模组吗?
答:可以!UltimateRanks 内置了一个权限系统(独立模式),无需任何依赖即可运行。
问:这与我当前的权限组兼容吗?
答:如果您使用的是 LuckPerms,UltimateRanks 可以与您的现有用户组同步。您需要在 ranks.yml 中创建匹配的权限组定义。
技术问题
问:这会导致服务器延迟吗?
答:不会。所有数据库操作均为 100% 异步。UltimateRanks 不会造成任何服务器刻(tick)延迟。
问:它支持多少玩家?
答:已测试支持 1,000+ 名并发玩家。配合 MySQL 和适当的缓存机制,它可以适应任何规模的服务器。
问:如果我的数据库崩溃了怎么办?
答:在会话期间,玩家会保留其缓存的权限组数据。重新加入时,UltimateRanks 将尝试重新连接。不会发生数据丢失(断开连接前会保存缓存数据)。
问:我可以在 BungeeCord 网络中使用它吗?
答:可以!请使用 MySQL 数据库模式。您网络中的所有服务器将共享同一个权限组数据库。玩家在不同服务器之间保持其权限组不变。
配置问题
问:如何创建新的权限组?
添加到 ranks.yml:
ranks:
newrank:
weight: 15
display_name: '<aqua>NewRank</aqua>'
prefix: '<aqua>[NewRank]</aqua> '
suffix: ''
gui_icon: DIAMOND
permissions:
- 'permission.node.here'
然后执行: /rank reload
问:如何更改 GUI 标题?
config.yml:
gui:
menu-title: '<gradient:red:blue>Custom Title</gradient>'
问:渐变效果是如何工作的?
简单渐变(2种颜色):
prefix: '<gradient:red:blue>VIP</gradient> '
多色渐变:
prefix: '<gradient:red:yellow:green:blue>Rainbow</gradient> '
带格式化的渐变:
prefix: '<bold><gradient:gold:yellow>VIP</gradient></bold> '
游戏性问题
问:玩家可以拥有多个权限组吗?
答:可以! 这是核心功能之一。玩家可以同时拥有 VIP、Builder 和 Helper 等多个权限组。
问:多个权限组的权限会叠加吗?
答:会! 如果您拥有 [Member] 权限组的 essentials.spawn 和 [VIP] 权限组的 essentials.fly,您将同时获得这两项权限。
问:玩家可以选择在聊天中显示哪个权限组吗?
答:可以! 打开 /rank menu 并点击任意已拥有的权限组即可将其设为活动状态。
问:当权限组过期时会发生什么?
1. 自动清理移除过期的权限组
2. 玩家收到通知(如果已启用)
3. 来自过期权限组的权限被移除
4. 如果过期的权限组是活动状态,则切换到其他已拥有的权限组
5. 删除数据库条目
问:我可以给予临时权限组吗?
可以!使用持续时间语法:
/rank grant Steve vip 30d 30天
/rank grant Steve builder 1w 1周
/rank grant Steve premium 1mo 1个月
/rank grant Steve special 1y 1年
/rank grant Steve permanent 永久
管理员问题
问:如何给某人赋予多个权限组?
/rank grant PlayerName vip
/rank grant PlayerName builder
/rank grant PlayerName helper
现在该玩家拥有这三个权限组!
他们可以通过 /rank menu 选择在聊天中显示的权限组
问:如何重置某人的权限组?
选项 1:设置为单个权限组(移除其他所有)
/rank set PlayerName default
选项 2:移除特定权限组
/rank remove PlayerName vip
/rank remove PlayerName builder
问:我可以看到某人有哪些权限组吗?
目前可通过检查数据库或缓存来实现。未来的更新将添加 /rank info <player> 命令。
问:如何备份数据库?
SQLite(自动备份):
cp plugins/UltimateRanks/data.db plugins/UltimateRanks/data.db.backup
MySQL(使用 mysqldump):
mysqldump -u username -p ultimateranks > backup.sql
故障排除
问:GUI 中未显示权限组
1. 检查 ranks.yml 语法(使用 YAML 验证器)
2. 确保权限组具有有效的 gui_icon 材质
3. 运行 /rank reload
4. 检查控制台是否有错误
问:权限不生效
1. 检查启动时控制台中显示的权限处理器模式
2. 验证 ranks.yml 中的权限
3. 使用 /rank menu 进行测试(需要 ultimateranks.menu 权限)
4. 检查 LuckPerms 是否产生干扰(如果使用独立模式)
问:数据库连接失败
SQLite:
1. 检查文件权限
2. 确保 data 文件夹存在
MySQL:
1. 验证 config.yml 中的凭据
2. 检查 MySQL 服务器是否正在运行
3. 手动测试连接
4. 检查防火墙规则
问:聊天前缀未显示
1. 确保 config.yml 中 chat.enabled: true
2. 检查是否有其他聊天插件覆盖
3. 验证玩家拥有活动的权限组(/rank menu)
4. 测试 PlaceholderAPI 占位符
支持
获取帮助
- 查看文档
- 仔细阅读本文档
- 查看示例配置
- 查阅常见问题解答中的常见问题
- 控制台日志
启用调试模式:
config.yml → advanced.debug: true
检查日志:
/logs/latest.log
查找 [UltimateRanks] 消息
- 社区支持
- 报告 Bug
请包含:
✅ 服务器版本(Paper 1.21.x)
✅ 插件版本
✅ 完整错误日志
✅ config.yml 和 ranks.yml
✅ 复现步骤
✅ 预期行为与实际行为的对比
用于支持的有用命令
检查插件版本
/version UltimateRanks
测试数据库连接
/rank reload
观察控制台中的数据库消息
启用调试模式
config.yml → advanced.debug: true
重启服务器
导出玩家数据(未来功能)
/rank export <player>
测试权限
/rank menu
如果此命令有效,则权限系统功能正常
性能优化
推荐设置
小型服务器(1-50 名玩家)
database:
type: sqlite
performance:
enable-cache: true
cache-expiration: 60 分钟
batch-size: 50
中型服务器(50-200 名玩家)
database:
type: mysql
mysql:
pool-size: 5
performance:
enable-cache: true
cache-expiration: 45
batch-size: 100
大型服务器(200+ 名玩家)
database:
type: mysql
mysql:
pool-size: 15
minimum-idle: 5
performance:
enable-cache: true
cache-expiration: 30
batch-size: 200
网络(BungeeCord/Velocity)
database:
type: mysql
mysql:
host: central-db.example.com
pool-size: 20
minimum-idle: 10
performance:
enable-cache: true
cache-expiration: 20
batch-size: 500
迁移指南
从 LuckPerms Groups 迁移
1. 导出 LuckPerms 组
/lp export
2. 在 ranks.yml 中创建对应的等级
ranks:
vip: 匹配 LuckPerms 组名
weight: 10
display_name: '<gold>VIP</gold>'
prefix: '<gold>[VIP]</gold> '
permissions: [] 留空,由 LuckPerms 处理权限
3. 启用 LuckPerms 同步
config.yml:
integrations:
luckperms:
sync-groups: true
4. 重载配置
/rank reload
玩家的 LuckPerms 组现在将与 UltimateRanks 同步
从 EssentialsX Kits/Ranks 迁移
1. 将 Essentials 组映射到 UltimateRanks
Essentials: "default" → UltimateRanks: "default"
Essentials: "vip" → UltimateRanks: "vip"
2. 从 Essentials 配置中复制权限
3. 授予玩家等级
/rank grant <player> <rank>
4. 移除 Essentials 等级系统(可选)
更新日志
版本 1.0.0 (初始发布)
✨ 特性:
✅ 多等级所有权系统
✅ 活动显示等级选择
✅ 分页 GUI,每页 28 个等级
✅ 双权限系统(独立模式 + LuckPerms)
✅ 完整 MiniMessage 支持(RGB、渐变)
✅ SQLite 和 MySQL 数据库支持
✅ 异步数据库操作
✅ 智能缓存系统
✅ 带警告的过期系统
✅ PlaceholderAPI 集成
✅ 5 个带有 Tab 补全的管理命令
✅ 包含 16 个示例等级
? 技术细节:
✅ Java 21 + Paper 1.21 API
✅ HikariCP 连接池
✅ 线程安全操作
✅ SOLID 架构
✅ 零刻延迟(100% 异步)
? 文档:
✅ 完整用户指南
✅ 管理员手册
✅ 配置示例
致谢与许可
开发团队
- 首席开发者: geturplugins
- 特别感谢: Paper Team, LuckPerms, PlaceholderAPI
使用的库
- Paper API - Minecraft 服务器 API
- LuckPerms API - 权限系统集成
- PlaceholderAPI - 占位符支持
- HikariCP - 连接池
- Adventure API - 文本组件系统
快速参考卡片
╔══════════════════════════════════════════════════════════════╗
║ ULTIMATERANKS 快速参考 ║
╠══════════════════════════════════════════════════════════════╣
║ ║
║ 玩家命令: ║
║ /rank menu → 打开等级选择 GUI ║
║ ║
║ 管理员命令: ║
║ /rank set <player> <rank> → 设置主等级 ║
║ /rank grant <player> <rank> [time] → 添加等级 ║
║ /rank remove <player> <rank> → 移除等级 ║
║ /rank reload → 重载配置 ║
║ ║
║ 时间格式: ║
║ 30d = 30天 1w = 1周 1mo = 1个月 ║
║ permanent = 永久有效 ║
║ ║
║ 占位符: ║
║ %ultimateranks_prefix% → 当前排名前缀 ║
║ %ultimateranks_rank_displayname% → 排名显示名称 ║
║ %ultimateranks_total_ranks% → 拥有数量 ║
║ ║
║ 配置文件: ║
║ config.yml → 数据库、GUI、聊天设置 ║
║ ranks.yml → 排名定义 ║
║ ║
║ 支持: ║
║ Discord: geturplugins ║
║ ║
╚══════════════════════════════════════════════════════════════╝
---
最终说明
反馈与建议
我们根据用户反馈持续改进 UltimateRanks!
**提交建议:**
- Discord
- SpigotMC 评论
---
**? 感谢您选择 UltimateRanks!**
*简化高级排名管理*
--- **
** ?️ UltimateRanks - Complete Documentation
Overview
Description
UltimateRanks is a next-generation rank management plugin for Minecraft servers running Paper 1.21+. Unlike traditional rank plugins that limit players to a single rank, UltimateRanks introduces a revolutionary hybrid system where players can own multiple ranks simultaneously while selecting which one to display actively in chat and tab lists.
Built with modern Java 21 features and the Paper API, UltimateRanks delivers exceptional performance through asynchronous database operations, intelligent caching, and a beautiful GUI-based rank management interface.
Why Choose UltimateRanks?
| Feature |
Traditional Plugins |
UltimateRanks |
| Multiple Ranks |
❌ One rank only |
✅ Unlimited ranks |
| Permission Stacking |
❌ Single rank perms |
✅ All owned ranks contribute |
| Visual Customization |
❌ Fixed display |
✅ Choose active display rank |
| GUI Management |
⚠️ Basic or none |
✅ Beautiful paginated GUI |
| RGB Colors |
⚠️ Limited support |
✅ Full MiniMessage support |
| Performance |
⚠️ Sync operations |
✅ 100% async database |
| LuckPerms Sync |
⚠️ Replace or conflict |
✅ Seamless integration |
Target Audience
- Network Servers: Manage complex rank hierarchies (VIP + Builder + Staff)
- RPG Servers: Class ranks + achievement ranks + donor ranks
- Creative Servers: Builder roles + theme ranks + VIP tiers
- Survival Servers: Progression ranks + donor perks + special events
- Prison Servers: Mine ranks + prestige + VIP packages
Features
? Core Features
- Multi-Rank Ownership System
- Players can own unlimited ranks simultaneously
- Own VIP + Builder + Helper at the same time
- All ranks contribute permissions (additive system)
- Zero conflicts between rank permissions
Example:
Player owns: [Member, VIP, Builder]
Permissions = Member + VIP + Builder (combined)
Active Display = VIP (shown in chat)
- Active Display Rank Selection
- Choose which rank appears in chat prefix/suffix
- Switch between owned ranks via interactive GUI
- Real-time updates without reconnecting
- Maintains all permissions from other ranks
- Beautiful Paginated GUI
- Clean, intuitive rank selection menu
- Visual states: Active (glowing), Owned (available), Locked (unavailable)
- 28 ranks per page with smooth navigation
- Expiration timers shown directly in GUI
- Custom icons with resource pack support
- Advanced Permission System
- Dual Mode Operation:
- Standalone Mode: Built-in Bukkit permission system
- LuckPerms Mode: Full integration with LuckPerms API
- Auto-detection of available systems
- Permission aggregation from all owned ranks
- Wildcard support (e.g.,
essentials.*)
- Negation support (e.g.,
-essentials.fly)
- Expiration & Time Management
- Temporary ranks with automatic expiration
- Flexible duration formats:
30d, 7d, 1w, 1mo, 1y, permanent
- Automatic cleanup of expired ranks
- Warning notifications before expiration
- Visual countdown in GUI
- Full MiniMessage Support
- RGB colors:
<FF5555>text</color>
- Gradients:
<gradient:gold:yellow>VIP</gradient>
- Formatting:
<bold>, <italic>, <underline>
- Hover events and click actions
- Legacy color code conversion
- High-Performance Database
- SQLite: Zero-config, perfect for small servers
- MySQL: HikariCP pooling for large networks
- 100% asynchronous operations (zero server lag)
- Transaction support for data integrity
- Automatic schema management
- Smart Caching System
- In-memory cache for online players
- Sub-millisecond lookup times
- Automatic cache invalidation
- Thread-safe concurrent operations
? Visual Features
Chat Formatting
Before:
<Player> Hello!
After:
[VIP] Player ★: Hello!
Format:
{prefix} + {player} + {suffix} + : + {message}
GUI States
| State |
Visual |
Description |
| Active |
? Glowing item |
Currently equipped rank |
| Owned |
✅ Normal icon |
Click to equip |
| Locked |
? Barrier |
Not owned |
Rank Display Example
╔══════════════════════════════╗
║ My Ranks ║
╠══════════════════════════════╣
║ ║
║ [? VIP] (Active) ║
║ Click to keep equipped ║
║ Duration: Permanent ║
║ ║
║ [✅ Builder] ║
║ Click to equip ║
║ Expires in: 15 days ║
║ ║
║ [? MVP] (Locked) ║
║ You don't own this rank ║
║ ║
╚══════════════════════════════╝
? Technical Features
Architecture
- SOLID Principles: Single Responsibility, Interface Segregation
- Design Patterns: Strategy, Builder, Repository, Singleton
- Dependency Injection: Clean, testable code
- Layer Separation: Model, Manager, Database, GUI, Commands
Performance Metrics
Database Operations:
✅ Load Player Data: ~5ms (SQLite), ~3ms (MySQL)
✅ Save Player Data: ~8ms (SQLite), ~4ms (MySQL)
✅ Rank Switch: ~2ms (cache hit)
Memory Usage:
✅ Base Plugin: ~5MB
✅ Per Player (cached): ~2KB
✅ GUI Open: +8KB
Scalability:
✅ 1,000+ concurrent players supported
✅ 100+ ranks tested
✅ Zero tick lag (100% async)
Thread Safety
- Concurrent hash maps for player cache
- CompletableFuture for async operations
- Synchronized database transactions
- No race conditions in rank switching
? Integration Features
LuckPerms Integration
- Auto-Sync: UltimateRanks ⟷ LuckPerms groups
- Fallback Support: Works with or without LuckPerms
- Group Creation: Auto-create missing LuckPerms groups
- Permission Inheritance: Respects LuckPerms hierarchy
PlaceholderAPI Support
Available Placeholders:
%ultimateranks_prefix% → Active rank prefix
%ultimateranks_suffix% → Active rank suffix
%ultimateranks_rank_displayname% → Rank display name
%ultimateranks_rank_id% → Rank ID
%ultimateranks_rank_weight% → Rank weight
%ultimateranks_total_ranks% → Total owned ranks
Chat Plugin Compatibility
- ✅ EssentialsX Chat
- ✅ ChatControl
- ✅ VentureChat
- ✅ Any plugin using PlaceholderAPI
Installation
Requirements
- Minecraft Server: Paper 1.21+ (or Purpur/Pufferfish)
- Java Version: Java 21+
- Optional Dependencies:
- LuckPerms 5.4+ (for advanced permissions)
- PlaceholderAPI 2.11+ (for placeholders)
Quick Install
-
Download
Download UltimateRanks-1.0.0.jar from releases
-
Install
Place in plugins folder
cp UltimateRanks-1.0.0.jar /path/to/server/plugins/
-
First Start
Start server to generate configs
java -jar paper.jar
Wait for: "[UltimateRanks] ✓ UltimateRanks enabled successfully"
Stop server
stop
-
Configure
Edit generated configs
nano plugins/UltimateRanks/config.yml
nano plugins/UltimateRanks/ranks.yml
-
Restart
Start server again
java -jar paper.jar
Verification
Console Output (Success):
[UltimateRanks] ═══════════════════════════════
[UltimateRanks] UltimateRanks v1.0.0
[UltimateRanks] Advanced Rank Management
[UltimateRanks] ═══════════════════════════════
[UltimateRanks] Loading configuration files...
[UltimateRanks] ✓ Configuration loaded
[UltimateRanks] Connecting to database...
[UltimateRanks] ✓ Database connected (SQLite)
[UltimateRanks] Initializing managers...
[UltimateRanks] ✓ Loaded 10 ranks
[UltimateRanks] ✓ Managers initialized
[UltimateRanks] Initializing permission system...
[UltimateRanks] ✓ LuckPerms detected - Using LuckPerms handler
[UltimateRanks] Registering event listeners...
[UltimateRanks] ✓ Event listeners registered
[UltimateRanks] Registering commands...
[UltimateRanks] ✓ Commands registered
[UltimateRanks] ✓ PlaceholderAPI integration enabled
[UltimateRanks] ✓ UltimateRanks enabled successfully in 245ms
[UltimateRanks] ✓ Permission Mode: LuckPerms
Configuration
Main Configuration (config.yml)
Database Selection
database:
type: sqlite Options: sqlite, mysql
GUI Customization
gui:
menu-title: '<gradient:gold:yellow>My Ranks</gradient>'
items-per-page: 28
refresh-interval: 100 ticks
Chat Formatting
chat:
enabled: true
format: '{prefix}{player}{suffix}: {message}'
allow-colors: true
Expiration Management
expiration:
auto-cleanup: true
cleanup-interval: 30 minutes
notify-on-expiration: true
warn-before-expiration: 24 hours
Permission System
permissions:
mode: auto Options: auto, standalone, luckperms
apply-on-join: true
refresh-on-change: true
Rank Definitions (ranks.yml)
ranks:
vip:
weight: 10 Hierarchy (higher = better)
display_name: '<gold>VIP</gold>' Shown in GUI/messages
prefix: '<gradient:yellow:gold>[VIP]</gradient> '
suffix: ''
gui_icon: GOLD_INGOT Item in GUI
custom_model_data: 0 Resource pack support
permissions:
- 'essentials.fly'
- 'essentials.heal'
- 'ultimateranks.chat.color'
MySQL Configuration
database:
type: mysql
mysql:
host: localhost
port: 3306
database: ultimateranks
username: root
password: 'your_password'
pool-size: 10
parameters: '?useSSL=false&autoReconnect=true'
? Creating Ranks from Scratch - Complete Guide
? Quick Overview
Where to create ranks: plugins/UltimateRanks/ranks.yml
Process:
- Define rank structure
- Set weight (hierarchy)
- Choose colors/prefix
- Add permissions
- Pick GUI icon
- Reload plugin
? Step-by-Step Tutorial
Step 1: Open ranks.yml
Navigate to your server folder
cd plugins/UltimateRanks/
Edit ranks.yml
nano ranks.yml
or use Notepad++/VSCode
Step 2: Basic Rank Structure
ranks:
your_rank_name: Unique identifier (lowercase, no spaces)
weight: 10 Number (higher = more important)
display_name: '<gold>Display Name</gold>' What players see
prefix: '<gold>[Prefix]</gold> ' Chat prefix
suffix: '' Chat suffix (optional)
gui_icon: GOLD_INGOT Item shown in menu
custom_model_data: 0 For resource packs (0 = disabled)
permissions: List of permissions this rank gives
- 'permission.node.1'
- 'permission.node.2'
? Example: Creating Your First Rank
Let's create a "Supporter" rank from scratch:
ranks:
supporter:
weight: 5 Low tier (above default)
display_name: '<gradient:green:lime>Supporter</gradient>'
prefix: '<gradient:green:lime>[Supporter]</gradient> '
suffix: ' <green>♥</green>'
gui_icon: EMERALD Green emerald item
custom_model_data: 0
permissions:
- 'essentials.spawn' Basic teleport
- 'essentials.sethome' Set homes
- 'essentials.home' Teleport home
- 'essentials.back' Return to death point
Save the file, then in-game:
/rank reload
/rank grant YourName supporter
Commands & Permissions
Commands
| Command |
Description |
Permission |
Usage Example |
/rank menu |
Open rank GUI |
ultimateranks.menu |
/rank menu |
/rank set <player> <rank> |
Set main rank |
ultimateranks.admin.set |
/rank set Steve vip |
/rank grant <player> <rank> [time] |
Add rank |
ultimateranks.admin.grant |
/rank grant Steve builder 30d |
/rank remove <player> <rank> |
Remove rank |
ultimateranks.admin.remove |
/rank remove Steve vip |
/rank reload |
Reload configs |
ultimateranks.admin.reload |
/rank reload |
Command Aliases
/rank → /ranks, /ur
menu → gui, open
remove → take, revoke
reload → rl
Permissions Hierarchy
ultimateranks.* (All permissions)
├── ultimateranks.use (Basic access)
├── ultimateranks.menu (GUI access)
└── ultimateranks.admin.* (Admin commands)
├── ultimateranks.admin.set
├── ultimateranks.admin.grant
├── ultimateranks.admin.remove
└── ultimateranks.admin.reload
Special Permissions
| Permission |
Description |
Default |
ultimateranks.chat.color |
Use color codes in chat |
false |
ultimateranks.bypass.expiration |
Ranks never expire |
op |
ultimateranks.notify.expiration |
Get expiration warnings |
true |
Usage Guide
For Players
Opening the Rank Menu
1. Type: /rank menu
2. GUI opens showing all available ranks
3. Click any owned rank to equip it
4. Your chat prefix updates immediately
Understanding Rank States
? Glowing Item = Currently Active
→ This is your display rank
→ Shown in chat and tab list
✅ Normal Item = Owned but Not Active
→ Click to switch to this rank
→ You still have its permissions
? Barrier = Locked
→ You don't own this rank
→ Ask staff to grant it
Checking Expiration
Open /rank menu and hover over any owned rank:
[VIP]
✅ Click to Equip
Duration: 25 days, 14 hours
Weight: 10
For Administrators
Setting Up Ranks
1. Define Rank in ranks.yml
ranks:
premium:
weight: 20
display_name: '<gradient:aqua:blue>Premium</gradient>'
prefix: '<gradient:aqua:blue>[Premium]</gradient> '
suffix: ' <aqua>★</aqua>'
gui_icon: DIAMOND
permissions:
- 'essentials.*'
- 'worldedit.selection.*'
2. Reload Configuration
/rank reload
3. Grant to Players
Permanent rank
/rank grant PlayerName premium
30-day rank
/rank grant PlayerName premium 30d
1 week rank
/rank grant PlayerName premium 1w
Managing Player Ranks
View Player's Ranks
Players can see their own via /rank menu
Admins use database or cache inspection
Reset Player Ranks
Remove all ranks and set default
/rank set PlayerName default
Temporary VIP Promotion
Grant VIP for 7 days
/rank grant PlayerName vip 7d
Player gets notified 24 hours before expiration
Rank auto-removes after 7 days
Multi-Rank Assignment
Player can be VIP + Builder + Helper simultaneously
/rank grant PlayerName vip
/rank grant PlayerName builder
/rank grant PlayerName helper
All three ranks grant permissions
Player chooses which shows in chat via GUI
Common Workflows
New Player Setup
1. Player joins → automatically gets "default" rank
2. Player donates → grant VIP
/rank grant PlayerName vip
3. Player applies for builder → grant builder
/rank grant PlayerName builder
Player now has: default + vip + builder (all permissions)
Player chooses "vip" or "builder" for chat display
Staff Promotion
Promote to Helper (keep VIP)
/rank grant PlayerName helper
Player retains VIP perks + gets staff permissions
Can switch between [VIP] and [Helper] prefix in GUI
Seasonal Events
Halloween Event - 30 days
/rank grant * halloween 30d
All online players get halloween rank
Auto-expires after event
Placeholders
PlaceholderAPI Integration
All placeholders work with any plugin supporting PlaceholderAPI (DeluxeChat, FeatherBoard, etc.)
| Placeholder |
Output |
Example |
%ultimateranks_prefix% |
Active rank prefix |
[VIP] |
%ultimateranks_suffix% |
Active rank suffix |
★ |
%ultimateranks_rank_displayname% |
Rank display name |
VIP |
%ultimateranks_rank_id% |
Rank identifier |
vip |
%ultimateranks_rank_weight% |
Rank weight |
10 |
%ultimateranks_total_ranks% |
Total owned ranks |
3 |
Usage Examples
DeluxeChat Format
formats:
default:
format: '%ultimateranks_prefix%%player_name%%ultimateranks_suffix%: %message%'
Output: [VIP] Steve ★: Hello!
Tab List (TAB Plugin)
header: |
&6Server Name
&e%ultimateranks_prefix%%player_name%
Scoreboard (FeatherBoard)
board:
title: '&6&lServer'
lines:
- '&7Rank: %ultimateranks_rank_displayname%'
- '&7Weight: %ultimateranks_rank_weight%'
- '&7Total Ranks: %ultimateranks_total_ranks%'
Signs
[Shop]
VIP Only
%ultimateranks_rank_displayname%
Required
FAQ
General Questions
Q: What makes UltimateRanks different from other rank plugins?
A: UltimateRanks allows players to own multiple ranks simultaneously while choosing which one displays in chat. Traditional plugins force "one rank only" - we give all permissions from all ranks while letting players customize their appearance.
Q: Does this replace LuckPerms?
A: No! UltimateRanks integrates with LuckPerms. Use LuckPerms for your complex permission setups, and UltimateRanks for visual rank management and the GUI system. They work together seamlessly.
Q: Can I use this without LuckPerms?
A: Yes! UltimateRanks has a built-in permission system (Standalone Mode) that works without any dependencies.
Q: Is this compatible with my current ranks?
A: If you're using LuckPerms, UltimateRanks can sync with your existing groups. You'll need to create matching rank definitions in ranks.yml.
Technical Questions
Q: Does this cause server lag?
A: No. All database operations are 100% asynchronous. There's zero server tick lag from UltimateRanks.
Q: How many players can this support?
A: Tested with 1,000+ concurrent players. With MySQL and proper caching, it scales to any server size.
Q: What happens if my database crashes?
A: Players retain their cached rank data during the session. On rejoin, UltimateRanks will attempt to reconnect. No data loss occurs (cached data saves before disconnect).
Q: Can I use this on BungeeCord networks?
A: Yes! Use MySQL database mode. All servers in your network will share the same rank database. Players keep their ranks across servers.
Configuration Questions
Q: How do I create a new rank?
Add to ranks.yml:
ranks:
newrank:
weight: 15
display_name: '<aqua>NewRank</aqua>'
prefix: '<aqua>[NewRank]</aqua> '
suffix: ''
gui_icon: DIAMOND
permissions:
- 'permission.node.here'
Then: /rank reload
Q: How do I change the GUI title?
config.yml:
gui:
menu-title: '<gradient:red:blue>Custom Title</gradient>'
Q: How do gradients work?
Simple gradient (2 colors):
prefix: '<gradient:red:blue>VIP</gradient> '
Multi-color gradient:
prefix: '<gradient:red:yellow:green:blue>Rainbow</gradient> '
With formatting:
prefix: '<bold><gradient:gold:yellow>VIP</gradient></bold> '
Gameplay Questions
Q: Can players have multiple ranks?
A: YES! That's the core feature. Players can own VIP + Builder + Helper simultaneously.
Q: Do multiple ranks stack permissions?
A: YES! If you own [Member] with essentials.spawn and [VIP] with essentials.fly, you get BOTH permissions.
Q: Can players choose which rank shows in chat?
A: YES! Open /rank menu and click any owned rank to make it active.
Q: What happens when a rank expires?
1. Automatic cleanup removes expired ranks
2. Player receives notification (if enabled)
3. Permissions from expired rank are removed
4. If expired rank was active, switches to another owned rank
5. Database entry is deleted
Q: Can I give temporary ranks?
Yes! Use duration syntax:
/rank grant Steve vip 30d 30 days
/rank grant Steve builder 1w 1 week
/rank grant Steve premium 1mo 1 month
/rank grant Steve special 1y 1 year
/rank grant Steve permanent Forever
Admin Questions
Q: How do I give someone multiple ranks?
/rank grant PlayerName vip
/rank grant PlayerName builder
/rank grant PlayerName helper
Player now owns all three!
They choose which shows in chat via /rank menu
Q: How do I reset someone's ranks?
Option 1: Set to single rank (removes all others)
/rank set PlayerName default
Option 2: Remove specific ranks
/rank remove PlayerName vip
/rank remove PlayerName builder
Q: Can I see what ranks someone has?
Currently via database or cache inspection. Future update will add /rank info <player> command.
Q: How do I backup the database?
SQLite (automatic backup):
cp plugins/UltimateRanks/data.db plugins/UltimateRanks/data.db.backup
MySQL (use mysqldump):
mysqldump -u username -p ultimateranks > backup.sql
Troubleshooting
Q: Ranks not appearing in GUI
1. Check ranks.yml syntax (use YAML validator)
2. Ensure rank has valid gui_icon material
3. Run /rank reload
4. Check console for errors
Q: Permissions not working
1. Check permission handler mode in console startup
2. Verify permissions in ranks.yml
3. Test with /rank menu (requires ultimateranks.menu)
4. Check if LuckPerms is interfering (if using standalone mode)
Q: Database connection failed
SQLite:
1. Check file permissions
2. Ensure data folder exists
MySQL:
1. Verify credentials in config.yml
2. Check MySQL server is running
3. Test connection manually
4. Check firewall rules
Q: Chat prefix not showing
1. Ensure chat.enabled: true in config.yml
2. Check if another chat plugin is overriding
3. Verify player has an active rank (/rank menu)
4. Test PlaceholderAPI placeholders
Support
Getting Help
- Check Documentation
- Read this document thoroughly
- Check example configurations
- Review common issues in FAQ
- Console Logs
Enable debug mode:
config.yml → advanced.debug: true
Check logs:
/logs/latest.log
Look for [UltimateRanks] messages
- Community Support
- Report Bugs
Include:
✅ Server version (Paper 1.21.x)
✅ Plugin version
✅ Full error logs
✅ config.yml and ranks.yml
✅ Steps to reproduce
✅ Expected vs actual behavior
Useful Commands for Support
Check plugin version
/version UltimateRanks
Test database connection
/rank reload
Watch console for database messages
Enable debug mode
config.yml → advanced.debug: true
Restart server
Export player data (future feature)
/rank export <player>
Test permissions
/rank menu
If this works, permission system is functional
Performance Optimization
Recommended Settings
Small Server (1-50 players)
database:
type: sqlite
performance:
enable-cache: true
cache-expiration: 60 minutes
batch-size: 50
Medium Server (50-200 players)
database:
type: mysql
mysql:
pool-size: 5
performance:
enable-cache: true
cache-expiration: 45
batch-size: 100
Large Server (200+ players)
database:
type: mysql
mysql:
pool-size: 15
minimum-idle: 5
performance:
enable-cache: true
cache-expiration: 30
batch-size: 200
Network (BungeeCord/Velocity)
database:
type: mysql
mysql:
host: central-db.example.com
pool-size: 20
minimum-idle: 10
performance:
enable-cache: true
cache-expiration: 20
batch-size: 500
Migration Guide
From LuckPerms Groups
1. Export LuckPerms groups
/lp export
2. Create matching ranks in ranks.yml
ranks:
vip: Match LuckPerms group name
weight: 10
display_name: '<gold>VIP</gold>'
prefix: '<gold>[VIP]</gold> '
permissions: [] Leave empty, LuckPerms handles it
3. Enable LuckPerms sync
config.yml:
integrations:
luckperms:
sync-groups: true
4. Reload
/rank reload
Players' LuckPerms groups now sync with UltimateRanks
From EssentialsX Kits/Ranks
1. Map Essentials groups to UltimateRanks
Essentials: "default" → UltimateRanks: "default"
Essentials: "vip" → UltimateRanks: "vip"
2. Copy permissions from Essentials config
3. Grant ranks to players
/rank grant <player> <rank>
4. Remove Essentials rank system (optional)
Changelog
Version 1.0.0 (Initial Release)
✨ Features:
✅ Multi-rank ownership system
✅ Active display rank selection
✅ Paginated GUI with 28 ranks per page
✅ Dual permission system (Standalone + LuckPerms)
✅ Full MiniMessage support (RGB, gradients)
✅ SQLite and MySQL database support
✅ Async database operations
✅ Smart caching system
✅ Expiration system with warnings
✅ PlaceholderAPI integration
✅ 5 admin commands with tab completion
✅ 16 example ranks included
? Technical:
✅ Java 21 + Paper 1.21 API
✅ HikariCP connection pooling
✅ Thread-safe operations
✅ SOLID architecture
✅ Zero tick lag (100% async)
? Documentation:
✅ Complete user guide
✅ Admin manual
✅ Configuration examples
Credits & License
Development Team
- Lead Developer: geturplugins
- Special Thanks: Paper Team, LuckPerms, PlaceholderAPI
Libraries Used
- Paper API - Minecraft server API
- LuckPerms API - Permission system integration
- PlaceholderAPI - Placeholder support
- HikariCP - Connection pooling
- Adventure API - Text component system
Quick Reference Card
╔══════════════════════════════════════════════════════════════╗
║ ULTIMATERANKS QUICK REFERENCE ║
╠══════════════════════════════════════════════════════════════╣
║ ║
║ PLAYER COMMANDS: ║
║ /rank menu → Open rank selection GUI ║
║ ║
║ ADMIN COMMANDS: ║
║ /rank set <player> <rank> → Set main rank ║
║ /rank grant <player> <rank> [time] → Add rank ║
║ /rank remove <player> <rank> → Remove rank ║
║ /rank reload → Reload configs ║
║ ║
║ TIME FORMATS: ║
║ 30d = 30 days 1w = 1 week 1mo = 1 month ║
║ permanent = never expires ║
║ ║
║ PLACEHOLDERS: ║
║ %ultimateranks_prefix% → Active rank prefix ║
║ %ultimateranks_rank_displayname% → Rank display name ║
║ %ultimateranks_total_ranks% → Number owned ║
║ ║
║ CONFIG FILES: ║
║ config.yml → Database, GUI, chat settings ║
║ ranks.yml → Rank definitions ║
║ ║
║ SUPPORT: ║
║ Discord: geturplugins ║
║ ║
╚══════════════════════════════════════════════════════════════╝
Final Notes
Feedback & Suggestions
We're constantly improving UltimateRanks based on user feedback!
Submit Suggestions:
? Thank you for choosing UltimateRanks!
Advanced Rank Management Made Simple
--- **
评论 0
登录后参与评分
还没有评论,来抢沙发吧