What is RTFM Mod
RTFM Mod is a small Minecraft mod that adds to your game a customizable, data-driven manual that can be populated using Markdown files. It aims at modpack makers that want to add some in-game documentation using non-arcane formatting. By default, the mod does nothing useful on its own 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. Simple as that.
When installed and run Minecraft once, take 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 will 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.
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).
Enjoy your new mod!
RTFM Mod Review:
RTFM Mod installing instruction:
- Download and install Minecraft Forge
- Download the mod.
- Head to %appdata%.
- Head to .minecraft/mods folder.
- Drag and put the downloaded jar (zip) file into it.
- If it does not exist, you can create one.
Credit: Vexatos, Sangar