Skip to main content
This guide covers all configuration options available in NHideAndSeek, including main config, arena settings, and item customization.

Main Configuration

The main configuration file is located at plugins/NHideAndSeek/config.yml.

General Settings

settings:
  debug: false                    # Enable debug mode for troubleshooting
  lang: en_US                     # Default language (en_US, tr_TR)
  game-chat-enabled: true         # Enable game-specific chat system
  game-logging: true              # Enable game event logging
  log-batch-size: 50              # Number of logs to batch before writing
  log-flush-interval: 10000       # Log flush interval in milliseconds
Enables detailed console logging for debugging purposes. Set to true only when troubleshooting issues.Default: false
Sets the default language for all players. Players can override this in their settings.Available: en_US (English), tr_TR (Turkish)Default: en_US
Enables the advanced chat system with team chat, global chat, and spectator chat modes.Default: true
Logs all game events to files in plugins/NHideAndSeek/logs/ directory.Default: true

Database Configuration

NHideAndSeek supports both SQLite and MySQL databases.

SQLite (Default)

database:
  type: SQLITE
Simple file-based database, perfect for small to medium servers. No additional configuration needed.

MySQL

database:
  type: MYSQL
  host: localhost                 # MySQL server address
  port: 3306                      # MySQL server port
  database: nhideandseek          # Database name
  username: root                  # MySQL username
  password: password123           # MySQL password

  # Connection Pool Settings (HikariCP)
  pool-size: 10                   # Maximum pool size
  minimum-idle: 2                 # Minimum idle connections
  keepalive-time: 600000          # Keepalive time (ms)
  maximum-lifetime: 1800000       # Max connection lifetime (ms)
  connection-timeout: 10000       # Connection timeout (ms)
For large servers with multiple instances, use MySQL for centralized data storage.
pool-size: Maximum number of connections in the pool. Increase for high-traffic servers.minimum-idle: Minimum number of idle connections to maintain. Should be lower than pool-size.keepalive-time: How often to send keepalive queries (in milliseconds).maximum-lifetime: Maximum time a connection can exist (in milliseconds).connection-timeout: How long to wait for a connection before timing out (in milliseconds).

Main Lobby

Configure the main lobby where players are teleported after leaving games.
main-lobby:
  enabled: false                  # Enable main lobby teleportation
  world: world                    # World name
  x: 0.0                          # X coordinate
  y: 64.0                         # Y coordinate
  z: 0.0                          # Z coordinate
  yaw: 0.0                        # Player rotation (horizontal)
  pitch: 0.0                      # Player rotation (vertical)
Set the main lobby location using /has setmainlobby command in-game.

Economy & Rewards

Configure coin rewards for players.
economy:
  winner-points: 10               # Coins for winning a game
  participation-points: 1         # Coins for participating
EventCoinsDescription
Win10Awarded to winners (both seekers and hiders)
Participation1Awarded to all players who complete a game
Balance these values based on your effect shop prices to create a fair economy.

Item Configuration

NHideAndSeek uses a powerful item configuration system that supports custom model data, glow effects, and more.

Item Configuration Structure

All items follow this structure:
item-name:
  material: "MATERIAL_NAME"       # Required
  amount: 1                       # Optional (default: 1)
  custom-model-data: 0            # Optional (0 = disabled)
  display-name: "&6Display Name"  # Optional
  lore:                           # Optional
    - "&7Line 1"
    - "&7Line 2"
  glow: false                     # Optional (enchanted glow)
  item-flags:                     # Optional
    - "HIDE_ATTRIBUTES"
    - "HIDE_ENCHANTS"
  slot: 0                         # Optional (inventory slot)

Supported Features

Custom Model Data

Use resource packs to display custom item models

Glow Effect

Add enchanted glow without showing enchantments

Hex Colors

Full RGB color support with #RRGGBB format

Item Flags

Hide vanilla attributes, enchantments, and more

Fireball Item

Seekers use fireballs to eliminate hiders.
fireball-item:
  material: STICK
  custom-model-data: 0            # Set to resource pack model ID
  display-name: "&c&lFireball"
  lore:
    - "&7Right-click to shoot!"
    - "&7Cooldown: %cooldown%s"   # Dynamic placeholder
Custom Model Data Example:
fireball-item:
  material: STICK
  custom-model-data: 1001         # Resource pack model
  display-name: "#FF6B6B&lᴍᴀɢɪᴄ ᴡᴀɴᴅ"
  lore:
    - "#FFE66D✦ #7DD3FCʀɪɢʜᴛ-ᴄʟɪᴄᴋ ᴛᴏ ᴄᴀѕᴛ"
    - "#A8E6A0ᴄᴏᴏʟᴅᴏᴡɴ: #FCD05C%cooldown%ѕ"
  glow: true                      # Add enchanted glow
The %cooldown% placeholder is automatically replaced with the fireball cooldown time.

Effect Selection Item

Displayed in lobby for players to choose their cosmetic effects.
select-effect-item:
  material: BLAZE_POWDER
  custom-model-data: 0
  slot: 4                         # Middle slot of hotbar
  display-name: "&6&lSelect Effect"
  lore:
    - "&7Choose your special effect!"
    - "&7from the available options."

Leave Arena Item

Allows players to leave the game and return to lobby.
leave-arena-item:
  material: RED_BED
  custom-model-data: 0
  slot: 8                         # Last slot of hotbar
  display-name: "&c&lLeave Arena"
  lore:
    - "&7Click to leave the arena."
    - "&7You will return to the main lobby."

Color Formatting

NHideAndSeek supports multiple color formats:
display-name: "&6&lGolden Text &r&7Gray"
CodeColorCodeFormat
&0Black&lBold
&1Dark Blue&mStrikethrough
&2Dark Green&nUnderline
&3Dark Aqua&oItalic
&4Dark Red&rReset
&5Dark Purple
&6Gold
&7Gray
&8Dark Gray
&9Blue
&aGreen
&bAqua
&cRed
&dLight Purple
&eYellow
&fWhite

Item Flags

Hide various item attributes and information.
item-name:
  item-flags:
    - "HIDE_ATTRIBUTES"           # Hide attack damage, speed, etc.
    - "HIDE_ENCHANTS"             # Hide enchantment list
    - "HIDE_UNBREAKABLE"          # Hide "Unbreakable" tag
    - "HIDE_DESTROYS"             # Hide "Can Destroy" info
    - "HIDE_PLACED_ON"            # Hide "Can Be Placed On" info
    - "HIDE_POTION_EFFECTS"       # Hide potion effects
    - "HIDE_DYE"                  # Hide dye information
The plugin automatically adds HIDE_ATTRIBUTES to all items. Add others as needed.

Glow Effect

Add an enchanted glow to items without displaying enchantments.
item-name:
  glow: true
This automatically:
  1. Adds Unbreaking I enchantment
  2. Adds HIDE_ENCHANTS flag
  3. Creates a glowing effect
Example:
premium-item:
  material: DIAMOND
  display-name: "#7DD3FC&lᴘʀᴇᴍɪᴜᴍ ɪᴛᴇᴍ"
  glow: true                      # Makes it glow!

Extra Settings

Additional gameplay restrictions and features.
extra-settings:
  prevent-block-break: true       # Prevent breaking blocks in arenas
  prevent-block-place: true       # Prevent placing blocks in arenas
  prevent-drop: true              # Prevent dropping items
  prevent-pickup: true            # Prevent picking up items
Disabling these protections may allow players to exploit or grief arenas.

Sound Configuration

Customize UI and game sounds.
sounds:
  click: "UI_BUTTON_CLICK"        # Menu click sound
  success: "ENTITY_PLAYER_LEVELUP" # Success action sound
  error: "ENTITY_VILLAGER_NO"     # Error action sound
  open: "BLOCK_CHEST_OPEN"        # Menu open sound
  close: "BLOCK_CHEST_CLOSE"      # Menu close sound

Available Sound Categories

  • UI_BUTTON_CLICK - Button clicks
  • UI_TOAST_IN - Toast notification appear
  • UI_TOAST_OUT - Toast notification disappear
  • BLOCK_NOTE_BLOCK_PLING - Note block pling
Find all available sounds at Minecraft Sound List

Arena Configuration

Each arena has its own configuration file in plugins/NHideAndSeek/arenas/.

Basic Arena Settings

name: "Arena Name"
id: "uuid-here"
enabled: true
world: "world"

# Arena boundaries
bounds:
  pos1:
    x: 100.0
    y: 64.0
    z: 100.0
  pos2:
    x: 200.0
    y: 100.0
    z: 200.0

Spawn Points

spawns:
  lobby:
    world: world
    x: 150.0
    y: 65.0
    z: 150.0
    yaw: 0.0
    pitch: 0.0

  spectator:
    world: world
    x: 150.0
    y: 80.0
    z: 150.0
    yaw: 0.0
    pitch: 0.0

  hider:
    0:
      world: world
      x: 120.0
      y: 65.0
      z: 130.0
      yaw: 90.0
      pitch: 0.0
    1:
      world: world
      x: 180.0
      y: 65.0
      z: 170.0
      yaw: -90.0
      pitch: 0.0

  seeker:
    0:
      world: world
      x: 150.0
      y: 65.0
      z: 150.0
      yaw: 180.0
      pitch: 0.0
Use in-game commands to set spawn points. Manual editing is not recommended.

Game Settings

settings:
  min-players: 4                  # Minimum players to start
  max-players: 20                 # Maximum players allowed
  game-duration: 300              # Game duration in seconds
  countdown-duration: 10          # Pre-game countdown
  lobby-countdown: 30             # Lobby countdown before game
  hiding-time: 15                 # Seeker delay time

Team Settings

settings:
  teams:
    auto-balance: true            # Auto-balance teams
    seeker-ratio: 4               # 1 seeker per 4 players
    seeker-priority:
      enabled: true               # Enable priority system
      permissions:
        - "vip.premium"           # Priority permissions
        - "vip.elite"
      priority-weight: 3.0        # Weight multiplier
Determines how many seekers are assigned based on player count.Examples:
  • Ratio 4: 8 players = 2 seekers, 12 players = 3 seekers
  • Ratio 5: 10 players = 2 seekers, 15 players = 3 seekers
Default: 4
Players with priority permissions are more likely to become seekers.priority-weight: Higher = more likely to be seekerExample: Weight 3.0 makes VIP players 3x more likely to be seeker.

Hider Settings

settings:
  hider:
    scale: 0.5                    # Player size (0.1-10.0)
    speed:
      enabled: true               # Enable speed effect
      amplifier: 1                # Speed level (0-255)
    invisibility:
      enabled: false              # Enable invisibility
      duration: 30                # Duration in seconds
Setting scale below 0.1 or above 3.0 may cause visual glitches.

Seeker Settings

settings:
  seeker:
    fireball:
      cooldown: 3                 # Seconds between shots
      speed: 1.5                  # Projectile speed
      damage: 4.0                 # Damage dealt
      fire-ticks: 100             # Fire duration (ticks)
      explosion-radius: 2.0       # Visual explosion size
      unlimited: true             # Unlimited ammo
    effects:
      night-vision:
        enabled: true             # Enable night vision

Spectator Settings

settings:
  spectator:
    enabled: true                 # Enable spectator mode
    fly: true                     # Allow flying

Customize GUI menus in plugins/NHideAndSeek/menus/.
menu-name:
  title: "&6Menu Title"           # Supports hex colors
  size: 54                        # Must be multiple of 9 (9-54)

  items:
    item-id:
      slot: 0                     # Inventory slot (0-53)
      material: "MATERIAL"
      custom-model-data: 0
      display-name: "&eItem Name"
      lore:
        - "&7Line 1"
        - "&7Line 2"
      glow: false
      item-flags:
        - "HIDE_ATTRIBUTES"

Filler Items

Fill empty slots with decorative panes.
menu-name:
  items:
    filler:
      enabled: true
      slots: [0, 1, 2, 3, 5, 6, 7, 8]  # List of slots
      material: "GRAY_STAINED_GLASS_PANE"
      display-name: " "           # Empty name
      lore: []                    # No lore

Best Practices

Backup Configs

Always backup configuration files before making changes

Test Changes

Test configuration changes on a test server first

YAML Validation

Use a YAML validator to check syntax errors

Reload Plugin

Use /has reload to apply changes without restart

Common Mistakes

YAML Indentation: Use 2 spaces, not tabs. Incorrect indentation breaks the config.
# ❌ Wrong (tabs)
settings:
	debug: false

# ✅ Correct (2 spaces)
settings:
  debug: false
Invalid Materials: Use exact Minecraft material names. Check Material List.

Troubleshooting

  • Check YAML syntax with a validator
  • Look for error messages in console
  • Delete config and regenerate with /has reload
  • Check file permissions
  • Verify material name is correct
  • Check custom-model-data matches resource pack
  • Ensure hex colors use # not &
  • Test item with /give command first
  • For MySQL: Check credentials and permissions
  • Verify database exists
  • Check if MySQL server is running
  • Test connection with MySQL client
  • Check firewall settings
  • Lower pool-size if using MySQL
  • Disable game-logging temporarily
  • Check debug is set to false
  • Monitor with /has performance command

Advanced Tips

Multi-Language Support

Add custom language files in plugins/NHideAndSeek/languages/:
# languages/custom_EN.yml
prefix: "&8[&6H&A&S&8]&r"
game:
  starting: "&aGame starts in &e%time%&a!"
  # ... more translations
Then set in config:
settings:
  lang: custom_EN

Performance Optimization

database:
  pool-size: 5                    # Lower for single server
  minimum-idle: 1

settings:
  log-batch-size: 100             # Higher = less frequent writes
  log-flush-interval: 30000       # 30 seconds

performance:
  alerts:
    alert-cooldown: 600           # 10 minutes between alerts

Need help? Join our Discord or open an issue on GitHub with your configuration questions!