Skip to content

⚙ Configuration Overview

Mirage is designed to be fully modular and highly configurable, allowing server owners to enable, disable, and balance individual systems without touching unrelated features.

Configuration is split across multiple focused files, each responsible for a specific system. This keeps Mirage flexible, readable, and safe to maintain as your server evolves.

🧩 Core Configuration Files

These files control Mirage’s global behavior and plugin-level settings.

messages.yml

Controls all player-facing and staff-facing messages. - Chat messages - Error messages - System notifications - Fully supports color codes and formatting

Safe to customize without impacting gameplay logic.

credentials.yml

Used for internal integrations and secure identifiers. - API keys - External service credentials - Internal authentication values

⚠ This file should never be shared publicly.

💎 Currency Configuration

Each Mirage currency has its own base configuration file, enchant definitions, and shop configuration.

Currency Base Files

These files define how each currency behaves globally.

  • credit.yml
  • crystal.yml
  • essence.yml
  • gem.yml
  • shard.yml

Common options include: - How the currency is earned - World or region restrictions - Scaling behavior - Integration with tools and upgrades

Enchant Configuration

Each currency-backed tool has its own enchant configuration file.

  • credit-enchants.yml
  • crystal-enchants.yml
  • essence-enchants.yml
  • gem-enchants.yml
  • shard-enchants.yml

These files control: - Available enchants - Starting and maximum levels - Proc chances - Upgrade costs - Reward commands

All enchant values are safe to rebalance without resetting player tools.

Shop Configuration

Each currency has a dedicated shop configuration.

  • credit-shop.yml
  • crystal-shop.yml
  • essence-shop.yml
  • gem-shop.yml
  • shard-shop.yml

Shop configs define: - Purchasable items - Prices - Display names and lore - Commands executed on purchase

Shops operate independently and do not affect other currencies unless explicitly configured.

🛠 Tool & Utility Systems

auto-sell.yml

Controls automatic selling behavior across Mirage tools. - What items can be sold - Sell values - Tool-specific behavior

Used by: - Harvester Hoes - Credit Hoes - Crystal Swords - Shard Rods - Gem Pickaxes

selection.yml

Controls the selection system used for zones and portals. - Wand behavior - Selection limits - Admin workflow settings

statistics.yml

Defines tracked statistics and leaderboard behavior. - What stats are tracked - Update intervals - Leaderboard limits

Used by: - /canetop - /blocktop - /croptop - /fishtop - /mobtop

🌑 Zone & World Control

dark-zone.yml

Controls Darkzone behavior. - PvP / PvE toggles - Command blocking - Enderpearl control - Portal interaction - Build modes

light-zone.yml

Controls Lightzone behavior. - Safe zones - Protected regions - Restricted actions - Portal handling

Both zone systems share similar structures but operate independently.

portal.yml

Controls Mirage’s portal system. - Portal creation rules - Allowed destinations - Area definitions - Zone integration

Used by both Darkzones and Lightzones.

🎯 Design Philosophy

Mirage’s configuration system is designed to: - Avoid monolithic config files - Allow per-system balancing - Enable safe live adjustments - Reduce upgrade conflicts - Scale from small servers to large networks

Most changes do not require data wipes or tool resets, allowing you to rebalance progression at any time.