Configuration Guide

Display Settings

Configure how damage indicators, leaderboards, and menus are displayed in VitalStrike

Quick Navigation

Basic Settings

Configure basic display settings

Basic display settings control the fundamental aspects of how damage indicators appear in-game. These settings affect all damage indicators regardless of type.

Basic Display Configuration

config.yml

# Display Settings
display:
  duration: 1.5 # How long damage/heal numbers stay visible (in seconds)

The duration setting controls how long damage numbers remain visible before fading away.

Duration Impact

Setting a longer duration makes damage numbers stay visible longer, which can be helpful for tracking damage over time. However, too long a duration might cause visual clutter during intense combat. A value between 1.0 and 2.0 seconds typically provides a good balance.

Position Settings

Configure where damage indicators appear

Position settings control where damage numbers appear relative to the entity and how they move. These settings allow you to customize the exact placement of indicators for optimal visibility.

Position Configuration

config.yml

display:
  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)

Position settings control where damage numbers appear relative to the entity and how they move.

Offset Positioning

The x and y values determine where damage numbers appear relative to the entity:

y: -0.2 - Slightly below the entity
y: 0.5 - Above the entity
x: -0.5 - To the left of the entity
x: 0.5 - To the right of the entity

Random Offset & Direction

random-offset adds variation to prevent indicators from stacking:

random-offset: -1 - Disabled (fixed position)
random-offset: 0.2 - Small random variation
random-offset: 0.5 - Larger random variation

The direction setting controls which way indicators float.

Animation Settings

Configure how damage indicators animate

Animation settings control how damage numbers fade in/out and move through the air. These settings allow you to create smooth, visually appealing damage indicators that enhance the combat experience.

Animation Configuration

config.yml

display:
  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

Animation settings control how damage numbers fade in/out and move through the air.

Animation Tips

For smoother animations, keep fade-in and fade-out times between 0.1 and 0.3 seconds. The float-speed controls how quickly indicators move (higher values = faster movement). The float-curve adds a curved path to the movement, creating a more dynamic effect.

Fade Effects

Fade effects control the opacity transition of damage indicators:

fade-in: 0.25 - How long it takes to appear
fade-out: 0.25 - How long it takes to disappear

Setting these to 0 will make indicators appear/disappear instantly.

Movement Effects

Movement effects control how indicators float through the air:

float-speed: 0.03 - Speed of movement
float-curve: 0.02 - Curve intensity

Higher float-curve values create more pronounced curved paths.

Leaderboard Display

Configure leaderboard appearance

Leaderboard display settings control how the in-game leaderboards appear to players. These settings allow you to customize titles, entry formats, and number formatting for different leaderboard types.

Leaderboard Configuration

config.yml

leaderboard:
  display:
    title-formats:
      damage: "<gold><bold>Top %d Damage Dealers</bold></gold>"
      combo: "<gold><bold>Top %d Highest Combos</bold></gold>"
      average: "<gold><bold>Top %d Average Damage</bold></gold>"
    entry-format: "<yellow>#%d <white>%s: <gold>%s"
    header: "<dark_gray><strikethrough>                    </strikethrough>"
    footer: "<dark_gray><strikethrough>                    </strikethrough>"
  default-type: "damage"
  display-limit: 10
  number-format:
    damage: "%.1f"
    average: "%.1f"
    combo: "%d"

Customize how leaderboards look, including titles, entries, and number formatting.

Title Formats

Customize the title for each leaderboard type:

Damage leaderboard
Combo leaderboard
Average damage leaderboard

The %d placeholder is replaced with the display limit.

Entry Format

The entry-format controls how each leaderboard entry appears:

%d - Position number
%s - Player name
%s - Value (damage, combo, etc.)

Number Format

Control how numbers appear in each leaderboard type:

%.1f - One decimal place (12.5)
%.2f - Two decimal places (12.57)
%d - Whole numbers only (13)

Help Menu Display

Configure help menu appearance

Help menu display settings control how the plugin's help menu appears to players. These settings allow you to customize the header, title, footer, and command listings to match your server's style.

Help Menu Configuration

config.yml

help-menu:
  header: "<dark_gray><strikethrough>                    </strikethrough>"
  title: "<gold><bold>VitalStrike Commands</bold></gold>"
  footer: "<dark_gray><strikethrough>                    </strikethrough>"
  commands:
    toggle:
      command: "/vs toggle [on|off]"
      description: "Toggle damage indicators on or off"
    reload:
      command: "/vs reload"
      description: "Reload the plugin configuration"

Customize the appearance of the help menu, including headers, titles, and command listings.

Adding Custom Commands

You can add additional commands to the help menu by adding new entries under the commands section. Each command needs a unique key, a command string, and a description. These will automatically appear in the help menu.

Menu Structure

The help menu is structured with:

Header (decorative line)
Title (plugin name)
Command listings
Footer (decorative line)

Command Format

Each command in the help menu includes:

command - The command syntax
description - What the command does

Optional parameters are typically shown in [brackets].