NoticeExpress

一个发布服务器公告的绝佳方式。

管理

NoticeExpress

一个用于服务器公告与通知的 Minecraft Fabric 模组,附带可选的客户端 GUI 增强功能。

功能特性

  • 📢 服务端公告管理 - 创建、删除、置顶和管理服务器公告
  • 💾 持久化存储 - 使用 SQLite 数据库可靠地存储公告
  • 🎨 双显示模式 - 基于聊天的通知(回退方案)以及可选的客户端 GUI
  • 📌 置顶重要公告 - 突出显示关键公告
  • 🔐 权限系统 - 公告管理需要 OP 等级 3
  • ⚙️ 可配置 - 基于 JSON 的配置系统

环境要求

  • Minecraft:1.21.7
  • Fabric Loader:0.18.4 或更高
  • Fabric API:0.129.0+1.21.7 或更高
  • Java:21 或更高

安装方法

服务端(必需)

  1. 下载模组 JAR 文件
  2. 将其放入服务器的 mods 文件夹
  3. 启动服务器
  4. 配置文件将生成于 config/noticeexpress/config.json

客户端(可选)

  1. 下载同一个模组 JAR 文件
  2. 将其放入客户端的 mods 文件夹
  3. 享受增强的 GUI 功能(即将推出)

命令

所有命令均以 /notice 开头:

管理命令(OP 等级 3+)

发布公告

/notice publish <title> <content>

示例:

/notice publish "Server Maintenance" "The server will be down for maintenance on Saturday from 2-4 PM."

删除公告

/notice delete <id>

示例:

/notice delete 1

置顶公告

/notice pin <id>

示例:

/notice pin 2

取消置顶公告

/notice unpin <id>

示例:

/notice unpin 2

查看命令(所有玩家)

列出所有公告

/notice list

显示所有公告的紧凑列表,包含其 ID 和标题。

显示完整公告

/notice show

在聊天中显示所有公告的完整内容。

聊天显示格式

在聊天中查看公告时,它们会以如下格式显示:

[Publisher] [YYYY/MM/DD HH:mm] [PINNED]
Title (in gold, bold)
Content (in white, supports multiple lines)

示例:

[Admin] [2026/02/02 12:30] [PINNED]
Server Maintenance
The server will be down for maintenance on Saturday from 2-4 PM. 
Please save your progress before then.

配置

配置文件位置:config/noticeexpress/config.json

{
  "serverTitle": "Server Announcements",
  "databasePath": "config/noticeexpress/notices.db"
}

配置选项

  • serverTitle:客户端 GUI 中显示的标题(默认值:"Server Announcements")
  • databasePath:SQLite 数据库文件的路径(默认值:"config/noticeexpress/notices.db")

数据库

NoticeExpress 使用 SQLite 进行持久化存储。数据库会自动创建和管理。

数据库架构

CREATE TABLE notices (
    id INTEGER PRIMARY KEY AUTOINCREMENT,
    title TEXT NOT NULL,
    publisher TEXT NOT NULL,
    publisher_uuid TEXT NOT NULL,
    content TEXT NOT NULL,
    timestamp INTEGER NOT NULL,
    is_pinned INTEGER NOT NULL DEFAULT 0,
    created_at INTEGER NOT NULL
)

权限

本模组使用 Minecraft 内置的 OP 系统:

  • OP 等级 3+:可以发布、删除、置顶和取消置顶公告
  • 所有玩家:可以使用 /notice list 和 /notice show 查看公告

客户端 GUI(即将推出)

可选的客户端模组将提供增强的 GUI,包含:

  • 📋 可滚动的公告列表
  • 🎴 美观的公告卡片
  • 📌 可视化的置顶标识
  • ✨ 展开/折叠功能
  • 🖱️ 点击交互界面

开发者指南

从源码构建

  1. 克隆仓库:
git clone https://github.com/0x002500/NoticeExpress.git
cd NoticeExpress
  1. 构建模组:
./gradlew build
  1. 在 build/libs/ 中找到编译好的 JAR

项目结构

src/
├── main/
│   ├── java/top/orderly/noticeexpress/
│   │   ├── NoticeExpress.java          # Main mod class
│   │   ├── command/
│   │   │   └── NoticeCommand.java      # Command registration and handlers
│   │   ├── config/
│   │   │   └── ModConfig.java          # Configuration management
│   │   ├── database/
│   │   │   ├── DatabaseManager.java    # SQLite connection manager
│   │   │   └── NoticeRepository.java   # CRUD operations
│   │   ├── model/
│   │   │   └── Notice.java             # Notice entity
│   │   └── util/
│   │       ├── ChatNotificationFormatter.java  # Chat formatting
│   │       ├── PermissionChecker.java          # Permission utilities
│   │       └── TimeFormatter.java              # Time formatting
│   └── resources/
│       ├── fabric.mod.json             # Mod metadata
│       └── assets/noticeexpress/
│           └── icon.png                # Mod icon
└── client/
    └── java/top/orderly/noticeexpress/
        ├── NoticeExpressClient.java    # Client initialization
        └── ui/                         # GUI components (coming soon)

API 用法

通过代码创建公告

import top.orderly.noticeexpress.NoticeExpress;
import top.orderly.noticeexpress.model.Notice;

Notice notice = new Notice();
notice.setTitle("My Notice");
notice.setPublisher("System");
notice.setPublisherUuid(UUID.randomUUID());
notice.setContent("This is a programmatically created notice.");

NoticeExpress.getNoticeRepository().createNotice(notice);

获取公告

import top.orderly.noticeexpress.NoticeExpress;
import top.orderly.noticeexpress.model.Notice;
import java.util.List;

// Get all notices
List<Notice> allNotices = NoticeExpress.getNoticeRepository().getAllNotices();

// Get a specific notice by ID
Notice notice = NoticeExpress.getNoticeRepository().getNoticeById(1);

// Get notices since a timestamp
long timestamp = System.currentTimeMillis() - 86400000; // Last 24 hours
List<Notice> recentNotices = NoticeExpress.getNoticeRepository().getNoticesSince(timestamp);

路线图

  • 客户端 GUI
  • 网络数据包通信
  • 玩家加入通知
  • 本地化支持(英文和中文)

贡献指南

欢迎贡献!请随时提交 Pull Request。

  1. Fork 仓库
  2. 创建功能分支(git checkout -b feature/AmazingFeature)
  3. 提交变更(git commit -m 'feat: add some amazing feature')
  4. 推送到分支(git push origin feature/AmazingFeature)
  5. 打开 Pull Request

提交信息规范

本项目遵循 Conventional Commits:

  • feat: - 新功能
  • fix: - 问题修复
  • docs: - 文档变更
  • style: - 代码风格变更(格式化等)
  • refactor: - 代码重构
  • test: - 添加或更新测试
  • chore: - 维护任务

许可证

本项目采用 Apache-2.0 许可证 - 详情请参阅 LICENSE 文件。