Effect File Structure

Effect File Structure

Each effect is defined in plugins/BeaconPlus/effects/filename.yml. This guide explains every top-level and nested key available.

Root Level

• Display Name: Name shown in GUIs.
• Description: General flavor text.
• Enabled: (Boolean)
• Item: Item Configuration for the effect's icon.
• Levels: (List) A collection of tiers for the effect.

---

Level Properties

Each entry in the Levels list can contain:

• Description: (String) Text for this tier specifically.
• Power Consumption: (Integer) Power required from the beacon to run this tier.
• Cost: (Map) Requirements to purchase this upgrade.
  • vault, experience, level, exp_gain or custom item names.
• Condition: (Map) Condition required for the effect to apply to an entity.
• Upgrade Condition: (Map) Condition required to purchase this level.
• Effects: (List) Built-in Effects applied at this level.
• Modes: (Optional Map) If defined, replaces the Effects list with multiple selectable modes.

---

Mode Properties

If a level uses Modes, it adds these keys:

• Max Active Modes: (Integer) How many modes a player can have active at once (Default: 1).
• Default Mode: (String) The ID of the mode enabled by default.
• Default Modes: (List) Multiple mode IDs enabled by default.
• Modes Map: Map of Mode ID: Mode Details.
  • Mode Details include: Description, Power Consumption, Condition, and Effects.

---

Best Practices

• ID Stability: The filename of the .yml becomes the Effect ID. Don't rename it unless you want to reset player progress.
• Legacy Compatibility: If you omit Modes, the Effects list is automatically wrapped into a single mode named default.
• Optimization: Use Condition blocks to prevent complex effects (like MAGNET) from checking every single entity if you only care about CREEPERS.