Config yml

Configuration Guide: config.yml

The config.yml file handles the global settings for BeaconPlus. This is where you configure your economy, manage world names, and set up menu animations.

---

1. Basic Settings

Default Language

Sets the fallback language for players who haven't selected one yet.

• Tip: Players can change their own language in the Beacon Settings GUI.
• How to use: Use the file codes found in the plugins/BeaconPlus/languages/ folder (e.g., en_us).

World Aliases

Gives your worlds nice, human-readable names in menus.

• Why use this?: By default, placeholders like {world} show the raw folder name (e.g., world_nether). Aliases let you display "The Underworld" instead.
• YAML Example:

  World Alias:
    world: "Overworld"
    world_the_end: "The End"
    prison_spawn_A: "Sector A"

---

2. Connecting Your Economy

BeaconPlus lets you decide exactly what currency users pay with. You can mix and match different economy types for different upgrades.

Global Options

• Currency: The symbol (e.g., $) or text (e.g., Coins) shown in menus.
• Display Name: The label used in the "Upgrade Cost" description.
• Format: How the price looks (e.g., Cost: {amount} {economy_currency}).

Supported Providers

1. Vault (Standard Money):
   • Uses your server's main economy (requires Vault + EssentialsX/CMI).
   • Note: Automatically disabled if no economy plugin is found.
2. PlayerPoints:
   • Uses the PlayerPoints plugin for premium currency.
3. Level & Exp:
   • Level: Costs usage Vanilla Experience Levels (e.g., 30 Levels).
   • Exp: Costs raw Experience Points.
4. Item (Material-based):
   • Players pay with physical items from their inventory.
   • YAML Example (Custom Emerald Currency):

     Item:
       Emerald:
         Currency: "Emerald(s)"
         Display Name: "&aEmeralds"
         Format: "{amount}x {economy_currency}"
         Item:
           type: EMERALD

---

3. Upgrading from Version 2

If you are updating from an older version of BeaconPlus, follow these steps to move your data safely.

The Conversion Process

When Enable is set to true, the plugin will read your old FlatDB files and convert them to the v3 format.

Important Steps:

1. Backup: Always ZIP your plugins/BeaconPlus folder before starting.
2. Effect Mapping: v3 uses different IDs for effects. The Effect Mapping section lets you link old IDs to new ones (e.g., experience: "exp_boost").
3. One-Time Run: Migration happens once per player. After that, the old data is ignored.

---

4. Menu Animations

Make your menus look dynamic with opening animations.

• Types: SLIDE, DISSOLVE, EXPAND, RANDOM.
• Performance: All animations are client-side (visual items only) and have zero impact on server TPS.
• Custom Covers: You can choose what blocks are used for the "Slide" animation background.

YAML Example:

Animations:
  Slide:
    Cover 1:
      type: GRAY_STAINED_GLASS_PANE
      meta:
        display-name: " "
    Cover 2:
      type: BLACK_STAINED_GLASS_PANE

---

5. Frequently Asked Questions

• "Can I combine economies for one upgrade?": No. A single upgrade level must cost one specific currency (e.g., only Money or only Levels).
• "What if I don't set a World Alias?": The plugin will just display the original folder name. It won't cause any errors.
• "Do I need to enable migration?": No. If this is a new server installation, set Legacy Conversion.Enable: false for a slightly faster startup.