|
|
|
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!
|
|
|
|
|
|
|
|
[[_TOC_]]
|
|
|
|
|
|
|
|
## 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
|
|
|
|
|
|
|
|
<img src="https://git.lumine.io/mythiccraft/mythiccrucible/-/wikis/uploads/9bd4350803c5e63b7e1dc3669472a646/augments.gif" alt="Augments in action" width="50%">
|
|
|
|
|
|
|
|
## Creating an Augment Type
|
|
|
|
Inside any [pack](/../../../MythicMobs/-/wikis/Packs) folder you can have an `augments.yml` file. In there you can specify new Augment Types by using this syntax for each Augment:
|
|
|
|
```yaml
|
|
|
|
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 |
|
|
|
|
| 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
|
|
|
|
```yaml
|
|
|
|
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
|
|
|
|
```
|
|
|
|
#### Augments Slots of multiple Types
|
|
|
|
```yaml
|
|
|
|
TestMultiGemSlots:
|
|
|
|
Material: NETHERITE_SWORD
|
|
|
|
AugmentationSlots:
|
|
|
|
- Type: RED_GEM
|
|
|
|
Amount: 1
|
|
|
|
- Type: GREEN_GEM
|
|
|
|
Amount: 1
|
|
|
|
- Type: BLUE_GEM
|
|
|
|
Amount: 1
|
|
|
|
```
|
|
|
|
|
|
|
|
## Creating Augment Items
|
|
|
|
Finally, you can create the Augments themselves by using the following syntax
|
|
|
|
```yaml
|
|
|
|
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
|
|
|
|
Icon: '' # Overrides the Type Filled Icon (Icons.Filled field inside augments.yml)
|
|
|
|
Stats:
|
|
|
|
- CRITICAL_STRIKE_CHANCE 0.05 ADDITIVE
|
|
|
|
Skills:
|
|
|
|
- fireball @targetlocation ~onUse
|
|
|
|
``` |
|
|
|
\ No newline at end of file |
