Skip to content

Configuration Reference

EssentialsLite reads plugins/EssentialsLite/config.yml. The shipped defaults below are from src/main/resources/config.yml; GUI files are loaded separately from gui/settings.yml, gui/rtp.yml, and menus.yml. YAML booleans, numbers, strings, and lists are significant. Durations explicitly named *-ticks use server ticks; *-seconds, *-ms, and cooldown use the units shown below.

Teleport And Homes

Path Type Default Effect
home.enabled boolean true Enables home commands.
home.cooldown number 1000 Home-use cooldown.
home.warmup number 5000 Home teleport warmup.
home.default-limit integer 1 Base home limit.
home.permissions.<key> integer map vip: 2, mvp: 3, elite: 4, legend: 5, god: 6 Highest matching essentials.home.limit.<key> sets the effective limit.
home.actionbar.enabled boolean true Shows home teleport action-bar feedback.
homeadmin.enabled boolean true Enables home administration.
warp.enabled boolean true Enables warp commands.
warp.cooldown number 1000 Warp-use cooldown.
warp.warmup number 3000 Warp teleport warmup.
warp.confirmation-menu.enabled boolean true Uses confirmation UI for warp teleports.
spawn.enabled boolean true Enables spawn.
spawn.cooldown number 1000 Spawn-use cooldown.
spawn.warmup number 5000 Spawn teleport warmup.
back.enabled boolean true Enables /back.
back.cooldown / back.warmup number 1000 / 5000 Back cooldown and warmup.
teleport.actionbar.enabled boolean false Teleport countdown action bar.
teleport.show-seconds.enabled / .time boolean / integer true / 5 Shows remaining seconds for the configured time.
teleport.effects-enabled / .effect boolean / string list true / WITCH_MAGIC, PORTAL_TRAVEL Applies teleport effects.
teleport.sounds-enabled / .sound boolean / string list true / ENDERMAN_TELEPORT, ENTITY_ENDERMAN_TELEPORT Plays teleport sounds.

TPA uses tpa.enabled: true, tpa.cooldown: 1000, tpa.warmup: 3000, and tpa.timeout-seconds: 60. tpa.actionbar.enabled defaults to false; tpa.worlds-enabled is an empty list (no configured world restriction). tpauto.enabled defaults to true and tpauto.default to false. tpahere.enabled defaults to true. tpaccept.confirmation-menu and tpa.confirmation-menu.send contain the same confirmation schema: enabled, rows, confirm-slot, deny-slot, player-slot, location-slot, flying-slot, background.{enabled,materials,damage,name}, and items.{confirm,deny,player,flying}.{materials,damage}. items.location additionally has overworld, nether, end, and custom material/damage entries.

home:
  enabled: true
  default-limit: 1
  permissions: { vip: 2, mvp: 3, elite: 4, legend: 5, god: 6 }
  cooldown: 1000
  warmup: 5000
rtp:
  enabled: true
  cooldown: 60000
  warmup: 5000
  worlds:
    world:
      enabled: true
      world-name: world
      min-distance: 500
      max-distance: 10000

RTP And RTP Duel

rtp.enabled defaults to true, with max-attempts: 5, default-world-key: world, cooldown: 60000, and warmup: 5000. rtp.hooks.factions and rtp.hooks.worldguard default to true. rtp.cooldowns.reduced and .admin are 30 and 15. The optional title has enabled: true, fade-in: 10, stay: 40, and fade-out: 10.

Each rtp.worlds.<key> is an object with enabled (boolean), world-name (string), display-name (string), lore (string list), material (string list), min-distance and max-distance (numbers). Shipped keys are world, world_nether, and world_the_end, all enabled, using world names world, world_nether, and world_the_end, and distances 500 to 10000.

RTP duel defaults: enabled: true, request-timeout-seconds: 30, request-cooldown-seconds: 60, warmup-ms: 5000, world-key: "", worlds: [world], random-world: true, and timeout-seconds: 600. location-search.max-attempts is 25; teleport.first-delay-ticks and .second-delay-ticks are 1 and 2. Queue defaults are enabled: true, match-interval-ticks: 20, and expire-seconds: 300. Arena defaults are size: 50, spawn-offset-blocks: 2, boundary-margin: 1.0, and push-strength: 0.45.

The duel display defaults to enabled, wall height 6, wall materials [RED_STAINED_GLASS, STAINED_GLASS, GLASS], wall data 14, inset 1, nearby radius 5, nearby Y radius 5, first/second show delays 5/20 ticks, and interaction-refresh: true. Sudden death is disabled; its defaults are after-seconds: 60, interval-ticks: 20, and damage: 1.0. Bets are enabled with min: 0.0 and max: 1000000.0. blocked-commands defaults to tpa, etpa, tpahere, etpahere, tpaccept, etpaccept, tpyes, and tpauto; an empty list disables command-label blocking.

rtp-duel:
  enabled: true
  worlds: [world]
  random-world: true
  queue: { enabled: true, match-interval-ticks: 20, expire-seconds: 300 }
  bets: { enabled: true, min: 0.0, max: 1000000.0 }
  blocked-commands: [tpa, etpa, tpahere, etpahere, tpaccept, etpaccept, tpyes, tpauto]

Economy, Leaderboard, Kits

economy.enabled is true; currency names are Coin and Coins, starting-balance: 0.0, min-payment: 0.01, max-payment: 1000000000.0, and save-interval-ticks: 200. economy.locks.make_money_zero defaults to true, making Vault balance getters return zero while an account is locally or remotely locked. MySQL sync is enabled by default with poll-interval-ticks: 1, lock-ttl-ms: 2000, and max-events-per-poll: 500. Separate storage mysql.enabled defaults to false, with url: jdbc:mysql://localhost:3306/db, username: root, and password: password.

baltop.enabled defaults to true, page-size: 10, cache-size: 100, refresh-interval-seconds: 60, and placeholder-limit: 10. Its header and entry formats are &6&lBaltop &7- Page &f%page% and &e%position%. &f%player% &7- &a%balance%; menu refresh cooldown is 5 seconds.

kit.enabled and all kit gates default to true: kitpreview, createkit, editkit, and deletekit. kit.menu.title is &e&lKits. Kit definitions are stored in the separate kit configuration managed by KitManager; this root file only controls the gate and menu title.

Chat And Utility Gates

Chat format defaults to enabled. chat-format.default is %luckperms_prefix%<gray>%player%<gray>:<white> %message%. Permission formats are owner priority 100, admin priority 90, and vip priority 10; each has priority (integer) and format (string). Chat channels default to enabled with default-channel: general; general is enabled and formats %player%: %message%, staff is enabled with permission essentials.staffchat, and proximity is disabled with radius 100.

The following root command gates default to true: unknown-command, enchant, afk, enderchest, realname, rename, craft, hat, broadcast, clear, clearchat, eback, setspawn, fly, gamemode, gms, gmc, gma, gmsp, message, god, menu, heal, kill, weather, feed, essentialslite, help, invsee, balance, pay, balancetop, sethome, delhome, top, world, tp, tphere, tpall, speed, helpop, exp, give, item, near, playtime, suicide, powertool, createwarp, channel, staffchat, disposal, anvil, and rtp. setwarp, deletewarp, tpahere, tpauto, and spawner also default to enabled. enchant.unsafe defaults to false; speed-limits.fly and .walk are 1.0.

Other gates/settings: repair.signs.enabled: true (storage folder repair_signs); lore.enabled: true, max-length: 100, max-lines: 20; chat-item.enabled: true, token [item], and configured hand formats; ignore.chat-filter: true, ignore.list-trim: 5; confirmation.enabled: true, timeout: 10, and commands [pay, clearinventory, suicide, die, delhome]; afk.enabled: true, auto-afk: true, time: 60, action bar enabled, kick disabled at 300, protection no-damage: true, and target protection disabled by default; workstations.enchanting.force-level-30.enabled: true, session timeout 300 seconds, costs 8/18/30.

unknown-command.enabled defaults to true; fallback_unknown_command is <red>Unknown command '<white>%command%<red>'. Please use <white>/help<red> to see a complete list. messages.prefix defaults to an empty string. nickname and realname are enabled, with nickname prefix ~; rename is enabled with visible length 32 and total raw length 64. auto-broadcast is disabled, interval 120, non-random, with its configured messages list. death-message.enabled is true and its died/killed strings use the documented victim/killer placeholders. spawner.enabled is true, mode WHITELIST, and list [PIG, SHEEP, COW, CHICKEN, ZOMBIE, SKELETON, SPIDER, CREEPER].

Spawn, Settings, Hostile Spawn

Spawn defaults to enabled, firework enabled, hide players false, first join enabled, join false, death true, respect bed false, warmup 5000, random teleport disabled with worlds [world], and sound enabled with self: false, empty permission, and the two configured dragon-growl sound names. Join/quit messages are enabled with cooldown 60; their default messages use %vault_group% and %player%. Titles are enabled with fade 10, duration 60, and configurable title.contents string-list entries.

night-vision defaults to enabled, personal default disabled, refresh interval 20 ticks, duration 600 seconds, and particles false. player-settings.defaults controls night-vision: false, death-messages, chat-messages, join-leave-messages, coinflip-messages, scoreboard, bossbar, accept-payments, tpa-requests (all true), auction-quick-buy: true, disable-hostile-mob-spawn: false, auto-pay: false. TAB commands are tab scoreboard %state% %player% -s and tab bossbar %state% %player% -s. Auction quick buy uses permission zelauction.fastbuy, Vault permission true, Bukkit attachment true.

Hostile spawn blocking is enabled, fallback view distance 10 chunks, padding 0, and an empty types list (built-in hostile types). Blocked reasons are NATURAL, REINFORCEMENTS, JOCKEY, MOUNT, PATROL, and RAID; SPAWNER is not included.

rtp-zones.hologram defaults to enabled, provider order [FancyHolograms, DecentHolograms], vertical offset 3.0, name format essentialslite_rtpzone_{zone_key}, and five configured lines. Its countdown is enabled with the shipped seconds list, message/actionbar/title all enabled, title fade/stay/fade-out 5/20/5, and enter message enabled. rtp-zones zone definitions themselves are stored in the separate rtp-zones.yml file.

GUI Files

gui/settings.yml defaults to title: %lang_key_gui.settings.title%, rows: 4, localized enabled/disabled status strings, and 15 item definitions: night_vision, death_messages, chat_messages, join_leave_messages, coinflip_messages, private_messages, scoreboard, bossbar, accept_payments, tpa_requests, tpa_auto, auction_quick_buy, disable_hostile_mob_spawn, and auto_pay. Each supports enabled (boolean), slot (integer), material (string list), display_name, display_name_fallback, lore, and lore_fallback (string/list). The setting effect is the matching player-settings.defaults setting and runtime player value.

gui/rtp.yml defaults to three rows, localized title and title_other, enabled black stained-glass background (material, damage: 15, display_name), and one item per RTP world key. Each item supports enabled, slot (auto or integer), material (string list), amount, damage, enchanted, localized/fallback display name and lore. Lore placeholders include %min_distance% and %max_distance%.

menus.yml is loaded from its menus section. Each menu has title, rows, and items; each item supports material (string or list), name, lore (list), slot, amount, damage, enchanted, permission, skull-owner, skull-texture, and command with sender (PLAYER or CONSOLE) and cmd (string or list). Viewer %player_name% is replaced before dispatch. The shipped main_menu has 6 rows and tools has 5 rows; item permissions gate visibility/use.

menus:
  example:
    title: "&bExample"
    rows: 3
    items:
      spawn:
        material: COMPASS
        name: "&bSpawn"
        lore: ["&7Teleport to spawn"]
        slot: 13
        permission: essentials.spawn
        command: { sender: PLAYER, cmd: "spawn" }

Source: src/main/resources/config.yml, src/main/resources/gui/settings.yml, src/main/resources/gui/rtp.yml, src/main/resources/menus.yml; loaders/accessors include ConfigManager, MenuLoader, SettingsMenuConfig, RtpMenuConfig, NightVisionConfig, SpawnManager, and RandomTeleportManager.