Skip to content

Configuration

eldor edited this page Nov 17, 2025 · 3 revisions

Configuration Reference

Complete reference for all configuration options in config.yml.

File Location

plugins/ChestLockLite/config.yml

Configuration Sections

Database Settings

database:
  filename: "locks.db"
  backup-interval: 24
  • filename: SQLite database file name (default: locks.db)
  • backup-interval: Auto-backup interval in hours (0 to disable, default: 24)

Lock Settings

locks:
  allow-locking: true
  allow-passwords: true
  max-password-length: 32
  min-password-length: 4
  password-cooldown: 3
  max-chests-per-player: 50
  allow-admin-unlock: true
  allow-trusted-players: true
  max-trusted-players-per-chest: 20
  auto-lock-on-place: false
  allow-hoppers: true
  allow-furnaces: true
  admin-notification: true
  • allow-locking: Enable/disable container locking (default: true)
  • allow-passwords: Enable/disable password protection (default: true)
  • max-password-length: Maximum password length (default: 32)
  • min-password-length: Minimum password length (default: 4)
  • password-cooldown: Cooldown in seconds between password attempts (default: 3)
  • max-chests-per-player: Maximum containers a player can own (default: 50)
  • allow-admin-unlock: Allow admins to unlock any container (default: true)
  • allow-trusted-players: Enable trusted players system (default: true)
  • max-trusted-players-per-chest: Maximum trusted players per container (default: 20)
  • auto-lock-on-place: Automatically lock containers when placed (default: false)
  • allow-hoppers: Enable/disable hopper locking (default: true) - v1.1.0+
  • allow-furnaces: Enable/disable furnace locking (default: true) - v1.1.0+
  • admin-notification: Show notifications to admins when opening locked containers (default: true) - v1.1.0+

Messages

All messages support color codes and placeholders:

messages:
  chest-locked: "&cThis {type} is locked!"
  lock-success: "&a{type} locked successfully!"
  unlock-success: "&a{type} unlocked successfully!"
  password-set: "&aPassword set successfully!"
  password-removed: "&aPassword removed successfully!"
  password-cooldown: "&cPlease wait {seconds} seconds before trying another password!"
  cannot-break-chest: "&cYou cannot break this {type}! It is locked by &e{owner}&c."
  # ... see config.yml for complete list

Placeholders:

  • {type} - Automatically replaced with container type (chest, barrel, hopper, furnace, etc.) - v1.1.0+
  • {owner} - Owner name
  • {seconds} - Cooldown seconds
  • {max} - Maximum value
  • {min} - Minimum value

Visual Settings

visual:
  show-particles: true
  particle-type: "VILLAGER_HAPPY"
  • show-particles: Show particles when chest is opened (default: true)
  • particle-type: Particle effect type (default: VILLAGER_HAPPY)
    • Common types: FLAME, HEART, VILLAGER_HAPPY, SMOKE, NOTE

Reloading Configuration

After editing config.yml:

  1. Stop your server
  2. Edit the file
  3. Start your server

Or use the admin command (requires chestlocklite.admin.reload):

/cl reload

Configuration Tips

  • password-cooldown: Set to 0 to disable cooldown (not recommended)
  • max-chests-per-player: Set to -1 for unlimited chests
  • backup-interval: Set to 0 to disable automatic backups
  • auto-lock-on-place: Useful for PvP servers where chests should be protected immediately

Default Values

If you delete or corrupt your config.yml, stop the server and delete the file. The plugin will regenerate it with default values on next start.

Advanced Configuration

For database optimization, see Database Management.

For permission configuration, see Permissions Guide.

Clone this wiki locally