聊天频道

聊天频道

**ChatChannels** 是一个面向 **Minecraft 1.20.1 (Forge)** 的高级服务端聊天频道系统。

ChatChannels

ChatChannels 是一个面向 Minecraft 1.20.1 (Forge) 的高级双向聊天频道系统。 它添加了可配置的全局/本地/交易/管理频道、私聊、速率限制、日志记录,并与流行的权限系统集成。


✨ 特性

  • 开箱即用的多个聊天频道
    • global – 全服聊天
    • local – 可配置范围的距离聊天
    • trade – 交易 / 市场频道
    • staff – 仅限管理人员的频道(受权限控制)
    • pm – 私聊频道(内部使用)
  • 完全可配置的频道
    • 自定义 id、显示 name、type、prefix、颜色、范围和默认频道
    • 每个频道可选的权限节点 – 限制谁可以查看/使用每个频道
  • 权限系统集成
    • 支持 LuckPerms(通过官方 API)
    • 支持 FTB Ranks(ranks.snbt 权限)
    • 如果没有可用的权限插件,则回退到原版 OP 等级 4
  • 每位玩家的聊天状态
    • 记住每位玩家最后使用的频道
    • 静音特定频道
    • 忽略特定玩家
  • 速率限制 / 防刷屏
    • 每位玩家可配置的每时间窗口消息数
  • 日志记录
    • 所有频道消息均可记录以供管理(服务端)
  • 服务器配置选项
    • 本地聊天范围
    • 速率限制(消息数 / 秒数)
    • 可选的**“加入/离开频道”**系统消息

🔌 安装 / 客户端与服务端

ChatChannels 是一个以服务端为核心的模组,但必须安装在服务端和所有连接的客户端上。

  • 单人游戏 / 对局域网开放

    • 在客户端安装该模组。集成服务器将自动使用相同的模组运行。
  • 专用服务器

    • 将模组 JAR 放入服务端的 mods 文件夹。
    • 同时将该 JAR 包含在加入服务器的所有玩家的客户端整合包中。

该模组作为标准 Forge 模组构建,side = BOTH: 它包含服务端逻辑(频道、权限、配置、日志)以及用于处理网络数据包和显示聊天频道的客户端代码。


🧩 需求与兼容性

  • Minecraft: 1.20.1
  • 加载器: Forge 47.x(基于 Forge 47.4.0 构建并测试)
  • Java: 17

适用于:

  • 专用服务器 – 核心逻辑在服务端运行
  • 客户端: 该模组旨在同时安装在服务端和客户端以获得最佳体验(频道 UI、数据包等)

可选集成(非必需,但受支持):

  • LuckPerms – 用于权限检查,如 chat.channels.global
  • FTB Ranks – 用于权限节点和基于等级的名称格式化:
    • ranks.snbt 中的权限节点,例如:
      • chat.channels.global
      • chat.channels.local
      • chat.channels.trade
      • chat.channels.staff
    • 通过 ftbranks.name_format 设置等级名称格式(用作特权标签)

如果 LuckPerms 和 FTB Ranks 都不存在,模组将回退到原版操作员等级检查(hasPermissions(4))。


⚙️ 配置概览

模组在首次运行时生成其配置文件。共有三个主要配置文件:

1. config/chatchannels.json

定义所有聊天频道和全局速率限制。

每个频道的字段:

  • id – 内部频道 ID(例如 "global"、"local"、"trade"、"staff"、"pm")
  • name – UI 中显示的显示名称(例如 "Global"、"Local")
  • type – 频道的行为方式:
    • GLOBAL、LOCAL、TRADE、STAFF、TEAM、PRIVATE、CUSTOM
  • prefix – 消息前的短前缀,例如 "[G]"、"[Local]"、"[Trade]"
  • color – 十六进制颜色字符串,例如 "#FFFFFF"、"#FFD700"
  • radius – 对于 LOCAL 频道:以方块为单位的范围;0 = 类似全局广播
  • default – 如果应作为新玩家的默认频道则为 true
  • permission – 使用该频道所需的权限节点
    • 默认示例:
      • chat.channels.global
      • chat.channels.local
      • chat.channels.trade
      • chat.channels.staff
    • 如果设置为空字符串 "",则该频道不需要权限。

速率限制部分:

"rate_limit": {
  "messages": 5,
  "per_seconds": 3
}
  • messages – 玩家可以发送多少条消息
  • per_seconds – 以秒为单位的时间窗口 如果超过限制,玩家将收到类似“You are sending messages too fast.”的系统消息。

2. serverconfig/chatchannels-server.toml

服务端游戏玩法设置:

  • localChat.radius 默认 LOCAL 频道的默认范围(以方块为单位)。

  • rateLimit.messages 与 chatchannels.json 中相同,但作为 Forge 服务端配置暴露。

  • rateLimit.seconds 速率限制的时间窗口。

  • channels.showSwitchMessages

    • true(默认)– 当玩家加入或离开频道时显示服务器消息:
      • Joined channel <id>
      • Left channel <id>
    • false – 不发送这些系统消息。

当玩家使用触发 JOIN/LEAVE 操作的频道命令 / UI 时,会发送这些消息。


3. config/chatchannels_privileges.json

控制聊天中玩家名称前显示的特权标签(等级标签)的颜色。

  • defaultColor – 未知/未指定标签的十六进制颜色(例如 "#FFD700")
  • tags – 从特权标签字符串到十六进制颜色的映射:
    • 标签来源于:
      1. LuckPerms 前缀(如果可用),或
      2. ftbranks.name_format(如果可用),或
      3. 服务器操作员的 "OP"

默认示例:

{
  "defaultColor": "#FFD700",
  "tags": {
    "Игрок": "#AAAAAA",
    "VIP": "#55FFFF",
    "Модератор": "#55FF55",
    "Админ": "#FF5555",
    "OP": "#FF5555"
  }
}

您可以自定义此文件以匹配您服务器的等级名称和颜色。


🔑 权限

默认使用以下权限节点:

  • chat.channels.global – 在全局频道中发言
  • chat.channels.local – 在本地频道中发言
  • chat.channels.trade – 在交易频道中发言
  • chat.channels.staff – 访问管理频道(用于版主/管理员)

这些节点可以通过以下方式控制:

  • LuckPerms(将它们分配给用户/组),或
  • FTB Ranks(ranks.snbt),例如:
default: {
  ...
  chat.channels.global: true
  chat.channels.local: true
  chat.channels.trade: true
}

vip: {
  ...
  chat.channels.global: true
  chat.channels.local: true
  chat.channels.trade: true
}

如果您希望某个频道对所有人可用而无需权限,只需在 chatchannels.json 中将其 permission 字段设置为空字符串 ""。


📝 说明

  • 所有配置文件在首次服务器启动时自动生成。
  • 可在服务器重启之间安全地自定义和重载。
  • 该模组目前不添加用于创建频道的命令 — 自定义频道完全通过 chatchannels.json 定义。