CoreEngineWIKI
ESC
NavigateEnter OpenESC Close

Config Overview

Structure of CoreEngine's configuration files. Every file can be edited directly; for most changes, /coreengine reload is enough afterward instead of a server restart.

Main Configuration (config.yml) #

Location: plugins/CoreEngine/config.yml

This file only contains shared base settings. Feature-specific settings live in the individual files under plugins/CoreEngine/modules/.

Most important sections:

YAML
general:
  # Seconds until confirmations (e.g. shop purchases) expire
  confirmation-timeout: 30

economy:
  # Starting balance for new accounts
  start-balance: 1000.0
  # Currency name and symbol
  currency-name: "Coin"
  currency-name-plural: "Coins"
  currency-symbol: "⛃"
  # Limits and minimum amount
  max-balance: 1000000000.0
  min-transfer: 0.01
  # Entries per /baltop page
  baltop-entries-per-page: 10

cooldown:
  # Fallback cooldown for commands without their own value
  default: 0
  # Cooldowns for core commands (module cooldowns are in modules/*.yml)
  commands:
    pay: 1

cost:
  # Costs for core commands (0 = free)
  commands: {}

warmup:
  # Default wait time for all teleport commands
  default:
    duration: 3
    cancel-on-move: true
    display: actionbar
    particles:
      enabled: true
      type: PORTAL
      count: 10
      radius: 0.5
  # Warmups for core commands
  commands: {}

Module Configurations (modules/*.yml) #

Location: plugins/CoreEngine/modules/<module>.yml

Every module file can be turned on or off via enabled: true/false. Many modules additionally have their own cooldown, cost and warmup settings in the same format as in config.yml.

Module FileCategoryMost Important Settings
afk.ymlAFKAuto-AFK timeout, AFK kick time, broadcast, tab list decoration, anti-AFK machine detection
betterhud.ymlIntegrationBetterHud popup integration for economy and teams
chat.ymlChatChat format, display name, LuckPerms integration, Nexo glyphs, team/alliance chat
holograms.ymlHologramsView distance, line spacing, placeholder update rate, text shadow, background
homes.ymlHomesHome limit, name length, world blacklist, cooldown, cost, warmup
jobs.ymlJobsMax jobs, leveling, quests, boosts, dynamic pay, integrations, job shop, exploit protection
joinleave.ymlJoin/LeaveJoin/leave texts, MOTD, sounds, titles, action bar, vanish suppression
messaging.ymlMessagesFormats for private messages, maximum message length
mobteleport.ymlMob TeleportRadius, leash reattachment, invulnerability, entity filter, region protection
moderation.ymlModerationWarn actions, jail rules, CommandSpy blacklist, vanish
nick.ymlNicknamesNick length, colors, formatting
permissions.ymlCommand VisibilityTab completion only shows permitted commands, hides namespaced duplicates
rtp.ymlRandom TeleportRadius, height range, attempts, world border, biome, queue, claim protection, cost
shop.ymlChest ShopsShop limit, hopper protection, price limits, tax, sounds, integrations
sleep.ymlSleepSleep percentage, skip speed, AFK exclusion, world mode
spawn.ymlSpawnFirst spawn, respawn logic, cooldown, cost, warmup
stations.ymlStationsVirtual workstation commands, hub menu
tab.ymlTab ListTab name, LuckPerms integration, Nexo glyphs, optional fixed tab layout
team.ymlTeamsLimits, ranks, team level, score, bank, menu, CoreProtect logging
teleport.ymlTeleportSafety check, combat lock, back positions, cooldown, cost, warmup
tpa.ymlTPARequest timeout, distance limit, cross-dimension, cooldown, cost, warmup
utility.ymlUtilityGod persistence, near radius, toggleable utility commands, cost/cooldowns
warps.ymlWarpsName length, cooldown, cost, warmup
websession.ymlWeb InterfaceConfiguration of the web interface for /cweb
world.ymlWorldGamerule menu, custom gamerule presets
worldspawn.ymlWorld SpawnToggle for /setworldspawn

Common Structure of All Modules #

YAML
enabled: true  # Enables/disables the entire module

# Command-specific cooldowns (seconds, 0 = disabled)
cooldown:
  commands:
    home: 5
    warp: 3

# Command-specific costs (economy, 0 = free)
cost:
  commands:
    home: 0
    rtp: 100.0

# Command-specific warmups (wait time before action/teleport)
warmup:
  commands:
    home:
      duration: 2
      cancel-on-move: true
      display: actionbar
      particles:
        enabled: true
        type: PORTAL
ℹ️

Note: Bypass permissions can be used to bypass these restrictions: cooldown.bypass.<command>, cost.bypass.<command> and warmup.bypass.<command> (or .* for all commands of a module).

Messages (messages.yml) #

Location: plugins/CoreEngine/messages.yml

All texts that players see are stored here centrally in MiniMessage format (colors like <red>, <bold>, <blue> etc.) and can be freely customized.

💡

Tip: After changes to messages.yml, /coreengine reload is enough; a restart is not necessary.

Jobs: Custom Definition Files #

Jobs are a special case: in addition to modules/jobs.yml (general job settings), each job has its own file under modules/jobs/, for example miner.yml or farmer.yml.

YAML
name: "Miner"
color: "<#FFB400>"           # Hex color
short-name: "MIN"
icon: "DIAMOND_PICKAXE"
description: "Mine ores for profit"
max-level: 100
actions:
  BREAK:
    DIAMOND_ORE:
      money: 10.0
      xp: 5.0
    COAL_ORE:
      money: 2.0
      xp: 1.0
titles:
  "1": "Novice Miner"
  "25": "Expert Miner"
level-up-rewards:
  "10": "give <player> diamond 5"

modules/jobs.yml controls the general settings:

YAML
enabled: true
jobs:
  max-jobs: 2              # Max. simultaneously active jobs per player
  leveling:
    max-level: 100
    xp-per-level: 100.0
  quests:
    enabled: true
    daily-reset: "00:00"
  boosts:
    enabled: true
  dynamic-pay:
    enabled: true
    player-count-multiplier: 0.5
  shop:
    enabled: true