Sword Configuration

Each sword skin is its own YAML file inside swords/. The filename (without .yml) is the skin ID used everywhere else in the plugin.


Full Example

# swords/wooden-sword.yml

sword-item:
  material: WOODEN_SWORD
  custom-model-data: 0
  display-name: '&5[&d!&5] &dTycoon Sword'
  glow: false
  item-flags:
    - "HIDE_ATTRIBUTES"
    - "HIDE_ATTRIBUTE_MODIFIERS"
    - "HIDE_ADDITIONAL_TOOLTIP"
  lore:
    - '&8ᴅᴜɴɢᴇᴏɴ ꜱᴡᴏʀᴅ'
    - "&r"
    - "&dInformation:"
    - " &5→ &dSword Tier: &a%sword-tier% &8/ &c%sword-max-tier% &e%sword-symbol-progress%&7%sword-symbol-progress-left%"
    - " &5→ &dSword Damage: &c%sword-damage%&4❤"
    - "&r"
    - "&7&o(( Shift+Right-Click to upgrade! ))"

sword-upgrades:
  max-tier: 5
  tiers:
    1:
      sword-damage: 1
      upgrade-cost:
        currency: money
        amount: 330
    2:
      sword-damage: 3
      upgrade-cost:
        currency: money
        amount: 1100
    3:
      sword-damage: 8
      upgrade-cost:
        currency: money
        amount: 3500
    4:
      sword-damage: 21
      upgrade-cost:
        currency: money
        amount: 12250
    5:
      sword-damage: 58
      upgrade-cost:
        currency: money
        amount: 42880

sword-item

Key
Type
Description

material

string

Bukkit material name (e.g. WOODEN_SWORD, NETHERITE_SWORD).

custom-model-data

integer

Custom model data value for resource packs. Use 0 for none.

display-name

string

Item display name. Supports & colour codes and hex (#RRGGBB).

glow

boolean

If true the item gets an enchantment glow without an actual enchantment.

item-flags

list

Vanilla flags to hide from the tooltip. See below.

lore

list

Item lore lines. Supports colour codes, PAPI placeholders, lore-only replacements, and if(…) then … conditionals.

Item Flags

Flag
Effect

HIDE_ATTRIBUTES

Hides attribute modifiers (attack damage, speed).

HIDE_ATTRIBUTE_MODIFIERS

Same as above (newer API alias).

HIDE_ADDITIONAL_TOOLTIP

Hides the extra Minecraft tooltip (durability bar, etc.).

HIDE_ENCHANTS

Hides enchantment lines.

HIDE_UNBREAKABLE

Hides the "Unbreakable" tag.

Lore - Conditional Lines

Lines can be made conditional using:

The expression is evaluated with full PlaceholderAPI support. The line is only shown when the expression is truthy (non-zero / non-false).



Lore-Only Replacements

These tokens work only inside lore of a sword file. They are resolved when the item is built and cannot be used in menus or chat.

Token
Returns

%sword-tier%

Player's current tier for this sword (e.g. 3).

%sword-max-tier%

Max tier configured for this sword.

%sword-damage%

Formatted damage for the player's current tier.

%sword-symbol-progress%

The upgrade symbol repeated for each earned tier (e.g. ⭐⭐⭐).

%sword-symbol-progress-left%

The upgrade symbol repeated for each remaining tier (e.g. ⭐⭐).

The symbol character itself is set via sword-upgrade-symbol in sword.yml.

Full PlaceholderAPI placeholders also work in lore (e.g. %phantomdungeons_leveling_sword-level_level%).

Last updated