🔗 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 admin, player, voting, queue, and validation commands |
| Troubleshooting | Fixing common setup issues |
Server owners
| Page | Use it for |
|---|---|
| Templates vs Events | Understanding templates, installed events, and template updates |
| 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, chance, and milestone rewards |
| Bossbars & Sidebars | Showing event progress on-screen |
| Schedules & Conditions | Per-event schedules, cooldowns, conditions, and scheduled voting |
| Event Voting | Letting players vote for the next event |
| Manual Event Queues | Queue-based participation, lobby countdowns, and manual scoring |
| Actions & Triggers | Running actions when events start, finish, stop, or players score |
| Event Milestones | Rewarding players at score milestones |
| Dialogues | NPC-style dialogue sequences for event addons |
| GUI Customization | Customizing EventForge menu titles |
| Text Effects | Using EventForge's built-in no-resource-pack text effects |
| TextEffect Integration | Connecting EventForge to the separate TextEffect plugin |
| 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 |
| Capture Zone | Hold a zone for points |
| Visit Regions | Visit configured locations for points |
| Interact Blocks | Interact with configured blocks for points |
| 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 |
| Bukkit Events | Listening to EventForge developer events |
| VariableService | Parsing EventForge variables from addons |
| EventService | Reading and controlling events |
| EventPackService | Installing and managing event packs |
| StatsService | Reading player event stats |
| ScheduleService | Reading schedules and upcoming events |
| EventVoteService | Reading and controlling manual event votes |
| ScheduledVoteService | Reading scheduled hybrid votes |
| EventQueueService | Reading and interacting with manual event queues |
| ObjectiveService | Reading registered objective types |
| Custom Objectives | Creating addon objective types |
| ActionService | Running EventForge actions from addons |
| Action Registry | Registering custom action types |
| TextEffectService | Parsing EventForge built-in text effects from addons |
| Dialogue Service | Starting and managing dialogues |
| Event Milestones API | Reading event milestone reward data |
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.3 Release | TextEffect integration, voting, scheduled voting, manual queues, API, and validation updates |
| v1.0.2 Release | Spigot support, new objectives, milestones, validation, and API additions |
| v1.0.1 Release | API publishing, addons, variable parsing, and polish |
| v1.0.0 Release | Initial stable release notes |
Common tasks
Create a basic event​
Start with:
Mining Rush
Mob Hunt
Fishing Frenzy
Collection Rush
Let players vote for an event​
Read:
Event Voting
Schedules & Conditions
PlaceholderAPI
Use manual queues or a lobby countdown​
Read:
Manual Event Queues
Bossbars & Sidebars
TextEffect Integration
Add bonus rewards​
Read:
Rewards
Event Milestones
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
Use visual text effects​
Read:
Text Effects
TextEffect Integration
Bossbars & Sidebars
Build an addon​
Read:
Maven Setup
API Overview
Bukkit Events
EventVoteService
ScheduledVoteService
EventQueueService
Custom Objectives
Action Registry
Use Skript​
Read:
Skript Addon
Skript Example Scripts
Summary
Use this page as a shortcut hub when setting up, configuring, extending, or debugging EventForge.