angelloNotifier
一款用于 Velocity 的公告发布、通知发送与管理插件。
简介
angelloNotifier 是专为 Velocity 设计的代理端公告板。它允许你在代理服务器上发布全网络范围的公告,将其存储在 YAML 文件中,并让玩家稍后从共享历史记录中重新查看同一份公告。
该插件定位为公共公告板而非私人邮箱。公告是全局可见的,但每位玩家仅拥有自己的已读状态。加入时的预览、忽略服务器设置、MiniMessage 格式支持以及每条公告的独立生命周期设置,都是围绕这一模型构建的。
安装
编译 jar 文件或下载发行版,将其放入 Velocity 的 plugins/ 目录,然后启动一次代理服务器。插件将在首次启动时创建其工作目录并写入默认资源文件。之后,请根据你的网络需求调整 plugins/angelloNotifier/config.yml 中的配置,然后重启代理服务器或运行 /angello reload 命令。
如果你是在更新现有安装,建议在替换 jar 文件之前备份 config.yml 和 data.yml。数据格式简单且易于阅读,但备份可以在你测试新功能时让回滚变得更加容易。
快速开始
基础命令为 /angello,同时提供 /angellonotifier、/anno 和 /noticeboard 作为别名。对于玩家而言,常用操作非常简单:使用 /angello inbox 在聊天栏打开分页公告列表,使用 /angello show <id> 重新打印特定公告,使用 /angello unread 报告该玩家尚未阅读的公告数量。
对于管理员,核心命令如下:
/angello send <title> || <body> [|| lifetime]
标题位于第一段。正文位于第二段。可选的第三段仅针对该条公告设定生命周期。如果省略生命周期参数,插件将回退使用 config.yml 中 settings.default-notification-lifetime 的值。
一个简单的示例如下:
/angello send <gold>Maintenance</gold> || <red>The network will restart in 10 minutes.</red>
带有自定义生命周期的公告示例如下:
/angello send <yellow>Reminder</yellow> || Please read the event rules before joining. || 3
如果你希望包含多行正文,可以在命令输入框中输入实际换行,或者在正文部分使用 \n。插件将正文存储为行列表,并以块状形式打印输出,对于多行输出,公告板前缀会单独显示在第一行。
管理审查命令包括 /angello list [page]、/angello delete <id> 和 /angello reload。删除操作不会改变剩余公告的 ID。如果公告 #12 被删除,该 ID 将永久消失,而后续公告将继续使用更高的 ID。
文档
GitHub Wiki 包含了当前实现的详细参考页面。Wiki 主页解释了整体模型和预期行为。配置页面记录了 config.yml 中的每一项设置。数据页面描述了 data.yml 的确切结构,包括玩家状态。命令页面更详细地解释了语法、别名、权限和示例。
你可以从这里开始阅读:
Home
config.yml
data.yml
Commands
反馈
请使用 GitHub Issues 提交错误报告和功能请求。在报告错误时,请提供你的 Velocity 版本、angelloNotifier 版本、配置文件以及相关控制台日志,以便复现问题。
如果问题涉及命令解析或格式显示,请提供你输入的完整命令和你收到的确切输出。如果问题涉及公告状态,请同时提供 data.yml 中受影响的部分。这通常决定了报告是能迅速得到调查,还是需要经过多轮追问才能解决。
贡献
欢迎贡献。请 Fork 仓库,创建功能分支,并保持更改内容集中、易于审查。
在提交 Pull Request(合并请求)时,请说明更改了什么、为什么更改以及如何测试这些更改。
如果您的更改影响了配置结构、命令行为、通知持久化或国际化(i18n),请在适当情况下更新 README、Wiki 页面以及随附的资源文件。由于此类插件的命令语法和存储数据结构属于项目的公开接口,因此很容易导致文档不同步。
许可证
本项目采用 MIT 许可证授权。详情请参阅 LICENSE 文件。
angelloNotifier
A velocity announcement and notification sending and managing plugin.
Introduction
angelloNotifier is a proxy-side notice board for Velocity. It lets you publish one network-wide notice on the proxy,
store it in YAML, and let players reopen that same notice later from a shared history.
The plugin is designed as a public notice board rather than a private mailbox. Notices are global, while each player
only has their own read state. Join-time previews, ignored servers, MiniMessage support, and per-notice lifetime
settings are all built around that model.
Installation
Build the jar or download a release, place it in the Velocity plugins/ directory, and start the proxy once. The plugin
will create its working directory and write default resource files on first startup. After that, adjust
plugins/angelloNotifier/config.yml to fit your network and either restart the proxy or run /angello reload.
If you are updating an existing installation, it is still a good idea to keep a backup of both config.yml and
data.yml before replacing the jar. The data format is simple and human-readable, but a backup makes rollback much
easier if you are testing new behaviour.
Quick start
The base command is /angello, with /angellonotifier, /anno, and /noticeboard available as aliases. For players,
the usual workflow is very small. /angello inbox opens the paged notice list in chat, /angello show <id> reprints a
specific notice, and /angello unread reports how many notices are still unread for that player.
For administrators, the central command is:
/angello send <title> || <body> [|| lifetime]
The title is the first segment. The body is the second segment. The optional third segment is the lifetime for that one
notice only. If the lifetime is omitted, the plugin falls back to settings.default-notification-lifetime from
config.yml.
A simple example looks like this:
/angello send <gold>Maintenance</gold> || <red>The network will restart in 10 minutes.</red>
A notice with a custom lifetime looks like this:
/angello send <yellow>Reminder</yellow> || Please read the event rules before joining. || 3
If you want multiple body lines, either type actual new lines in the command input or use \n inside the body segment.
The plugin stores the body as a list of lines and prints it back as a block, with the notice board prefix on its own
first line for multi-line output.
Administrative review commands are /angello list [page], /angello delete <id>, and /angello reload. Notice IDs do
not change after deletion. If notice #12 is deleted, that ID remains gone, while later notices continue with higher
IDs.
Documentation
The GitHub Wiki contains the detailed reference pages for the current implementation. The wiki home page explains the
overall model and intended behaviour. The configuration page documents every setting in config.yml. The data page
describes the exact structure of data.yml, including player state. The command page explains syntax, aliases,
permissions, and examples in more detail.
You can start here:
Home
config.yml
data.yml
Commands
Feedback
Please use GitHub Issues for bug reports and feature requests. When reporting a bug, include your Velocity version, the
angelloNotifier version, your configuration files, and the relevant console logs so the issue can be reproduced.
If the problem involves command parsing or formatting, include the exact command you entered and the exact output you
received. If the problem involves notice state, include the affected part of data.yml as well. That usually makes the
difference between a report that can be investigated quickly and one that needs several rounds of follow-up questions.
Contributing
Contributions are welcome. Fork the repository, create a feature branch, and keep changes focused and easy to review.
When opening a Pull Request, explain what changed, why it changed, and how to test it.
If your changes affect configuration structure, command behaviour, notice persistence, or i18n, please update the
README, the wiki pages, and the shipped resource files where appropriate. Documentation drift is easy to introduce in a
plugin like this because command syntax and stored data shape are part of the public surface of the project.
License
This project is licensed under the MIT License. See
the LICENSE file for details.
评论 0
登录后参与评分
还没有评论,来抢沙发吧