GuideME

GuideME

一个为模组和模组包制作者设计的指南工具包，支持舒适的Markdown格式化，并包含实时3D场景！

GuideME

本项目为您的模组或整合包指南手册提供基础框架。基于驱动应用能源2指南手册的技术，它允许您用简单的Markdown编写指南，同时直接从结构文件中嵌入3D场景。

对玩家而言，基于GuideME的指南手册提供：

  • 丝滑的滚动体验
  • 内容居中突出，配备支持文本重排和内联元素的高级文本排版引擎
  • 带有注释的交互式3D场景，直观展示模组中的概念
  • 主题间的交叉链接和链接工具提示中的快速信息
  • 在指南手册中以“JEI风格”展示内联合成配方
  • 提供“按住G键”功能，可在任意物品提示中快速跳转到相关指南手册页面

对模组作者而言，它提供丰富的可扩展API，允许您：

  • 为Markdown添加自定义内联或块级标签，由自定义Widget系统支持
  • 扩展合成配方渲染，在指南中显示您的自定义配方
  • 使用自定义Markdown前言，轻松为指南手册页面添加任意信息
  • 使用自定义索引，基于自定义属性快速查找页面
  • 允许资源包或附属模组向您的指南添加自己的内容

文档

面向内容作者和模组作者的文档可在我们的网站guideme.appliedenergistics.org找到，您也可以直接通过AE2 Discord联系我们。

示例

以下是来自AE2指南手册的示例页面（源码）。

---
navigation:
  parent: ae2-mechanics/ae2-mechanics-index.md
  title: 频道
  icon: 控制器
---

# 频道

应用能源2的[ME网络](me-network-connections.md)需要频道来支持使用网络存储或其他网络服务的[设备](../ae2-mechanics/devices.md)。可以把频道想象成连接到所有设备的USB线缆。一台计算机只有有限的USB端口，只能支持有限数量的设备连接。大多数机器、完整方块设备和标准线缆最多只能传输8个频道。您可以将完整方块设备和标准线缆视为一束8根“频道线”。然而，[致密线缆](../items-blocks-machines/cables.md#dense-cable)最多可以支持32个频道。其他能够传输32个频道的设备只有<ItemLink id="me_p2p_tunnel" />和[量子网络桥](../items-blocks-machines/quantum_bridge.md)。每次设备使用一个频道时，想象从线束中拔出一根USB“线”，这显然意味着那根“线”在后续线路中不可用。

<GameScene zoom="7" interactive={true}>
  <ImportStructure src="../assets/assemblies/channel_demonstration_1.snbt" />
</GameScene>

示例