EasyBackup is a robust and lightweight Spigot plugin designed to automate backups for your server’s most essential directories. Whether you're managing a small survival world or a large multiplayer network, EasyBackup keeps your data safe with minimal downtime. All backups are stored in /plugins/EasyBackup/backups, ensuring easy access whenever you need them.
Easily set backups to run on a daily, weekly, or monthly schedule tailored to your needs.

Efficient Backup Retention
Automatically purge the oldest backups once your set limit is reached, optimizing storage.

Real-Time Progress Tracking
Monitor backup progress with a clear visual progress bar and percentage updates.

Smart File Exclusion
Automatically exclude critical or temporary files to ensure reliable, conflict-free backups.

Robust Permissions Control
Securely restrict backup commands to authorized users only, ensuring enhanced server protection.

Detailed Debug Logging
Enable comprehensive logging for performance insights and troubleshooting.

Seamless Update Checker
Stay current with notifications when new plugin versions are available.

Commands

/eb start
Manually trigger the backup process.

/eb status
Check the current backup status and progress.

Folder Management
/eb folder add <folder_path>
Register a folder for backup.

/eb folder remove <folder_path>
Unregister a folder from backup.

/eb folder list [page]
Display a paginated list of registered folders.

/eb backups list [page]
List available backup files with pagination.

/eb help [page|keyword]
Show general or detailed help for commands.

Permissions

To use EasyBackup’s features, ensure you grant the following permission nodes as needed:

easybackup.use
Base permission to use EasyBackup commands.
(Default: op)

easybackup.start
Permission to manually trigger backups.
(Default: op)

easybackup.status
Permission to check the current backup status.
(Default: op)

easybackup.folder.add
Permission to register a folder for backup.
(Default: op)

easybackup.folder.remove
Permission to unregister a folder from backup.
(Default: op)

easybackup.folder.list
Permission to list all registered backup folders.
(Default: op)

easybackup.backups.list
Permission to list available backup files.
(Default: op)

easybackup.notify
Permission to receive in-game backup notifications.
(Default: op)

easybackup.notify.update
Permission to receive update notifications.
(Default: op)

Installation Instructions

Download the Plugin:
Get the latest EasyBackup.jar from this resource page or your preferred distribution channel.

Install:
Place the EasyBackup.jar file into your server’s plugins/ directory.

Start Your Server:
Restart your Minecraft server so that the plugin generates its default configuration files.

Configure:
Edit plugins/EasyBackup/config.yml to customize settings such as backup folders, scheduling frequency, retention limits, and message templates.

Enjoy Peace of Mind:
With EasyBackup in place, your server is now protected by automated, reliable backup routines.

Frequently Asked Questions (FAQ)

Q: What happens if a backup is already running?
A: EasyBackup will notify you via the console and in-game if you try to trigger a backup while one is in progress.

Q: Can I receive notifications on backup events?
A: Yes, players with the easybackup.notify permission will receive in-game messages when backups start, complete, or fail.

Q: How do I update the list of backup folders?
A: Use /eb folder add <folder_path> to add and /eb folder remove <folder_path> to remove folders. Changes take effect immediately for new backups.

Q: Is there a way to monitor backup progress?
A: The /eb status command displays a visual progress bar along with the current backup percentage.

Configuration Example

Below is an example of the config.yml:

Code (YAML):

##############################################################################
#                                                                            #
#     ______                    ____                _                         #
#    |  ____|                  |  _ \              | |                        #
#    | |__    __ _  ___  _   _ | |_) |  __ _   ___ | | __ _   _  _ __         #
#    |  __|  / _` |/ __|| | | ||  _ <  / _` | / __|| |/ /| | | || '_ \        #
#    | |____| (_| |\__ \| |_| || |_) || (_| || (__ |   < | |_| || |_) |       #
#    |______|\__,_||___/ \__, ||____/  \__,_| \___||_|\_\ \__,_|| .__/        #
#                      __/ |                                 | |             #
#                     |___/                                  |_|             #
#                                                                            #
#                   EasyBackup Configuration File                            #
##############################################################################

#########################################
# Update Checker Settings
#########################################
update-checker:
  enabled : true           # Set to false to disable update checking.

#########################################
# Backup Options
#########################################
# Specify the folders to backup (relative to your server's root directory).
backup-options:
  folders :
   - world
    - plugins

#########################################
# Automatic Backup Settings
#########################################
# Configure the automatic backup schedule.
# Options:
#   enabled: true/false - Enable or disable automatic backups.
#   frequency: "daily", "weekly", or "monthly".
#   time: Time in HH:mm (24-hour format) when backups run.
auto-backup:
  enabled : true
  frequency : daily   # Options: daily, weekly, monthly.
  time : "22:00"     # Example: "04:00" for 4 AM.

#########################################
# Backup Retention Settings
#########################################
# Manage old backup files.
# Options:
#   enabled: true/false - Enable or disable automatic deletion.
#   max: Maximum number of backup files to retain.
backup-retention:
  enabled : true
  max : 5

#########################################
# Debug Settings
#########################################
# Enable or disable debug logging for troubleshooting.
debug:
  enabled : true

#########################################
# Message Templates
#########################################
# Customize all user-facing messages.
#
# Available Variables:
#   %time%     - Next scheduled backup time.
#   %progress% - Current backup progress percentage.
#   %folder%   - Folder name (used in dynamic messages).
#   %page%     - Current page number.
#   %total%    - Total number of pages.
#
# Color codes can be used with '&' (e.g. "&a" is light green).
messages:
  prefix : '&7 [&bEasyBackup&7 ] '

  # Backup process messages
  backup-started : '&aThe backup process is now starting ...'
  backup-completed : '&aBackup completed successfully!'
  backup-failed : '&cBackup failed! Please check the console for details.'
  status-idle : '&aNo backup is running. Next backup scheduled at &e %time%&a.'
  status-running : '&aA backup is in progress : &e%progress%%&a completed.'

  # Notification messages for players
  notify-auto-backup-started : '&aAutomatic backup has started.'
  notify-manual-backup-started : '&aManual backup has started.'
  notify-backup-completed : '&aBackup completed successfully!'
  notify-backup-error : '&cBackup encountered an error. Please check the console.'

  # No-permission message
  no-permission : '&cSorry, you do not have permission to use this command.'

  # Folder command messages
  folder-not-exist : '&cThe specified folder does not exist or is not a directory.'
  folder-already-registered : '&eThat folder is already registered for backup.'
  folder-registered : '&aFolder registered for backup : &f%folder%'
  folder-unregistered : '&aFolder unregistered for backup : &f%folder%'
  changes-take-effect : '&aChanges will take effect on the next scheduled backup.'
  folder-not-registered : '&eThat folder is not registered for backup.'

  # Backup process error message
  backup-already-in-progress : '&cA backup is already in progress.'

  # Paging messages
  page-number-must-be-at-least-1 : '&cPage number must be at least 1.'
  invalid-page-number : '&cInvalid page number. Please enter a valid integer.'
  page-number-exceeds-total : '&cPage number exceeds total pages ( %total%).'
  registered-folders-header : '&aRegistered folders for backup (Page %page% of %total%):'

  # Backup directory error
  backup-directory-not-exist : '&cBackup directory does not exist.'
 

Elevate your server’s reliability with EasyBackup—automated, secure, and fully configurable backups for every Minecraft network.
Enjoy effortless peace of mind knowing your world is safe!