Content generated with AI — it may contain mistakes.

ExyliaClans/ReferenceUpdated in v1.5.0

Configuration

Where ExyliaClans keeps its files, how to reload them, and the settings owners change most: language, limits, bank currency, claims and DTR.

Page 19 of 2911 min read
      

Most settings can be changed from a menu, so you rarely need the file. Open this page when you want a file's location, a default, or every key of a block.

Where the files are#

Six files, all generated on first start from typed defaults, comments included. config.yml and wars.yml sit in plugins/ExyliaClans/; messages.yml, webhooks.yml, lfc.yml, lfp.yml and the menus sit in a language folder next to them:

plugins/ExyliaClans/
  config.yml
  wars.yml
  lang/es/messages.yml
  lang/es/webhooks.yml
  lang/es/lfc.yml
  lang/es/lfp.yml
  lang/es/menus/*.yml

A key the plugin does not recognise is removed on the next start instead of being ignored. Four blocks keep keys you write yourself: default-roles, levels.level-definitions, levels.kill-streak-bonuses and the categories block of each recruitment file.

Editing in game#

/clanadmin opens the clan list. Its Plugin ▸ Settings button (needs exyliaclans.admin) opens a hub with one card per theme: general, modules, teleports, claims, DTR, levels, rivals, mail and logs, clan wars (wars.yml) and recruitment (recruitment.yml). A page for a module that is switched off shows it as off.

Each page explains its values and shows the current one and its default. Click to edit (numbers and durations are typed); shift-right-click resets. A change is written to the file and applied like a reload. Anything not on a page (database, sounds, role lists) stays in the YAML.

Reloading#

Run /clanadmin reload. It re-reads all six files (the language files from the language now named), rebuilds the level table, starts or stops the modules whose switch changed, re-reads the recruitment categories, applies a changed visibility-mode to everybody online and recompiles the menus. Changes to default-roles only reach clans created afterwards.

language#

yaml
language: default

Which folder under plugins/ExyliaClans/lang/ the menus and messages are read from. default follows the language set in ExyliaLib's own config.yml, so one line there switches every Exylia plugin. en, es, pt, fr, ru or tr set this plugin alone. Each language is a complete folder you can edit.

English is the base the others are laid over, so a line not translated yet still arrives in English. Any other code you invent starts as English for you to rewrite. A changed language takes effect on /clanadmin reload. Colours, tags and message lists work as in Colours and Messages and languages; menus are edited as in Edit menus.

Servers that ran 1.1.0 keep their edits

On the first start of 1.2.0 the old messages.yml, lfc.yml, lfp.yml and menus/ move to lang/custom/, and config.yml is pointed at it with language: custom, so nothing a server edited is lost. Set language to default or a code to switch to the shipped translations.

Limits and waits#

The settings block holds the member, alliance and rival caps (30, 5 and 10 by default), the invite and create waits, the /clan home and /clan regroup warmups and the clan name rules (3 to 16 characters, letters, digits and _). A rank permission such as exyliaclans.members.<n> replaces the base number; see Permissions. The full table is below.

settings: every key
yaml
settings:
  max-members: 30
  max-alliances: 5
  max-rivals: 10
  invite-expire-seconds: 60
  invite-cooldown-seconds: 60
  create-cooldown-seconds: 120
  home-warmup-seconds: 5
  home-cancel-on-move: true
  home-cancel-on-damage: true
  home-warmup-tick-sound: "UI_BUTTON_CLICK|0.6|1.3"
  regroup-warmup-seconds: 5
  regroup-cancel-on-move: true
  regroup-cancel-on-damage: true
  regroup-warmup-tick-sound: "UI_BUTTON_CLICK|0.6|1.3"
  regroup-cooldown-seconds: 60
  regroup-expire-seconds: 60
  clan-name-min-length: 3
  clan-name-max-length: 16
  clan-name-regex: "^[a-zA-Z0-9_]+$"
  visibility-mode: DISABLED
  forced-ff-worlds: []
  chat:
    quick-clan-prefixes: ["."]
    quick-ally-prefixes: ["@"]
KeyDefaultWhat it does
max-members30Base member cap, before level bonuses. exyliaclans.members.<n> on the leader replaces it
max-alliances5Base alliance cap. exyliaclans.allies.<n> on the leader replaces it
max-rivals10Base rival cap. exyliaclans.rivals.<n> on the leader replaces it
invite-expire-seconds60How long a clan invite and an alliance request stand. 0 never expires
invite-cooldown-seconds60Per clan, before the same player can be invited again. 0 is off
create-cooldown-seconds120Per player, between creating two clans. 0 is off. exyliaclans.createcooldown.<n> replaces it
home-warmup-seconds5Countdown on /clan home. 0 is instant. exyliaclans.homewarmup.<n> replaces it
home-cancel-on-movetrueMoving cancels the warmup
home-cancel-on-damagetrueDamage cancels it
home-warmup-tick-soundUI_BUTTON_CLICK|0.6|1.3NAME|VOLUME|PITCH per second. Blank for silence
regroup-*as the home-* onesThe same four for /clan regroup join
regroup-cooldown-seconds60Per clan, between calls. 0 disables. exyliaclans.regroupcooldown.<n> on the leader replaces it
regroup-expire-seconds60How long a regroup point stays joinable. 0 never expires
clan-name-min-length3Shortest clan name
clan-name-max-length16Longest
clan-name-regex^[a-zA-Z0-9_]+$Pattern a name must match
visibility-modeDISABLEDDISABLED, CLAN_ONLY, ALLY_ONLY, CLAN_AND_ALLY_MIXED or UNIFIED, in any case. An unknown value is reported in the console and read as DISABLED. See Relations
forced-ff-worlds[]Worlds where friendly fire is always on
chat.quick-clan-prefixes["."]Prefixes that send one line to clan chat
chat.quick-ally-prefixes["@"]Prefixes that send one line to clan and allies

An invitation is checked against invite-expire-seconds every time it is read, so one past its time never lets anybody in. A sweep every thirty seconds deletes the expired rows and tells whoever is online: the invited player for an invite, the requesting clan for an alliance request. Invitations written before 1.2.0 carry no send time and count as sent at the update.

The <n> nodes are per-rank numbers: the highest wins for the caps, the lowest for the waits. The clan-wide ones are read off the leader while they are online; the value here applies the rest of the time.

bank-currency#

yaml
bank-currency: ""

The currency the clan bank holds and claims are paid in: any currency id from ExyliaLib's economy.yml, items and experience included. Empty is the default currency. Deposits, withdrawals, claim and reclaim prices, /clanadmin setbalance, the bank menu and the leaderboard all use it and write amounts the way that currency formats them.

Changing it does not convert balances

What a bank holds is a number. Switch bank-currency on a running server and every bank reads the same number in the new currency.

Modules#

The modules block is thirteen booleans, all true. Turn one off to stop its commands and menus. See Modules.

Claims#

The claims block sets prices, area limits and who protects the land. See Claims.

claims: every key
yaml
claims:
  base-price: 500.0
  price-per-block: 1.0
  min-area: 25
  max-area: 10000
  pillar-duration-seconds: 10
  min-separation: 5
  map-radius: 200
  reclaim-enabled: true
  reclaim-fee: 0.0
  protection-mode: WORLDGUARD

Network scope#

yaml
claims-scope: server
war-arenas-scope: default

Which servers of a shared database share claims and war arenas. Claims belong to a world name, so a claim made on one server must not protect a same-named world on another.

ValueShared by
defaultThe servers of this server's network group (network-group in ExyliaLib's config.yml); with no group, every server
globalEvery server on the database
serverOnly this server
a group nameThe servers of that group

claims-scope ships as server and war-arenas-scope as default. Switching keeps the existing rows: the new table starts from the old one. Database setup is in Database.

DTR#

The dtr block holds the raid-protection rules. See DTR.

dtr: every key
yaml
dtr:
  no-loss-worlds: []
  death-loss: 0.9
  members-per-point: 3
  frozen-duration-seconds: 600
  regen-amount: 0.1
  regen-interval-seconds: 45
  min-dtr: -1.0
  color-normal: "&a"
  color-regenerating: "&e"
  color-frozen: "&b"
  color-raidable: "&c"

Other blocks#

  • levels: max-level, exp-actions, level-definitions (with each level's modifiers perks) and kill-streak-bonuses. See Levels.
  • default-roles: the ranks a new clan is built with. See Roles.
  • relational-placeholders: the four colours one player is drawn with to another. The four labels live in messages.yml, under relations. See Placeholders.
  • bossbars: focus, camp and rally, each with enabled and a config of color and style; the two markers also take max-distance and duration-seconds. What each bar says is in messages.yml, under bossbars. See War tools.
  • kick-protection: enabled (true) gives a kicked player a truce, and duration-seconds (120) sets how long it lasts. The full rule is in Relations.
  • logs: max-entries-per-clan (200).
  • rivals: kill-exp-multiplier (2.0), kill-stat-multiplier (1.0) and notify-target-on-declare (true).
  • webhooks: enabled (true) lets clans connect a Discord webhook; off, the settings button disappears and every webhook command refuses. set-cooldown-seconds (30) and test-cooldown-seconds (10) are per clan; 0 turns each off. See Discord webhooks.
  • mail: expiry-days (14), expiry-check-interval-minutes (30), max-message-length (256), max-mails-per-clan (100) and send-cooldown-seconds (30, per player; 0 is off). See Chat and mail.
home-effects and regroup-effects

Two identical blocks, one per teleport, holding only how long each title stays:

yaml
home-effects:
  warmup-title:
    fade-in: 0
    stay: 10
    fade-out: 0
  teleport-title:
    fade-in: 10
    stay: 50
    fade-out: 15

Timings are ticks, twenty to a second. The words are in messages.yml, under teleport.home and teleport.regroup: warmup-actionbar, warmup-title, warmup-subtitle, arrival-title and arrival-subtitle. %time% is the seconds remaining.

The relational labels, the boss bar texts and the teleport titles used to live in config.yml. On the first start of 1.2.0 they are lifted out and written into messages.yml at their new keys, unless that file already says something there, so a server's own wording survives the move.

The other files#

  • wars.yml: team sizes, timers, the result broadcast and the commands allowed during a war. See Clan wars.
  • webhooks.yml: the in-game lines of the webhook feature (messages) and one Discord template per event (events). See Discord webhooks.
  • lfc.yml and lfp.yml: settings plus a categories block you write. See Recruitment.
  • messages.yml: every line the plugin can send; nothing player-facing is hardcoded. Details below.

Some lines show on the player's HUD instead of in chat, through the [hud:group] tag, and fall back to chat for players who cannot see it: clan.member-joined and clan.member-left (hud:members), clan.member-promoted and clan.member-demoted (hud:roles), clan.bank-deposited and clan.bank-withdrew (hud:bank) and level.level-up (hud:level). New in v1.5.0

messages.yml: sections and tricks

Eighteen sections under a prefix: clan, claim, errors, level, dtr, placeholders, logs, lfc, lfp, mail, admin, confirm, relations, bossbars, teleport, war, war-admin and style. It lives in lang/<language>/.

SectionWhat is in it
clanThe whole /clan surface: creation, invites, roles, bank, home, chat, the ten chat prompts
claimClaiming, unclaiming, the map, the claim tool's own name and lore
errorsEvery refusal, including module-disabled, kick-protection and role-name-invalid
levelLevel-ups, level-downs, EXP lines
dtrThe DTR display and the frozen, regenerating and raidable detail lines
placeholdersShort words the menus and the PlaceholderAPI layer substitute
logsThe five log line templates: with and without a target, detail, no detail, unknown actor
lfc, lfpThe recruitment boards on both sides
mailThe clan mailbox
adminEverything /clanadmin says
confirmThe wording of the shared confirmation screen
relationsThe four relational labels: member, ally, enemy, none
war, war-adminClan wars: the request, the fight, the result, and the arena and kit setup
bossbarsWhat the focus, camp and rally bars say
teleportThe countdown and arrival lines of home and regroup
styleThe lines of /clan style, which colours the clan name
  • Colours are palette tokens. {primary}, {error}, {highlight}, {success}, {warning}, {muted}, {info}, {letters}, so recolouring the server never means editing this file.
  • A line may open with an effect tag. [sound:ENTITY_VILLAGER_NO|1.0|1.0] plays a sound and never reaches the screen. Most shipped lines carry one.
  • %prefix% is substituted from the prefix key, and MiniMessage click and hover tags work.
  • A message can be a list of lines, and a line opening with [center] is centred in chat. The prompts that ask a player to act ship that way (clan invitation, alliance request, regroup call, new mail, expired LFC profile, new LFP application, the claim map running out) as a short centred block with a clickable button. A server that never edited those lines gets the new block on update; an edited one is kept.

The placeholders section holds short words that get substituted (Yes, No, Enabled, Online, the progress-bar characters), so sixty-five menu files do not each spell their own. Two of its keys are also read by the PlaceholderAPI layer: placeholders.none is what %exyliaclans_clan_name% and %exyliaclans_clan_role% answer for a player with no clan, and placeholders.na is what an empty roster slot or an unranked leaderboard position answers. See Placeholders.

Something missing on this page? Tell us on Discord