Markdown Manual

Description

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:

What means Verified?

• Compatibility: The mod should be compatible with the latest version of Minecraft and be clearly labeled with its supported versions.
• Functionality: The mod should work as advertised and not cause any game-breaking bugs or crashes.
• Security: The mod should not contain any malicious code or attempts to steal personal information.
• Performance: The mod should not cause a significant decrease in the game's performance, such as by causing lag or reducing frame rates.
• Originality: The mod should be original and not a copy of someone else's work.
• Up-to-date: The mod should be regularly updated to fix bugs, improve performance, and maintain compatibility with the latest version of Minecraft.
• Support: The mod should have an active developer who provides support and troubleshooting assistance to users.
• License: The mod should be released under a clear and open source license that allows others to use, modify, and redistribute the code.
• Documentation: The mod should come with clear and detailed documentation on how to install and use it.

How to Install