🥥CocoVaults

Welcome to the official documentation for CocoVaults! Here you will find everything you need to know about configuring and using the plugin effectively.

About CocoVaults

CocoVaults is a premium virtual storage plugin that allows players to manage and access virtual chests across different servers. Highly customizable and supporting multiple storage systems, CocoVaults ensures a seamless and robust storage experience for players.

---

How to Configure CocoVaults

The plugin is relatively easy to set up and fully customizable. You can choose to store data using MySQL, MariaDB, SQLite, YAML, or JSON.

Settings.yml File

Below is a breakdown of the configuration file and how to modify it according to your needs:

# Version of the configuration file / plugin, do not modify these settings.
Config-Version: 2.0.3
Plugin-Version: 2.0.7

#######################
##  Storage Settings ##
#######################
Storage-Mode:
  # YAML storage is deprecated. Consider migrating to a safer option like JSON or SQLite.
  Mode: JSON # Available options: YAML, MySQL, MariaDB, SQLite, JSON

  # Connection pool configuration for SQL databases
  Connection-Pool-Settings:
    max-connections: 20
    min-idle: 5
    connection-timeout: 30000
    max-lifetime: 1800000

  # Database credentials
  MySQL-Data:
    host: 127.0.0.1
    port: 3306
    name: DatabaseName
    user: root
    password: root

  MariaDB-Data:
    host: 127.0.0.1
    port: 3310
    name: DatabaseName
    user: root
    password: root

  SQLite-Data:
    file: database.db

Key Configuration Details:

• Storage-Mode: Defines how vault data is stored. Available options include YAML, MySQL, MariaDB, SQLite, and JSON.

• Database Credentials: Required for MySQL and MariaDB connections.

• Connection Pool Settings: Helps optimize database performance.

---

Permissions System

Plugin Permissions:

• cocovaults.* – Grants access to all plugin commands.

• cocovaults.open – Allows players to open their vaults.

• cocovaults.admin – Grants access to administrative vault commands.

• cocovaults.icons – Allows changing vault icons.

---

Commands and Usage

General Commands:

• /cocovaults <VAULT> – Opens a specific vault.

• /cocovaults GUI – Displays all available vaults in a GUI.

• /cocovaults icon <MATERIAL> <VAULT> – Changes the icon of a vault.

Admin Commands:

• /cocovaults admin reload – Reloads the plugin configuration.

• /cocovaults admin forceopen <PLAYER> <VAULT> – Forces the opening of a player's vault.

• /cocovaults admin view <PLAYER> <VAULT> – Views a player's vault as an administrator.

---

GUI Customization

CocoVaults features a fully customizable Graphical User Interface (GUI), allowing for intuitive vault management.

GUI Settings:

GUIs:
  Vault-List-GUI: "<black>CocoVaults GUI - Page %page%"
  GUI-Item-Name: "<white>CocoVault <green>%vault%"
  Player-Vault: "<black>CocoVault %vault%"
  Next-Page-Button: "<white>Next Page ➡"
  Previous-Page-Button: "<white>⬅ Previous Page"

• Customize GUI labels and buttons to match your server's theme.

GUI Items:

GUI-Items:
  Default-Vault: CHEST
  Lore-Vaults:
    - '<green>CocoVault - Virtual Chest'
    - '<yellow>Occupied space: <white>[<green>%usage%<white>/54]'
    - '<yellow>Free space: <white>[<green>%free%<white>/54]'
  Decoration: BLACK_STAINED_GLASS_PANE
  Next-Page-Item: ARROW
  Previous-Page-Item: ARROW

• Set up default icons and tooltips for vault items in the GUI.

---

Blacklisted Items

To prevent specific items from being stored in vaults, use the Item-BlackList setting:

Item-BlackList:
  - DIAMOND_BLOCK
  - DIAMOND

• This restricts players from storing diamond blocks and diamonds inside their vaults.

---

Database Integration

CocoVaults supports real-time database queries, ensuring seamless synchronization across multiple servers.

• MySQL & MariaDB: Recommended for large-scale servers.

• SQLite & JSON: Suitable for small or local servers.

How to Set Up Database Storage:

1. Choose MySQL or MariaDB as your Storage-Mode.

2. Enter the correct database credentials in Settings.yml.

3. Restart the server to apply the changes.

---

Cross-Server Compatibility

CocoVaults supports cross-server functionality, enabling players to access their vaults across different servers in a network.

• Data is synchronized in real-time.

• Asynchronous operations prevent lag.

---

Migration and Importing

If you're migrating from PlayerVaultsX, CocoVaults provides a built-in importer.

Steps to Import Data:

1. Backup your existing data before proceeding.

2. Run the following command:

   /cocovaults admin import PlayerVaultsX

3. Confirm the import by running the command again.

4. Wait for the process to complete.

After completion, a success message will appear:

Conversion from PlayerVaultsX has completed successfully! %vaults% vaults from %players% players have been converted.

---

Compatibility with Hybrid Servers

CocoVaults works seamlessly with hybrid servers such as ArcLight, enabling compatibility with both Bukkit/Spigot plugins and Forge mods.

Benefits:

• Supports CustomModelData for unique item textures.

• Works with ItemsAdder, Oraxen, Nexo, EcoItems, and modded items.

• Allows storage of NBT-based custom items.

Performance Considerations:

• Optimized for asynchronous database operations to prevent lag.

• Supports configurable cooldowns to balance server load.

---

For additional support, contact the FruitForge development team. Thank you for choosing CocoVaults!