Configuration
Every setting in config.yml, shields.yml and messages.yml, with its default.
Every file lives in plugins/ExyliaShields/. Run /shieldsadmin reload after a change.
config.yml#
language: default
force_system: true
disabled-worlds: []
ui:
default_dye_color: "PURPLE"
preview:
enabled_material: "LIME_DYE"
disabled_material: "GRAY_DYE"
showcase:
locations: []
pause-seconds: 3.0
radius: 24.0
only: []
menu:
style: CLASSIC| Key | Default | What it does |
|---|---|---|
language | default | Which folder under lang/ the menus and messages are read from. See below. |
force_system | true | Only players with exyliashields.use may have designs on their shields. |
disabled-worlds | [] | Worlds where designs are not drawn: a held shield shows plain there and gets its design back on leaving. Names match ignoring case. |
ui.default_dye_color | PURPLE | The colour selected when the editor opens. |
ui.preview.* | see above | The item of the preview toggle, on and off. Its text is in messages.yml. |
showcase | see above | Places that show the community's designs off on a loop. See The community library. |
menu.style | CLASSIC | What /shields opens: the inventory menus, or SPATIAL for the 3D shield picker. |
crate and shop are on The crate and the shop.
/shieldsadmin settings, or the settings button of the /shieldsadmin hub, opens a settings hub with a card for
General (permission-only designs, disabled worlds, menu style, default dye, language) and Crate and shop (switches,
starting keys, duplicate refund, reward, crates at once), and shields.yml's patterns and colours with it. The same catalogue is also
editable from ExyliaLib's web editor. Either way, a change that would
lose an entry — a pattern or colour the server does not know, or a file left with none — is refused
whole, and an applied one reloads the catalogue, prices, crate and open menus at once.
language#
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:
plugins/ExyliaShields/
config.yml
shields.yml
lang/es/messages.yml
lang/es/menus/*.ymlEnglish is the base the others are laid over, so a line not translated yet still arrives in English.
A changed language takes effect on /shieldsadmin reload.
On the first start of 1.2.0 the old messages.yml and menus/ move to lang/custom/, the preview
labels and the import prompt config.yml used to hold move into lang/custom/messages.yml, 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.
With it on, a player without exyliashields.use has their shield design removed whenever they
equip a shield. That is the point — it is how an expired rank stops showing a design it no longer
owns. Everybody holds the node by default, so it only bites a group it is denied to.
shields.yml#
max_layers: 6
shield_patterns:
stripe_bottom:
name: "Base Stripe"
item:
material: WHITE_BANNER
banner_patterns:
base_color: WHITE
patterns:
- pattern: STRIPE_BOTTOM
color: LIGHT_GRAY
shield_colors:
white:
name: "White"
item: WHITE_BANNERmax_layers caps how deep a design may go, for a player without an exyliashields.layers.<n> node. Each pattern names the vanilla pattern it applies and the
banner it is drawn as in the menu; each colour names its display name and icon.
The keys are the permission ids: stripe_bottom is exyliashields.pattern.stripe_bottom. Each entry
also names a tier (its crate rarity) and may set a price for the shop — see
The crate and the shop.
ownership#
ownership:
scope: global
global-currencies: []Where what a player unlocks here counts: global (every server, the default), server, default (this server's network group) or a group name. What was unlocked globally always counts. global-currencies lists currencies whose purchases count on every server whatever the scope. Restart to apply. New in v1.6.0
messages.yml#
Every line the plugin sends, and every word a menu draws, in lang/<code>/messages.yml. prefix is
{primary}&lSHIELDS {letters_black}•<reset>.
| Key | What it is |
|---|---|
slot_applied | Sent when a slot becomes the worn design. %slot% is its number. |
no_access | Sent when a player's rank lacks the feature node a click or command needs. |
admin_moved | Told to staff who typed a staff command the old way, /shields <command>; %command% is the new spelling. |
ui | Words drawn inside menus: the click hint, no_permission, the active and inactive slot lines, the colour picker's two names, unknown_owner, how a pattern and a colour are described on the crate reels, and the preview button's preview_enabled / preview_disabled. |
import | no_slots_available, design_not_found, success, and prompt, what a player is asked when importing without naming an id. |
showcase | The showcase subcommands' answers, and designer, the line floating above a showcased design. |
crate | What the crate says as it opens and pays out: won, duplicate, no-keys, busy, empty, disabled, keys-received, rewards-claimed. |
key_item | The crate key item's name and lore. |
crate_commands | The keys, unlocks and crate block subcommands' answers. |
designer, wardrobe | Every word the 3D designer and picker draw, and the /shieldsadmin spatial answers. |
What the shop's confirmation and purchase answers say is ExyliaLib's own, under purchase in
ExyliaLib's messages.yml.
Something missing on this page? Tell us on Discord