VitalVials

# VitalVials Plugin VitalVials is a unique Minecraft plugin that allows players to purchase and manage in-game effects using their health. With a fully customizable configuration, server owners can create a balanced between risk and reward, where players must carefully consider the cost of powerful effects against their own vitality. ## Features - **Health-Based Economy**: Players trade their max health / health points for powerful effects - **Fully Configurable**: Customize every aspect of effects, costs, and mechanics - **Dynamic Scoreboard**: Real-time tracking of active effects and remaining duration - **Player-Specific Settings**: Each player can customize their scoreboard - **Cooldown System**: Prevent effect spamming with configurable cooldowns - **Refund System**: Option to refund effects (configurable per effect) ## Installation 1. Download the latest version of VitalVials from the (https://github.com/b4n9z/VitalVials/releases) 2. Place the `VitalVials.jar` file in your server's `plugins/` directory 3. Restart your server 4. Configure the plugin to your liking in `plugins/VitalVials/config.yml` and `plugins/VitalVials/effects.yml` and `plugins/VitalVials/activation.yml` 5. Use `/vv reload` to apply changes without restarting ## Commands ### Main Command - `/vv` or `/vitalvials` - Main command for VitalVials ### Subcommands - `/vv reload` - Reload the plugin configuration - `/vv shop` - Opens the effect shop - `/vv buyEffect <effect>` - Buy an effect directly - `/vv viewStatus` - View your current active effects - `/vv scoreboard <on/off/editShort>` - Toggle or customize your scoreboard - `/vv refundEffect <effect>` - Refund an effect - `/vv removeData <player/allPlayer>` - Remove player data ## Permissions | Permission | Description | Default | |-------------------|------------------------------------|---------| | `vv.admin` | Full access to all commands | op | | `vv.reload` | Allows reloading the plugin | op | | `vv.shop` | Access to the effect shop | op | | `vv.buyEffect` | Allows buying effects | op | | `vv.viewstatus` | View own effect status | op | | `vv.scoreboard` | Access to scoreboard customization | op | | `vv.refundEffect` | Refund purchased effects | op | | `vv.removedata` | Remove player data | op | ## Configuration VitalVials is highly configurable through the `config.yml`, `effects.yml` and `activation.yml` file. Here are the main sections: ### Main Configuration <details> <summary>Click to expand</summary> The configuration file (config.yml) allows you to customize several aspects of the plugin: ```yaml effects: effects.yml # Path to the effects.yml file that contains the effects list activation: activation.yml # Activation settings maxHP: # max HP enabled: true # Enable / Disable max HP, when enabled players can't get more HP when trying to Refund Effect, so player can't get more HP that you set value: 20 # Max HP (Health Points) minHP: 2 # Min HP (Health Points) to allow player not buying effect when HP is same or less than this scoreboard: # scoreboard settings defaultShowScoreboard: true # Show scoreboard on right side by default (per player can disable it on their own using command if you give them access) periodUpdate: 10 # period to update scoreboard (in seconds) permissionsAllPlayer: reload: false # Allow reload command for all players shop: true # Allow shop command for all players buyEffect: true # Allow buyEffect command for all players viewStatus: true # Allow viewStatus command for all players scoreboard: true # Allow scoreboard command for all players refundEffect: true # Allow refundEffect command for all players removeData: false # Allow removeData command for all players ``` </details> ### Effect Configuration Each effect can be configured with the following options: - `enabled`: Enable/disable the effect - `name`: The name of the effect in shop - `effect`: The name of the effect to give (default), don't change if you don't know what it is - `lore`: The lore of the effect in shop - `maxLevel`: The max level/amplifier of the effect - `particles`: Whether particles will be shown when getting the effect - `saveEffectData`: Whether the effect data will be saved to the player data - `priceType`: The type of price when buying the effect (MAX_HEALTH to buy using MAX HEALTH player or HEALTH to buy using HEALTH player) - `refundPercentage`: The percentage of the HP refundable (calculate from level 1 effect) after buying the effect (-1 to disable refund) - `autoActivate`: Whether the effect will be auto activated after buying, if false you need set it in activation config Array section (``): - `durationPerUpgrade`: Duration in seconds per upgrade, -1 for infinite (in seconds) - `cooldownPerUpgrade`: Cooldown per upgrade (in sec