Configuration

Configuration

Complete configuration guide for GlowPlayersPro.

Configuration File

The config.yml file is located at plugins/GlowPlayersPro/config.yml.

General Settings

Config Version

config-version: 1

DO NOT edit this value. The plugin uses this version to detect outdated configurations.

Language

language: "en"

Sets the language for plugin messages.

• en — English (default)
• pt — Portuguese

To add a new language, create a file in the languages/ folder and set the filename here.

Core Settings

settings:
  # Show the [GlowPlayersPro] prefix in messages?
  use-prefix: true

  # Color used BOTH for auto-glow on join AND for "/glow" with no arguments (toggle).
  # Available: BLACK, DARK_BLUE, DARK_GREEN, DARK_AQUA, DARK_RED, DARK_PURPLE,
  #            GOLD, GRAY, DARK_GRAY, BLUE, GREEN, AQUA, RED, LIGHT_PURPLE, YELLOW, WHITE
  default-color: "WHITE"

  # Enable glow automatically when players join? (uses default-color)
  default-glow-enabled: false

  # NEON effect speed (20 ticks = 1 second).
  # Lower = faster. Values below 5 with many players online can impact performance.
  neon-speed-ticks: 10

  # Colors cycled by the NEON effect (use any of the 16 standard colors listed above).
  neon-colors: [RED, GOLD, YELLOW, GREEN, AQUA, BLUE, LIGHT_PURPLE]

  # Cooldown in seconds between glow changes per player (0 = disabled).
  # Players with glowplayers.admin bypass this. Prevents command spam.
  cooldown-seconds: 0

  # Should the plugin manage scoreboard teams to color the glow?
  # Keep TRUE for standalone use.
  # Set to FALSE if you use TAB (or another team/nametag plugin) and let it
  # apply the color via the %glowplayerspro_color% placeholder.
  use-teams: true

Options Explained

Option	Default	Description
use-prefix	true	Shows [GlowPlayersPro] prefix before messages
default-color	WHITE	Color used for auto-glow on join and toggle without arguments
default-glow-enabled	false	Applies glow automatically when players join
neon-speed-ticks	10	Animation speed for neon effect (20 ticks = 1 second)
neon-colors	[RED, GOLD, YELLOW, GREEN, AQUA, BLUE, LIGHT_PURPLE]	Colors cycled by neon effect
cooldown-seconds	0	Time between glow changes (0 = disabled)
use-teams	true	Manages scoreboard teams (disable for TAB integration)

Sound Effects

sounds:
  enabled: true

  # Sound when glow is ENABLED
  on-enable:
    sound: "entity.experience_orb.pickup"
    volume: 0.5
    pitch: 1.0

  # Sound when glow is DISABLED
  on-disable:
    sound: "entity.item.break"
    volume: 0.3
    pitch: 0.8

Sound Configuration

Parameter	Description	Values
enabled	Enable/disable all sounds	true / false
sound	Sound name	Minecraft key format (e.g., entity.experience_orb.pickup)
volume	Sound volume	0.0 (silent) to 1.0 (loudest)
pitch	Sound pitch	0.5 (low/deep) to 2.0 (high/pitched)

Common Sounds

• entity.experience_orb.pickup — Experience orb pickup
• entity.item.break — Item breaking
• entity.arrow.hit_player — Arrow hitting player
• block.note_block.pling — Note block pling
• entity.player.levelup — Level up

Debug Options

debug:
  # Log every sound played to the console?
  log-sounds: false

Warning: Use only for troubleshooting. May generate many console messages.

Complete Configuration Example

config-version: 1
language: "en"

settings:
  use-prefix: true
  default-color: "AQUA"
  default-glow-enabled: true
  neon-speed-ticks: 8
  neon-colors: [AQUA, BLUE, LIGHT_PURPLE, RED, GOLD]
  cooldown-seconds: 5
  use-teams: true

sounds:
  enabled: true
  on-enable:
    sound: "entity.player.levelup"
    volume: 0.7
    pitch: 1.2
  on-disable:
    sound: "block.anvil.land"
    volume: 0.5
    pitch: 0.9

debug:
  log-sounds: false

Updating the Configuration

When a new plugin version is released, new options may be added to config.yml. The plugin will automatically detect if your configuration is outdated and display a warning in the console.

To update:

1. Back up your current config.yml
2. Delete the config.yml file
3. Restart the server to generate a new configuration
4. Re-apply your custom values from the backup

Troubleshooting

If you encounter configuration issues:

1. Check that the YAML is valid (correct indentation)
2. Restart the server after making changes
3. Use /glow reload to reload configurations
4. Check the console for error messages

For more details, see Troubleshooting.