Word of warning: Do NOT change anything in the backup folder. Only copy out of the folder and change there. If you make changes to the folder structure, if WILL mess up the AutoRemove system.
The configuration file for this module can be found in /ForgeEssentials/Backup/config.cfg
The configuration file is well documented.
Example of default config file after beta #219 or official build #252
You can use the command to make manual backups of worlds or folders. And you can use the AutoBackup & AutoRemove functions, explained in the config, to set up a fully automated backup system. More on that later.
| Command Usage | Aliases | Permission Node | Description |
|---|---|---|---|
| /backup | ForgeEssentials.backup.command | Makes a backup of all loaded worlds. | |
| /backup <dimensionID> | ForgeEssentials.backup.command | Makes a backup of a specific world. | |
| /backup <folder> | ForgeEssentials.backup.command | Makes a backup a folder relative to the server's jar file. | |
Some properties explained:
"worldSaving": If you change this to true you will allow all worlds to save. If this remains false, the worlds will only save at the set intervals. This will reduce the HDD lag but if your server crashes, you will lose all changes made after the last save.
"whitelist": If you add any dimensions to this list, it will assume they will need backups. Even though they might not be loaded. Still, if "backupOnWorldUnload" is false, it will not save unloaded worlds!
"blacklist": If you add any dimensions to this list, it will never automatically make backups of that dimension. Manual backups don't check this list.
"extraFolders": If you add folders to this list, it will make backups of those folders every time the world is backed up. You can use this to save the config folder or extra data saved by mods.
This is explained in the config. Use this to regulate the amount of backups made.