AutoMessage [1.21]

插件

· 作者 DMK

⚡ AutoMessage 是一个高性能插件,支持完全自定义的全服自动广播。

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

最新 3.0.1 · 26.3 · Bukkit / BungeeCord

一键开服(送7天)

AutoMessage - 正确的消息,发送给正确的玩家,在正确的时刻

不是又一个聊天轮播器。而是一个完整的公告引擎。
面向现代 Minecraft 服务器和网络,提供定向、本地化且感知事件的广播。

6 个运行时  ·  8 种通知展示面  ·  8 条受众规则  ·  3 种事件触发器  ·  3 种内置语言  ·  每种语言一次渲染  ·  无需数据库

? 为什么选择 AutoMessage

⚙️ 安装与配置

? 参考文档

? 广播应赢得关注

当每条消息都发送给所有人时,玩家会逐渐学会忽略公告。AutoMessage 使服务器通信变得更有针对性:每个广播流拥有自己的调度计划,每条消息选择自己的受众,并且文本会以每位玩家实际游玩的语言呈现——这一切都由运行在 Bukkit, Folia, Sponge, Velocity, Fabric 和 Minestom 上的同一个核心驱动。

游戏中同时显示的三种公告形式:屏幕顶部的Boss血条倒计时、屏幕中央的全屏标题以及下方的聊天行

在一台服务器上的一次公告设置:包含 Boss 血条倒计时、全屏标题和聊天行。

从头到尾的完整公告体验

在玩家加入三秒后向回归的老玩家致以问候——绝不按固定时钟触发,也绝不会打扰新玩家,并使用他们自己的语言。仅需两个文件即可实现全部功能:

# scheduledMessages.yml - 谁收到,何时发送
messages:
  - name: welcome-back
    trigger:
      type: JOIN
      delay: 3s
    rules:
      - type: PLAYTIME
        min: 10h
# lang/en.yml - 发送什么内容
announcements:
  welcome-back:
    - chat: "<gray>Welcome back, <aqua>{PLAYER}<gray>."
      sound: "entity.player.levelup MASTER 1.0 1.2"

服务器处理这些文件的流程如下:

两名玩家加入。三秒后,拥有240小时游戏时间的老玩家满足时长规则并收到附带升级音效的问候语;而仅游玩了十二分钟的新玩家则不会收到任何消息。

这浓缩了整个功能集:以事件替代时钟,以特定受众替代全员广播,以及与其他翻译并存的文本内容。

⚖️ 超越简单的轮播列表

这句标语并非营销噱头。轮播器只能回答一个问题——下一条该说什么?——并将答案以单一语言、在单一时钟周期内发送给所有人。

普通轮播器 AutoMessage
接收者 所有在线玩家 权限、群组、世界、在线人数、游戏时长 - 使用 ANY_OF、NONE_OF、NOT 组合
触发时机 一个全局间隔 每个频道独立的计划,以及 JOIN(加入)、FIRST_JOIN(首次加入)和重新触发的 PLAYER_COUNT(玩家数量)事件
显示形式 一行聊天信息 聊天栏、操作栏、标题、副标题、Boss 条和音效,合并为一条公告
内容呈现 向所有人显示同一文本 玩家自己的语言,每条消息可设置备用语言回退
运行环境 单一服务器类型 Bukkit、Folia、Sponge、Velocity、Fabric 和 Minestom,每种均为原生构件

底层细节

? 四种轮播策略

SHUFFLE(随机洗牌)、SEQUENTIAL(顺序)、RANDOM(随机)或加权选择,按频道配置。洗牌模式会在重复之前发完一整副牌。
? 适配运行时的配置

代理服务器无法感知世界规则或首次加入触发器。平台无法支持的选项会被省略在文件之外,既不会写入也不会被读取。
? 发布前预览

/automessage view <name> 仅向你个人渲染真实的本地化消息,忽略其受众规则。
↗ 超越服务器

将聊天内容镜像到 Discord Webhook,剥离仅限玩家的占位符,并禁用自动提及功能。
♻ 重载而非重启

/automessage reload 就地应用计划、消息和语言配置 - 包括在服务器运行时添加的翻译文件。
? 轻量分发路径

无数据库。空服时短路处理,占位符每条消息只扫描一次而非每次公告扫描一次,且所有以相同语言阅读相同文本的玩家共享单次渲染结果。

? 精准触达目标听众

规则可组合。每个顶层规则都必须通过,当受众条件需要比“与”更复杂的逻辑时,ANY_OF、NONE_OF 和 NOT 可在其中嵌套。

十二名玩家在线;一条要求 rank.vip 权限且至少十小时游戏时间的规则选中了五人,其余人保持暗色

同样的规则也适用于由事件发送的消息,因此如果一条加入问候语仅限于拥有特定权限的玩家,那么即使某人刚进门,只要缺少该权限就永远不会收到它。

⚡ 基于事件触发,而非时钟计时

带有触发器的消息会完全脱离其频道的轮播机制,等待特定事件发生。

三个通道:一个每五分钟触发的频道,一个玩家连接后三秒触发的加入触发器,以及一个在一百在线人数时触发一次,仅在人数降至阈值以下后才重新触发的玩家数量里程碑

PLAYER_COUNT 值得再读一遍:它在人数上升时触发一次,并且只有在服务器人数回落至阈值之下后才会重新触发,因此当在线人数徘徊在边界附近时,不会因为有人登录而反复宣布相同的里程碑。

? 几乎不占用服务器资源

格式化是公告中最耗时的部分。颜色、渐变、悬停文本和占位符都必须在任何字符发送给任何人之前进行解析 - 而显而易见的方法是为每个接收它的玩家单独执行一次。五百名玩家在线意味着同一句话为了表达同一个意思而被构建了五百次,在主线程上执行,而其他 Tick 则在一旁等待。

AutoMessage 按语言构建一次,并将完成的结果分发给所有阅读它的玩家。

一次公告触达 500 名玩家。按玩家格式化意味着对同一文本解析 500 次,耗时 5.16 毫秒,约等于十分之一的服务器 Tick。AutoMessage 按语言格式化一次,耗时 0.34 毫秒。

按玩家格式化 AutoMessage
每次公告的解析次数 每位玩家一次,即 500 次 实际正在阅读的每种语言一次
主线程耗时 5.16 毫秒 0.34 毫秒
50ms Tick 中的占比 ~10%,每次公告 ~0.7%

这相当于每次公告的主线程时间减少了 15 倍,这是在真实发送路径上、500 名观众在线的情况下测量的 - 而不是单个函数的微基准测试。剩余的工作是将完成的文本发送给每个连接,这是任何插件都无法避免的。

随着玩家数量的增加,节省的效果也会增长,而且配置它无需付出额外代价:没有需要调整大小的缓存,没有需要调优的设置,也没有需要放弃的行为。

它从不牺牲正确性来换取速度。 对于每个玩家显示不同的消息 - 例如包含 {PLAYER} 名称,或携带任何 PlaceholderAPI 令牌 - 仍然会为每个玩家单独构建,因为只有令牌背后的扩展内容才知道两个玩家是否会看到相同的内容。分组仅应用于文本确实完全相同的地方,其他地方则不适用。

分发路径还有三个地方拒绝做无用功:

  • 占位符每条消息只扫描一次,而非每次公告扫描一次。 消息包含哪些令牌是由文本决定的,因此在读取文件时确定并记住,直到重载 - 而不是每次频道触发时重新推导。
  • 空服时短路处理。 没有在线玩家意味着没有选择、没有格式化也没有工作。
  • 公告期间不触碰磁盘。 无数据库,无玩家记录,热路径上无 I/O 操作。

? 一套引擎。六种运行时

AutoMessage 使用共享的平台无关核心,并为每种服务器类型提供小型运行时适配器。 这意味着在调度、查看器、权限和生命周期钩子方面,行为保持熟悉,同时这些功能对底层平台保持原生支持。

一个平台无关的核心连接到六个工件:Bukkit、Folia、Sponge、Velocity、Fabric 和 Minestom

工件 运行时 支持的行 Java 平台特定说明
Bukkit Spigot、Paper、Purpur 及其他基于 Bukkit 的服务器 Minecraft 1.21–26.2 21+ 完整功能集;可选 PlaceholderAPI 集成
Folia Folia Minecraft 1.21–26.2 21+ 专用的区域化调度;可选 PlaceholderAPI 集成
Sponge Sponge API 17 Minecraft 1.21.10 21+ 完整功能集,但不包括 PlaceholderAPI
Velocity Velocity 3.5.1 代理 代理运行时 21+ 无世界、游戏时长、首次加入或 PlaceholderAPI 功能
Fabric 专用 Fabric 服务器 Minecraft 1.21.11 21+ 服务端模组;需要 Fabric API;无 PlaceholderAPI
Minestom 嵌入式 Minestom 库 协议 1.21.11 25+ 类路径库;无世界、游戏时长、首次加入或 PlaceholderAPI;权限/组规则需要回调

[!NOTE] Java 21 是插件工件的字节码最低要求,并非承诺每个 Minecraft 服务器版本都能在 Java 21 上运行。请使用服务器所需的 JVM;Minestom 本身需要 Java 25。

每个工件都会写入平台感知的配置。运行时无法尊重的选项将被省略,而不是生成并静默忽略。

在 Paper 和 Velocity 代理上生成的相同文件:代理文件中缺少世界规则、游戏时长规则、首次加入触发器、世界占位符、PlaceholderAPI 说明和游戏时长示例

Quilt 怎么办?

没有单独的 Quilt 工件。Quilt 可以读取 Fabric 元数据,但此分支未声明经过测试的 Quilt 版本。将 Fabric jar 视为在 Quilt 上的实验性使用,并自行携带兼容的 Fabric API。

? 配置模型

AutoMessage 分离了 何时、谁 和 什么。添加语言无需复制调度规则,更改频道间隔也不会触及消息文本。

flowchart LR
    schedule["config.yml<br/>WHEN<br/>channels · periods · selectors"]
    audience["scheduledMessages.yml<br/>WHO<br/>rules · weights · triggers"]
    content["lang/*.yml<br/>WHAT<br/>localized MiniMessage notices"]
    minecraft["Minecraft<br/>PLAYER OUTPUT"]
    discord["discordWebhook.yml<br/>OPTIONAL MIRROR"]

    schedule --> audience --> content --> minecraft
    content -. "chat text" .-> discord

    classDef config fill:#11182d,stroke:#8b7cf6,color:#eef0ff,stroke-width:1px;
    classDef output fill:#0d2028,stroke:#45d7e8,color:#ecfeff,stroke-width:1px;
    class schedule,audience,content config;
    class minecraft,discord output;
文件 职责
config.yml 主开关、备用语言、频道、启动延迟、周期和选择器
scheduledMessages.yml 消息名称、频道分配、权重、受众规则和事件触发器
lang/<code>.yml 本地化的命令回复和实际的 MiniMessage 公告有效载荷
discordWebhook.yml 可选的 Discord Webhook、显示名称和头像

? 获取 AutoMessage

你需要什么 从哪里获取
当前公开的 Bukkit 构建 Modrinth · SpigotMC · Hangar
发布历史和更新日志 GitHub Releases
来自此分支的多平台工件 从源代码构建所有六个

[!IMPORTANT] 发布状态: 本自述文件记录的是本地多平台分支。当前的公开列表仍代表较早的专注于 Bukkit 的发布线。在新的 GitHub 发布所有六个工件之前,请使用 ./gradlew dist 构建多平台 jars。

? 快速开始

  1. 获取为运行时构建的工件。平台 jar 故意分开。
  2. 将其放入平台的 plugins/ 或 mods/ 目录中。对于 Minestom,将 jar 添加到应用程序类路径,并使用下面显示的构建器。
  3. 启动服务器一次。AutoMessage 生成带注释的配置以及工作的示例公告。
  4. 编辑 config.yml、scheduledMessages.yml 和 lang/ 内的文件。
  5. 运行 /automessage reload,然后使用 /automessage view <name> 测试一条消息。

[!TIP] 从生成的文件开始。它们不是空模板:每个可用字段旁边都有解释和一个工作的示例,内容会根据创建它们的平台进行调整。

? 构建你的第一个公告

下面的示例创建一个独立的事件流,向其添加一个公告,并从单个本地化有效载荷渲染多种通知类型。

1. 调度流

# config.yml
enabled: true
fallbackLanguage: en

channels:
  - name: default
    enabled: true
    initialDelay: 1m
    period: 5m
    selector: SHUFFLE

  - name: events
    enabled: true
    initialDelay: 30s
    period: 15m
    selector: SEQUENTIAL

2. 注册公告

# scheduledMessages.yml
messages:
  - name: event-night
    channel: events

3. 设计玩家接收的内容

# lang/en.yml
announcements:
  event-night:
    - chat:
        - "<dark_gray>[<gold>EVENT<dark_gray>] <gray>The arena opens in <gold>5 minutes<gray>."
        - "<gray>Click <click:run_command:'/warp arena'><hover:show_text:'<yellow>Teleport'><aqua><u>here</u></aqua></hover></click> to join."
      actionbar: "<yellow>Prepare your loadout - the event starts soon"
      title: "<gradient:#ffd166:#ff6b6b><bold>EVENT NIGHT</bold></gradient>"
      subtitle: "<gray>The arena opens in 05:00"
      times: "500ms 3s 500ms"
      bossbar:
        message: "<light_purple>Event countdown"
        duration: 10s
        color: PURPLE
        overlay: PROGRESS
        progress: 0.75
      sound: "block.note_block.pling MASTER 1.0 1.0"

The same announcement on four surfaces at once: a boss bar countdown, a gradient title and subtitle, two chat lines and an action bar above the hotbar

Use only the parts that fit the message. A simple chat announcement can be a single string; a showcase announcement can combine every surface above.

? Reference

Announcement channels and selectors

Every channel has its own schedule and independent selector state:

channels:
  - name: tips
    enabled: true
    initialDelay: 1m
    period: 5m
    selector: SHUFFLE

  - name: promotions
    enabled: true
    initialDelay: 2m
    period: 20m
    selector: WEIGHTED
Selector Behavior
SHUFFLE Randomizes the order and shows every message once before anything repeats
SEQUENTIAL Walks straight through the configured list
RANDOM Draws independently; the same message may appear twice in a row
WEIGHTED Draws randomly in proportion to each message's weight

SEQUENTIAL and SHUFFLE keep their position across a normal configuration reload. A weight of 0 parks a message only in a WEIGHTED channel; other selectors do not consult weights.

Audience rules

Top-level rules behave like logical AND. Nest ANY_OF, NONE_OF and NOT when the audience needs more expressive logic.

Rule Matches
PERMISSION Viewers holding a permission node
GROUP Viewers holding group.<name>; this is permission-based, not a direct LuckPerms/Vault lookup
WORLD Viewers in one of the configured worlds
PLAYER_COUNT While the live online count is inside a configured range
PLAYTIME Viewers whose native platform playtime is inside a configured duration range
ANY_OF At least one nested rule
NONE_OF None of the nested rules
NOT The inverse of one nested rule
messages:
  - name: vip-event
    channel: events
    rules:
      - type: ANY_OF
        rules:
          - type: PERMISSION
            permission: rank.vip
          - type: PERMISSION
            permission: rank.staff
      - type: PLAYER_COUNT
        min: 10
        max: 100

Rules still apply to messages sent by an event trigger. Platform-specific rules are generated only where the runtime can supply the required data.

Event triggers

A triggered message leaves its timed channel rotation completely:

messages:
  - name: welcome-back
    trigger:
      type: JOIN
      delay: 3s

  - name: first-join-welcome
    trigger:
      type: FIRST_JOIN
      delay: 3s

  - name: one-hundred-online
    trigger:
      type: PLAYER_COUNT
      threshold: 100

PLAYER_COUNT fires once when the threshold is reached and re-arms only after the online count drops below it. FIRST_JOIN is unavailable on runtimes that do not expose a persistent first-join signal.

[!NOTE] /automessage enable and /automessage disable control scheduled channels. Event-triggered announcements operate independently.

Languages and fallback behavior

AutoMessage ships en, pl and de. Add another language by copying a file to lang/<code>.yml, translating it and running /automessage reload.

For a player using pt_br, AutoMessage looks for:

  1. lang/pt_br.yml
  2. lang/pt.yml
  3. the fallbackLanguage from config.yml

A missing announcement falls back individually, so a new translation does not have to be complete before it is useful.

MiniMessage, placeholders and notification parts

All text uses Kyori MiniMessage, including colors, gradients, decorations, hover text and click actions.

Built-in placeholders:

Player-scoped Server-scoped
{PLAYER} · {DISPLAY_NAME} · {UUID} · {WORLD} {ONLINE} · {MAX_PLAYERS} · {DATE} · {TIME}

On Bukkit and Folia, an installed PlaceholderAPI is detected automatically. Standard %placeholder_name% tokens containing letters, digits and underscores can then be used alongside the built-ins.

Available notification keys:

Key Value
bare string / chat One chat line or a list of lines
actionbar MiniMessage text shown above the hotbar
title / subtitle Title layers; either can be used independently
times Three durations: fade in, stay, fade out
hideTitle Explicitly clear the current title
bossbar Message, duration, color, overlay and optional progress 0.0–1.0
sound Sound key, or key source volume pitch

Need a visual starting point? Try the external EternalCode Notification Generator and adapt the generated notification to the language-file structure above.

Time format

每种持续时间都接受显式单位,且单位可以组合:

单位 含义 示例
ms 毫秒 500ms
s 秒 30s
m 分钟 5m
h 小时 2h
d 天 1d

1m30s 是合法的。纯数字会被解释为秒数。频道周期短于 50ms 的会被标准化,基于刻(tick)的运行时间最终会在刻边界上执行。

Discord Webhook 镜像

在 discordWebhook.yml 中设置 enabled: true 并提供 Discord webhook URL,即可将计划触发和手动触发的公告镜像到 Discord。

该集成设计得较为保守:

  • 仅镜像聊天部分;
  • MiniMessage 格式会被展平为纯文本;
  • 使用配置的备用语言;
  • 解析服务器占位符,但移除玩家作用域的值;
  • 禁用自动 Discord @提及;
  • webhook 必须使用 HTTPS 以及有效的 Discord webhook 主机/路径;
  • 对速率限制响应进行退避重试。

启用 webhook 是可选的,且在禁用或缺少有效 URL 时不会发出任何出站请求。更改 webhook 的启用状态或 URL 后,请重启 AutoMessage 以重建连接。

命令与权限

命令 权限节点 描述
/automessage enable command.automessage.enable 恢复计划公告频道
/automessage disable command.automessage.disable 暂停计划公告频道
/automessage reload command.automessage.reload 重新加载计划、消息定义和语言配置
/automessage view <name> command.automessage.view 预览一条本地化消息;仅限玩家,支持 Tab 补全
/automessage next command.automessage.next 显示每个频道即将发布的下一条公告及其触发倒计时,且不消耗本次发送机会
/automessage send <channel> command.automessage.send 立即发送该频道的下一条公告;其间隔计时从此刻重新开始
/automessage toggle command.automessage.toggle 玩家自行关闭或重新开启公告;跨重启保持记忆
/automessage stats command.automessage.stats 按频道统计:已发布数量、上次发布时间、下次预定时间,随后按消息统计相同信息
将 AutoMessage 嵌入 Minestom

Minestom 没有插件目录。初始化 Minestom,将 AutoMessage 置于类路径中,并在 Minestom 自身初始化完成后启用该库:

MinecraftServer.init();

AutoMessageMinestom autoMessage = AutoMessageMinestom.builder()
        .dataDirectory(Path.of("automessage"))
        .permissions((sender, node) -> myPermissions.check(sender, node)) // 可选
        .enable();

// 在服务器关闭期间:
autoMessage.shutdown();

如果没有提供权限回调,AutoMessage 将使用 Minestom 的操作员等级来保护其命令。由于运行时无法准确回答相关查询,权限和组受众规则将被省略。

? 从源码构建

构建所有运行时环境需要 JDK 25。从仓库根目录运行:

./gradlew dist

该任务会运行所有检查,构建每个平台特定的 jar 包,并将六个可安装工件同步到 build/dist 中:

  • Bukkit
  • Folia
  • Sponge
  • Velocity
  • Fabric
  • Minestom

如果任何验证失败,则不会生成发行版。普通的 ./gradlew build 会执行相同的项目检查,但会将工件保留在各自的模块内部。

? 支持本项目

AutoMessage 免费、开源且独立维护。

发现问题? 想要贡献? 想要支持开发?
提交 Bug 报告或功能请求 阅读贡献指南并提交拉取请求 GitHub Sponsors · PayPal

请在所有社区空间中遵循项目的行为准则。 AutoMessage 根据 GNU 通用公共许可证 v3.0 分发。

如果 AutoMessage 改善了你的服务器通信体验,请给仓库点个星。
这有助于其他服务器管理员发现该项目。

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源