Back to mods
RTFM project artwork

CurseForge · Minecraft mod

RTFM

A customizable markdown-based in-game manual.

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which RTFM release should I use?

Updated 8 years ago
Latest stable file RTFM-MC1.12-1.0.1.4.jar
Game version 1.12.1, 1.12, 1.12.2
Loader Not required

RTFM-MC1.12-1.0.1.4.jar targets 1.12.1, 1.12, 1.12.2. The project page does not say whether it belongs on the client. The project page does not say whether it belongs on the dedicated server. No extra mods listed for this file.

Where it goes

Is RTFM required on the client, server, or both?

The project page does not say whether it belongs on the client. The project page does not say whether it belongs on the dedicated server.

Client Source doesn’t say
Dedicated server Source doesn’t say
Loader for this release No loader listed
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

The source does not explicitly classify this release as client-only or server-only.

What else does RTFM-MC1.12-1.0.1.4.jar need?

RTFM-MC1.12-1.0.1.4.jar. Change the file and its required mods may change too.

No extra mods listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

This file does not list any required or optional mods.

Before you install it

Add RTFM without breaking your instance.

Built for RTFM-MC1.12-1.0.1.4.jar. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use RTFM-MC1.12-1.0.1.4.jar. It targets 1.12.1, 1.12, 1.12.2; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Put it on the correct side

    The project page does not say whether it belongs on the client. The project page does not say whether it belongs on the dedicated server.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside RTFM-MC1.12-1.0.1.4.jar. It opens that exact file at the source.

About this project

What does RTFM add?

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).

Project description from CurseForge.

Pick your setup

RTFM by Minecraft version and loader

Choose the version and loader you play, then open the matching release.

4 available setups

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

RTFM versions and loaders

7 of 7 releases match

Looking for an older file? The official CurseForge project page is in Resources.