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.3+

Optional integrations:

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

Optional plugins are only needed if your events, rewards, placeholders, TextEffect displays, 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.3-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
├─ schedule_config.yml
├─ cooldowns.yml
├─ events/
├─ packs/
├─ data/
└─ history/

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

Default behaviour

Fresh installs keep classic EventForge behaviour by default.

By default:

Events use AUTOMATIC participation
TextEffect integration is disabled
Manual event voting is disabled
Scheduled voting is disabled
Queue bossbars are disabled
Queue title countdowns are disabled

This means existing server setups do not suddenly require players to join queues or install extra plugins.

Server owners can enable the new v1.0.3 systems when they are ready.

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 confirm

Validate the event

After installing or editing an event, validate it:

/eventforge validate mining_rush

You can also validate all loaded config files:

/eventforge validate

For scheduled voting, you can validate schedule_config.yml directly:

/eventforge validate schedule_config.yml

Start your first event

Start the installed event:

/eventforge start mining_rush

If the event uses automatic participation, it starts normally.

If the event uses manual participation, EventForge opens a queue first and players can join with:

/events join mining_rush

Enable optional systems

Enable TextEffect integration​

TextEffect integration is optional and requires the separate TextEffect plugin and resource pack.

Enable it in config.yml:

integrations:
  texteffect:
    enabled: true
    mode: "ALWAYS"

Read:

TextEffect Integration

Enable event voting​

Manual event voting is disabled by default.

Enable it in config.yml:

voting:
  enabled: true

Then start a vote:

/eventforge vote start mining_rush mob_hunt fishing_frenzy

Players vote with:

/events vote mining_rush

Read:

Event Voting

Enable scheduled voting​

Scheduled voting is disabled by default.

Enable it in schedule_config.yml:

scheduled-voting:
  enabled: true

Then enable one of the scheduled vote entries under schedules:.

Read:

Schedules & Conditions
Event Voting

Enable manual queues​

Automatic participation is the default.

To make one event use a manual queue, edit the installed event file:

participation:
  mode: MANUAL
  queue-duration: 30s
  min-players: 1
  max-players: 0
  allow-leave-before-start: true

Players join the queue with:

/events join <event>

Read:

Event Queues

Reloading safely

Use:

/eventforge reload confirm

This reloads EventForge files and safely refreshes runtime systems such as TextEffect hook state, active votes, scheduled voting config, and queues.

Common first checks

After installing, check:

/eventforge validate
/eventforge templates
/eventforge schedules
/events

If something is wrong, check the console and read:

Troubleshooting

Summary

Install the jar, start the server, install a bundled template, reload, validate, then start the event.

The newer v1.0.3 systems are included but opt-in, so you can enable TextEffect, voting, scheduled voting, or manual queues when your server is ready to use them.