Augments

💠 Augments

Augments are special powers that permanently enhance players during a game. They introduce variety and strategy — each player can build a unique playstyle through their chosen augments.

---

⭐ Features

• Permanent Powers: Grant ongoing effects that enhance a player’s abilities.

• Selection Process: Players choose 1 of 3 random augments when offered.

• Reroll Option: Players can reroll their augment choices if they don’t like them.

• Round Availability: Augments appear only on specific rounds (defined in Round Builder).

• Random Selection: If a player doesn’t pick an augment, one is chosen automatically.

• Custom Tiers: Default tiers are SILVER, GOLD, and PRISMATIC, but these can be customized.

---

🔧 Configuration

The main settings for Augments are located in game.yml under the roll.augments section.

# game.yml
roll:
  augments:
    base: 2
    high-stakes: 1
    choices: 3

Key	Type	Default	Description
base	integer	2	The base number of Augment rolls offered per game.
high-stakes	integer	1	Additional rolls offered if the "High Stakes" augment is active.
choices	integer	3	The number of random augments presented to the player to choose from.

The availability of augments is controlled through tier lists in the augments/ folder.

---

📁 Augment Files

The plugins/ArenaLegends/augments/ folder contains two types of files:

1. Definitions (augment-*.yml): Each file defines a single augment's properties, like its name, description, and effects.

2. Tier Lists (augments-*.yml): These files determine which augments are available for each tier (SILVER, GOLD, PRISMATIC).

Tier Lists

To control which augments can appear in the game, you must add their file names to the appropriate tier list.

Example from augments-prismatic.yml:

# A list of all PRISMATIC augments that can be rolled in-game.
# To disable one, simply remove it from this list.
augments:
  - "augment-alpha-and-omega.yml"
  - "augment-blade-waltz.yml"
  - "augment-celestial-body.yml"
  # ... and so on

If you create a new augment-*.yml file, you must add its filename to one of the tier lists (augments-silver.yml, augments-gold.yml, or augments-prismatic.yml), otherwise it will never appear in the game.

Augment Definition

Each individual augment-*.yml file contains the specific settings for that augment.

Parameter	Type	Description
enabled	boolean	Whether the augment is active. Must also be in a tier list to appear.
name	string	The display name of the augment.
color	hex	The color used in UI and displays (e.g., #f082fa).
tier	string	The augment’s tier — SILVER, GOLD, or PRISMATIC.
model	integer	Custom model data for the icon.
description	list	A list of lore lines shown in menus. Supports placeholders.

Example from augment-alpha-and-omega.yml:

general-settings:
  enabled: true
  name: "ᴀʟᴘʜᴀ ᴀɴᴅ ᴏᴍᴇɢᴀ"
  color: "#f082fa"
  tier: PRISMATIC
  model: 11201173
  description:
    - "&eRound start: &7Your {MOD_HEALTH} &7is set to 1."
    - ""
    - "&eDuring round: &7Gain {MOD_HEALTH} &7over time,"
    - "&7scaling infinitely. Taking damage puts"
    - "&7this effect on cooldown."

Combine augments with the Round Builder to control when each tier of augments can appear.