CourierAPI

CourierAPI

CourierAPI 是一个 Fabric 模组库,允许任何模组通过 Java API、JSON 文件或游戏内命令向玩家发送动画 HUD 通知卡片。支持服务器到客户端的广播以及客户端本地显示。

基础库

CourierAPI Logo.

CourierAPI 是一个 Fabric 模组库,允许任何模组向玩家发送动画 HUD 通知卡片——可通过 Java API、JSON 文件或游戏内命令实现。支持服务器到客户端的广播以及客户端本地显示。


功能

  • HUD 右上角的动画滑入 / 滑出卡片
  • 完全可自定义颜色——标题、描述、背景和边框强调色(ARGB)
  • 每条通知可配置显示时长
  • 最多同时显示 4 条通知;多余的通知自动排队
  • 当描述文本过长时自动换行至第二行
  • 服务器 → 客户端——通过 Java API 或 JSON 文件发送通知,无需编写代码
  • 仅客户端——从另一个客户端模组本地显示通知,无需服务器
  • 为管理员提供即插即用的 /courier 命令
  • 服务器首次启动时自动创建示例 couriernotifications.json

面向开发者

将以下内容添加到你的 gradle.properties:

courierapi_version=0.1

然后在 build.gradle 中:

repositories {
    maven {
        name = "LunazStudios"
        url  = "https://maven.lunazstudios.com/releases"
    }
}

dependencies {
    modImplementation "com.lunazstudios:CourierAPI:${project.minecraft_version}-${project.courierapi_version}"
}

完整文档和 API 使用示例可在 GitHub 仓库 中查看。


服务器 API

Notification n = Notification.builder("Event Started!", "Head to the arena.")
        .durationSeconds(6)
        .borderColor(0xFFFF4444)
        .build();

CourierAPI.send(player, n);        // single player
CourierAPI.broadcast(server, n);   // all online players

客户端 API

// Client-side only — do not call on a dedicated server
CourierClientAPI.showLocal(n);

JSON——无需编写代码

将 couriernotifications.json 放在服务器根目录下,以定义可复用的通知:

{
  "restart_warning": {
    "title": "Server Restart",
    "description": "The server restarts in 5 minutes.",
    "duration": 8,
    "border_color": "#FF5555"
  }
}

在游戏内使用 /courier send restart_warning 触发它们,或将条目放入 couriernotifications_queue.json 以通过外部脚本或 RCON 派发——无需重启。


命令

命令 描述
/courier send <id> 向所有在线玩家广播一条通知
/courier reload 从磁盘重新加载 couriernotifications.json

需要权限等级 2(管理员)。