mch

mch-cli | mch-viewer

A "version control system" for Minecraft worlds.

---

Can be used to back up worlds in a storage efficient way and keep a history of worlds.

Install (Unix: macOS/Linux)

mch is distributed as a single runnable jar plus a small mch launcher script. The default install is user-local (no sudo):

• ~/.local/share/mch/versions/<version>/mch-cli-all.jar
• ~/.local/share/mch/current -> versions/<version>
• ~/.local/bin/mch

Install latest

curl -fsSL https://raw.githubusercontent.com/bkaw/mch/main/scripts/install.sh | bash

PATH setup

If mch isn’t found after install, add this to your shell config (~/.bashrc, ~/.zshrc, ...):

export PATH="$HOME/.local/bin:$PATH"

Upgrade

Re-run the installer. It installs the jar into a versioned directory and updates the current link.

Uninstall

rm -f ~/.local/bin/mch
rm -rf ~/.local/share/mch

Java is required to run mch. If you don’t have java installed, install a JRE/JDK first.

How?

When a new commit (a backup / snapshot of the world) is made, mch will only re-save the parts of the world that changed. Everything that didn't change is not saved. This saves a ton of storage space and time!

Usage Overview

For detailed usage instructions, see the mch-cli README.

Mch is a command line interface (CLI) that works a bit like Git.

An mch repository holds the internal files mch needs to store the world. A Minecraft world is then added to the repository. By running mch commit the current snapshot of the world will be saved to the repository as a commit.

You can list commits with mch log and restore to previous commits using mch restore <commit hash> which will restore the world to a folder called mch-restore.

Since restoring an entire world can take a while when the world is big, mch-viewer can be used to view commits in-game without having to restore the entire commit.

Sounds cool?

Check out mch-cli for more details, or contact me on discord @alvinn8 if you have questions or want to chat!