# Look what awaits you!

Welcome to the ultimate technical and functional documentation for the **OmniMobCurrencies** plugin. This wiki provides an in-depth look at every feature, configuration, and technical detail of the system.

***

### 🪙 ᴄᴜʀʀᴇɴᴄɪᴇꜱ (ᴘʟᴜɢɪɴ ᴄᴜʀʀᴇɴᴄɪᴇꜱ)

The plugin features a robust hierarchical currency system designed to drive your server's economy. Each currency has its own unique visual identity and acquisition method.

| Currency      | Symbol |     Material    | Rarity    | Description                              | Acquisition                                        |
| ------------- | :----: | :-------------: | --------- | ---------------------------------------- | -------------------------------------------------- |
| **Scrap**     |    ⚓   |   Iron Nugget   | Common    | The most basic unit of value.            | Common mobs (Zombies, Skeletons, Farm animals).    |
| **Common**    |    ✴   |   Gold Nugget   | Common    | A reliable mid-tier currency.            | Creepers, Blazes, and basic missions.              |
| **Rare**      |    ✦   |     Diamond     | Rare      | Highly valuable and sought after.        | Endermen, Wither Skeletons, Guardians, and Ghasts. |
| **Epic**      |    ✧   |  Amethyst Shard | Epic      | Elite currency for premium items.        | Phantoms, Hoglins, and high-tier missions.         |
| **Legendary** |    ✪   | Netherite Scrap | Legendary | Extremely rare, reserved for champions.  | Wither, Ravagers, Evokers, and boss events.        |
| **Mythic**    |    -   |        -        | Mythic    | Ultimate currency, limited availability. | Special events (Boss Rush) or Admin rewards.       |

> **Technical Detail:** Currencies can be either **Virtual** (stored in database) or **Physical** (vouchers). Legendary coins are physical items by default.

***

### ⚔️ ᴍᴏʙ ᴅʀᴏᴘꜱ & ᴀᴄᴛɪᴏɴ ᴇɴɢɪɴᴇ

The core of the plugin is its sophisticated drop system. Every mob death is processed through several filters to determine if a reward is granted.

#### ⚙️ ᴅʀᴏᴘ ꜰɪʟᴛᴇʀꜱ

* **Probability:** Each drop has a `chance` (0-100%).
* **Quantity:** Supports fixed amounts or ranges (e.g., `1-5`).
* **Event Requirements:** Certain drops (like Mythic) only occur during specific events.
* **Region Hooks:** Integration with **WorldGuard** allows for region-specific loot tables.

#### 🎬 ᴀᴄᴛɪᴏɴ ᴇɴɢɪɴᴇ ᴄᴏᴍᴍᴀɴᴅꜱ

When a drop or reward occurs, the plugin can execute multiple actions simultaneously:

* `[MESSAGE] <text>`: Sends a private message to the player.
* `[COMMAND] <command>`: Runs a command via console (placeholders: `%player%`).
* `[SOUND] <SOUND_NAME>`: Plays a Minecraft sound.
* `[TITLE] <main>;<sub>`: Displays a large title and subtitle.
* `[ACTIONBAR] <text>`: Shows a message above the player's hotbar.

#### 📋 ᴅᴇꜰᴀᴜʟᴛ ᴅʀᴏᴘ ᴛᴀʙʟᴇ

| Mob      | Currency  | Chance | Amount | Notes                      |
| -------- | --------- | :----: | :----: | -------------------------- |
| Zombie   | Scrap     |   50%  |   1-3  | Basic hunt.                |
| Skeleton | Scrap     |   40%  |   1-2  | -                          |
| Creeper  | Common    |   20%  |   1-3  | Explosive rewards.         |
| Enderman | Rare      |   10%  |    1   | Inter-dimensional loot.    |
| Wither   | Legendary |  100%  |   1-5  | Boss-tier drop.            |
| Wither   | Epic      |   50%  |    1   | Bonus boss reward.         |
| Wither   | Mythic    |   10%  |    1   | **Only during Boss Rush.** |
| Ghast    | Rare      |  100%  |    1   | High-risk reward.          |

***

### 📢 ɢʟᴏʙᴀʟ ᴇᴠᴇɴᴛꜱ (ꜱᴄʜᴇᴅᴜʟᴇᴅ & ʀᴀɴᴅᴏᴍ)

The plugin manages 11 distinct global events that dynamically alter server rewards and player behavior.

| Event ID          | Name            |    Type    | Multiplier | Frequency / Schedule | Special Features              |
| ----------------- | --------------- | :--------: | :--------: | -------------------- | ----------------------------- |
| `double_loot`     | ᴅᴏᴜʙʟᴇ ʟᴏᴏᴛ     | Multiplier |     2x     | Daily (18:00-19:00)  | Affects all mob drops.        |
| `lucky_hour`      | ʟᴜᴄᴋʏ ʜᴏᴜʀ      |   Chance   |    +50%    | Random (10% chance)  | Increases drop probability.   |
| `boss_rush`       | ʙᴏꜱꜱ ʀᴜꜱʜ       | Multiplier |     1x     | Random (2% chance)   | **Enables Mythic drops.**     |
| `night_hunters`   | ɴɪɢʜᴛ ʜᴜɴᴛᴇʀꜱ   | Multiplier |     2x     | Daily (20:00-06:00)  | Rewards night activity.       |
| `weekend_frenzy`  | ᴡᴇᴇᴋᴇɴᴅ ꜰʀᴇɴᴢʏ  | Multiplier |     3x     | Sat-Sun (All day)    | The ultimate farm time.       |
| `happy_hour`      | ʜᴀᴘᴘʏ ʜᴏᴜʀ      |   Chance   |     2x     | Random (15% chance)  | Short duration (10m).         |
| `undead_uprising` | ᴜɴᴅᴇᴀᴅ ᴜᴘʀɪꜱɪɴɢ | Multiplier |     2x     | Random (8% chance)   | Zombie/Skeleton bonus.        |
| `nether_fire`     | ɴᴇᴛʜᴇʀ ꜰɪʀᴇ     | Multiplier |     2x     | Random (5% chance)   | Blaze/Ghast/Piglin bonus.     |
| `farm_frenzy`     | ꜰᴀʀᴍ ꜰʀᴇɴᴢʏ     | Multiplier |     3x     | Daily (10:00-12:00)  | Animal loot boost.            |
| `blood_moon`      | ʙʟᴏᴏᴅ ᴍᴏᴏɴ      | Multiplier |     5x     | Random (1% chance)   | Rare and extremely rewarding. |
| `end_voyage`      | ᴇɴᴅ ᴠᴏʏᴀɢᴇ      | Multiplier |     2x     | Random (3% chance)   | Enderman/Shulker bonus.       |

***

### 🎯 ᴅᴀɪʟʏ ᴍɪꜱꜱɪᴏɴꜱ (ᴄᴏᴍᴘʟᴇᴛᴇ ʟɪꜱᴛ)

The mission system offers 33 unique objectives that reset every 24 hours at midnight. Players can track progress via `/omni missions`.

#### 📋 ᴍɪꜱꜱɪᴏɴ ᴏʙᴊᴇᴄᴛɪᴠᴇꜱ

1. **Zombie Slayer**: Kill 50 Zombies (Reward: 100 Scrap).
2. **Skeleton Hunter**: Kill 30 Skeletons (Reward: 1 Common).
3. **Master Hunter**: Kill 500 Monsters (Reward: 50 Rare).
4. **Wither Warrior**: Kill 1 Wither (Reward: 10 Legendary).
5. **Creeper Remover**: Kill 20 Creepers (Reward: 50 Common).
6. **Spider Cleaner**: Kill 40 Spiders (Reward: 80 Common).
7. **Enderman Hunter**: Kill 10 Endermen (Reward: 2 Rare).
8. **Slime Splitter**: Kill 25 Slimes (Reward: 100 Common).
9. **Blaze Extinguisher**: Kill 15 Blazes (Reward: 3 Rare).
10. **Ghast Slayer**: Kill 5 Ghasts (Reward: 5 Rare).
11. **Wither Skeleton Slayer**: Kill 20 Wither Skeletons (Reward: 10 Rare).
12. **Piglin Punisher**: Kill 30 Piglins (Reward: 150 Common).
13. **Hoglin Hunter**: Kill 15 Hoglins (Reward: 5 Epic).
14. **Magma Cube Masher**: Kill 20 Magma Cubes (Reward: 200 Common).
15. **Drowned Diver**: Kill 30 Drowneds (Reward: 100 Scrap).
16. **Phantom Phantom**: Kill 10 Phantoms (Reward: 3 Epic).
17. **Pillager Pillager**: Kill 20 Pillagers (Reward: 5 Rare).
18. **Ravager Reaper**: Kill 3 Ravagers (Reward: 2 Legendary).
19. **Witch Watcher**: Kill 10 Witches (Reward: 50 Common).
20. **Guardian Grinder**: Kill 15 Guardians (Reward: 10 Rare).
21. **Shulker Sheller**: Kill 10 Shulkers (Reward: 5 Epic).
22. **Silverfish Squasher**: Kill 50 Silverfish (Reward: 100 Common).
23. **Husk Hurler**: Kill 25 Husks (Reward: 80 Common).
24. **Stray Strider**: Kill 25 Strays (Reward: 80 Common).
25. **Cave Spider Crusher**: Kill 30 Cave Spiders (Reward: 120 Common).
26. **Vex Vanquisher**: Kill 5 Vexes (Reward: 5 Rare).
27. **Evoker Ender**: Kill 2 Evokers (Reward: 1 Legendary).
28. **Brute Beater**: Kill 10 Piglin Brutes (Reward: 10 Rare).
29. **Zombified Piglin Slayer**: Kill 40 Zombified Piglins (Reward: 150 Common).
30. **Endermite Exterminator**: Kill 15 Endermites (Reward: 50 Common).
31. **Iron Golem Terminator**: Kill 5 Iron Golems (Reward: 5 Rare).
32. **Glow Squid Hunter**: Kill 15 Glow Squids (Reward: 2 Rare).
33. **Any Mob**: Kill 100 Monsters (Reward: 5 Rare).

***

### 🛒 ᴄᴜʀʀᴇɴᴄʏ ᴍᴀʀᴋᴇᴛ (ꜱʜᴏᴘ ꜱʏꜱᴛᴇᴍ)

A rotating black market system where players can spend their earned coins.

* **Rotation Frequency:** Default 1 hour (configurable).
* **Item Pool:** Items are pulled from `shop_items.yml`.
* **Dynamic Costs:** Items can require multiple types of currency simultaneously (e.g., 10 Common + 1 Rare).

#### 🔄 ᴇxᴄʜᴀɴɢᴇ ʀᴀᴛᴇꜱ

The exchange menu allows players to trade up their lower-tier coins:

* **50 Scrap** ➜ **1 Common**
* **50 Common** ➜ **1 Rare**
* **25 Rare** ➜ **1 Epic**
* **10 Epic** ➜ **1 Legendary**

***

### 📊 ᴀɴᴀʟʏᴛɪᴄꜱ & ꜱᴛᴀᴛɪꜱᴛɪᴄꜱ

The plugin tracks everything to provide a competitive environment.

* **Killstreaks:** Announcements and rewards at 10 and 50 kills without dying.
* **Global Milestones:** Server-wide goals (e.g., 1,000 coins collected) that trigger rewards for everyone online.
* **Leaderboards:** Real-time top hunters displayed via Holograms (`/omni hologram`).
* **Economy Trends:** Visual ASCII representation of currency fluctuations over time, accessible via placeholders.

***

### 🧩 ᴘʟᴀᴄᴇʜᴏʟᴅᴇʀꜱ (ᴘᴀᴘɪ ɪɴᴛᴇɢʀᴀᴛɪᴏɴ)

The plugin offers a massive list of placeholders for scoreboards, tablists, or custom menus.

| Placeholder                        | Description                                | Example           |
| ---------------------------------- | ------------------------------------------ | ----------------- |
| `%omni_balance_<id>%`              | Player balance for the specified currency. | `500`             |
| `%omni_symbol_<id>%`               | Currency symbol.                           | `⚓`               |
| `%omni_currency_name_<id>%`        | Display name of the currency.              | `Scrap`           |
| `%omni_shop_timer%`                | Time remaining until shop rotation.        | `00:45:12`        |
| `%omni_event_status_<id>%`         | Status of a specific event.                | `Active/Inactive` |
| `%omni_event_time_<id>%`           | Time remaining for an active event.        | `02:15:00`        |
| `%omni_event_description_<id>%`    | Full description of an event.              | -                 |
| `%omni_active_events_count%`       | Total number of active events.             | `2`               |
| `%omni_multiplier_loot%`           | Current global loot multiplier.            | `2.0x`            |
| `%omni_multiplier_chance%`         | Current global chance multiplier.          | `1.5x`            |
| `%omni_economy_trend_<id>%`        | ASCII chart showing economy trend.         | `[▃▅▇]`           |
| `%omni_total_earned_<id>%`         | Total lifetime earned currency.            | `1500`            |
| `%omni_total_spent_<id>%`          | Total lifetime spent currency.             | `1000`            |
| `%omni_global_milestone_progress%` | Server progress towards the next goal.     | `750`             |
| `%omni_global_milestone_target%`   | Next server milestone target.              | `1000`            |
| `%omni_global_stat_<key>%`         | Custom global statistic.                   | `123`             |
| `%omni_lang_<key>%`                | Fetch message from lang files.             | -                 |
| `%omni_missions_status%`           | Whether missions are enabled.              | `Active`          |

> **Advanced Usage:** `%omni_lang_key:name=value%` allows passing dynamic parameters to language strings directly through PlaceholderAPI.

***

### 💻 ᴛᴇᴄʜɴɪᴄᴀʟ ᴅᴏᴄᴜᴍᴇɴᴛᴀᴛɪᴏɴ

For advanced administrators and developers.

#### 🗄️ ᴅᴀᴛᴀ ꜱᴛᴏʀᴀɢᴇ

* **Database Type:** SQLite (`data.db`).
* **ORM:** J256 ORMLite for efficient data mapping.
* **Tables:**
  * `balances`: Stores UUID, Currency ID, and amount.
  * `global_stats`: Tracks server-wide progression.
  * `player_missions`: Real-time tracking of daily mission progress.
  * `hologram_locations`: Persists holographic leaderboard positions.

#### 🔗 ᴘʟᴜɢɪɴ ɪɴᴛᴇɢʀᴀᴛɪᴏɴꜱ (ʜᴏᴏᴋꜱ)

* **Vault:** Seamlessly integrates with your primary economy. Converts mob coins into Vault balance.
* **WorldGuard:** Filters drops based on region flags.
* **MythicMobs:** Full support for custom MythicMobs entities and drops.
* **PlaceholderAPI:** Extensive list of placeholders for scoreboards and TAB.

***

### ⌨️ ᴄᴏᴍᴍᴀɴᴅꜱ & ᴘᴇʀᴍɪꜱꜱɪᴏɴꜱ

| Command                      | Description          | Permission   |
| ---------------------------- | -------------------- | ------------ |
| `/omni balance [p]`          | View balance.        | `omni.use`   |
| `/omni shop`                 | Open rotating shop.  | `omni.use`   |
| `/omni missions`             | Open daily missions. | `omni.use`   |
| `/omni withdraw <c> <a>`     | Create a voucher.    | `omni.use`   |
| `/omni exchange`             | Open exchange menu.  | `omni.use`   |
| `/omni admin`                | Central Admin GUI.   | `omni.admin` |
| `/omni give <p> <c> <a>`     | Give currency.       | `omni.admin` |
| `/omni reload`               | Reload config files. | `omni.admin` |
| `/omni shop reroll`          | Force shop rotation. | `omni.admin` |
| `/omni hologram create <id>` | Create leaderboard.  | `omni.admin` |

***

### 🎨 ᴄᴜꜱᴛᴏᴍɪᴢᴀᴛɪᴏɴ & ꜱᴛʏʟᴇ

The plugin follows a modern "Clean & Aqua" design philosophy.

* **Primary Color:** Aqua Green (`<#00F5A0>`) used for all major headers and symbols.
* **Font Style:** Most titles use the **Small Caps** font style (`ᴛʜɪꜱ ꜰᴏɴᴛ`) for a premium look.
* **Message Formatting:**
  * Descriptions: White (`&f`) or Light Gray (`&7`).
  * Highlights: Aqua Green (`<#00F5A0>`).
* **Emoji Support:** Full support for Unicode emojis (⚓, ✦, ✪, etc.) across all files.

***

### ⚙️ ᴄᴏɴꜰɪɢᴜʀᴀᴛɪᴏɴ ꜰɪʟᴇꜱ

* `config.yml`: Global settings, sounds, drop tables, and milestones.
* `currencies.yml`: Currency ID definitions and Vault integration settings.
* `events.yml`: Configuration for all 11 global events and their timers.
* `missions.yml`: Definitions for hunting objectives and rewards.
* `shop_items.yml`: The complete pool of items available for rotation in the market.
* `guis/`: 6+ dedicated YAML files for UI customization.

***

⭐ **OmniMobCurrencies** - *The ultimate mob-economy engine.*


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://dani3l.gitbook.io/plugins/omni-mob-currencies/look-what-awaits-you.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.