> For the complete documentation index, see [llms.txt](https://edseries-plugins.gitbook.io/p/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://edseries-plugins.gitbook.io/p/edevents/getting-started/readme.md).

# EdEvents

Configurable mining & mob-kill events for EdPrison, PinnaPrison, EdTools and EdDungeons.

Timed server events with a leaderboard, boss bar, action bar, chat announcements with the winner's **face rendered in chat** and fully configurable rewards. Events start automatically on a schedule or with a command, and every text a player can see is configurable.

## What it works with

EdEvents detects the plugin installed on the server at startup — nothing to configure:

| Plugin          | What counts                                                                      | Currencies for `[GIVE-ECO]`                                      |
| --------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| **EdPrison**    | Blocks mined (hand-mined + explosions/fills), currency earned                    | Every currency & level track (`tokens`, `money`, `blocks`...)    |
| **PinnaPrison** | Blocks mined (hand-mined + enchant/bomb/drill/autominer sweeps), currency earned | Every currency in `currencies/` (`tokens`, `gems`, `beacons`...) |
| **EdTools**     | Blocks mined (own swings + enchant batches), currency earned                     | Every currency in `currencies/` (`money`, `mine-coins`...)       |
| **EdDungeons**  | Mobs killed, damage dealt, currency earned                                       | Every currency in `currencies/` (`souls`, `essence`...)          |
| none            | Vanilla block breaks, mob kills and damage                                       | —                                                                |

The action bar never fights the host plugin: EdEvents plugs into each plugin's action bar so the event text is appended next to the mining bar, and only sends its own bar when the host is not showing one.

## Event types

* **LEADERBOARD** — runs for its duration; the players with the most progress win (placements 1, 2, 3...).
* **FIRST\_TO\_GOAL** — the first player to reach the goal wins and the event ends immediately.
* **COMMUNITY** — everyone contributes to one shared goal; every participant is rewarded when it is reached.

## Objectives

`BLOCKS_MINED`, `MOBS_KILLED`, `DAMAGE_DEALT`, `CURRENCY_EARNED` and `CUSTOM` (fed by `/edevents progress` or the API), each with filters (block types, mob ids, worlds, currencies, permission) so you can build "only ores", "only bosses" or "only diamond blocks" events.

## Highlights

* **Fully async** — progress counting is lock-free, boss/action bar text is built off the main thread, skins and data saves are async.
* **Everything configurable** — every message, title, sound, boss bar, action bar, reward and announcement, per event, with global defaults so event files stay tiny.
* **Chat heads** — the winner's skin face drawn in chat with coloured characters next to your own lines.
* **Random or fixed-time scheduler**, weighted events, cooldowns, minimum players, countdowns.
* **Rewards for placements, participation, community goals, losers and everyone**, delivered to offline players when they join.
* **Milestones**, countdown announcements, join info for players logging in mid-event.
* **Statistics** (wins, top 3, played, best score), event history and 60+ placeholders.
* **Developer API** with Bukkit events for start, progress, wins and end.

## Quick start

1. Drop `EdEvents-x.y.z.jar` into `plugins/` (PlaceholderAPI recommended) next to your prison/dungeon plugin.
2. Start the server — `plugins/EdEvents/` is created with 7 example events in `events/`.
3. `/events start mining-frenzy` — or wait for the scheduler (every 45–75 minutes by default).

See [Creating Events](/p/edevents/features/events.md) to make your own.