Stable Creation Tools vr1.2

README.md

A complete overhaul of Minecraft's book system into a documentation platform.

Download View all features Documentation Roadmap

Stable · Released and maintained — r1.2 for 1.21–1.21.11 (targets through 26.2). Live-preview Markdown editor, libraries, themes, templates, and multiplayer sync.

Why it exists

Purpose

Written books in Minecraft are text dumps. README.md transforms them into a powerful, interactive documentation tool — Markdown rendering, theming, libraries, search, and export — for documentation, education, storytelling, and developer content.

Who it's for

Map makers, educators, server staff, storytellers, and developers who want rich in-game documentation.

Key capabilities

Markdown-powered books

A hand-written parser and renderer for Markdown in books.

Libraries & search

Index, organise, and search your written works.

Multiplayer sync

Share and synchronise books across players.

Export & themes

Export to Markdown, text, JSON, or HTML with custom themes.

Features

Everything README.md does

10 features across 5 categories — all real, all working.

Book Overhaul 2 features

Markdown engine

A hand-written lexer, parser, and renderer turns written books into rich documents.

Backwards compatible

Existing books remain readable and upgradeable.

Interactive Elements 3 features

Rich formatting

Colors, ==highlight==, ||spoiler||, callouts, tables, task lists, and syntax-highlighted code blocks.

Live-preview editor

Write Markdown in the editor and preview the rendered output live.

Theming

8 built-in themes plus custom JSON themes.

Documentation Platform 3 features

Libraries & search

Index, organise, and search your written works.

Export & backup

Export to Markdown, text, JSON, or HTML, plus ZIP backups and batch conversion.

Templates

15 templates ship with the mod for common documentation layouts.

Multiplayer Sync 1 feature

Client + server sync

Share and synchronise books with MD5 change detection, roles, and conflict resolution.

Extensible 1 feature

Public API

A public API, EventBus, and provider system let other mods extend README.md.

Getting Started

How to use README.md

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.

View the full README.md tutorial →

Compatibility

Versions & loaders

Property	Value
Loader / platform	Fabric
Latest version	r1.2
Minecraft versions	1.21, 1.21.1, 1.21.2, 1.21.3, 1.21.4, 1.21.5, 1.21.6, 1.21.7, 1.21.8, 1.21.9, 1.21.10, 1.21.11

Stable across the 1.21.x series.

Version history

Changelog

r1.2

2026-07-10 Release Latest

Markdown engine + libraries

Live-preview Markdown editor
Libraries, search, themes, export
Multiplayer sync

Roadmap

Where it's going

Markdown engine

done

Lexer, parser, and renderer.

Authoring tools

Editor, undo/redo, and autosave.

Knowledge base

later

Deep library and search features.

FAQ

Questions, answered

Can I read normal books?

Yes — existing books remain readable and upgradeable.

Is it client or server side?

Both — multiplayer sync with MD5 change detection, roles and conflict resolution.

What Markdown does it support?

Rich formatting, colors, ==highlight==, ||spoiler||, callouts, tables, task lists and syntax-highlighted code blocks.

Can I theme my books?

Yes — 8 built-in themes plus custom JSON themes.

What can I import/export?

Markdown, text, JSON and HTML, plus ZIP backups and batch conversion.

Can other mods extend it?

Yes — it ships a public API, EventBus and provider system, plus 15 templates.

Compatibility & limitations

What to know

Compatibility. Stable across the 1.21.x series.

Status. Released and maintained — r1.2 for 1.21–1.21.11 (targets through 26.2). Live-preview Markdown editor, libraries, themes, templates, and multiplayer sync.

Downloads

Get README.md

r1.2 for 1.21.x.

Fabric mod JAR View Tutorial

Ecosystem

Part of something bigger

Every Hero Studios product is engineered to work with the rest of the ecosystem — one design language, one performance bar, one long-term vision. README.md belongs alongside these tools.