CourierAPI

模组

· 作者 LunazStudios

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

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

最新 26.1.2-0.1 · 26.1.2 · Fabric

一键开服(送7天)

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


功能

  • 在 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);        // 发送给单个玩家
CourierAPI.broadcast(server, n);   // 发送给所有在线玩家

客户端 API

// 仅限客户端调用 —— 不要在专用服务器上调用
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(操作员)。

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源