Banira Codex (香草志)

Banira Codex

A shared library for configuration, networking, player data and interfaces across Forge, Fabric and NeoForge.

🌿 The name

“Codex” conveys recording, collecting and establishing conventions. Banira Codex brings together shared capabilities for mod development across Minecraft versions, giving dependent mods a consistent way to work with different loaders.

📖 About

Banira Codex provides common services for mods such as Sakura Sign-In, Aotake Sweep and Narcissus Farewell. These include configuration, networking, events, player data, notifications, input handling and interfaces.

For players, it provides shared configuration screens, quick actions and notifications. For developers, it offers consistent public APIs while keeping loader-specific implementations inside the library.

Each supported Minecraft version and loader has its own build. Choose the matching file and install it wherever a dependent mod requires it. The 2.0 versions of Sakura Sign-In, Aotake Sweep and Narcissus Farewell require Banira Codex 2.0.

✨ Features

• Configuration management — In-game editors, searchable settings, player preferences and configuration synchronization.
• Quick actions — Configurable menu entries, shortcuts and inventory access.
• Notifications — Message history, read status, important unread reminders and display preferences.
• Shared interfaces — Reusable forms, selectors, tooltips and HUD controls.
• Common services — Networking, events, permissions, persistent player data and shared cost handling.
• Cross-loader APIs — Consistent public interfaces for supported Forge, Fabric and NeoForge versions, with separate client-side APIs.
• Optional integrations — ApricityUI rendering, supported inventory and minimap integrations, and item NBT editing assistance.

Optional integrations depend on the Minecraft version, loader and installed dependency versions.

香草志

面向 Forge、Fabric 与 NeoForge 的跨版本基础库，提供配置、网络、玩家数据和界面等公共能力。

🌿 释义

“志”有记录、汇集与规范之意。香草志将跨版本模组开发所需的公共能力汇集起来，让子模组以稳定的方式接入不同加载器。

📖 介绍

香草志为樱花签、竹叶清、水仙辞等模组提供配置、网络、事件、玩家数据、通知、输入和界面等公共功能。

对于玩家，它提供这些模组共用的配置界面、快捷入口和通知系统；对于开发者，它提供一致的公共 API，并在内部处理不同加载器和 Minecraft 版本之间的差异。

每个受支持的 Minecraft 版本与加载器都有独立构建。请下载对应文件，并在依赖模组要求的运行端安装。樱花签、竹叶清和水仙辞 2.0 均需要 Banira Codex 2.0。

✨ 特性

• 配置管理：游戏内编辑器、配置搜索、玩家个人设置和配置同步。
• 快捷入口：可配置的菜单项、快捷键与背包入口。
• 通知系统：消息历史、已读状态、重要未读提醒和显示偏好。
• 公共界面：可复用的表单、选择器、悬浮提示和 HUD 控件。
• 基础服务：网络、事件、权限、玩家数据持久化和共享费用处理。
• 跨加载器 API：在受支持的 Forge、Fabric、NeoForge 版本中保持公共接口一致，并独立划分客户端 API。
• 可选联动：ApricityUI 渲染、部分背包与小地图联动，以及物品 NBT 编辑辅助。

可选联动的支持范围取决于 Minecraft 版本、加载器及已安装的依赖版本。