Plugin Documentation Overview:
PlayerConvenience is a Bukkit/Spigot plugin that allows players to save and restore their inventories. It provides a GUI interface for easy management and includes features like inventory preview and automatic saving on death.
Features
- Save player inventories
- Restore saved inventories
- Preview saved inventories
- Automatic inventory saving on player death
- Configurable restore cost
- Permission-based access
Commands
- /invrestore - Opens the main GUI for inventory management
Permissions
- invrestore.use - Allows access to the inventory restore feature
- invrestore.restore.free - Allows free inventory restory (bypasses cost)
Configuration
The plugin uses two main configuration files:
config.yml
- debug: Enable/disable debug logging
- restore-price: Cost to restore an inventory
- max-restore-days: Maximum number of days to keep saved inventories
- users-folder: Folder name for storing user data
messages.yml
Contains all customizable messages used by the plugin.
GUI System
- Main Restore GUI: Displays saved inventories as clickable items
- Preview GUI: Shows the contents of a saved inventory before restoring
Inventory Management
- Inventories are saved automatically on player death
- Players can have up to 9 saved inventories
- Inventories older than max-restore-days are automatically removed
Economy Integration
- Uses Vault for economy support
- Players are charged restore-price when restoring an inventory (if not free)
Creative Mode Handling
- Players in Creative mode are automatically switched to Survival when previewing inventories
- Prevents item duplication and other potential issues
Safety Features
- Cooldown system to prevent spam
- Locks to prevent concurrent operations on the same inventory
Data Storage
- Player inventories are saved in YAML format in the users-folder
Error Handling
- Comprehensive error logging
- User-friendly error messages