AdventureLib
一、简介
AdventureLib —— Adventure 系列插件的公共基础框架库，提供命令构建、配置管理、数据库访问、GUI 框架、经济挂钩、消息工具、安全工具等 86 个核心类，被 AdventurePass、AdventureShop 等多个插件依赖。
功能模块
| 模块 | 类数 | 说明 |
|---|---|---|
command/ | 2 | 命令构建器、子命令抽象 |
config/ | 3 | 配置助手、迁移器、语言助手 |
database/ | 4 | 数据库管理器、表构建器、条件查询 |
gui/ | 11 | GUI 构建器、分页、动画、会话管理 |
hook/ | 5 | Vault / PAPI / PlayerPoints 集成 |
i18n/ | 1 | 多语言消息系统 |
item/ | 6 | 物品构建器、序列化、头颅工具 |
message/ | 5 | ActionBar / BossBar / 粒子 / 富文本 |
security/ | 3 | 防刷工具、输入过滤、限流器 |
util/ | 40+ | 通用工具集（详见工具集页面） |
action/ | 2 | 动作注册与执行 |
event/ | 1 | 自定义事件基类 |
pdc/ | 1 | PersistentDataContainer 助手 |
二、依赖此库的插件
- AdventurePass — 冒险通行证
- AdventureShop — 随机商店
- 其他使用 AdventureLib 工具类的系列插件
下一篇安装说明 →
安装说明
环境要求
| 项目 | 要求 |
|---|---|
| 服务端 | Spigot / Paper 1.20+ |
| Java | 17+ |
安装
- 放入
AdventureLib-3.0.0.jar到 plugins 目录 - 确保在依赖它的插件之前加载
- AdventureLib 自身无需配置，作为纯依赖库运行
ℹ️ 注意
AdventureLib 是一个前置库插件，不提供独立的游戏功能，仅为其他 Adventure 系列插件提供公共 API。
上一篇← 概览
下一篇核心模块 →
核心模块
命令框架
- CommandBuilder — 流式 API 构建插件命令
- SubCommand — 子命令抽象基类，自动补全和权限检查
配置框架
- ConfigHelper — 配置文件加载/保存/默认值
- ConfigMigrator — 版本间配置自动迁移
- LangHelper — 多语言文件管理
数据库框架
- DatabaseManager — SQLite/MySQL 双引擎，自动建表
- TableBuilder — 流式 DDL 构建器
- Compare / UpdateCondition — 条件查询构建
经济挂钩
- VaultHook — Vault 经济接口
- PlayerPointsHook — PlayerPoints 点券接口
- PapiHook / PapiExpansionBuilder — PAPI 变量注册
上一篇← 安装说明
下一篇GUI 框架 →
GUI 框架
GUI 构建器
| 类 | 说明 |
|---|---|
GuiBuilder | 流式 API 创建 GUI |
GuiManager | GUI 生命周期管理 |
GuiSession | 玩家 GUI 会话状态 |
GuiPagination | 分页逻辑 |
PaginatedChestGui | 带翻页的箱子 GUI |
GuiAnimator | GUI 动画效果 |
GuiConfigUtil | 从 YAML 配置加载 GUI 布局 |
GuiClick / GuiClose | 点击/关闭事件回调 |
ConfirmDialog | 确认对话框 |
ChatInputHandler | 聊天输入捕获 |
SoundConfig | GUI 音效配置 |
上一篇← 核心模块
下一篇工具集 →
工具集
物品工具
- ItemBuilder — 物品构建器 (Material, name, lore, enchant, flags, PDC)
- ItemSerializer / InventorySerializer — 物品/背包序列化
- SkullUtil — 自定义头颅创建
- ArmorUtil — 护甲检测工具
消息工具
- MessageUtil — 彩色消息、MiniMessage 支持
- ActionBarProgress — ActionBar 进度条
- BossBarUtil — BossBar 显示
- RichMessage — 富文本消息构建
- ParticleBuilder — 粒子效果构建器
通用工具 (40+ 类)
| 工具类 | 说明 |
|---|---|
SchedulerUtil | 调度器 (Folia 兼容) |
FoliaUtil | Folia 平台检测 |
CooldownManager | 冷却时间管理 |
FormulaUtil | 数学公式解析 |
ProbabilityUtil | 概率/权重随机 |
WeightedRandom | 带权重的随机选择器 |
RateLimiter | 请求限流 |
AntiDupeUtil | 防刷物品检测 |
InputSanitizer | 输入过滤 |
TeleportUtil | 安全传送 |
HologramUtil | 全息文字工具 |
NametagUtil | 名牌管理 |
RideController | 骑乘控制 |
EntityAIUtil | 实体 AI 控制 |
DataAutoSave | 数据自动保存 |
UpdateChecker | 版本更新检查 |
上一篇← GUI 框架