转载 开源 工具 SimplePushEvents 0.0.5

[MD]
# SimplePushEvents

SimplePushEvents 是一款适用于最新版 Minecraft 的 Spigot 服务端插件。它会在玩家加入、离开、执行指定命令、完成特定行为，以及服务器启动或关闭时，自动向 ntfy.sh 推送服务发送通知，帮助服主和玩家实时了解服务器动态。

## 运行环境

- 兼容 Minecraft 1.20.6
- 需要 Java 21

## 功能

- 服务器启动和关闭时发送通知。
- 在以下事件发生时发送推送通知：
- 玩家加入或离开服务器；
- 玩家解锁进度；
- 玩家创建传送门；
- 玩家死亡，包括死亡消息；
- 玩家执行 `/spe [message content]`，可用于发送自定义通知并设置自定义权限。
- 可自定义通知消息格式，也可以单独启用或禁用各类通知。
- 可快速接入 ntfy.sh 推送服务。
- 配置简单，部署快捷。
- 可监控并通知以下指定玩家命令：
- `/op`
- `/deop`
- `/ban`
- `/banip`
- `/pardon`
- `/pardonip`
- `/whitelist`

## 安装与设置

1. **安装插件**
下载 SimplePushEvents，并将插件文件放入 Spigot 服务端的 `plugins` 目录。

2. **生成并编辑配置**
首次启动服务器后，插件会在 ``plugins/simplepushevents`` 目录中生成配置文件 ``options.yml``。编辑该文件，按需调整通知消息和功能设置。

3. **安装 ntfy 应用**
前往 [ntfy.sh](https://ntfy.sh/) 下载 ntfy 应用，可通过 Play 商店或 App Store 安装。ntfy.sh 服务可免费使用。

4. **订阅推送主题**
打开 ntfy 应用，订阅配置项 ``donottouch.pushchannel`` 中指定的主题。订阅后，即可接收插件发送的通知。

5. **重启或重载服务器**
修改配置后，重启或重载 Spigot 服务器以应用新的设置。

6. **接收通知**
完成设置后，当玩家加入、离开或服务器启动、关闭时，插件会按照当前配置自动发送推送通知。

## 插件配置

部署插件前，请确认已在 ``options.yml`` 文件中正确配置以下参数：

```yaml
donottouch:
configexists: true
pushchannel: 7fc647dd98
messages:
general:
title: 'Minecraft Server:'
startup:
status: true
content: The server is online now!
poweroff:
status: true
content: The server is shutting down!
chatcommand:
status: true
content: '[%PLAYER%] wrote: %MESSAGE%'
permission: spe.usechatcommand
player:
advancement:
status: true
content: 'The player %PLAYER% unlocked the advancement: %NAME%'
join:
status: true
content: The player %PLAYER% joined!
leave:
status: true
content: The player %PLAYER% left!
count:
status: true
content: 'Players online right now: %ONLINE%/%MAX%'
death:
status: true
content: 'The Player %PLAYER% died: %MESSAGE%'
portalcreation:
status: true
content: The Player %PLAYER% created a portal at %LOCATION%
command:
disableall: false
op:
status: true
content: The player %PLAYER% executed /op for %TARGET% !
deop:
status: true
content: The player %PLAYER% executed /deop for %TARGET% !
ban:
status: true
content: The player %PLAYER% executed /ban for %TARGET% !
banip:
status: true
content: The player %PLAYER% executed /ban-ip for %TARGET% !
pardon:
status: true
content: The player %PLAYER% executed /pardon for %TARGET% !
pardonip:
status: true
content: The player %PLAYER% executed /pardon-ip for %TARGET% !
whitelist:
status: true
content: 'The player %PLAYER% used a whitelist command: %CONTENT%'
```

## 使用说明

请确保运行服务器的环境能够访问 ntfy.sh 推送服务。该插件依赖 ntfy.sh 发送通知；安装 ntfy 应用并订阅对应的推送主题后，即可接收服务器事件提醒。

## 扩展建议

如果你希望插件支持更多事件类型，可以向项目作者提交 Issue。
[/MD]