EriAPI

EriAPI

一个面向Forge 1.12.2的综合性库模组——为GUI、物品、方块、数据存储、调度器、聊天、能力、事件、键位绑定和网络提供流畅API。无需样板代码即可构建模组。

基础库

EriAPI Logo

EriAPI

适用于 Minecraft Forge 1.12.2 的一体化模组开发框架

Minecraft 1.12.2 Forge Java 8 License

文档(英文) · 文档(法文) · 问题与建议


什么是 EriAPI?

EriAPI 是一个专为 Minecraft Forge 1.12.2 打造的综合型库模组,它帮你消除样板代码,并为每一项常见的模组开发任务提供简洁、流式的 API。你不再需要与 Forge 冗长的内部机制较劲,只需编写富有表现力的单行代码,剩下的交给 EriAPI 处理。

无论你是在构建一个小型实用模组,还是一个大型整合包的核心,EriAPI 都能为你提供开箱即用的生产级工具——无需复制粘贴,无需重复造轮子。

模块

GUI 框架

一套完整的 UI 工具包,以 1920x1080 设计像素进行设计,并可自动缩放至任意屏幕分辨率。借助 30 多种即用型组件构建丰富的界面:按钮、文本输入框、滑块、复选框、单选按钮、滚动面板、标签页视图、图表、颜色选择器、上下文菜单、工具提示、Toast 通知等等。每个组件都支持动画、声音反馈以及流式 API 模式。

物品与方块构建器

使用流式构建器创建物品、方块和配方——无需手动注册类、处理事件或编写 JSON 模型。支持基础物品、食物、工具(镐、斧、剑、锹、锄)、盔甲套装,以及带自定义掉落物、方块实体和交互回调的方块。

数据与存储

使用简单的注解式 POJO 进行持久化数据存储。用 @EriData 声明一个类,用 @Sync 标记字段以实现自动客户端同步,框架便会处理 NBT 序列化、能力附加、死亡持久化、维度切换以及登录同步——所有这些都透明进行。

任务调度器

无需触碰 tick 事件即可调度延迟任务、重复任务、顺序链和异步操作。内置线程池用于非主线程工作,并提供安全回调到主线程的机制。

聊天构建器

使用流式 API 构建带颜色、样式、点击事件、悬停提示和 URL 的富文本聊天消息。包含一个分页器,用于显示带可点击导航按钮的长列表。

能力系统

让 Forge 能力变得简单。用 @EriCapability 注解一个 POJO,指定目标(玩家、实体、物品或方块实体),框架便会自动处理注册、附加、NBT 持久化、死亡复制以及客户端同步。

事件系统

用一行代码订阅任意 Forge 事件。添加过滤器、设置优先级、使其仅触发一次,或在延迟后自动过期——所有这些都无需创建专门的事件处理类。

按键绑定管理器

使用流式 API 注册键盘快捷键:简单按键、多键组合(Ctrl+Shift+X)、双击检测以及长按回调。支持上下文感知激活(仅游戏内、仅 GUI 中或始终),并具备自动冲突检测。

网络层

用于 GUI 交互的客户端-服务端通信。发送操作、同步数据以及远程打开 GUI——所有这些都通过一个带有自动数据包注册的集中式网络处理器完成。

安全框架

服务端防复制与漏洞防御工具包。以零信任验证保护任意容器 GUI 免受物品复制漏洞的影响。包含 GuiRateLimiter(按玩家操作限流)、ItemIntegrityValidator(物品数量快照/验证/回滚)、ContainerLock(同步并发访问)以及 DupeAlertManager(实时管理员警报)。专为高玩家数服务器(500-1000 名玩家)设计。

面向开发者

EriAPI 是一个库模组——它本身不会做任何事情。将它作为依赖添加到你的模组中,即可开始使用它的任意模块。所有 API 都遵循相同的流式模式,因此一旦你学会其中一个,就等于掌握了全部。

快速开始

将 EriAPI 添加到你的 build.gradle:

dependencies {
    compile files('libs/eriapi-1.0-SNAPSHOT-1.12.2.jar')
}

在你的 @Mod 注解中声明依赖:

@Mod(modid = "yourmod", dependencies = "required-after:eriapi")

就这样。每个模块都立即可用。

完整文档



EriAPI

适用于 Minecraft Forge 1.12.2 的一体化模组开发框架

文档(法文) · 文档(英文) · 问题与建议


什么是 EriAPI?

EriAPI 是一个专为 Minecraft Forge 1.12.2 打造的综合型库模组,它帮你消除重复代码,并为每一项常见的模组开发任务提供简洁、流式的 API。你不再需要与 Forge 冗长的内部机制较劲,只需编写富有表现力的单行代码,剩下的交给 EriAPI 处理。

无论你是在构建一个小型实用模组,还是一个大型整合包的核心,EriAPI 都能为你提供开箱即用的生产级工具——无需复制粘贴,无需重复造轮子。

模块

GUI 框架

一套完整的 UI 工具包,以 1920x1080 设计像素进行设计,并可自动缩放至任意分辨率。借助 30 多种即用型组件构建丰富的界面:按钮、文本输入框、滑块、复选框、单选按钮、滚动面板、标签页、图表、颜色选择器、上下文菜单、工具提示、Toast 通知等等。每个组件都支持动画、声音反馈以及流式 API 模式。

物品与方块构建器

使用流式构建器创建物品、方块和配方——无需手动注册类、处理事件或编写 JSON 模型。支持基础物品、食物、工具(镐、斧、剑、锹、锄)、完整盔甲套装,以及带自定义掉落物、方块实体和交互回调的方块。

数据与存储

通过简单的注解式 POJO 进行持久化数据存储。用 @EriData 声明一个类,用 @Sync 标记字段以实现自动客户端同步,框架便会处理 NBT 序列化、能力附加、死亡持久化、维度切换以及登录同步——所有这些都透明进行。

任务调度器

无需触碰 tick 事件即可调度延迟任务、重复任务、顺序链和异步操作。内置线程池用于非主线程工作,并提供安全回调到主线程的机制。

聊天构建器

使用流式 API 构建带颜色、样式、点击事件、悬停提示和 URL 的富文本聊天消息。包含一个分页器,用于显示带可点击导航按钮的长列表。

能力系统

让 Forge 能力变得简单。用 @EriCapability 注解一个 POJO,指定目标(玩家、实体、物品或方块实体),框架便会自动处理注册、附加、NBT 持久化、死亡复制以及客户端同步。

事件系统

用一行代码监听任意 Forge 事件。添加过滤器、设置优先级、使其仅触发一次,或在延迟后自动过期——所有这些都无需创建专门的事件处理类。

按键绑定管理器

使用流式 API 注册键盘快捷键:简单按键、多键组合(Ctrl+Shift+X)、双击检测以及长按回调。支持上下文感知激活(仅游戏内、仅 GUI 中或始终),并具备自动冲突检测。

网络层

用于 GUI 交互的客户端-服务端通信。发送操作、同步数据以及远程打开 GUI——所有这些都通过一个带有自动数据包注册的集中式网络处理器完成。

安全框架

服务端防复制与漏洞防御工具包。以零信任验证保护任意容器 GUI 免受物品复制漏洞的影响。包含 GuiRateLimiter(按玩家操作限流)、ItemIntegrityValidator(物品数量快照/验证/回滚)、ContainerLock(同步并发访问)以及 DupeAlertManager(实时管理员警报)。专为高玩家数服务器(500-1000 名玩家)设计。

面向开发者

EriAPI 是一个库模组——它本身不会做任何事情。将它作为依赖添加到你的模组中,即可开始使用它的任意模块。所有 API 都遵循相同的流式模式,因此一旦你学会其中一个,就等于掌握了全部。

快速开始

将 EriAPI 添加到你的 build.gradle:

dependencies {
    compile files('libs/eriapi-1.0-SNAPSHOT-1.12.2.jar')
}

在你的 @Mod 注解中声明依赖:

@Mod(modid = "votremod", dependencies = "required-after:eriapi")

就这样。每个模块都立即可用。

完整文档