Inventory Backup

---

📖 Project Overview

InvBackup is a Minecraft plugin that provides robust inventory backup and recovery functionality for server administrators. The plugin features an intuitive graphical interface (GUI) for easy interaction, allowing administrators to manage and restore player inventories, configure automatic backups, and apply world-specific settings. This ensures seamless protection of player progress, even in the event of server crashes or other issues.

<div align="center"> <img src="https://cdn.modrinth.com/data/ua1oolre/images/6ba972c134d19430d8f6ce597e5ea9286019ba57.gif" alt="gif" width="400"/> <img src="https://cdn.modrinth.com/data/ua1oolre/images/0fbec4b8d5147909304a4b086b4c13541cd47edb.gif" alt="gif" width="400"/> <img src="https://cdn.modrinth.com/data/ua1oolre/images/89690db94e12b51d93a9f4da684939f0d87b71ed.gif" alt="gif" width="400"/> </div>

📋 Features

- Pagination: Manage and navigate through the plugin's settings, player inventories, and backup versions via an easy-to-use GUI. - Pagination: Allows manual or automatic backups of player inventories. - Pagination: Restore a player's inventory from the latest or a specific backup version through the GUI or commands. - Pagination: Define which worlds should allow inventory backups or restorations. - Pagination: Automatically back up player inventories at configurable time intervals. - Pagination: Admins can change backup settings such as intervals, maximum backup versions, and toggle world-specific features directly from the plugin’s GUI. - Pagination: Navigate player inventory backups and version history through paginated menus, ensuring smooth browsing of multiple backup versions.

Вот обновлённая таблица команд с добавлением команды для открытия интерфейса меню:

---

🛠️ Commands

The InvBackup plugin offers several commands for managing and controlling player inventory backups and opening menus:

| Command | Description | Usage | Aliases | |----------------------------------|--------------------------------------------------------------------------|----------------------------------------|----------------| | InvBackup | Manually save the inventory of a specified player. | `/invbackup save <player>` | `/ib save` | | InvBackup | Restore the specified player's inventory from a backup copy. (if no version is specified, the latest save is loaded) | `/invbackup restore <player> <version>`| `/ib restore` | | InvBackup | Toggle the world check feature to restrict inventory backups/restores by world. | `/invbackup toggleworldcheck` | `/ib toggleworldcheck` | | InvBackup | Set the world for inventory backup operations. | `/invbackup setworld <world>` | `/ib setworld` | | InvBackup| Set an automatic backup interval in seconds. | `/invbackup setinterval <time>` | `/ib setinterval` | | InvBackup | Reload the plugin’s configuration settings. | `/invbackup reload` | `/ib reload` | | InvBackup | Manually save the inventories of all online players. | `/invbackup saveall` | `/ib saveall` | | InvBackup | Opens the main InvBackup menu interface where admins can navigate various options such as settings, player inventories, and more. | `/invbackup menu` | `/ib menu` |

---

Highlights:

- Manual Control: Automatically create backups at regular intervals to ensure data integrity. - Manual Control: Enable or disable backups for specific worlds. - Manual Control: Admins can initiate backups and restores as needed for individual players

---

🔑 Permissions

The plugin uses a straightforward permission system that controls access to various features, both in the GUI and via commands.

| Default | Default | Default | |--------------------------|---------------------------------------------------------------------------------|--------------| | `invbackup.admin` | Full access to all backup and restore features, including GUI settings. | OP |

Permission Breakdown:

- `invbackup.admin`: This permission grants full control over the plugin, allowing players with this role to manage inventories, backups, restores, and settings through both commands and the GUI.

---

⚙️ Configuration File

The InvBackup plugin generates a configuration file (`config.yml`), allowing server administrators to customize key settings such as backup intervals and world checks. Changes can be made directly in the file or through the GUI.

Example configuration:

```yaml save-interval: 600 check-world: true world-name: world max-versions: 100 ```

Key Configuration Options:

- `max-versions`: Defines how often (in seconds) automatic backups are made. Default is `600` seconds (10 minutes). Can be changed with `/invbackup setinterval <time>`. - `max-versions`: Enables or disables world-specific checks for inventory backups and restores. Default is `true`. Can be toggled using `/invbackup toggleworldcheck`. - `max-versions`: Sets the name of the world where inventory backups and restores are allowed. Default is `world`. Can be changed with `/invbackup setworld <world>`. - `max-versions`: The maximum number of backup versions to store for each player. Once this limit is reached, the oldest versions are deleted. Default is `100`.

> Admins can modify these values either directly in the configuration file or through the corresponding commands. After making changes to the configuration, use `/invbackup reload` to apply them.

---

🖥️ Graphical Interface Overview

1. Main Menu: - Accessible via `/invbackup menu`, providing links to player inventories, settings, and the option to save all players inventories.

2. Settings Menu: - Modify key settings such as backup intervals, world checks, and the maximum number of backup versions using a toggleable GUI interface.

3. Player Inventory Menu: - View player heads and select a player to view or manage their inventory backups. View and restore player saves, switch between different saved settings, and organize player inventory backups in an easy-to-use interface.

4. Inventory Versions: - View previous versions of a player's inventory and select versions to restore, with pagination for easy navigation of large backup histories.

5. Restore Menu: - Restore a player's inventory directly from the selected version via the GUI by selecting the appropriate option.

---

🚀 Quick Start Guide

1. Install the Plugin: Download the `.jar` file and place it in your server's `plugins` folder.

2. Start or Restart the Server: Restart or restart the server to activate the plugin.

3. Set Backup Intervals: Use `/invbackup setinterval <time>` or `/invbackup menu` to configure backup settings to determine how often inventories are automatically saved.

4. Backup and restore: Save inventories manually with `/invbackup save <player>` or wait for automatic backup and restore them with `/invbackup restore <player>`.

5. Customize World Behavior: Toggle world-specific checks as needed with `/invbackup toggleworldcheck`.