mirror of
https://github.com/vipul-sharma20/mine-palace.git
synced 2026-06-28 08:13:03 +00:00
A tool that turns your Obsidian (or any markdown) vault into a walkable Minecraft memory palace.
https://minepalace.vipul.xyz/
- Python 82%
- HTML 10.7%
- CSS 6.8%
- Dockerfile 0.5%
| assets | ||
| src/mine_palace | ||
| tests | ||
| .dockerignore | ||
| .gitignore | ||
| Dockerfile | ||
| index.html | ||
| PLAN.md | ||
| pyproject.toml | ||
| README.md | ||
| styles.css | ||
Mine Palace
Mine Palace turns an Obsidian-style markdown vault into a walkable Minecraft memory palace.
Full world view plus split detail views from the current Minecraft build.
This implementation is intentionally hackathon-shaped:
- no external Python dependencies
- deterministic sample vault for demos
- world planning based on folders and notes
- output as
mcfunctionfiles, plain command lists, and a visual HTML preview - optional live application over RCON
What it builds
- a central hub
- one district per top-level folder
- note alcoves laid out inside each district
- paths from the hub to each district
- signs, shelves, lecterns, and barrels for each note
- optional experimental book placement commands
Quick Start
Generate a demo world from the bundled sample vault:
cd /Users/vipul/projects/mine-palace
PYTHONPATH=src python3 -m mine_palace.cli demo --output build/demo
Build from a real vault:
cd /Users/vipul/projects/mine-palace
PYTHONPATH=src python3 -m mine_palace.cli plan \
--vault /Users/vipul/tools/noto \
--output build/noto \
--limit 60
If you want to bias the build toward specific folders:
PYTHONPATH=src python3 -m mine_palace.cli plan \
--vault /Users/vipul/tools/noto \
--output build/curated \
--include Engineering Incidents LLM Meetings Projects Self
Apply the generated structure commands to a running Minecraft server over RCON:
export MC_RCON_PASSWORD='...'
PYTHONPATH=src python3 -m mine_palace.cli apply-rcon \
--commands build/demo/commands/clear.txt \
--host 127.0.0.1 \
--port 25575
PYTHONPATH=src python3 -m mine_palace.cli apply-rcon \
--commands build/demo/commands/build.txt \
--host 127.0.0.1 \
--port 25575
Or deploy an entire generated artifact directory in one step:
export MC_RCON_PASSWORD='...'
PYTHONPATH=src python3 -m mine_palace.cli deploy-rcon \
--artifacts build/demo \
--host 127.0.0.1 \
--port 25575
If written-book commands do not match your server version, add --skip-books.
Output Structure
Running plan or demo generates:
manifest.json: structured world plancommands/clear.txt: clear-and-reset commands for quick rebuildscommands/build.txt: plain commands, safe for RCON replaycommands/books.txt: experimental written-book commandsmcfunction/clear.mcfunction: clear function filemcfunction/build.mcfunction: structure build filemcfunction/books.mcfunction: optional book placement functionpreview/index.html: visual preview of the world layout
Demo Flow
- Run
demoto generate a sample vault and world artifacts. - Open
preview/index.htmlto inspect the plan. - Apply
commands/build.txtover RCON to your test server. - Record a flythrough from hub to district to note alcove.
Notes
- The structure build is the reliable path.
- Written-book placement is generated separately because command syntax can vary between server versions.
- For large vaults, the CLI uses balanced round-robin sampling so one folder does not dominate the demo.