Markdown Manual

MarkdownManual is a library mod that enables creating in-game manuals with content defined in Markdown documents. It is designed for mod developers to easily provide documentation for their modifications directly within the game. The mod offers a simple default manual appearance, but it can be easily restyled or fully integrated into an existing interface. This mod does not add any player-facing content on its own.

To see an example of using this library, look at TIS-3D, which uses it for its in-game manual. For the necessary code setup, refer to the Manuals class. For defining the manual's content, check out the doc directory. In short: register a new manual in the manuals registry, add content for the new manual, register an item to make the manual available to players. Content documents are Markdown documents that can contain links to other documents. Images and blocks/items can be embedded using Markdown-style image references (e.g., ).

Here are some example screenshots demonstrating how flexibly the default manual interface's style can be customized. The same content three times with different themes: