您可以开始输入需要翻译的内容了。

您可以开始输入需要翻译的内容了。

一个交互式游戏内指南模组，具备流畅的UI渲染、Markdown解析和3D多方块预览功能。

您可以开始输入需要翻译的内容了。预览查看大图

📘 指南 —— 通用文档系统

一个轻量级、模块化且高度可定制的 Minecraft Forge 1.20.1+ 游戏内指南系统。
专为整合包作者、服务器网络或自定义模组开发者打造 —— 提供 100% 数据隔离、从磁盘直接加载媒体流，并且零虚拟资源包开销。

 

✨ 主要特性：

📚 多指南书配置自主性
  • 从磁盘直接编译：自动映射并加载本地机器上 config/guide/books/[book_id]/ 路径下的指南书。无需再将文件打包进 Mod JAR 包内。
  • 自动生成蓝图：首次启动时，模组会将一份完整且可直接构建的指南书模板提取到你的配置文件夹中，从而保护自定义资源在整合包更新时不被覆盖。
  • 简洁的书籍选择器：拥有一个完全响应式的书籍目录视口，并支持活动过滤，可以清晰地呈现隔离的书籍命名空间，没有任何 Mod ID 冲突。
⚙️ 热重载与开发者友好管道
  • 运行时布局切换（/guide reload）：编辑磁盘上的 Markdown 文件、布局节点、纹理或 JSON 本地化表格后，立即在游戏中重新填充指南书内存。默认对所有玩家可用，无需 OP 或作弊权限。
  • 快捷聊天导航（/guide）：一个专用的聊天命令，可以随时将用户直接引导至主书籍目录视口，无需依赖物品。
  • 开发者模式切换：通过 config/guide/guide-client.toml 隐藏面向玩家的说明手册或蓝图，同时保持其对开发者可用。
🧭 高级导航与搜索光标
  • 全面改进的搜索框：配备了一个清晰的垂直光标（|），能够完美地在英文和西里尔键盘布局上执行移动序列和文本选择操作。
  • 智能侧边栏子菜单：无缝地将下拉子章节（@submenu:）和剧透内容隐藏在点击之后，优化渲染帧率并防止布局裁剪。
  • 坚不可摧的追踪与历史记录：导航记忆功能会锁定侧边栏子菜单的展开状态，并且文本超链接的点击区域能够在任何动态滚动条偏移下，在数学上完美地追踪文本行。
🧩 高级内容渲染
  • 自然文本缩进支持：Markdown 引擎完全尊重文本序列开头的空格和制表符块，允许构建结构化的嵌套列表而不会导致超链接区域不同步。
  • 直接媒体流式加载：直接从本地书籍目录渲染静态图像（@image:）和动画 GIF（@gif:），彻底消除了棋盘格占位纹理的错误。
  • 合并的多方块 NBT 投影：3D 全息投影仪（PlacementProjector）和页面渲染器（StructureRenderer）直接从配置文件夹编译 .nbt 蓝图。创作者可以将多方块结构原生地捆绑到他们的指南中，而无需外部数据包。
🔗 模组与任务集成
  • 实时服务器同步复选框：拥有一个客户端到服务器的交互式任务系统。任务完成状态与玩家 UUID 绑定，并安全地保存在服务器端 NBT 结构中，防止进度文件因本地数据清除而丢失。
  • JEI 导航就绪：使用 @bind:mod_id:item 将章节绑定到特定物品条目，即可在 JEI 内部直接触发匹配的指南页面，或者点击指南物品传送门以立即调出活跃的配方表。

🛠️ 指南书目录架构：

📁 config/guide/books/[book_id]/
┣ 📂 chapters/                 # 内容章节目录
┃  ┣ 📄 index.md               # 内置的主索引（英文）
┃  ┣ 📄 introduction.md        # 内置的第一章（英文）
┃  ┗ 📂 your_language/         # 语言特定文件文件夹
┃     ┣ 📄 index.md            # 主目录索引
┃     ┗ 📄 introduction.md     # 你的第一份指南书章节
┣ 📂 lang/                     # 本地化文件
┃  ┣ 📄 en_us.json             # 标题和布局索引的本地化表格
┃  ┗ 📄 your_language.json     # 自定义语言文件
┣ 📂 models/                   # 本地指南书3D模型数据
┣ 📂 sounds/                   # 背景音频资源
┃  ┗ 🎵 your_sound.ogg         # 背景音乐或环境音 .ogg 文件
┣ 📂 textures/                 # 用户界面和图像资源
┃  ┗ 🖼️ item/your_logo.png     # 本地图片和动画 .gif 存储位置
┣ 📂 structures/               # 结构示意数据
┃  ┗ 🏗️ your_structure.nbt     # 多方块 .nbt 蓝图文件
┗ 📄 book.json                 # 元数据配置（标题、目录图标、命名空间）

⚙️ 示例 book.json 配置结构：

{
  "name": "[book_id].book.guide",
  "namespace": "[book_id]",
  "default_chapter": "introduction",
  "icon": "your_logo.png",
  "bg_music": "background_music (without.ogg)",
  "dev_only": false
}

📦 需求：

  • Minecraft 1.20.1
  • Forge 47.x+
  • Java 17+

💬 反馈与支持：

→ GitHub Issues
→ CurseForge Comments

📜 许可协议：

MIT 许可协议 —— 可在任何整合包环境中自由使用、修改和分发。感谢标注原作者，但非强制要求。