Project Essentials Backup

God bless your server. Oh! i wanted to say: this mod makes backups of your world according to certain settings.

Lightweight additional module for Essentials. Just make server and client world backup by time or via command.

How to Install

For start the modification, you need installed Forge, it is desirable that the version matches the supported versions. You can download Forge 1.14.4 from the link and Forge 1.15.2 from it link. Move the downloaded mod to the mods folder (installation example below).

val MV = valueOf(your_minecraft_version)

.
├── assets
├── config
├── libraries
├── mods (that's how it should be)
│   ├── Project Essentials Core-MOD-1.MV.X-1.X.X.jar (mandatory)
│   └── Project Essentials Backup-1.MV.X-1.X.X.jar
└── ...

Dependencies

Also do not forget to install dependencies, only two types of dependencies: mandatory (game will not start without a mod) and recommended (without a mod, game can start, but I recommend using it).

Download dependencies: Core

Last step

Now try to start the game, go to the mods tab, if this modification is displayed in the mods tab, then the mod has been successfully installed.

Configuration

Configuration location

.minecraft/config/ProjectEssentials/backup.json

Default configuration

{
    "backupEnabled": true,
    "firstLaunchDelay": true,
    "backupCreationDelay": 120000,
    "backupCompressionLevel": 3,
    "backupDirectoryPath": "backup",
    "backupDateFormat": "yyyy-MM-dd_HH.mm.ss",
    "maxBackupFiles": 10,
    "rollingBackupFilesEnabled": true,
    "removeExtraFiles": true
}

Configuration documentation

Property

Type

Description

backupEnabled

Boolean

If value false then backup loop will be stopped.

firstLaunchDelay

Boolean

If value true then backup not will be making at server start. (i.e if value true then: server start -> delay -> backup -> delay, if value false then: server start -> backup -> delay)

backupCreationDelay

Long

Delay between backup in milliseconds.

backupCompressionLevel

Int

Compression level for zip file. Allowed range is 1 - 9 (1 - low compression, 9 - high compression).

backupDirectoryPath

String

Path to backup directory.

backupDateFormat

String

Date format for backup archive.

maxBackupFiles

Int

Maximum backup files in backup directory.

rollingBackupFilesEnabled

Boolean

New backup file is created periodically, and the old backup file is renamed by appending a date to the name. Each time a new backup file is started, the numbers in the file names of old backup files are increased by one, so the files "rotate" through the dates. Old backup files whose number exceeds a threshold can then will be deleted to save space.

removeExtraFiles

Boolean

If value true then extra files will be deleted from backup directory, i.e random files, not backup files.

If you have any questions or encounter a problem, be sure to open an issue

Last updated

Was this helpful?