XRank

插件

· 作者 Wind_Blood

一款可在聊天、Tab 列表、命名标签甚至系统消息中全位置显示标题的插件。支持 MySQL、SQLite 和 YAML。兼容 1.8.x 及以上版本的所有基于 Bukkit 的服务端。

0 本站下载 0 关注 更新于 2 个月前

最新 1.2-alpha · 26.2 · Bukkit / Folia

一键开服(送7天)

XRank Logo

0 为什么会有这个插件

只是为了好玩。

我之前其实就计划开发这样一个标题插件,现在终于完成了它:XRank。


1 功能特性

1.1 四路渲染系统

XRank 以其全面的四路渲染方法脱颖而出,涵盖了玩家表示的各个方面:

  • TAB 列表 → Player#setPlayerListName(String)

    • 智能协议长度截断(支持 RGB 颜色代码)
    • 自动检测 TAB 插件并让出渲染以避免冲突
    • 当标签名称超过长度限制时回退到纯文本名称
  • 聊天格式 → AsyncPlayerChatEvent#setFormat(String)

    • 可自定义格式,支持 %rank%、%name%、%message% 占位符
    • 保留其他插件的聊天修改(非侵入式)
    • 最高优先级的事件处理
  • 名称标签(头顶上方) → Scoreboard#Team 配合 setPrefix/setSuffix + Team#setColor(反射机制)

    • 从等级显示继承颜色
    • 自动创建队伍/按玩家管理
    • 解决队伍名称被占用时的冲突
  • 系统消息 → Player#displayName(Component) (Adventure API, 1.16.5+) 或在 NMS EntityPlayer#displayName 上使用反射 (1.8.x–1.15.x)

    • 现代服务器完全支持 Adventure API
    • 旧版本通过 NMS 反射回退
    • 适用于死亡消息和大多数服务器生成的系统文本

为什么这很重要: 大多数等级插件只处理 2 条路径(TAB + CHAT),一些高级插件会增加 NAMETAG。XRank 是少数完成所有4 条路径的插件之一,确保玩家名字出现的任何地方都能获得一致的等级显示体验。

但是,某些消息(例如 /tp 命令的消息)可能仍然使用原始玩家名称,而不是由 XRank 处理的版本。

这是因为系统消息中的等级基于 displayName,而一些原版命令使用的是原始名称而非 displayName。这基本上是无法避免的。

你可以将其视为一种便于调试的被动设计……在传送时使用无用的等级前缀确实很愚蠢,但在死亡消息中使用前缀是可以接受的。

1.2 多存储支持

  • YAML - 简单的基于文件的存储
  • SQLite - 轻量级数据库,适用于中小型服务器(默认)
  • MySQL - 企业级数据库,适用于大型服务器
  • 自动迁移 - 在不同存储类型之间无缝迁移数据,无需担心数据丢失

1.3 灵活的等级管理

  • 每个玩家可拥有多个等级
  • 可配置的等级显示名称,支持颜色代码 (&)
  • 为新玩家分配默认等级
  • 基于权限的默认等级绕过 (xrank.ignore_default)
  • 支持对在线/离线/所有玩家进行批量操作

1.4 PlaceholderAPI 支持(可选)

  • %xrank_ranks% - 完整等级显示(包含颜色)
  • %xrank_ranks_raw% - 原始等级名称(无格式)
  • %xrank_has_rank% - 如果玩家有任何等级则返回 true
  • %xrank_prefix% - 来自格式的等级前缀
  • %xrank_suffix% - 来自格式的等级后缀

1.5 开发者 API

  • 基于异步 CompletableFuture 的 API
  • 按 UUID 锁定以确保线程安全操作
  • RankChangeEvent 用于监听等级更新
  • 可通过 allow_to_use_api 配置选项启用/禁用 API

1.6 多版本与平台支持

  • 支持 Minecraft 1.8.9 至 1.21+
  • 兼容 Folia,使用 RegionScheduler
  • 针对 Paper/Purpur 优化
  • 支持 Spigot/Bukkit 旧版环境
  • 自动检测 TAB 插件(让出 TabList 渲染)

已知限制: 在 Folia 服务器上,由于 Bukkit Scoreboard API 被禁用,名称标签等级功能不可用。这是平台本身的限制。

1.7 国际化

  • 通过 lang 配置支持多语言消息
  • 没有硬编码的玩家消息
  • 自动修复缺失键值的配置补全

1.8 线程安全操作

  • 按 UUID 锁定确保原子化的读-改-写操作
  • 异步数据库操作不会阻塞主线程
  • 使用 ConcurrentHashMap 缓存玩家数据

2 命令

命令 权限 描述
/xrank - 显示插件版本和状态
/xrank give <player|-all|-online|-offline> <rank> xrank.give 给玩家(们)授予等级
/xrank remove <player|-all|-online|-offline> <rank> xrank.remove 移除玩家(们)的特定等级
/xrank remove <player|-all|-online|-offline> xrank.remove 移除所有等级(需要确认)
/xrank list [player|-all|-online|-offline] xrank.list 列出玩家(们)的等级
/xrank reload xrank.admin 重新加载配置并应用更改

/xrk = /xrank

批量目标:

  • -all - 所有玩家(在线 + 离线)
  • -online - 所有在线玩家
  • -offline - 所有离线玩家

3 权限节点

权限 描述
xrank.give 允许向玩家授予等级
xrank.remove 允许移除玩家的等级
xrank.list 允许查看玩家的等级
xrank.admin 完全管理员访问权限(包括重载)
xrank.ignore_default 玩家不会接收默认等级

4 配置

4.1 基本设置

# 语言 (messages 部分的键名)
lang: "en"

# 调试模式(记录额外信息)
debug: false

# 启动时显示标志
show_logo: true

# 新玩家的默认等级(空 = 无)
default-rank: "default"

# 启用显示名称修改
display-name-enabled: true

# API 访问开关
allow_to_use_api: true

# 移除确认超时时间(秒)
remove-confirm-timeout: 30

4.2 存储配置

storage:
  # 选项:yaml, sqlite, mysql
  type: "sqlite"
  
  mysql:
    host: "localhost"
    port: 3306
    database: "xrank"
    username: "root"
    password: "password"

4.3 格式配置

# TAB 列表/显示格式(支持 %rank%, %name%)
format: "%rank%%name%"

# 聊天格式(支持 %rank%、%name%、%message%)
chat-format: "%rank%%name%&f: %message%"

4.4 等级定义

ranks:
  owner: "&4[&cOwner&4] "
  admin: "&c[Admin] "
  vip: "&6[VIP] "
  default: "&7[Player] "

4.5 消息自定义

消息按语言键组织。en 的示例如下:

messages:
  en:
    no-permission: "&cYou don't have permission to do this."
    player-not-found: "&cPlayer {player} not found."
    rank-given: "&aSuccessfully gave {rank} to {players}"
    rank-removed: "&aSuccessfully removed {rank} from {players}"
    rank-not-found: "&cRank {rank} not found for {players}"
    confirm-warning: "&6This will remove ALL ranks from {player}"
    confirm-again: "&6Type /xrank remove {player} again within {seconds}s to confirm"
    confirm-done: "&aRemoved all ranks from {players}"
    reload-done: "&aConfiguration reloaded successfully!"
    list-header: "&6--- Rank List ---"
    list-format: "&f{player}&7: {ranks}"
    list-no-ranks: "&f{player}&7: No ranks"
    list-footer: "&6--- End of List ---"
    usage-give: "&cUsage: /xrank give <player|-all|-online|-offline> <rank>"
    usage-remove: "&cUsage: /xrank remove <player|-all|-online|-offline> [rank]"
    no-ranks-record: "&cNo rank records found."

5 开发者 API

5.1 获取玩家等级

Main.getInstance().getPlayerRanks(uuid).thenAccept(ranks -> {
    // ranks 是一个 List<String>
});

5.2 设置玩家等级

Main.getInstance().setPlayerRanks(uuid, "PlayerName", Arrays.asList("admin", "vip"))
    .thenAccept(success -> {
        // success 是 Boolean
    });

5.3 添加等级

Main.getInstance().addRank(uuid, "PlayerName", "vip")
    .thenAccept(changed -> {
        // changed 是 Boolean
    });

5.4 移除等级

Main.getInstance().removeRank(uuid, "vip")
    .thenAccept(changed -> {
        // changed 是 Boolean
    });

5.5 RankChangeEvent

@EventHandler
public void onRankChange(RankChangeEvent event) {
    UUID uuid = event.getPlayerId();
    String name = event.getPlayerName();
    List<String> oldRanks = event.getOldRanks();
    List<String> newRanks = event.getNewRanks();
    // 处理等级变更
}

6 安装

  1. 下载最新的 xrank-X.X.X.jar
  2. 将其放入服务器的 plugins/ 文件夹中
  3. 重启或重载服务器
  4. 根据需要配置 plugins/xrank/config.yml
  5. 使用 /xrank reload 命令重载

7 依赖

  • 服务端:所有基于 Bukkit 的服务端 (1.8.9+)
  • 可选:PlaceholderAPI 以支持占位符

9 反馈

请发送邮件至 windblood@foxmail.com,谢谢!

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源