Markdown Manual

What Markdown Manual Does

Markdown Manual is a library mod that gives you a simple way to create in-game manuals. The manuals are written in plain Markdown files that live in your mod’s assets. When a player opens a manual item, the mod reads the Markdown, turns it into a readable screen, and shows it in the game.

Who It Helps

If you're building a mod that needs to explain new items, blocks, or mechanics, Markdown Manual lets you ship that information without writing custom UI code. It works on both NeoForge and Fabric, so you can use it in most mod packs that target Minecraft 1.21.1 or 1.21.11.

Core Features

• Markdown support - Headers, bold, italics, code blocks, lists, and links are rendered. The mod also understands a small set of custom protocols for images, blocks, and items.
• Easy registration - Create a Manual instance, register it, and add a DocumentProvider that points to a folder in your assets. The mod handles the rest.
• Custom items - Subclass the provided AbstractManualItem to give the manual a physical item that players can hold and open.
• Extensible UI - The default screen can be styled with ManualStyle and ManualScreenStyle implementations, or you can replace the screen entirely if you need a different look.

Compatibility

Markdown Manual requires both client and server sides to be present. It supports NeoForge and Fabric loaders. The mod is compatible with Minecraft 1.21.1 and 1.21.11 only. No other versions are listed in the mod’s metadata.

Licensing

The mod is released under the MIT license. All assets are public domain unless otherwise noted, so you can include it in any mod pack without restrictions.

Getting Started

To use Markdown Manual in your own mod, add it as a dependency in your build script and follow the API documentation. The README on GitHub contains code snippets that show how to register a manual, add a document provider, and create a manual item.

Why Use It

If you want a lightweight, well-documented way to ship manuals, Markdown Manual gives you a proven library that handles the heavy lifting. Look, it frees you from writing custom rendering code and lets you focus on the content of your mod.

Where to Find It

The mod’s source and documentation are hosted on GitHub. The Modrinth page lists the supported loaders and Minecraft versions, and the GitHub repository contains the full API and examples.