EriAPI
Minecraft Forge 1.12.2 的一体化模组开发框架
Documentation (EN) · Documentation (FR) · Issues & Ideas
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 的一体化模组开发框架
Documentation (FR) · Documentation (EN) · Issues & Ideas
EriAPI 是什么?
EriAPI 是一个面向 Minecraft Forge 1.12.2 的综合库模组,旨在消除冗余代码,并为常见的模组开发任务提供简洁、流畅的 API。你无需再与 Forge 冗杂的内部实现打交道,只需编写表达性强的单行代码,EriAPI 即可处理其余部分。
无论你是正在构建一个简单的实用工具模组,还是一个庞大的整合包核心,EriAPI 都能开箱即用地为你提供生产级工具——无需复制粘贴,无需重复造轮子。
模块
GUI 框架
一套完整的 UI 工具包,采用 1920x1080 像素设计,并支持自动缩放至任意分辨率。使用超过 30 种开箱即用的组件构建丰富的界面:按钮、文本字段、滑块、复选框、单选按钮、可滚动面板、标签页、图表、颜色选择器、上下文菜单、工具提示、Toast 通知等。每个组件均支持动画、音效反馈以及流畅 API 模式。
Item & Block Builder(物品与方块构建器)
使用流畅的构建器创建物品、方块和配方——无需手动注册类、管理事件或编写 JSON 模型。支持基础物品、食物、工具(镐、斧、剑、铲、锄)、全套盔甲,以及带有自定义掉落物、方块实体和交互回调的方块。
Data & Storage(数据与存储)
通过简单的注解 POJO 实现持久化数据存储。只需声明一个带有 @EriData 注解的类,并使用 @Sync 标记字段以实现客户端自动同步,框架便会透明地处理 NBT 序列化、Capability 附加、死亡后数据保留、维度切换以及登录时的同步——一切尽在不言中。
Task Scheduler(任务调度器)
安排延迟任务、重复任务、顺序链和异步操作,而无需触碰 Tick 事件。内置线程池用于在主线程之外执行工作,并提供安全回调至主线程的支持。
Chat Builder(聊天构建器)
通过流畅 API 构建包含颜色、样式、点击事件、悬停工具提示和 URL 的丰富聊天消息。内置分页器,可通过可点击的导航按钮显示长列表。
Systeme de Capabilities(能力系统)
简化的 Forge Capability 系统。用 @EriCapability 注解一个 POJO,指定目标类型(玩家、实体、物品或方块实体),框架会自动处理注册、附加、NBT 持久化、死亡时复制以及客户端同步。
Systeme d'Events(事件系统)
仅需一行代码即可监听任何 Forge 事件。添加过滤器、定义优先级、设置仅触发一次或超时自动过期——所有这些功能均无需创建专用的 Handler 类。
Keybinding Manager(按键绑定管理器)
使用流畅 API 注册键盘快捷键:支持单键、多键组合(Ctrl+Shift+X)、双击检测以及长按回调。支持上下文激活(仅限游戏中、仅限 GUI 中或始终启用),并具备自动冲突检测功能。
Couche Reseau(网络层)
用于 GUI 交互的客户端-服务器通信。发送动作、同步数据和远程打开 GUI——所有这些都通过中央网络管理器完成,并自动注册数据包。
Framework de Securite(安全框架)
服务端防刷取和防止漏洞利用的工具包。通过零信任验证保护任何容器 GUI 免受物品 duplication 漏洞的影响。包括 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")
至此完成。每个模块立即可用。
完整文档
EriAPI
The all-in-one modding framework for Minecraft Forge 1.12.2
Documentation (EN) · Documentation (FR) · Issues & Ideas
What is EriAPI?
EriAPI is a comprehensive library mod for Minecraft Forge 1.12.2 that eliminates boilerplate code and provides a clean, fluent API for every common modding task. Instead of wrestling with Forge's verbose internals, you write expressive one-liners and let EriAPI handle the rest.
Whether you're building a simple utility mod or a massive modpack core, EriAPI gives you production-ready tools out of the box — no copy-pasting, no reinventing the wheel.
Modules
GUI Framework
A complete UI toolkit designed in 1920x1080 design pixels with automatic scaling to any screen resolution. Build rich interfaces with 30+ ready-to-use components: buttons, text fields, sliders, checkboxes, radio buttons, scroll panels, tab views, charts, color pickers, context menus, tooltips, toast notifications, and more. Every component supports animations, sound feedback, and the fluent API pattern.
Item & Block Builder
Create items, blocks, and recipes with a fluent builder — no need to manually register classes, handle events, or write JSON models. Supports base items, food, tools (pickaxe, axe, sword, shovel, hoe), armor sets, and blocks with custom drops, tile entities, and interaction callbacks.
Data & Storage
Persistent data storage using simple annotated POJOs. Declare a class with @EriData, mark fields with @Sync for automatic client synchronization, and the framework handles NBT serialization, capability attachment, death persistence, dimension changes, and login sync — all transparently.
Task Scheduler
Schedule delayed tasks, repeating tasks, sequential chains, and async operations without touching tick events. Built-in thread pool for off-thread work with safe callbacks to the main thread.
Chat Builder
Build rich chat messages with colors, styles, click events, hover tooltips, and URLs using a fluent API. Includes a paginator for displaying long lists with clickable navigation buttons.
Capability System
Forge capabilities made simple. Annotate a POJO with @EriCapability, specify the target (player, entity, item, or tile entity), and the framework handles registration, attachment, NBT persistence, death copy, and client synchronization automatically.
Event System
Subscribe to any Forge event in a single line. Add filters, set priority, make it fire once, or auto-expire after a delay — all without creating dedicated event handler classes.
Keybinding Manager
Register keyboard shortcuts with a fluent API: simple keys, multi-key combos (Ctrl+Shift+X), double-tap detection, and hold callbacks. Context-aware activation (in-game only, GUI only, or always) with automatic conflict detection.
Network Layer
Client-server communication for GUI interactions. Send actions, sync data, and open GUIs remotely — all through a centralized network handler with automatic packet registration.
Security Framework
Server-side anti-duplication and exploit prevention toolkit. Protect any container GUI from item duplication exploits with zero-trust validation. Includes GuiRateLimiter (per-player action throttling), ItemIntegrityValidator (snapshot/validate/rollback item counts), ContainerLock (synchronized concurrent access), and DupeAlertManager (real-time admin alerts). Designed for high-player-count servers (500-1000 players).
For Developers
EriAPI is a library mod — it does nothing on its own. Add it as a dependency to your mod and start using any of its modules. All APIs follow the same fluent pattern, so once you learn one, you know them all.
Quick Start
Add EriAPI to your build.gradle:
dependencies {
compile files('libs/eriapi-1.0-SNAPSHOT-1.12.2.jar')
}
Declare the dependency in your @Mod annotation:
@Mod(modid = "yourmod", dependencies = "required-after:eriapi")
That's it. Every module is immediately available.
Full Documentation
EriAPI
Le framework tout-en-un pour le modding Minecraft Forge 1.12.2
Documentation (FR) · Documentation (EN) · Issues & Ideas
Qu'est-ce qu'EriAPI ?
EriAPI est un mod librairie complet pour Minecraft Forge 1.12.2 qui supprime le code repetitif et fournit une API fluent et propre pour chaque tache courante du modding. Au lieu de se battre avec les internals verbeux de Forge, vous ecrivez des one-liners expressifs et EriAPI gere le reste.
Que vous construisiez un petit mod utilitaire ou le coeur d'un modpack massif, EriAPI vous donne des outils prets pour la production — sans copier-coller, sans reinventer la roue.
Modules
GUI Framework
Un toolkit UI complet concu en 1920x1080 pixels de design avec mise a l'echelle automatique vers n'importe quelle resolution. Construisez des interfaces riches avec plus de 30 composants prets a l'emploi : boutons, champs texte, sliders, checkboxes, boutons radio, panneaux scrollables, onglets, graphiques, selecteur de couleur, menus contextuels, tooltips, notifications toast, et bien plus. Chaque composant supporte les animations, le feedback sonore et le pattern fluent API.
Item & Block Builder
Creez des items, blocks et recettes avec un builder fluent — pas besoin d'enregistrer manuellement des classes, de gerer des events ou d'ecrire des JSON models. Supporte les items de base, la nourriture, les outils (pioche, hache, epee, pelle, houe), les armures completes, et les blocks avec drops custom, tile entities et callbacks d'interaction.
Data & Storage
Stockage de donnees persistantes via de simples POJOs annotes. Declarez une classe avec @EriData, marquez les champs avec @Sync pour la synchronisation client automatique, et le framework gere la serialisation NBT, l'attachment de capability, la persistence a la mort, les changements de dimension et la sync au login — le tout de maniere transparente.
Task Scheduler
Planifiez des taches differees, repetitives, des chaines sequentielles et des operations asynchrones sans toucher aux tick events. Thread pool integre pour le travail hors du thread principal avec callbacks securises vers le main thread.
Chat Builder
Construisez des messages chat riches avec couleurs, styles, events au clic, tooltips au survol et URLs via une API fluent. Inclut un paginateur pour afficher de longues listes avec des boutons de navigation cliquables.
Systeme de Capabilities
Les capabilities Forge simplifiees. Annotez un POJO avec @EriCapability, specifiez la cible (joueur, entite, item ou tile entity), et le framework gere l'enregistrement, l'attachment, la persistence NBT, la copie a la mort et la synchronisation client automatiquement.
Systeme d'Events
Ecoutez n'importe quel event Forge en une seule ligne. Ajoutez des filtres, definissez la priorite, faites-le se declencher une seule fois ou expirez-le automatiquement apres un delai — le tout sans creer de classes handler dediees.
Keybinding Manager
Enregistrez des raccourcis clavier avec une API fluent : touches simples, combos multi-touches (Ctrl+Shift+X), detection de double-tap et callbacks de maintien. Activation contextuelle (en jeu uniquement, dans un GUI uniquement, ou toujours) avec detection automatique des conflits.
Couche Reseau
Communication client-serveur pour les interactions GUI. Envoyez des actions, synchronisez des donnees et ouvrez des GUIs a distance — le tout via un gestionnaire reseau centralise avec enregistrement automatique des packets.
Framework de Securite
Toolkit anti-duplication et prevention d'exploits cote serveur. Protegez n'importe quel GUI conteneur contre les exploits de duplication d'items avec une validation zero-trust. Inclut GuiRateLimiter (limitation d'actions par joueur), ItemIntegrityValidator (snapshot/validation/rollback du nombre d'items), ContainerLock (acces concurrent synchronise), et DupeAlertManager (alertes admin en temps reel). Concu pour les serveurs a forte affluence (500-1000 joueurs).
Pour les Developpeurs
EriAPI est un mod librairie — il ne fait rien tout seul. Ajoutez-le comme dependance a votre mod et commencez a utiliser n'importe lequel de ses modules. Toutes les APIs suivent le meme pattern fluent, donc une fois que vous en maitrisez une, vous les connaissez toutes.
Demarrage Rapide
Ajoutez EriAPI a votre build.gradle :
dependencies {
compile files('libs/eriapi-1.0-SNAPSHOT-1.12.2.jar')
}
Declarez la dependance dans votre annotation @Mod :
@Mod(modid = "votremod", dependencies = "required-after:eriapi")
C'est tout. Chaque module est immediatement disponible.
Documentation Complete
评论 0
登录后参与评分
还没有评论,来抢沙发吧