Minecraft x markdown vaults

Make your notes into a world you can walk through.

Mine Palace turns a markdown vault into a Minecraft memory palace. In vault mode, top-level folders become districts. In diary mode, dated notes become years, months, and day alcoves. Notes become shelves, lecterns, signs, and readable books you can open inside Minecraft.

Build your world See the flow GitHub

World view

See a generated note world as an actual place.

These screenshots show one generated world style from Mine Palace. The current planner supports both folder-based vault layouts and diary layouts built from dated markdown notes.

Wide overview of the Mine Palace world with connected rooms around a central hub — Full world view

Aerial view of Mine Palace library rooms connected around a central hub in Minecraft — Complete library view

Bookshelf detail inside a Mine Palace district room — Bookshelf detail

Single note view inside Mine Palace — Note detail

Input

Markdown vault or diary

Bring a markdown vault from tools like Obsidian. Use default vault mode for folder-based districts, or diary mode for dated notes like YYYY-MM-DD.md.

Shape

Readable world

Vault mode creates districts from folders. Diary mode creates year/month/day layouts from journal entries. In both cases, note content is available as books inside Minecraft.

Deploy

Minecraft server

Inspect the preview first, then replay generated commands over RCON or use the function files however you like.

How it works

Three simple steps.

Pick a vault and layout

Use the bundled sample vault for a demo, point the planner at a general markdown vault, or use diary mode for dated journal notes.

Generate artifacts

The CLI writes a manifest, build commands, book commands, and a visual HTML preview.

Inspect, then deploy

Open the preview, confirm the layout, then apply the generated commands to a running Minecraft server.

Quickstart

Commands people can actually follow.

1. Try the demo world

PYTHONPATH=src python3 -m mine_palace.cli demo --output build/demo

This creates a sample vault plus the world plan, commands, and preview in build/demo.

2. Build from your own vault

PYTHONPATH=src python3 -m mine_palace.cli plan \
  --vault /path/to/your/vault \
  --output build/my-world

Use --include if you want to bias the build toward specific folders instead of your whole vault.

3. Build a diary world

PYTHONPATH=src python3 -m mine_palace.cli plan \
  --layout diary \
  --vault /path/to/your/diary \
  --output build/my-diary-world

Diary mode expects dated markdown files named like YYYY-MM-DD.md.

4. Open the preview

open build/my-world/preview/index.html

The preview is the sanity check. It shows the hub, districts, note count, and overall world layout before you touch Minecraft.

5. Deploy to a server over RCON

export MC_RCON_PASSWORD='...'
PYTHONPATH=src python3 -m mine_palace.cli deploy-rcon \
  --artifacts build/my-world \
  --host 127.0.0.1 \
  --port 25575

If written-book commands do not match your server version, use --skip-books in the deployment flow.

What you need

Enough to get from notes to blocks.

Before you start

Python 3.11+
A markdown vault or dated diary folder
A Minecraft Java world or server
RCON enabled if you want one-command deployment

What gets generated

manifest.json for the planned layout
commands/clear.txt for rebuild-safe clearing
commands/build.txt for replayable commands
commands/books.txt for readable note books
mcfunction/build.mcfunction for function-based use
preview/index.html for visual inspection