🔗 Quick Links
Use this page to jump to the part of the docs you need.
Getting started
| Page | Use it for |
|---|---|
| Installation | Installing EventForge on your server |
| Folder Structure | Understanding EventForge files and folders |
| Commands & Permissions | Viewing commands and permissions |
| Troubleshooting | Fixing common setup issues |
Server owners
| Page | Use it for |
|---|---|
| Templates vs Events | Understanding how EventForge event files work |
| Event Packs | Grouping events into packs |
| Event Variables | Reusing colours, names, rewards, and text |
| Multi-objective Events | Running multiple objectives in one event |
| Rewards | Participation, leaderboard, and chance rewards |
| Bossbars & Sidebars | Showing event progress on-screen |
| Schedules & Conditions | Scheduled events, start rules, and cooldowns |
| Actions & Triggers | Running actions when events start, finish, stop, or players score |
| Dialogues | NPC-style dialogue sequences for event addons |
| GUI Customization | Customizing EventForge menu titles |
| PlaceholderAPI | Using EventForge placeholders in other plugins |
Built-in objectives
| Page | Use it for |
|---|---|
| Mining Rush | Mine blocks for points |
| Mob Hunt | Kill mobs for points |
| Fishing Frenzy | Catch items for points |
| Collection Rush | Collect items for points |
| Mob Invasion | Spawn invasion waves |
| Custom Content Support | Custom items, mobs, catches, and addon objectives |
Developers
| Page | Use it for |
|---|---|
| Maven Setup | Adding the EventForge API to your addon |
| API Overview | Understanding the public API |
| EventService | Reading and controlling events |
| ScheduleService | Reading schedules and upcoming events |
| ObjectiveService | Reading registered objective types |
| Custom Objectives | Creating addon objective types |
| Action Registry | Registering custom action types |
| Dialogue Service | Starting and managing dialogues |
| Bukkit Events | Listening to EventForge developer events |
Examples
| Page | Use it for |
|---|---|
| Simple Addon Example | Reading EventForge data from another plugin |
| Advanced Relic Hunt Example | Creating a custom objective and custom action |
| Skript Addon | Using EventForge from Skript |
| Skript Example Scripts | Ready-to-use Skript files bundled with the addon |
Changelog
| Page | Use it for |
|---|---|
| v1.0.0 Release | Initial stable release notes |
| v1.0.1 Release | Latest v1.0.1 feature update |
Common tasks
Create a basic event
Start with:
Mining Rush
Mob Hunt
Fishing Frenzy
Collection Rush
Add bonus rewards
Read:
Rewards
Stop events from starting too often
Read:
Schedules & Conditions
Reuse text across an event file
Read:
Event Variables
Make one event use several objectives
Read:
Multi-objective Events
Run commands, titles, sounds, or webhooks from triggers
Read:
Actions & Triggers
Build an addon
Read:
Maven Setup
API Overview
Custom Objectives
Action Registry
Dialogue Service
Use Skript
Read:
Skript Addon
Skript Example Scripts
Summary
Use this page as a shortcut hub when setting up, configuring, extending, or debugging EventForge.