Updated

Docs are always up to date•This site only shows the latest configuration and features. Version history and older configs aren’t available here yet.

Configuration

Messages Configuration

Configure system messages, help menus, and text formatting for your server.

Quick Navigation

System Messages

Configure basic system messages

System messages are displayed to players when they interact with the plugin's commands and features. These messages can be fully customized to match your server's style and tone.

Basic Messages Configuration

config.yml

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!"

System messages are displayed to players when they interact with the plugin's commands and features.

Message Variables

Some messages support variables that are replaced with dynamic content:

%player% - Player's name
%damage% - Damage amount
%combo% - Combo count

Color Formats

Available color and formatting options

VitalStrike supports a wide range of color and formatting options for all text displayed by the plugin. These formats can be used in any message configuration to create visually appealing and informative text.

Color Format Guide

config.yml

# Color Formats Available:
# Basic Colors:
# <red>, <dark_red> - Red variants
# <blue>, <dark_blue> - Blue variants
# <green>, <dark_green> - Green variants
# <aqua>, <dark_aqua> - Aqua variants
# <purple>, <dark_purple> - Purple variants
# <yellow>, <gold> - Yellow/gold variants
# <gray>, <dark_gray> - Gray variants
# <black>, <white> - Black and white

# Formatting:
# <bold> - Bold text
# <italic> - Italic text
# <underlined> - Underlined text
# <strikethrough> - Strikethrough text
# <obfuscated> - Obfuscated text

# Gradients:
# <gradient:color1:color2>text</gradient>

Use these color codes and formatting options to customize any message in the plugin.

Basic Colors

<red>

<blue>

<green>

<gray>

Text Formatting

<bold> - Bold text
<italic> - Italic text
<underlined> - Underlined
<strikethrough> - Strikethrough
<obfuscated> - Obfuscated

Advanced Formatting

Gradients:

<gradient:red:yellow>Text</gradient>

Combined:

Help Sections

Configure help menu sections

Help sections provide detailed information about different aspects of the plugin. These sections can be accessed through the help command and provide players with guidance on how to use the plugin's features.

Help Sections Configuration

help.yml

help-menu:
  sections:
    combos:
      title: "<gold><bold>Combo System Help</bold></gold>"
      content:
        1: "<yellow>Combos increase when you hit enemies in succession"
        2: "<yellow>Higher combos give damage multipliers"
        3: "<yellow>Combos decay after a period of inactivity"
    permissions:
      title: "<gold><bold>Permissions Help</bold></gold>"
      content:
        1: "<yellow>vitalstrike.use - Basic plugin usage"
        2: "<yellow>vitalstrike.toggle - Toggle indicators"
        3: "<yellow>vitalstrike.reload - Reload configuration"
        4: "<yellow>vitalstrike.stats - View statistics"
        5: "<yellow>vitalstrike.leaderboard - View leaderboards"
        6: "<yellow>vitalstrike.hologram - Toggle holograms"
        7: "<yellow>vitalstrike.admin.permissions - Manage permissions"

Help sections provide detailed information about different aspects of the plugin.

Creating Custom Help Sections

You can create additional help sections by adding new entries under the sections key. Each section needs a unique identifier, a title, and numbered content entries. Players can access these sections with /vs help [section-name].

Section Structure

Each help section consists of:

title - The section heading
content - Numbered list of help entries

The content entries are displayed in numerical order.

Example Help Section

Combo System Help

Combos increase when you hit enemies in succession
Higher combos give damage multipliers
Combos decay after a period of inactivity

Command Help

Configure command descriptions and usage

Command help provides information about available commands and their usage. This section allows you to customize how commands are displayed in the help menu, including their syntax and descriptions.

Command Help Configuration

help.yml

help-menu:
  commands:
    toggle:
      command: "/vs toggle [on|off]"
      description: "Toggle damage indicators on or off"
    reload:
      command: "/vs reload"
      description: "Reload the plugin configuration"
    stats:
      command: "/vs stats"
      description: "View your combat statistics"
    leaderboard:
      command: "/vs lb [damage|combo|average]"
      description: "View the damage leaderboards"
    hologram:
      command: "/vs hologram [on|off]"
      description: "Toggle combo holograms on or off"
    permissions:
      command: "/vs perm <add|remove|list> <player> [permission]"
      description: "Manage player permissions"
    help:
      command: "/vs help [section]"
      description: "Show this help menu or a specific section"
    vitalawakening:
      command: "/vs vitalawakening [amount]"
      description: "Get Vital Awakening revival items"
    resourcepack:
      command: "/vs resourcepack"
      description: "Load the custom resource pack"

Command help provides information about available commands and their usage.

Command Syntax Conventions

When writing command syntax:

[argument] - Optional argument
<argument> - Required argument
[a|b|c] - Choose one of these options

Command Structure

Each command entry consists of:

command - The command syntax
description - What the command does

These are displayed when a player uses /vs help.

Example Command Display

/vs toggle [on|off]

Toggle damage indicators on or off

/vs stats

View your combat statistics