Configuration¶
Everything is configured in plugins/HCFCore/: config.yml for the server-wide settings, then one file per module. Every setting is commented in its file, and each page of this section shows the complete shipped file, comments included, with a summary of what matters.
The files are written on the first start and never overwritten afterwards.
Rules that hold everywhere¶
/hcf reloadapplies changes without a restart — every file below, andlang/en.yml. Onlykitmap-modeand thestoragesection ofconfig.ymlneed a restart — and adding, removing or renaming a command ofeffect-commands.yml.- A bad value never stops the server. A value that cannot be used — a number where true/false is expected, an unknown block name, a malformed time — is reported in the console and replaced by its default. A typo costs you that one setting.
- A setting missing from your file takes its built-in default. When a new version adds settings, your files keep working; compare them with the shipped ones to see what is new.
0usually means "no limit" for limits and caps — each file says so where it applies.- A
*-secondssetting is at most a hundred years (3153600000); a longer one is reported and capped. - Times of day (event schedules, refills, map phase dates, daily announcements) are read in the file's
time-zone. The default"system"follows the host's clock; write a zone such as"Europe/Paris"so moving hosts does not shift everything. - Colours use
&codes (&c,&l...) in every text a player sees.
YAML 1.1
In YAML, unquoted on, off, yes and no are booleans. Quote them if you mean the words.
The files¶
| File | Controls | Switch |
|---|---|---|
config.yml |
Language, game mode (kitmap-mode), storage (SQLite or MySQL, save interval) |
— |
theme.yml |
The look of everything: colours by role, the message prefix, the list symbol, small-capital titles, the menus' frame | — |
teams.yml |
Team names, size, co-leaders, invitation expiry, the role needed for each action, alliances, focus, rally, bank, the Team Points scale, KOTH caps | always on |
claims.yml |
Claim limits, placement rules, protection, HQ and base, /team hq and /team stuck countdowns, claimable worlds, roles for claiming, the warzone |
enabled |
dtr.yml |
Maximum DTR, loss per death, floor, regeneration, announcements | enabled |
pvp.yml |
Deathban and its tiers, combat tag, strength nerf, knockback, attack speed, safe zones, loot protection, friendly fire | enabled, and one per part |
classes.yml |
Classes: armour sets, warmup, passive, held and click effects, energy, archer tag, backstab, team limits | enabled |
effect-commands.yml |
/speed, /strength and your own: effect, level, aliases, permission |
enabled |
economy.yml |
Starting balance, ceiling, currency, /pay |
enabled |
events.yml |
KOTH and Citadel zones, Kill the King, Conquest, schedules, rewards, zone holograms | enabled |
resourcenodes.yml |
Mountains: regions, block palettes, refill times, protection, refill speed | enabled |
phases.yml |
SOTW length and date, EOTW date, the Purge | always on — nothing happens until one starts |
lives.yml |
Starting lives, using one at login, /lives send — HCF mode only |
enabled |
staff.yml |
Staff mode and its toolbar, vanish, staff chat, broadcast format, freeze, invsee, lastinv, tickets, strike offences | enabled, and one per part |
chat.yml |
Public chat format, kill count, local chat range, team chat logging | enabled (team chat works either way) |
ui.yml |
Scoreboard title, lines and refresh rate; tab list header and footer | scoreboard.enabled, tablist.enabled |
general.yml |
/spawn, /logout, /rename, private messages |
enabled |
kits.yml |
How kits are given, the layout editor, refill signs | enabled |
abilities.yml |
Partner items: the shared cooldown and where they are refused, every ability, the Pocket Bard | global.enabled |
killstreaks.yml |
Streak rewards | enabled |
enchants.yml |
Custom enchants | enabled |
limiters.yml |
Enchantment caps, potion caps, effect caps, blocks per claim | enabled |
schedule.yml |
Tips, daily announcements and commands, custom timers, key-all | enabled |
settings.yml |
Which settings players may switch, what /cobble drops |
enabled |
redeem.yml |
Wait after a failed code | enabled |
crowbar.yml |
Crowbar item, uses, cooldown, cost | enabled |
elevators.yml |
Elevator signs: their words, reach, cooldown, own land only, combat | enabled |
holograms.yml |
Leaderboard refresh | enabled |
apollo.yml |
Lunar Client waypoints, team view, cooldowns, nametags | enabled, and one per part |
Teams, player statistics and the map phases have no switch: the rest of the plugin is built on them.
Made in game, not in a file¶
Some things live in the database because they are made in game:
- kits —
/kit create; - redeem codes —
/redeemadmin; - holograms —
/hologram; - server land —
/team createsystem,/team forceclaim.
Shipped switched off or empty¶
On purpose — each is a decision about your server that the plugin does not make for you. Setting up a map, step 10 goes through them. The example events and Mountains run only when staff start them, until you give them times.
Messages¶
Every message is in lang/en.yml — see Messages and translation.