GitLab

Have you ever wished to make it so you could embed a gem into your items and give them special powers? Then Augments are just for you!

• What are Augments?
• Creating an Augment Type
• Adding Augments Slots To Items
  • Augments Slots of a single Type
  • Augments Slots of multiple Types
• Creating Augment Items
• Creating Augment Removers
• Unlocking Extra Slots

What are Augments?

The Augments feature allows you to:

• Create special "Augmentation" items that can be embedded in other items to give it special skills or modify stats
• Give your custom items specific Augmentation slots, so that only Augments of the same Type can be put in

Creating an Augment Type

Inside any pack folder you can have an augments.yml file. In there you can specify new Augment Types by using this syntax for each Augment:

GEM:
  Enabled: true
  Display: 'Gem'
  Formatting:
    Empty: '<augment.icon> Empty <augment.type> Slot'
    Filled: '<augment.icon> <augment.type>: <augment.tooltip>'
  Icons:
    Empty: '☆'
    Filled: '★'
    Invalid: ''

This configuration will create an Augment Type called GEM

Field	Description
Enabled	Whether the Augment Type is enabled
Display	The Display Name of the Augment Type
Formatting.Empty	The line to show on an item when its Augment Socket is empty
Formatting.Filled	The line to show on an item when its Augment Socket is full
Formatting.ShowEmptySlot	If false, {augments-each} will not list empty slots
Icons.Empty	What <augment.icon> will show when an item's Augment Socket is empty
Icons.Filled	What <augment.icon> will show when an item's Augment Socket is filled
Icons.Invalid	What <augment.icon> will show when an item's Augment Socket is invalid

Placeholder	Description
<augment.icon>	Placeholder that changes value based on whether the augment slot on an item is filled or not, as explained above
<augment.type>	The Display Name of the Augment Type (the Display field from above)
<augment.tooltip>	Specified on the Augment Item itself in Augmentation.Tooltip

Adding Augments Slots To Items

You can add Augments Slots via either of the following syntaxes

Augments Slots of a single Type

TestGemSlots:
  Material: NETHERITE_SWORD
  AugmentationSlots:
    Type: GEM           # The Augment Type to add a slot for
    Amount: 1to2        # How many Augments Slots should the items have
    Chance: 1           # The chance of the item being given these slots on generation
    MaxAmount: 3        # Max amount of augment slots this item can have. Defaults to infinity if left out

Augments Slots of multiple Types

TestMultiGemSlots:
  Material: NETHERITE_SWORD
  AugmentationSlots:
  - Type: RED_GEM
    Amount: 1
  - Type: GREEN_GEM
    Amount: 1
    Chance: 0.5
  - Type: BLUE_GEM
    Amount: 1
    Chance: 0.25
    MaxAmount: 2

Creating Augment Items

Finally, you can create the Augments themselves by using the following syntax

TestGem:
  Material: NETHERITE_SCRAP
  Display: '<red>Firey Gem'
  Model: 69420
  Augmentation:
    Type: GEM
    Tooltip: '<red>Fiery Gem <gray>(On Use: Shoot Fireballs)'  # Used in the <augments.tooltip> placeholder seen above. If removed, defaults to the display name of the item.
    Icon: ''  # Overrides the Type Filled Icon (Icons.Filled field inside augments.yml)
    ReplaceItemModel: thePathToYourItemModel # Can also be NONE
    ReplaceEquipModel: thePathToYourEquipModel # Can also be NONE
    ReplaceItemModelNamespace: mythic # The namespace for the item model
    Conditions:
    - day true
    Stats:
    - CRITICAL_STRIKE_CHANCE 0.05 ADDITIVE
    Skills:
    - fireball @targetlocation ~onUse

Creating Augment Removers

To remove augments from an item, an item can be created using the following syntax

GemRemover:
  Material: NETHERITE_SCRAP
  Display: '<aqua>Gem Remover'
  AugmentationRemover:
    Type: GEM             # The type of gem it should remove
    DestroySocket: false  # Should the augment slot be removed entirely?
    ReturnAugment: true   # Should the augment be returned to the player?

Unlocking Extra Slots

The following item can be used to unlock an extra augment slot on a different item:

GemSlotUnlocker:
  Material: NETHERITE_SCRAP
  Display: '<aqua>Gem Slot Unlocker'
  AugmentationSocket:
    Type: GEM              # Type of slot to unlock
    MaxSockets: 3          # Amount of available slots a target item can have. 

• If a GEM augment on an item has MaxAmount set to 2, the Gem Slot Unlocker will not be able to unlock a 3rd slot on that item.
• If that item has a MaxAmount of 5, this Gem Slot Unlocker cannot unlock the 4th and 5th slot on that item.