Mod

RTFM

Quick rating

RTFM

No reviews yet

A customizable markdown-based in-game manual.

Mod Loaders
Forge
Minecraft

Community voices

Reviews

Versions
Loading versions…
Match includes

Click once to include, again to exclude, again to clear

Rating Any
Any 0.5 1.0 1.5 2.0 2.5 3.0 3.5 4.0 4.5 5.0
Min
Max
Play Status
Reviews
Time Played
hrs+
Verified developers only
Has developer response
List view
Grid view
Compact view
Sort by
Date
Rating
Helpful
Unhelpful
Edited
Sort ascending
Delete this review?

This removes your review from the project. You can write a new review after.

Review submitted for moderation

Your review has been sent to moderators, who will check that it meets our guidelines before it appears publicly.

No reviews yet. Be the first to review this project!

Get it on

Available Platforms

About

Project Details

Type
Mod
Latest Version
RTFM-MC1.12-1.0.1.4.jar
Authors

For authors

Embed Badge

If you're the author of this project, you can embed a live badge anywhere that supports HTML or Markdown. It updates automatically whenever ratings change.

Custom banner text
ModDex rating badge preview

Use HTML for any page that supports it, or Markdown for README files and Markdown-based descriptions.

Identifiers

Platform IDs

CurseForge ID

Resources

External Links

Source Issues Wiki Discord

About

Description

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

Screenshots

Gallery

  • Config
    Config A screenshot of the config. To make the description look less boring.
  • Manual page
    Manual page A testing manual page, containing formatted text and an image.

Versions

Files

Relations

Project Relations

More like this

Similar Mods

Suggestions use data such as tags, dependencies, dependents, descriptions, titles, and more to rank how much they overlap with this mod.

On ModDex

Community snapshot

0
Ratings
0
Followers
0
In stacks

By the numbers

Statistics

~36,000
Downloads
Last Updated
Created
Last synced
When ModDex last fetched and imported data for this project from CurseForge or Modrinth. High-traffic and active projects are checked more often.
Next pipeline sync