MineGIT

Cloud sync for Minecraft worlds!

Sync and back up your worlds between multiple devices! Fully integrated into the Minecraft client for a seamless experience when loading, saving, and downloading worlds from the cloud.

How does it work?

Worlds that you select are uploaded to your GitHub account as repositories. Every time you quit to the title screen, a commit of the current state of your world is created and pushed to the repository on GitHub. Whenever the world is loaded, the mod will check if any new versions of the world are available in the cloud, and if so, they will be downloaded to your device.

Since this mod uses Git internally, it also means that only the files in your world save folder that you modify will be uploaded and downloaded each time, saving storage space and internet bandwidth.

How do I set it up?

There are several steps to setting up this mod, which include creating a personal access token for GitHub, as well as choosing the worlds you would like to enable MineGIT for.

Video guide:

Creating a GitHub personal access token

In order to do the first-time setup, you will need to generate a GitHub personal access token through the following steps: 1. Create an account on GitHub if you do not have one already (https://github.com) 2. Navigate to the page to create a personal access token 3. Click `Generate new token` 4. Enter any name (such as MineGIT) under `Token name` 5. Scroll to `Expiration` and set it to `No expiration` (so that you do not have to repeat this process when the token expires) 6. Under `Repository access` choose `All repositories` 7. Under `Permissions`, click `Add permissions` and select `Administration` and `Contents` 8. Set `Access` on the `Administration` and `Contents` lines to `Read and write` 9. Press `Generate token` and copy the generated token to be pasted into Minecraft later (the generated token should start with `github_pat_` and be followed by a long string of letters and numbers)

Setting up in-game

Once the mod is installed and you are in-game, do the following steps to link your GitHub account with the mod: 1. Click on the cloud button on the bottom left corner of the world creation or world selection screen (If the button does not appear, you have already previously linked your account; see the section below entitled 'Reconfiguring account linking') 2. Enter your GitHub username and personal access token (PAT) that you created in the previous step on the new page that appears 3. Press the button labeled `Test credentials` to make sure you've entered the information properly 4. You may now exit the screen and proceed to either enable sync for a world or clone an existing one

Reconfiguring account linking

If you have already previously set up account linking and would like to change settings afterwards, you have a couple of options to get back to the configuration screen: - From the world selection screen: If you have From the world selection screen: installed, simply find the mod in the mods list and open the configuration from there - From the world selection screen: There is a button in the top right corner of the world cloning screen that will open the configuration screen - From the world selection screen: By holding alt and clicking on the world sync button on the bottom left of the world selection screen, you will be brought back into the configuration screen

Enabling sync for a world

World syncing needs to be enabled individually for each world you would like to sync to your GitHub account. To enable sync for a world, do the following: 1. Select a world on the world selection screen 2. Press the cloud button in the bottom left of the screen labeled `Enable world sync` 3. Confirm your decision on the next screen

This process will create a new repository named `minegit_[world folder name]` on your GitHub account, initialize a Git repository in your world save folder, and push its current state to GitHub. From this point forward, loading the world will pull the world's latest changes from GitHub, and exiting the world will push changes to GitHub.

You can now download this world on another device to effectively sync changes between them through the next step: cloning.

Downloading a world on a different device (Cloning)

Cloning a world will download the exact state of the world as it was last saved to GitHub. Use the following steps to clone a world: 1. Navigate to github.com in a web browser 2. Click on your profile picture in the top right corner and then `Repositories` 3. Find the repository corresponding to the world you would like to clone and copy its name 4. Back in Minecraft, click on the button with an arrow pointing downwards labelled in the bottom left corner of either the world selection screen or world creation screen 5. Paste the name of the repository you copied earlier and press `Clone` 6. You are now able to load the world like normal and have changes be synced across your devices!

Tips & Tricks

- If you want to exit a world without pushing it to GitHub (for example, if you wanted to restart Minecraft and load the same world without having to wait for changes to be pushed), you can hold `Alt` while clicking `Save and Quit to Title`. This will skip the 'pushing to GitHub' step. - Git keeps a list of all of the worlds changes every time you exit the world. This is useful, since if you have a little knowledge of how to use the Git command line interface you can rollback your world to a previous version! - If you want to save some storage space taken up by the size of the Git repository on your computer, or make the world quicker to clone on other devices, use the `Prune World Commits` button in the edit world menu. This will delete all of the old versions of your world, leaving only the most recent one.

Report an issue

If you run into bugs, crashes, or simply have a suggestion on how to improve the mod, please feel free to open an issue on the mod's issue tracker!

Please include the current Minecraft version, Fabric version, mod version, and any relevant game logs when submitting an issue.