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.

What's new

Latest in README.md

Full changelog

r1.2 Latest 2026-07-10 Release

Markdown engine + libraries

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

See it in action

README.md vr1.2 — the real thing, not a mockup

No demo video — run it yourself

We do not publish mockups as proof of working software. This page describes build r1.2: launch it, follow the tutorial step by step, or read the docs — every claim links to something you can execute today. Recorded walkthroughs are tracked on the roadmap.

Follow the tutorial instead

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

README.md — feature registry

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.

Quick start

Get started with README.md in minutes

Follow these steps — most installs take under five minutes.

Step 1

Install the mod for your Minecraft version (stable r1.2 across 1.21 → 1.21.11; targets through 26.2) — install it server-side too for multiplayer sync.

Step 2

Start a book with /readme new — pick from one of the 15 bundled templates or begin from scratch.

Step 3

Write Markdown in the live-preview editor and see the rendered output as you type: ==highlights==, ||spoilers||, callouts, tables, task lists and syntax-highlighted code blocks.

Step 4

Manage books from chat: /readme open <name>, /readme save, /readme search <term>.

Step 5

Organise works into a library and search them; restyle with 8 built-in themes or a custom JSON theme.

Step 6

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

Step 7

For multiplayer, install on both client and server and use /readme sync — MD5 change detection, roles and conflict resolution keep books consistent.

Full README.md tutorial Documentation Download now

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. Install on both sides for shared books.

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 in config/.

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.

How do I edit a book?

Open it in the live-preview editor (/readme open <name> or /readme new) — write Markdown in the source pane and see the rendered output live before /readme save.

What formatting is available?

Colors, ==highlight==, ||spoiler||, callouts, tables, task lists and syntax-highlighted code blocks — rendered by a hand-written lexer, parser and renderer.

How does multiplayer sync work?

/readme sync synchronises books between client and server with MD5 change detection, roles and conflict resolution — install the mod on both sides.

Where are my books stored?

In config/ JSON files (human-readable) on both client and server; libraries and search index the works so you can find any of them.

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.