Skip to main content

📁 Templates and Event Files

EventForge uses templates and event files differently.

Understanding the difference helps you avoid editing the wrong file.


What is a template?

A template is a bundled event file that can be installed into your active events folder.

Templates are useful because they give you ready-to-play event examples.

Example bundled templates:

mining_rush
mob_hunt
fishing_frenzy
collection_rush
mob_invasion
capture_zone
exploration_hunt
interact_blocks_hunt

Templates are not automatically active just because they exist.

You install them when you want to use them.


What is an event?

An event is an active event configuration file inside:

plugins/EventForge/events/

EventForge loads event files from this folder.

If you want to edit a live event, edit the installed event file in:

plugins/EventForge/events/

Template install command

List available templates:

/eventforge templates

Install a template:

/eventforge installtemplate mining_rush

Reload EventForge:

/eventforge reload confirm

Validate the installed event:

/eventforge validate mining_rush

Start it:

/eventforge start mining_rush

Overwriting an installed template

If an event file already exists, EventForge will not overwrite it by accident.

To overwrite it, use:

/eventforge installtemplate mining_rush confirm
warning

This replaces the installed event file inside plugins/EventForge/events/.

Back up your edited event first if you want to keep your changes.


Recommended workflow

Use this flow when installing a new template:

/eventforge templates
/eventforge installtemplate mining_rush
/eventforge reload confirm
/eventforge validate mining_rush
/eventforge start mining_rush

Use this flow when replacing an old installed template:

backup plugins/EventForge/events/mining_rush.yml
/eventforge installtemplate mining_rush confirm
/eventforge reload confirm
/eventforge validate mining_rush

Folder example

A common setup looks like this:

plugins/EventForge/
├─ config.yml
├─ schedule_config.yml
├─ events/
│ ├─ mining_rush.yml
│ ├─ mob_hunt.yml
│ └─ capture_zone.yml

├─ packs/
│ └─ survival-pack/
│ ├─ pack.yml
│ └─ events/
│ ├─ fishing_frenzy.yml
│ └─ collection_rush.yml

└─ data/

The events/ folder contains the normal loaded events.

The packs/ folder can contain grouped event packs.

schedule_config.yml is used for global automation such as scheduled voting.


Editing templates

You usually should not edit bundled templates directly.

Instead:

1. Install the template.
2. Edit the installed file in plugins/EventForge/events/.
3. Reload EventForge.
4. Validate the event.

This keeps your active event files separate from the original examples.


Updating templates after a plugin update

EventForge does not automatically overwrite your installed event files during updates.

This protects your edited events.

If v1.0.3 includes a newer template and you want to use it:

/eventforge installtemplate capture_zone confirm

Then reload and validate:

/eventforge reload confirm
/eventforge validate capture_zone

Ready-to-play v1.0.3 templates

v1.0.3 includes updated ready-to-play templates.

mining_rush.yml
mob_hunt.yml
fishing_frenzy.yml
collection_rush.yml
mob_invasion.yml
capture_zone.yml
exploration_hunt.yml
interact_blocks_hunt.yml

These templates are vanilla-friendly by default and can be used without extra plugins.

They also include v1.0.3-ready comments and metadata for:

optional TextEffect usage
plain event name variables
manual participation settings
queue duration
min/max queued players
optional queue lobby location

Template participation mode

Bundled templates use:

participation:
mode: GLOBAL

This means they inherit the global participation mode from config.yml.

Fresh installs use:

participation:
default-mode: AUTOMATIC

So templates still behave like classic EventForge events unless you enable manual participation globally or per event.

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 can then join the queue with:

/events join <event>

Plain event names

v1.0.3 templates include a plain event name variable:

variables:
event_plain_name: "Mining Rush"

This is useful when using optional TextEffect tags.

Example:

messages:
start:
- "<neb>{var:event_plain_name}</neb> &ahas started!"

Use the plain variable inside TextEffect tags instead of wrapping a colour-coded display name.


Event packs

Event packs let you group events together.

Example:

plugins/EventForge/packs/survival-pack/
├─ pack.yml
└─ events/
├─ mining_rush.yml
└─ mob_hunt.yml

Use packs when you want to organise events by theme, server type, season, or addon.

Examples:

survival-pack
halloween-pack
winter-pack
pvp-pack
mining-pack

Template validation

After installing or editing a template, validate it:

/eventforge validate <event>

Example:

/eventforge validate mob_invasion

If something is wrong, check:

/eventforge errors <event>

Example:

/eventforge errors mob_invasion

You can also validate scheduled voting config directly:

/eventforge validate schedule_config.yml

Common mistakes

Editing the wrong file

If you edit a bundled template but the installed event is already in events/, your live event will not change.

Edit:

plugins/EventForge/events/<event>.yml

not the original bundled template.

Forgetting to reload

After editing files, run:

/eventforge reload confirm

Forgetting to validate

Before starting the event, run:

/eventforge validate <event>

Expecting new templates to overwrite old ones

EventForge protects edited installed event files.

If you want the newest bundled version, install it again with confirm after backing up your current file.


Summary

Templates are ready-made event files.

Events are the files EventForge actually loads from:

plugins/EventForge/events/

Use templates to install examples, then edit the installed event files.

v1.0.3 templates stay backwards compatible by default while adding comments and config sections for TextEffect integration and manual event queues.