GBLib

📘 GBLib — Fabric 模组的指南书库

GBLib 是一个轻量级、数据驱动的指南书框架，适用于 Minecraft 1.20.2 的 Fabric 模组。
它提供了一个简洁的 API，用于创建游戏内文档、教程、手册、典籍和模组指南 —— 全部无需编写一行 GUI 代码。

无论你是在构建一个小型实用模组还是一个完整的内容扩展，GBLib 都能为你提供一个精致、可定制的书籍系统，无缝融入 Minecraft 的 UI 风格。

---

✨ 特性

📚 数据驱动指南书

使用简单的 JSON 文件定义整本书：

• 标题、作者和元数据
• 带有自动换行的页面
• 分类和文档条目
• 可通过资源包完全重载

无需 Java 样板代码。

🖼️ 可定制 GUI

GBLib 包含一个灵活的指南书屏幕：

• 支持自定义纹理
• 9‑切片渲染，确保边角清晰
• 可调整大小（默认 185×144）
• 前景渲染（无背景溢出）
• 清晰的文本换行和布局

放入你自己的纹理，库会处理其余部分。

🧩 轻松集成

一行代码注册指南书物品：

GuidebookItem.setBookId(stack, new Identifier("modid", "my_book"))

在任何地方打开书籍：

GuidebookClientAPI.open(book)

🔄 热重载支持

指南书会在资源重载时自动重载，使开发过程中的迭代快速且无痛。

---

📁 JSON 结构示例

{
  "title": "示例指南书",
  "author": "GBLib",
  "pages": [
    { "type": "text", "content": "欢迎使用你的新指南书！" }
  ]
}

将指南书文件放置在： assets/<命名空间>/gamedata/guidebooks/<ID>.json

---

🛠️ 面向模组开发者

GBLib 设计为：

• 轻量级 —— 最小开销
• 模块化 —— 只用你需要的部分
• 可扩展 —— 添加自定义页面类型、渲染器或 UI 元素
• 稳定 —— 在重载和会话间行为一致

适用于：

• 科技模组
• 魔法模组
• 冒险模组
• 教程和入门引导
• 游戏内文档

---

📦 安装

在 fabric.mod.json 中将 GBLib 添加为依赖项：

"depends": {
  "fabricloader": ">=0.14.0",
  "minecraft": "1.20.2",
  "gblib": "*"
}

然后像其他库模组一样包含它。

---

❤️ 为何使用 GBLib？

因为自己编写指南书系统很繁琐。
GBLib 为你提供：

• 精致的 UI
• 简洁的 API
• 数据驱动的工作流程
• 一个“开箱即用”的系统

专注于你的模组内容 —— 让 GBLib 处理文档部分。

---

📜 许可证

GBLib 是开源的，可免费用于任何 Fabric 模组。
欢迎贡献、功能请求和 Pull Requests。

---

🚀 开始构建更好的指南书

GBLib 让创建美观、实用的游戏内文档变得简单。
如果你的模组需要一本指南书，GBLib 是添加它的最简单、最简洁的方式。