Configuration Guide

Basic Settings

Configure core plugin settings, display options, and basic functionality

Quick Navigation

General Settings

Core plugin configuration options

These settings control the core functionality of the plugin. The master switch enables or disables the entire plugin.

Basic Plugin Settings

config.yml

# General Settings
enabled: true

This is the master switch for the entire plugin. Set to false to disable all functionality.

Pro Tip

You can use permission-based toggles to enable/disable the plugin for specific players or groups instead of disabling it entirely.

Database Configuration

Configure how player data is stored

VitalStrike stores player statistics, preferences, and other data in a database. Currently, the plugin supports file-based storage.

Database Settings

config.yml

# Database Settings
database:
  enabled: true
  file: "playerdata.yml"

Simple file-based storage for player data. Perfect for small to medium-sized servers.

Database Performance

The file-based database is automatically saved when the server shuts down and periodically during operation. For larger servers, consider backing up the playerdata.yml file regularly.

Update Checker

Configure automatic update checking

VitalStrike can automatically check for updates when your server starts up. This helps ensure you're always running the latest version with the newest features and bug fixes.

Update Settings

config.yml

# Update Checker
update-checker:
  enabled: true

Enable or disable automatic checking for new plugin versions.

Update Notifications

When a new version is available, a notification will be shown to server operators when they join the game. You can also check for updates manually with the reload command.

World Settings

Configure world-specific behavior

Control how VitalStrike behaves in different worlds and dimensions. You can disable the plugin in specific worlds or adjust damage multipliers for different dimensions.

World Configuration

config.yml

# World Settings
world-settings:
  enabled: true # Master switch for world-based control
  disabled-worlds:
    - "example_world"
    - "minigames_world"
  # Dimension-specific settings
  dimensions:
    overworld:
      enabled: true
      damage-multiplier: 1.0 # Normal damage in overworld
    nether:
      enabled: true
      damage-multiplier: 1.2 # 20% more damage in nether
    end:
      enabled: true
      damage-multiplier: 1.1 # 10% more damage in end
  # If WorldGuard is present, respect PvP regions
  respect-worldguard-pvp: true

Fine-tune how VitalStrike behaves in different worlds and dimensions.

WorldGuard Integration

When respect-worldguard-pvp is enabled, VitalStrike will automatically disable damage indicators in WorldGuard regions where PvP is disabled.

Display Settings

Configure how damage indicators are displayed

These settings control the visual appearance and animation of damage indicators. Adjust how long they stay visible, their position, and animation properties.

Display Configuration

config.yml

# Display Settings
display:
  duration: 1.5 # How long damage/heal numbers stay visible (in seconds)
  position:
    y: -0.2 # Vertical offset (negative = lower, positive = higher)
    x: -0.5 # Horizontal offset (negative = left, positive = right)
    random-offset: -1 # Random variation (-1 = disabled, 0 or higher = amount of randomness)
    direction: "down" # Direction for indicators to move (down, up, left, right)
  animation:
    fade-in: 0.25 # Fade in duration in seconds
    fade-out: 0.25 # Fade out duration in seconds
    float-speed: 0.03 # Floating speed (blocks per tick)
    float-curve: 0.02 # Curve intensity for floating motion

Fine-tune how damage indicators appear and animate in-game.

Position Settings

y: Vertical position (-0.2 places indicators slightly below the entity)
x: Horizontal position (-0.5 places indicators to the left of the entity)
random-offset: Adds variation to prevent overlapping indicators
direction: Which way indicators move (down, up, left, right)

Animation Settings

fade-in/out: How quickly indicators appear and disappear
float-speed: How fast indicators move (higher = faster)
float-curve: Adds a curved path to indicator movement
duration: Total time indicators remain visible

Messages

Customize plugin messages

Customize all messages sent by the plugin to players. Messages support MiniMessage format for colors, formatting, and gradients.

Message Configuration

config.yml

# Messages
messages:
  no-permission: "<red>You don't have permission to use this command!"
  enabled-personal: "<green>VitalStrike damage indicators enabled for you!"
  disabled-personal: "<red>VitalStrike damage indicators disabled for you!"
  already-enabled: "<yellow>VitalStrike damage indicators are already enabled for you!"
  already-disabled: "<yellow>VitalStrike damage indicators are already disabled for you!"
  config-reloaded: "<green>Configuration reloaded successfully!"

Customize all plugin messages. Supports MiniMessage format for colors and formatting.

Color Formatting

VitalStrike supports both MiniMessage format and traditional Minecraft color codes:

<red>Text</red> - Red text

<bold>Text</bold> - Bold text

<gradient:red:gold>Text</gradient> - Gradient

&cText - Legacy format (red)