Skip to main content

⚙️ Installation

EventForge is a modular server events framework for modern Minecraft servers.

It can be used as a ready-to-use event plugin, or as a framework for installing event packs and developer-made objective addons.

Requirements

Recommended setup:

Java 21
Spigot, Paper, or Purpur 1.21 - 1.21.11
EventForge v1.0.2+

Optional integrations:

PlaceholderAPI
Vault or economy plugin
crate/reward plugins
ItemsAdder, Oraxen, Nexo, or MMOItems
MythicMobs
Skript
EventForgeSkriptAddon
custom EventForge addons
info

Optional plugins are only needed if your events or addons use them.

Download EventForge

Download the latest EventForge jar from the official resource page.

EventForge-x.x.x.jar

Use the release jar on your server.

Install the plugin

  1. Stop your server.

  2. Place the EventForge jar into:

plugins/

Example:

plugins/EventForge-1.0.2-release-obf.jar

  1. Start the server.

  2. EventForge should create:

plugins/EventForge/

First generated files

After first startup, EventForge may create files and folders such as:

plugins/EventForge/
├─ config.yml
├─ messages.yml
├─ cooldowns.yml
├─ events/
├─ packs/
├─ data/
└─ history/

Some files or folders may only appear after certain features are used.

Install your first template

EventForge includes bundled templates.

Run:

/eventforge templates

Then install one:

/eventforge installtemplate mining_rush

If the template already exists and you want to replace it:

/eventforge installtemplate mining_rush confirm

Reload EventForge:

/eventforge reload

Validate the event

Before starting an event, validate it:

/eventforge validate mining_rush

You can also validate all loaded event files:

/eventforge validate

If there are problems, check:

/eventforge errors

or:

/eventforge errors mining_rush

Start an event

Use:

/eventforge start mining_rush

Player-facing event commands are available through:

/events

Check command help with:

/eventforge help
/events help

Check the event

Once the event starts, test the configured objective.

For Mining Rush:

mine the configured blocks
check score updates
wait for event finish
check rewards

If the event does not score, run:

/eventforge validate mining_rush
/eventforge errors mining_rush

Also check the server console for validation warnings.

Installing PlaceholderAPI

PlaceholderAPI is optional.

Install it if you want to use EventForge placeholders in other plugins such as scoreboards, TAB, holograms, chat plugins, or menus.

Example placeholders:

%eventforge_active_names%
%eventforge_next_event%
%eventforge_next_event_time%
%eventforge_event_mining_rush_active%
%eventforge_event_mining_rush_player_score%
%eventforge_event_mining_rush_player_rank%

Test with:

/papi parse me %eventforge_next_event%

Installing EventForgeSkriptAddon

EventForgeSkriptAddon is optional.

Install it if you want to use EventForge from Skript.

Basic install:

plugins/
├─ EventForge.jar
├─ Skript.jar
└─ EventForgeSkriptAddon.jar

Then restart the server.

The addon includes example scripts showing how to listen to EventForge events, read scores, parse text effects, read milestones, and use EventForge data in Skript.

Installing addon plugins

Some EventForge addons add custom objectives or custom actions.

Basic install:

plugins/
├─ EventForge.jar
└─ YourEventForgeAddon.jar

Restart the server after installing addons.

If the addon provides event templates, follow the addon instructions for where to place them.

Common mistake: editing templates instead of events

Templates are installed into active event files.

Bundled templates are copied into:

plugins/EventForge/events/

Edit the installed file in events/ if you want to change the live event.

If you use:

/eventforge installtemplate mining_rush confirm

EventForge will overwrite the installed event file with the bundled template.

warning

Only use confirm when you actually want to replace the current installed event file.

Updating from an older EventForge version

When updating from an older version:

1. Stop the server.
2. Back up plugins/EventForge/.
3. Replace the old EventForge jar.
4. Start the server.
5. Run /eventforge reload.
6. Run /eventforge validate.
7. Check /eventforge errors.

For v1.0.2, bundled templates were updated. Existing installed event files are not overwritten automatically.

Use the template installer if you want the new template versions.

Summary

For most servers:

1. Install EventForge.
2. Start the server once.
3. Install a template.
4. Reload EventForge.
5. Validate the event.
6. Start the event.

After that, you can edit event files, add rewards, add schedules, and install addons.