Package: enderchest
EnderChestA system for managing your minecraft installations across instances and
installationsIn a NutshellEnderChest is a command-line utility for selectively sharing Minecraft assets
(configurations, mods, worlds, etc.)......across different computers...across different instances on the same computer...across server and client installationsA Note On LinkingStarting with Minecraft 1.20, Mojang by defaultno 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 folderunless you placea 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 throughthis guideorwatch this explainer, and if
you still have questions, feel free toopen an issue.InstallationEnderChest is written forPython 3.10 or greater,but should otherwise
run on any architecture or operating system.Note that the recommended sync protocol isrsync, and EnderChest requiresversion 3.2 or newer.
However, other protocols are available if a modernrsyncis not an option for you.The latest release can be installed from PyPI viapipx:pipxinstallenderchestFull installation instructions can be found onGitHub Pages.UsageEnderChest is a command-line utility. With yourenderchestvirtual
environment activated, run the following command to get an overview of the
available actions:$enderchest--helpand 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 onGitHub Pages.Quick-Start GuideTo get started, navigate your terminal to the directory where you'd like to
store your EnderChest. Then run:$enderchestcraftwhich will take you through a guided setup.Once your EnderChest is set up (and you've hopefully registered a few instances),
run$enderchestcraftshulker_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:$enderchestplaceto 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:$enderchestcloseTo pull in any changes from other installations, run:$enderchestopenand then$enderchestplaceto update your symlinks.More detailed usage instructions can be found onGitHub Pages.UninstallingIf you decide that EnderChest isn't for you, running$enderchestbreakwill 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.pipxuninstallenderchestContributingIf you're interested in helping develop this project, have a look at therepo backlogand then read
through thecontributor's guide.LicenseThis project--the executable, source code and all documentation--are published
under theGNU Public License v3,
and any contributions to or derivatives of this projectmustbe licensed under
compatible terms.