@occultus/notification-api
v0.22.0
Published
Star Tenon notification api
Readme
Star Tenon Notification API
这是一个通知 API,用于在游戏中显示通知,其支持下面的几种通知类型:
WelcomeNotification;UpdateNotification。
具体使用方法请参见源代码。
OpenToast 规范
[!IMPORTANT] 这个规范需要搭配对应的客户端资源才能正常显示。
本程序包中的
resources文件夹下是一个范例,你可以直接使用,也可以自行实现。
这是一个开放的 Toast 规范,我们规定在一个以toast:开头的标题中:
- 主标题
toast:后的内容为通知信息; - 副标题
toast:后的内容为通知图标路径。
例如:
player.onScreenDisplay.setTitle(
{
rawtext: [{ text: "toast:" }, { translate: "aaa" }]
},
{
subtitle: `toast:textures/items/apple`,
fadeInDuration: 0,
fadeOutDuration: 0,
stayDuration: 1
}
);当然,我们也可以使用封装好的 API 接口:
new Toast("测试内容", "textures/items/apple").send(player);动态属性
<ModID>:playedVersion- 属性类型:Player;
- 玩家上次游玩时的模组版本号
支持版本
本 API 支持任意可以运行 Script API v2.0.0+ 的游戏版本,包括:
- 1.21.90;
- 1.21.100;
- 1.21.110;
- 以及更多……
注意:本包理论上可以在部分更旧的版本上运作,但未经过严格的测试。
协议
本项目使用 MIT License 授权:
The MIT License (MIT)
Copyright © 2025 CTN Studios
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.