NexusSwag has two config files, both generated automatically on first launch. config.yml holds the general settings and limits, and gui.yml controls every menu (see the GUI Configuration page). Which cosmetics each player owns, and their equipped kill effect, are saved in data.yml.
General Settings
| Setting | Default | Description |
|---|
glow | true | Aqua outline around the player copy in previews and kill effects. Live emotes never glow |
all-unlocked | false | When true, every player owns every cosmetic. Handy for testing |
wall-material | BRICKS | Block used by the Build a Wall emote. Must exist as both a block and an item |
prison-material | IRON_BARS | Block used for the posts of the Block Prison kill effect |
Limits
| Setting | Default | Description |
|---|
limits.max-active | 24 | Most emotes, previews and kill effects that can run at once, server wide |
limits.max-kill-effects | 12 | Most kill effects that can run at once |
limits.emote-cooldown | 4 | Seconds before a player can start another emote |
limits.preview-cooldown | 2 | Seconds between previews |
Lower the limits if your server has a lot of players fighting at once. When a limit is reached, new effects are skipped instead of lagging the server.
Default Config File
glow: true
all-unlocked: false
wall-material: BRICKS
prison-material: IRON_BARS
limits:
max-active: 24
max-kill-effects: 12
emote-cooldown: 4
preview-cooldown: 2
Run /swag reload after editing either file. No restart is needed.
GUI Configuration
Every menu is built from gui.yml. Titles, rows, slots, icons, names, lore, sounds, messages, rarity colours and the progress bar can all be changed. Any key you delete falls back to its default, so you only need to keep the settings you want to change. Text uses MiniMessage formatting, for example <gold>, <b> and <gray>.
Sections
| Section | Controls |
|---|
sounds | Click, preview, equip, unequip and locked sounds |
labels | Names of the Emotes and Kill Effects categories |
texts | Shared text, such as what shows when nothing is equipped |
bar | The collection progress bar |
rarities | Label and colour for Common, Rare, Epic and Legendary |
messages | Chat messages sent from the menus |
hub | The main menu opened by /swag |
menu | The Emotes and Kill Effects menus |
overrides | Per-cosmetic name, description, icon and rarity |
Sounds
Each sound is written as a vanilla sound key, then a volume, then a pitch. Set a sound to none to turn it off.
| Key | Default | Plays when |
|---|
sounds.click | ui.button.click 0.6 1.0 | A menu button is clicked |
sounds.preview | ui.button.click 0.6 1.4 | A cosmetic is right-clicked to preview |
sounds.equip | entity.experience_orb.pickup 0.7 1.4 | A kill effect is equipped |
sounds.unequip | entity.experience_orb.pickup 0.7 0.8 | A kill effect is unequipped |
sounds.locked | block.note_block.bass 0.8 0.6 | A player clicks a cosmetic they don't own |
Progress Bar
| Setting | Default | Description |
|---|
bar.length | 20 | Number of characters in the bar |
bar.char | ` | ` | Character the bar is drawn with |
bar.filled | <green> | Colour of the filled part |
bar.empty | <dark_gray> | Colour of the empty part |
bar.format | {bar} <gray>{done}/{total} | Layout of the bar line |
Rarities
| Setting | Default | Description |
|---|
rarities.common | Common, <gray> | Label and colour for Common |
rarities.rare | Rare, <aqua> | Label and colour for Rare |
rarities.epic | Epic, <light_purple> | Label and colour for Epic |
rarities.legendary | Legendary, <gold> | Label and colour for Legendary |
Each rarity has a label and a color key. Menus list cosmetics from Common to Legendary.
Messages
| Key | Default |
|---|
messages.not-owned | <red>You don't own <white>{name}<red> yet. |
messages.equipped | <green>Equipped <white>{name}<green>. |
messages.unequipped | <gray>Unequipped <white>{name}<gray>. |
messages.kill-effect-removed | <gray>Kill effect unequipped. |
Main Menu
| Setting | Default | Description |
|---|
hub.title | <dark_gray>Swag | Inventory title |
hub.rows | 3 | Number of rows, 1 to 6 |
hub.filler | BLACK_STAINED_GLASS_PANE | Top and bottom rows |
hub.side-filler | GRAY_STAINED_GLASS_PANE | Middle rows |
hub.buttons.emote | slot 11 | The Emotes button |
hub.buttons.killeffect | slot 15 | The Kill Effects button |
hub.buttons.info | slot 13 | Your collection summary |
hub.buttons.stop | slot 22 | Stop emote, only shown while an emote is playing |
Every button has the same keys: slot, material, name, lore and an optional glow. Set a button's slot to -1 to hide it.
| Setting | Default | Description |
|---|
menu.title | <dark_gray>Swag » {type} | Inventory title |
menu.rows | 6 | Number of rows, 2 to 6 |
menu.filler | BLACK_STAINED_GLASS_PANE | Top and bottom rows |
menu.side-filler | GRAY_STAINED_GLASS_PANE | Left and right columns |
menu.accent | MAGENTA_STAINED_GLASS_PANE | Decorative panes in the top row |
menu.accent-slots | [2, 4, 6] | Slots the accent panes use |
menu.grid | 28 slots | Slots where cosmetics are placed. Set fewer slots for smaller pages |
menu.tabs.emote | slot 3 | The Emotes tab |
menu.tabs.killeffect | slot 5 | The Kill Effects tab |
menu.filters.all | All | Filter names: all, owned and locked |
menu.buttons | see below | Previous, next, back, filter, info, unequip, stop and empty |
| Column 1 | Column 2 |
|---|
| Button | Default slot | Notes |
previous | 45 | Only shown when there is a previous page |
next | 53 | Only shown when there is a next page |
back | 46 | Returns to the main menu |
filter | 48 | Cycles All, Owned and Locked |
info | 49 | Progress bar and equipped kill effect |
unequip | 50 | Only shown when a kill effect is equipped |
stop | 50 | Only shown while an emote is playing |
empty | 22 | Shown when the current filter has no results |
Cosmetic Item
| Key | Description |
|---|
menu.item.name-owned | Name for a cosmetic the player owns |
menu.item.name-locked | Name for a locked cosmetic |
menu.item.name-equipped | Name for the equipped kill effect |
menu.item.status-owned, status-locked, status-equipped | Text used for {status} |
menu.item.action-play, action-equip, action-unequip, action-locked | Text used for {action} |
menu.item.preview | Text used for {preview} |
menu.item.kind.emote, kind.killeffect | Text used for {kind} |
menu.item.wrap | How many characters per line the description wraps at |
menu.item.glow-equipped | Gives the equipped kill effect an enchant glow |
menu.item.lore | The lore lines, built from the placeholders below |
Placeholders
| Placeholder | Replaced With |
|---|
{name} | Cosmetic name |
{desc} | Description, wrapped across lines |
{rarity} | Rarity label |
{rarity_upper} | Rarity label in capitals |
{rarity_color} | Rarity colour tag |
{kind} | Emote or Kill effect |
{length} | How long it plays, in seconds |
{status} | Owned, Locked or Equipped |
{action} | What left-clicking does |
{preview} | The right-click preview hint |
{bar} | Collection progress bar |
{owned} and {total} | Cosmetics owned and available |
{equipped} | Name of the equipped kill effect |
{page} and {pages} | Page numbers on the page buttons |
{filter} | Current filter name |
{label} | Category name on the tabs |
{type} | Category name in the menu title |
Overrides
Use overrides to change how a single cosmetic looks in the menus. Every key is optional. This only changes what the menu shows, not how the cosmetic plays.
| Key | Description |
|---|
name | Display name |
description | Description text |
icon | Any Minecraft material |
rarity | common, rare, epic or legendary |
overrides:
emote:
guitar:
name: "Shred"
description: "Rip a solo on a big red guitar."
icon: GOLDEN_AXE
rarity: legendary
killeffect:
shark:
name: "Jaws"