MarkdownManual is a library mod enabling in-game manuals with content defined in Markdown documents. It is intended to be used by mod developers to provide in-game documentation of their mods in a simple manner. The mod provides a simple default manual look, but can be re-styled easily, or completely embedded into existing UI. This mod adds no player-facing content on its own.

For an example of how to use this library, see TIS-3D, which uses this for its in-game manual. For the required setup in code, please see the Manuals class. For content definition of the manual, please see the doc directory. But the short of it is: register a new manual with the manuals registry, register content for the new manual, register an item to make the manual available to players. Content documents are Markdown documents that may have links to other content documents. Images and blocks/items can be embedded using Markdown style image references (for example ![Tooltip](block:minecraft:furnace)).

Here are some example screenshots, demonstrating how flexible the styling of the default manual UI is. Same content three times with different skins:

Default UI.

Custom UI.

Custom dark UI.

OC2R: Valkyrien Skies

Compatibility

Minecraft: Java Edition

Platforms

Supported environments

Links

Creators

Details