Baikiruto API 概述
Baikiruto 是一个开源的跨版本物品库系统,基于 MIT 协议发布。提供完整的物品管理 API。
当前脚本子系统默认内置 fluxon,并且已经开放了 BaikirutoScriptType 注册接口,允许你把脚本执行器按“类型注册表”方式接入。
获取 API 实例
通过 Baikiruto.api() 获取 BaikirutoAPI 实例:
import org.tabooproject.baikiruto.core.BaikirutoAPI
val api: BaikirutoAPI = Baikiruto.api()
依赖配置
Gradle (Kotlin DSL)
repositories {
maven("https://repo.aeoliancloud.com/repository/releases")
}
dependencies {
compileOnly("org.tabooproject.baikiruto:Baikiruto:1.6.1:api")
compileOnly("org.tabooproject.baikiruto:Baikiruto:1.6.1:sources")
}
Maven
<repository>
<id>tabooproject</id>
<url>https://repo.aeoliancloud.com/repository/releases</url>
</repository>
<dependency>
<groupId>org.tabooproject.baikiruto</groupId>
<artifactId>Baikiruto</artifactId>
<version>1.6.1</version>
<classifier>api</classifier>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.tabooproject.baikiruto</groupId>
<artifactId>Baikiruto</artifactId>
<version>1.6.1</version>
<classifier>sources</classifier>
<scope>provided</scope>
</dependency>
plugin.yml
depend: [Baikiruto]
开源信息
- 协议:MIT
- 仓库:GitHub
API 模块一览
| 模块 | 说明 | 文档 |
|---|---|---|
| 物品 API | 物品构建、读取、注册、ID 查询 | Item API |
| 注册表 | Registry 接口与内置注册表 | Registry |
| 事件系统 | ItemEventBus 与生命周期/动作事件 | Events |
| 子系统 | 脚本类型注册、管理器、序列化、更新器等 | Subsystems |
如果你只是执行默认 Fluxon 脚本,可以继续直接传 String;如果你要接入新的脚本引擎或读取配置里的 typed source,请重点看 BaikirutoScriptSource、BaikirutoScriptType 和 getScriptTypeRegistry()。
包结构
org.tabooproject.baikiruto.core
├── Baikiruto // API 入口(object)
├── BaikirutoAPI // 核心 API 接口
├── BaikirutoScriptHandler // 脚本处理器接口
├── BaikirutoScriptSource // 带类型的脚本源
├── BaikirutoScriptType // 可注册的脚本类型接口
├── ScriptCacheStats // 脚本缓存统计
└── item
├── Item // 物品定义
├── ItemStream // 物品数据流
├── ItemHandler // 物品读取器
├── ItemManager // 物品管理器
├── ItemLoader // 物品加载器
├── ItemSerializer // 物品序列化器
├── ItemUpdater // 物品版本更新器
├── Registry<T> // 通用注册表接口
├── MetaFactory // 元数据工厂接口
├── ItemModel // 物品模型
├── ItemDisplay // 物品显示
├── ItemGroup // 物品分组
├── SerializedItem // 序列化物品
└── event
├── ItemEventBus // 事件总线
└── ... // 生命周期 + 动作事件