DearU

插件

· 作者 bindglam

一个用于邮箱的纸质插件

0 本站下载 0 关注 更新于 8 个月前

最新 1.0.0 · 1.21.11 · Folia / Paper

一键开服(送7天)

? DearU

适用于 Paper/Folia 服务器的现代化邮箱插件

✨ 功能特性

  • ? 邮箱系统 - 玩家可通过美观的图形界面接收和管理邮件
  • ? 包裹支持 - 向玩家发送单个物品或多物品包裹
  • ? 数据库抽象层 - 内置对 SQLite 和 MySQL 的支持
  • ⚡ 异步操作 - 使用 CompletableFuture 实现非阻塞邮件操作
  • ? 现代 API - 为插件开发者提供简洁的 Java 接口
  • ?️ 命令别名 - 可自定义的命令别名

? 项目结构

DearU/
├── api/                    # 包含公共接口的 Java 模块
│   └── DearU              # 主插件接口
│   ├── Mailbox            # 异步邮箱操作
│   ├── Mail               # 邮件类型的密封接口
│   │   ├── SingleMail     # 单件物品邮件
│   │   └── PackageMail    # 多物品包裹
│   ├── MailSender         # 邮件发送者表示
│   └── MailboxManager     # 邮箱实例管理器
│
└── core/                   # 包含实现的 Kotlin 模块
    └── DearUPlugin        # 主插件类
    ├── DearUConfiguration # 配置系统
    ├── DatabaseManager    # 数据库抽象层
    ├── MailboxManagerImpl # 邮箱实现
    └── MailboxGui         # GUI 实现

? 快速开始

环境要求

  • Java 21 或更高版本
  • Paper/Folia 服务器(最新版本)

安装步骤

  1. 构建插件:

    ./gradlew build
    
  2. 在 core/build/libs/ 目录下找到 JAR 文件

  3. 将其放入服务器的 plugins/ 文件夹中

  4. 重启服务器

配置说明

编辑 plugins/DearU/config.yml 以进行自定义设置:

# 数据库设置 (SQLite/MySQL)
database:
  sql:
    type: SQLITE  # 或 MYSQL
    mysql:
      host: localhost
      port: 3306
      database: dearu
      username: root
      password: password

# 命令别名
commands:
  mailbox:
    aliases:
      - mail
      - 우편함

? 开发指南

构建命令

# 构建项目
./gradlew build

# 运行测试服务器 (Paper)
./gradlew runServer

# 运行 Folia 测试服务器
./gradlew runFolia

# 清理构建产物
./gradlew clean

API 使用示例

发送邮件

import com.bindglam.dearu.DearU;
import com.bindglam.dearu.mail.*;

// 获取插件实例
DearU dearU = DearUProvider.get();

// 发送单件物品邮件
Mail singleMail = Mail.single(
    MailSender.server(),
    itemStack,
    "欢迎加入我们的服务器!"
);
dearu.mailboxManager().getMailbox(playerUUID)
    .putMail(singleMail);

// 发送包裹邮件
PackageMail.Body body = PackageMail.bodyBuilder()
    .name("欢迎礼包")
    .content(itemStack1)
    .content(itemStack2)
    .build();

Mail packageMail = Mail.packaged(
    MailSender.player(senderUUID),
    body,
    "这是您的初始装备包!"
);
dearu.mailboxManager().getMailbox(playerUUID)
    .putMail(packageMail);

读取邮件

import com.bindglam.dearu.Mailbox;
import java.util.concurrent.CompletableFuture;

Mailbox mailbox = dearU.mailboxManager().getMailbox(playerUUID);

// 获取所有邮件(异步)
CompletableFuture<List<Mailbox.IdentifiedMail>> future = mailbox.mails();
future.thenAccept(mails -> {
    for (Mailbox.IdentifiedMail identified : mails) {
        Mail mail = identified.mail();
        // 处理邮件...
    }
});

// 根据 ID 获取特定邮件
CompletableFuture<Mailbox.IdentifiedMail> mailFuture = mailbox.mail(mailId);
mailFuture.thenAccept(identified -> {
    if (identified != null) {
        Mail mail = identified.mail();
        // 处理邮件...
    }
});

?️ 架构设计

管理器模式

所有管理器均实现 Managerial 接口:

interface Managerial {
    fun start(context: Context)
    fun end(context: Context)
}

管理器在插件生命周期中进行初始化:

val managers = listOf(DatabaseManager, MailboxManagerImpl)
managers.forEach { it.start(Context(this, dearUConfig)) }

数据库抽象层

使用 DatabaseLib 统一 SQL 操作:

  • SQLite - 默认选项,使用插件数据文件夹中的 database.db
  • MySQL - 可配置用于生产环境

配置系统

基于嵌套类的配置系统,使用 ConfigLib:

class Commands {
    val mailbox = createExtendedComplexField { CommandField("mailbox") }
}

? 依赖项

运行时依赖

  • ConfigLib (1.0.0) - 配置系统
  • DatabaseLib (1.0.4) - 数据库抽象层
  • semver4j (6.0.0) - 版本比较

构建依赖

  • Shadow Plugin - JAR 阴影处理与重定位
  • RunPaper - 测试服务器管理

? 开源协议

本项目采用 MIT 许可证授权 - 详情请参阅 LICENSE 文件。

? 贡献指南

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

? 技术支持

  • ? 通过 GitHub Issues 报告 Bug
  • ? 欢迎提交功能请求
  • ? 查看代码文档以获取更多详细信息

用 ❤️ 为 Minecraft 社区打造

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源