Configuration

Configuration (config.yml)

The main configuration file for HidePlayer is located at plugins/HidePlayer/config.yml. The plugin is designed to be highly customizable and easy to understand for any server administrator.

Below is a detailed explanation of what each parameter does.

Default config.yml File

# ################################################
# #          HidePlayer Configuration            #
# ################################################

# Configuration version (do not change this to avoid issues)
config-version: 0.1

# Enable debug messages in the console (useful for tracking errors)
debug: true

# Automatically check for updates on GitHub (Notifies admins upon joining)
check_updates: true

# Plugin prefix (Will appear alongside most native chat messages)
prefix: "&8[&bHidePlayer&8] &r"

# Language to use. Reads from the langs folder (e.g. langs/en.yml or langs/es.yml)
language: "en"

# Chat format for administrators to identify hidden players
# "%1$s" represents the original player message, and you can adapt it at the end
# (Supports PlaceholderAPI variables)
admin-chat-format: "%1$s &8(%hideplayer_original_name%)&r"

# Sound System
sounds:
  hide: # Played when the player successfully hides
    enabled: true
    sound: "ENTITY_ENDERMAN_TELEPORT"
    volume: 1.0
    pitch: 1.0
  show: # Played when the player restores their original state
    enabled: true
    sound: "ENTITY_PLAYER_LEVELUP"
    volume: 1.0
    pitch: 1.0
  error: # Played if a command fails, or the player lacks permissions
    enabled: true
    sound: "ENTITY_VILLAGER_NO"
    volume: 1.0
    pitch: 1.0

# Format and design of the Admin Panel (/hp panel)
admin-panel:
  title: "&cAdmin Panel - Page {page}" # Menu title, supports {page} variable
  size: 54 # Total size, must be a multiple of 9, max 54. (e.g. 9, 18, 27, 36, 45, 54)
  next-page-item:
    material: "ARROW"
    name: "&aNext Page"
    lore:
      - "&7Click to go to the next page!"
  prev-page-item:
    material: "ARROW"
    name: "&cPrevious Page"
    lore:
      - "&7Click to go to the previous page!"
  player-head:
    # This is the physical item representing the hidden player (their head).
    # Supports {original_name}, {nick}, {skin}, and {uuid}.
    name: "&a{original_name}" 
    lore:
      - "&7Fake Nick: &f{nick}"
      - "&7Fake Skin: &f{skin}"
      - "&8Real UUID: {uuid}"

---

Advanced Explanation

• Admin Chat Format (admin-chat-format): Moderators will want to know who is chatting even when someone is using a fake nick. The plugin uses the API to intercept messages, applying this conditional format so an admin can always differentiate when reading messages from a fake nick that hides the real entity.
• Multilingual System (language): If you want to translate the plugin to another language, make sure to set the variable to its code (e.g. "es"), this way the plugin will use the corresponding .yml file located in the /langs/ folder.
• Panel Customization (admin-panel): You have total control over the colors and navigation items. The size must be a multiple of 9 so the inventory is correctly created in Minecraft.