Content generated with AI — it may contain mistakes.

ExyliaClans/Getting startedUpdated in v1.4.0

Install ExyliaClans

What to drop in, what to check on the first start, and the files and tables it creates.

Page 2 of 296 min read

In about ten minutes you go from the jar to a server where players can create clans, fund a bank and claim land.

Before you start#

  • Paper 1.21.1 or newer (Folia 1.21.4 or newer) on Java 21, with ExyliaLib installed.
  • An economy plugin if clans should pay for land. WorldGuard is optional: without it, use the built-in protection.

Steps#

Drop in the jars

ExyliaClans.jar, plus ExyliaLib, into plugins/ (add packetevents for the packet-drawn extras; it is optional).

Add an economy plugin

The bank pays for claims and is read through ExyliaLib's economy bridge, in the currency bank-currency names (empty is the default currency). Without one, /clan deposit and /clan withdraw refuse and no claim can ever be bought. ExyliaEconomy is a soft dependency, so its currencies are ready before ExyliaClans enables.

Decide who protects the land

claims.protection-mode ships as WORLDGUARD. If WorldGuard is not installed, set it to BUILTIN before anybody claims anything — see Claims.

Start the server

It writes six config files and sixty-five menu files, and creates nineteen tables. The menus and messages come in English, Spanish, Portuguese, French, Russian and Turkish; language: default follows ExyliaLib's.

Check the permissions

Every /clan node defaults to true, so players can use the plugin at once and their clan rank decides the rest. /clanadmin defaults to operators. See Permissions.

Check that it works#

Run /clan create Test in game. You should get a clan and the clan menu opens with /clan. Then follow Your first clan.

Files#

Config and language files
FileContents
config.ymllanguage, limits, warmups, the thirteen module switches, claims, DTR, levels, boss bars, webhooks and default-roles.
wars.ymlClan wars: team sizes, timers and the commands allowed in a war.
lang/<language>/messages.ymlEvery line the plugin sends, in seventeen sections.
lang/<language>/webhooks.ymlWhat a clan's Discord webhook posts, event by event, and the in-game lines around it.
lang/<language>/lfc.ymlLooking-for-clan: cooldowns, expiry, and the questions a player answers.
lang/<language>/lfp.ymlLooking-for-players: cooldowns, expiry, text limits, application limits, and what a clan may ask for.
lang/<language>/menus/*.ymlSixty-five screens, the twenty-two /clanadmin ones under menus/admin/.
database.ymlWritten by ExyliaLib. H2 by default; MySQL, MariaDB, PostgreSQL and MongoDB are the other engines, with a redis block alongside them that links several servers.

<language> is what language in config.yml resolves to — see Configuration.

The YAML is generated, not shipped

config.yml, wars.yml, messages.yml, webhooks.yml, lfc.yml and lfp.yml are written from typed records on first start, comments included. A key the reader does not recognise is pruned — except inside default-roles, levels.level-definitions, levels.kill-streak-bonuses and the two categories blocks, which belong to you and are never touched.

Tables#

Database tables
TableHolds
clansOne row per clan: name, leader, balance, open, friendly fire, home, banned list, DTR, EXP.
clan_membersOne row per player. The player's UUID is the key, so a player is in one clan by construction.
clan_rolesEvery rank of every clan, with its weight and its comma-separated permissions.
clan_relationsDirectional. Two rows make a mutual alliance; one row makes a rivalry.
clan_invitesStanding invitations, keyed playerUuid:clanId, with when they were sent.
clan_alliance_requestsPending alliance requests, keyed requestingClanId:targetClanId.
clan_claimsOne rectangle per clan: world, minX, minZ, maxX, maxZ and the height it was made at.
clan_statsKills, deaths and playtime per clan.
clan_player_statsThe same per player per clan, keyed playerUuid:clanId. Formerly player_stats; the old table is read and renamed on first start.
clan_logsThe audit trail, indexed by clan and timestamp descending.
clan_mailsThe mailbox, with read/deleted tracked per member as UUID lists.
clan_webhooksOne Discord webhook per clan, kept apart from clans because its URL is a secret.
lfc_profilesOne row per player advertising themselves.
lfp_postingsOne row per clan advertising for members.
lfp_applicationsApplications, keyed playerUuid:clanId.

Optional integrations#

Optional plugins and what they change
PluginWhat it changes
PlaceholderAPIRegisters the exyliaclans expansion, relational placeholders included.
WorldGuardBecomes the claim enforcer under protection-mode: WORLDGUARD, and blocks claiming over an existing region.
TABIts team handling is paused for a player while this plugin is colouring them, and resumed when they leave a clan.
EconomyThe bank, in the currency bank-currency names. ExyliaEconomy is a soft dependency so it loads first.
Apollo / FeatherServerAPIClient waypoints for the clan home and for camp and rally markers.
SurvivalCore clientRead through ExyliaLib, nothing to install on the server: a native rally, home and camp icons on the map, Clan and Allies chat tabs, team panels with the clan's name and ranks, and two keybinds.
RedisSet in database.yml on every server sharing the database, and the servers act as one clan system. See Database.

The first start#

Read the console. Three things are reported there and nowhere else:

  • Config issues. A key that could not be read is named, once, with what was wrong with it.
  • default-roles is empty. If you emptied that block, /clan create refuses rather than making a clan whose leader has no rank. Nothing is written back into the file.
  • DTR backfill. On the first start after enabling the DTR module, every existing clan sitting at 0.0 is given its maximum, and the count is logged.

Updating#

Replace the jar and restart. /clanadmin reload re-reads the six config files, rebuilds the level table, starts or stops modules and recompiles every menu. /exylialib reload also recompiles the menus, so a palette change made through the library is picked up without a restart.

A new key a release adds to a menu reaches your file at once; a changed default waits in /exylialib updates for you to apply or keep; anything you changed is never touched. See Menus.

Coming from 1.1.0

The first start of 1.2.0 moves your edited messages.yml, lfc.yml, lfp.yml and menus/ into lang/custom/ and sets language: custom, moves the text that used to sit in config.yml into messages.yml, and grants every existing rank FOCUS, CAMP and RALLY. Nothing to do by hand.

Reload does not rewrite existing clans

Changing default-roles only affects clans created afterwards. Clans that already exist keep the ranks they were made with, because those ranks are rows in clan_roles that the clan has since edited.

Something missing on this page? Tell us on Discord