Install README.md #
Install Fabric Loader for 1.21 (plus Fabric API if the downloads page asks for it), place the JAR in your mods folder, and launch with the Fabric profile.
- Install the mod for your Minecraft version.
- Write Markdown into a book using the editor.
- Preview the rendered output live.
- Organise works into a library and search them.
- Export to Markdown, text, JSON, or HTML, or sync with other players.
Working with README.md #
Product-specific steps, separate from the general install guide above.
Book commands
Manage your in-game books from chat:
/readme new
/readme open <name>
/readme save
/readme search <term>
/readme syncThemes & config
Both client and server read human-readable JSON configs in config/ — themes included.
Folder locations by platform #
| Platform | mods / resourcepacks folder | config folder |
|---|---|---|
| Windows | %appdata%\.minecraft\mods · \resourcepacks | %appdata%\.minecraft\config |
| macOS | ~/Library/Application Support/minecraft/mods | ~/Library/Application Support/minecraft/config |
| Linux | ~/.minecraft/mods · ~/.minecraft/resourcepacks | ~/.minecraft/config |
MultiMC / Prism users: these folders live inside Instances/<instance>/.minecraft/. Match the build to your exact Minecraft version — the compatibility table in the docs lists every supported version.
Configure #
Settings live in the config folder (JSON5 files you can edit by hand) and, where available, in the in-game settings screen the mod adds. The exact keys and keybinds are listed in the documentation and the FAQ below.
Tips for README.md #
- Keep README.md on the version range shown on its product page.
- If it doesn't load, confirm the JAR is in the right mods folder for the launcher and version you chose.
- Bedrock Edition, mobile, and console can't run Java Edition mods or packs — for a port or custom variant, request a commission.