enderchest 0.1.6

syncing and linking for all your Minecraft instances

EnderChest

A system for managing your minecraft installations across instances and installations

In a Nutshell

EnderChest is a command-line utility for selectively sharing Minecraft assets (configurations, mods, worlds, etc.)...

1. ...across different computers
2. ...across different instances on the same computer
3. ...across server and client installations

A Note On Linking

Starting with Minecraft 1.20, Mojang by default no longer allows worlds to load if they are or if they contain symbolic links. While it is true that an improper symlink could cause Minecraft to write data to a place it shouldn't, nothing in EnderChest will ever generate a symlink whose target is outside of your EnderChest folder unless you place a symbolic link in your EnderChest pointing to somewhere else (which you may want to do so that your screenshots, for example, point to your "My Pictures" folder).

If you still have concerns about symlinks or questions about how they work, read through this guide or watch this explainer, and if you still have questions, feel free to open an issue.

Installation

EnderChest is written for Python 3.10 or greater, but should otherwise run on any architecture or operating system.

Note that the recommended sync protocol is rsync, and EnderChest requires version 3.2 or newer. However, other protocols are available if a modern rsync is not an option for you.

The latest release can be installed from PyPI via pipx:

pipx install enderchest

Full installation instructions can be found on GitHub Pages.

Usage

EnderChest is a command-line utility. With your enderchest virtual environment activated, run the following command to get an overview of the available actions:

$ enderchest --help

and use:

$ enderchest <verb> --help

(e.g. enderchest place --help)

for further details on running each of those commands.

Full documentation, including tutorials, examples and full CLI docs, can be found on GitHub Pages.

Quick-Start Guide

To get started, navigate your terminal to the directory where you'd like to store your EnderChest. Then run:

$ enderchest craft

which will take you through a guided setup.

Once your EnderChest is set up (and you've hopefully registered a few instances), run

$ enderchest craft shulker_box <name>

for a guided setup of your first shulker box. Run this command again (with a different name) to create a new shulker box.

Now move whatever Minecraft assets (mods, configs, worlds) you want into that shulker box and run:

$ enderchest place

to create symlinks from your registered instance.

If you've set up your EnderChest to sync with other remote installations, you can push your local changes by running:

$ enderchest close

To pull in any changes from other installations, run:

$ enderchest open

and then

$ enderchest place

to update your symlinks.

More detailed usage instructions can be found on GitHub Pages.

Uninstalling

If you decide that EnderChest isn't for you, running

$ enderchest break

will replace all symlinks into your EnderChest folder with hard copies of the linked resources. After that completes, you can safely delete your EnderChest folder and remove the package via your Python package manager, e.g.

pipx uninstall enderchest

Contributing

If you're interested in helping develop this project, have a look at the repo backlog and then read through the contributor's guide.

License

This project--the executable, source code and all documentation--are published under the GNU Public License v3, and any contributions to or derivatives of this project must be licensed under compatible terms.