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

SettingDefaultDescription
glowtrueAqua outline around the player copy in previews and kill effects. Live emotes never glow
all-unlockedfalseWhen true, every player owns every cosmetic. Handy for testing
wall-materialBRICKSBlock used by the Build a Wall emote. Must exist as both a block and an item
prison-materialIRON_BARSBlock used for the posts of the Block Prison kill effect

Limits

SettingDefaultDescription
limits.max-active24Most emotes, previews and kill effects that can run at once, server wide
limits.max-kill-effects12Most kill effects that can run at once
limits.emote-cooldown4Seconds before a player can start another emote
limits.preview-cooldown2Seconds 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

SectionControls
soundsClick, preview, equip, unequip and locked sounds
labelsNames of the Emotes and Kill Effects categories
textsShared text, such as what shows when nothing is equipped
barThe collection progress bar
raritiesLabel and colour for Common, Rare, Epic and Legendary
messagesChat messages sent from the menus
hubThe main menu opened by /swag
menuThe Emotes and Kill Effects menus
overridesPer-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.

KeyDefaultPlays when
sounds.clickui.button.click 0.6 1.0A menu button is clicked
sounds.previewui.button.click 0.6 1.4A cosmetic is right-clicked to preview
sounds.equipentity.experience_orb.pickup 0.7 1.4A kill effect is equipped
sounds.unequipentity.experience_orb.pickup 0.7 0.8A kill effect is unequipped
sounds.lockedblock.note_block.bass 0.8 0.6A player clicks a cosmetic they don't own

Progress Bar

SettingDefaultDescription
bar.length20Number 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

SettingDefaultDescription
rarities.commonCommon, <gray>Label and colour for Common
rarities.rareRare, <aqua>Label and colour for Rare
rarities.epicEpic, <light_purple>Label and colour for Epic
rarities.legendaryLegendary, <gold>Label and colour for Legendary
Each rarity has a label and a color key. Menus list cosmetics from Common to Legendary.

Messages

KeyDefault
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.
SettingDefaultDescription
hub.title<dark_gray>SwagInventory title
hub.rows3Number of rows, 1 to 6
hub.fillerBLACK_STAINED_GLASS_PANETop and bottom rows
hub.side-fillerGRAY_STAINED_GLASS_PANEMiddle rows
hub.buttons.emoteslot 11The Emotes button
hub.buttons.killeffectslot 15The Kill Effects button
hub.buttons.infoslot 13Your collection summary
hub.buttons.stopslot 22Stop 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.

Cosmetic Menus

SettingDefaultDescription
menu.title<dark_gray>Swag » {type}Inventory title
menu.rows6Number of rows, 2 to 6
menu.fillerBLACK_STAINED_GLASS_PANETop and bottom rows
menu.side-fillerGRAY_STAINED_GLASS_PANELeft and right columns
menu.accentMAGENTA_STAINED_GLASS_PANEDecorative panes in the top row
menu.accent-slots[2, 4, 6]Slots the accent panes use
menu.grid28 slotsSlots where cosmetics are placed. Set fewer slots for smaller pages
menu.tabs.emoteslot 3The Emotes tab
menu.tabs.killeffectslot 5The Kill Effects tab
menu.filters.allAllFilter names: all, owned and locked
menu.buttonssee belowPrevious, next, back, filter, info, unequip, stop and empty
Column 1Column 2
ButtonDefault slotNotes
previous45Only shown when there is a previous page
next53Only shown when there is a next page
back46Returns to the main menu
filter48Cycles All, Owned and Locked
info49Progress bar and equipped kill effect
unequip50Only shown when a kill effect is equipped
stop50Only shown while an emote is playing
empty22Shown when the current filter has no results

Cosmetic Item

KeyDescription
menu.item.name-ownedName for a cosmetic the player owns
menu.item.name-lockedName for a locked cosmetic
menu.item.name-equippedName for the equipped kill effect
menu.item.status-owned, status-locked, status-equippedText used for {status}
menu.item.action-play, action-equip, action-unequip, action-lockedText used for {action}
menu.item.previewText used for {preview}
menu.item.kind.emote, kind.killeffectText used for {kind}
menu.item.wrapHow many characters per line the description wraps at
menu.item.glow-equippedGives the equipped kill effect an enchant glow
menu.item.loreThe lore lines, built from the placeholders below

Placeholders

PlaceholderReplaced 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.

KeyDescription
nameDisplay name
descriptionDescription text
iconAny Minecraft material
raritycommon, 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"