diff --git a/README.md b/README.md index 67fb7336..08074687 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,49 @@ # DriveBackupV2 -**Need help? Talk to me on [Discord](https://discord.gg/VdCAUtm)!** +**Need help? Talk to our team on [Discord](https://discord.gg/VdCAUtm)!** ## What is this? Have you ever lost your Minecraft world before? -Maybe your hard drive died. Maybe you used a server hosting service that terminated without warning. Maybe you just accidentally deleted it. +Maybe your hard drive died. +Maybe your server hosting provider terminated the server without warning. +Maybe you just accidentally deleted it. DriveBackupV2 is a plugin that aims to provide an extra layer of security to your data by backing it up remotely. ## Features -- Creates and/or uploads backups to Google Drive, OneDrive, Dropbox, or a remote (S)FTP server -- Can create a backup out of any files or folders on your Minecraft server -- Can include files and MySQL databases from external servers (such as a BungeeCord one!) -- Deletes backups locally and remotely if they exceed a specified amount -- Can automatically run backups at an interval or on a schedule +- Creates and/or uploads backups to Google Drive, OneDrive, Dropbox, +and/or a remote storage server with (S)FTP or S3 compatible api. +- Can automatically create a backup out of any files or folders on your Minecraft server. +- Can make backups of remote (S)FTP file sources and MySQL databases from external servers (such as a BungeeCord one!) +- Automatically deletes backups locally and remotely if they exceed a specified amount. +- Automatically run backups at a set interval or on a custom schedule. - And **much** more! +## Requirements + +### General Requirements + +- Java 8 or higher + +### Platform Specific Requirements + +#### Bukkit/Spigot/Paper/Purpur + +- Minecraft 1.8 - 1.20.X + +## Where can I download it? + +- [GitHub Releases](https://github.com/MaxMaeder/DriveBackupV2/releases) +- [Bukkit](https://dev.bukkit.org/projects/drivebackupv2) +- [Spigot](https://www.spigotmc.org/resources/drivebackupv2.79519/) +- [Modrinth](https://modrinth.com/plugin/drivebackupv2) +- [CurseForge](https://www.curseforge.com/minecraft/bukkit-plugins/drivebackupv2) + ## Basic Setup -First, download the plugin [here](https://dev.bukkit.org/projects/drivebackupv2) and copy it to the `plugins` folder on your server. Then, restart your server. Finally, follow the instructions below for the backup method of your choice. +First, download the plugin and copy it to the `plugins` folder on your server. +Then, restart your server. +Finally, follow the instructions below for the backup method of your choice. ### Google Drive Simply run `/drivebackup linkaccount googledrive` and follow the on-screen instructions. @@ -32,14 +57,24 @@ Simply run `/drivebackup linkaccount dropbox` and follow the on-screen instructi ### Local > Since **v1.3.0** -Change `local-keep-count` in the `config.yml` to the number of backups to keep locally. Set to `-1` to keep an unlimited amount of backups locally. +Change `local-keep-count` in the `config.yml` to set the number of backups to keep locally. +Set to `-1` to keep an unlimited number of backups locally. -Once you've completed the above instructions, backups will run automatically every hour. +Once you have completed the above instructions, +backups will run automatically every hour by default. ## Advanced Setup Learn how to set up and use more advanced features in the [wiki](https://github.com/MaxMaeder/DriveBackupV2/wiki). ## Privacy Policy -Since we need to access your Google Drive and/or OneDrive data to back up your world, we are required to provide a Privacy Policy. +Since we need to access your Google Drive +and/or OneDrive data to back up your world, +we are required to provide a Privacy Policy. -All of the data this plugin uploads and downloads from your Google Drive and/or OneDrive stays on your Minecraft server, so we never have access to it. This plugin physically cannot access any data in your Google Drive and/or OneDrive that is not related to backing up your Minecraft world backups. But don't take our word for it, all of this plugin's source code is available here! +All of the data this plugin uploads and downloads +or otherwise accessed from your Google Drive +and/or OneDrive stays on your Minecraft server, +so we never have access to it. +This plugin physically cannot access any data in your Google Drive +and/or OneDrive that is not related to backing up your Minecraft server. +But don't take our word for it, all of this plugin's source code is available here!