Markdown Manual

Markdown Manual

用于创建游戏内手册的库模组。

Markdown Manual预览查看大图

MarkdownManual 是一个库模组，允许通过以 Markdown 文档定义的内容在游戏中显示手册。它旨在供模组开发者使用，以便他们能够以简单的方式为模组提供游戏内文档。该模组提供了一个简单的默认手册外观，但可以轻松重新样式化，或者完全嵌入到现有 UI 中。此模组本身不添加任何面向玩家的内容。

关于如何使用此库的示例，请参阅 TIS-3D，它使用此库作为其游戏内手册。有关代码中的必要设置，请参阅 Manuals 类。有关手册内容定义，请参阅 doc 目录。简而言之：向手册注册表注册一个新手册，为新手册注册内容，然后注册一个物品以使玩家能够获得该手册。内容文档是 Markdown 文档，可以包含指向其他内容文档的链接。图像和方块/物品可以使用 Markdown 风格的图像引用来嵌入（例如 ![Tooltip](block:minecraft:furnace)）。

以下是一些示例屏幕截图，展示了默认手册 UI 样式的灵活性。相同的内容以三种不同的皮肤显示：

默认 UI。

自定义 UI。

自定义暗色 UI。