Skip to content

AntynK/McBackupper

Repository files navigation

Mc Backupper

Note

Цей документ має переклад українською.

A tool for making backups of Minecraft worlds from saves and versions folders.

Installation

Compatibility

The program was developed and tested only on Windows 10. Other operating systems are supported (the Flet framework is cross-platform), but they have never been tested.

Important

As mentioned in docs, Linux users have to install Zenity.

Download .exe file

Download the archive McBackupper.windows.64.bit.zip, unpack it, and run the mcbackupper.exe file.

Important

Antiviruses could mark this file as potentially malicious. You can try the second method.

Download source code

Download the Source code(zip) and unpack it.

The program was written in Python 3.12.4 (versions from 3.10 should also work) and the flet framework. It is better to download it from requirements.txt using the command:

For Windows:

pip install -r requirements.txt

For Linux and macOS:

pip3 install -r requirements.txt

Then run the main.py file using the command (or by double-clicking):

For Windows:

python main.py

For Linux and macOS:

python3 main.py

Basic

Creation

All data that you have entered during creation is stored separately from the backup file.
To change backup data, press and hold the left mouse button.

Note

Clicking the backup name will open it in the file explorer.

Backup data

File name - the backup file name, by default, is the world name. The creation date and .zip extension will be added after creation.

Note

This cannot be changed after creation.

Title - backup title, optional field.
Pool ignore - when checked, the backup is not included in the pool.

Backup pool

The pool (queue) automatically removes outdated backups. By default, the pool is set to 4. This means if you have 4 backups (with the Pool ignore flag unchecked) and create a new backup, the oldest one will be deleted.

Note

The program determines the oldest backup by the date that the user has entered.

Restoring and deleting

When restoring, the world folder will be permanently deleted and replaced with the folder from the backup.

Important

The program will immediately restore the world without pop-up windows.

When deleting, the backup file will be removed.

Important

The program will immediately delete the backup without pop-up windows.

Backup structure

All backups from the saves folder are saved at <backups>/saves/<WorldName>/backups. From the versions folder at <backups>/versions/<VersionName>/saves/<WorldName>/backups.

<backups> - the folder where all backups are saved (can be changed in settings). <VersionName> - version name.
<WorldName> - world name.
backups - folder where world backups are saved.

Note

Names are taken from folder names, so they may be different from what you see in the game.

Tip

To get the name of the world folder, in the select world menu, you can look below the world name, or you can open it when editing the world.

Features

The program can automatically determine the backup creation date (if it is formatted like YEAR-MONTH-DAY_HOUR-MINUTE-SECOND), so you can transfer backups created with Minecraft.

Note

Backups that have been transferred in this way will be included in the pool.

Localizers

GNU gettext is used for localisation. To add a new language, you need to create a subfolder with the language code, and inside create another folder LC_MESSAGES (example assets/locale/pl/LC_MESSAGES). Then copy template files (with .pot extension):

msginit -i assets/locale/controls.pot -o assets/locale/<language code>/LC_MESSAGES/controls.po

msginit -i assets/locale/dialogs.pot -o assets/locale/<language code>/LC_MESSAGES/dialogs.po

If .po files exist, already update them:

msgmerge --update assets/locale/<language code>/LC_MESSAGES/controls.po assets/locale/controls.pot

msgmerge --update assets/locale/<language code>/LC_MESSAGES/dialogs.po  assets/locale/dialogs.pot

To compile translations run compile.py script using the command (or by double-clicking):

For Windows:

python assets/locale/compile.py

For Linux and macOS:

python3 assets/locale/compile.py

After filling in the template, you can create a pull request.

Contributors

If you have ideas for improvement or want to contribute to the development of the project, please submit your contribution. See CONTRIBUTING.md.

About

This program is designed for easy and convenient creation of Minecraft world backups.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages