Mineuniverse
Log in Register
Mods

RTFM

A customizable markdown-based in-game manual.
by Vexatos
Download Claim this project
36,065 downloads
0 likes
Updated Jul 6, 2026
0 hypes
Miscellaneous

RTFM is a small mod adding a customizable, data-driven manual to the game that can be populated using Markdown files. It is aimed towards modpack makers that wish to add some in-game documentation using non-arcane formatting. The mod itself doesn't do anything useful unless you use it to actually add some pages to it, in particular it does not automatically add documentation for stuff in the game. It's just a system that allows you to document stuff yourself. Using Markdown files. That's it. Really.
A rendered manual page.
Once installed and you've run Minecraft once, have a look at the config. It allows defining tabs for the manual (shown to the side of the manual GUI). These are essentially just glorified entry points to a specified page in the manual. You'll also find a default index file in the rtfm subdirectory in your config directory, explaining how to add pages and such. Spoiler: it's really simple, just throw Markdown files in there and cross-reference them using standard Markdown links.

A screenshot of the config. Because.

As a free bonus, due to the manual pages being Markdown, if you maintain them on Github or so, you automagically have a more or less perfect copy of your manual in web-browsable from (minus images of items).

RTFM-MC1.12-1.0.1.4.jar
MC 1.12.1, 1.12, 1.12.2
Release 2018-05-06 Get

More from Vexatos

Don't stub your toe!
1,627

You Might Also Like

LoadingTips
A mod that adds custom tips to the loading screen
999,218
Sampler
Performance oriented debugging/administration tools
998,926
VulkanMod
Vulkan renderer mod for Minecraft.
997,115
Charm Fixer
Disables some modules on charm to fix incompatbility issues with owo
996,251
Trading station
Basic items to item trading machines
99,755
NarrateBookForMe [FABRIC]
Adds a narration keybind, and two GUI buttons to the book screen. Text-to-speech (tts) / narration on the go! Client sided.
99,734