AnnouncementCompensation 插件文档

GitHub 仓库
v1.0.0 Paper 1.19.2 JDK 17+ Zh-CN CC BY-SA 4.0
https://github.com/yumi-furry/AnnouncementCompensation

插件简介

AnnouncementCompensation 是一款适配 Paper 1.19.2 服务器的公告与补偿管理插件，支持通过Web管理面板发布公告、配置玩家补偿（物品/道具）、记录发放记录，同时实现玩家上线自动推送公告、点击道具领取补偿等核心功能，轻量化设计且兼容主流服务器环境。

核心特性

公告管理

Web面板发布/编辑/删除公告、登录自动推送、优先级置顶

补偿发放

自定义物品补偿、道具/指令领取、领取记录持久化

Web面板

Undertow轻量部署、BCrypt登录认证、可视化配置

数据管理

自动备份、日志记录、数据恢复

环境要求

依赖项 版本要求 说明
服务器核心 Paper 1.19.2-307+ 不兼容Spigot/CraftBukkit
JDK 17+ 编译与运行环境均需
额外依赖 无 插件内置所有业务依赖
网络环境 本地访问 无需公网IP即可使用面板

安装步骤

  1. 从GitHub仓库下载插件Jar包：
    Releases 页面 下载 AnnouncementCompensation-1.0.0.jar
  2. 将Jar包放入服务器 plugins 目录
  3. 启动/重启Paper服务器，插件会自动生成配置文件与数据目录
  4. （可选）配置Web面板端口（默认8080），修改 config.yml 后重启服务器

配置说明

核心配置文件（plugins/AnnouncementCompensation/config.yml）

# Web管理面板配置
web:
  port: 8080                  # 访问端口
  login:
    username: admin           # 管理员账号（默认）
    password: $2a$10$xxxxxx  # BCrypt加密密码（默认：admin123）
# 公告配置
announcement:
  enable: true                # 是否启用公告推送
  delay: 3                    # 玩家登录后延迟N秒推送公告
# 补偿配置
compensation:
  item:
    material: PAPER           # 补偿领取道具材质（默认纸张）
    name: "§6公告补偿领取券"   # 道具名称（支持颜色代码）
    lore:                     # 道具描述
      - "§7点击领取服务器公告补偿"
      - "§7领取后自动绑定账号"

插件基础配置（plugin.yml）

name: AnnouncementCompensation
main: com.server.AnnouncementCompensationPlugin
version: 1.0.0
api-version: 1.19
description: 公告与补偿管理插件，支持Web面板配置
author: yumi-furry
website: https://github.com/yumi-furry/AnnouncementCompensation
permissions:
  announcementcompensation.admin:
    description: 管理员权限（访问Web面板、配置公告/补偿）
    default: op

常用指令

指令 权限要求 说明
/announcement show 所有玩家 展示最新公告
/compensation claim 所有玩家 领取未领取的补偿
/announcementcompensation reload 管理员（op） 重载插件配置（无需重启服务器）

常见问题（FAQ）

Q1：启动服务器后，插件未加载？
Q2：Web面板无法访问？
Q3：玩家领取补偿后未获得物品？

开源协议

本项目采用 CC BY-SA 4.0 署名-相同方式共享 4.0 国际版 开源协议，核心规则如下：

允许的行为

  • 自由修改、二次开发本插件的代码和功能
  • 自由分发、商用/非商用部署本插件
  • 基于本插件创作衍生作品

强制要求（违反即侵权）

  1. 署名标注：任何修改/二次开发/分发行为，必须在衍生作品的显著位置标注原作者信息（yumi-furry）、原始项目地址（https://github.com/yumi-furry/AnnouncementCompensation）
  2. 原文标注：必须保留本插件原始文档的链接（https://github.com/yumi-furry/AnnouncementCompensation/blob/main/README.md），且标注“基于AnnouncementCompensation插件二次开发”
  3. 协议共享：二次开发的衍生作品必须采用与本项目相同的 CC BY-SA 4.0 协议开源，不得改用其他协议

协议详情

注意事项