Skip to main content

📁 Folder Structure

EventForge creates its files inside:

plugins/EventForge/

This folder stores the main config, messages, event files, packs, player data, history, and cooldown data.


Main folder

A typical EventForge folder looks like this:

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

Some files or folders may only appear after you use certain features.


config.yml

plugins/EventForge/config.yml

This is the main plugin config.

It controls global settings such as:

general behaviour
GUI settings
history settings
global feature toggles
default display options

Example:

gui:
enabled: true
rows: 6

messages.yml

plugins/EventForge/messages.yml

This file stores configurable messages used by EventForge commands and systems.

Use this file when you want to change command output, reload messages, stats messages, history messages, or other general plugin text.


cooldowns.yml

plugins/EventForge/cooldowns.yml

This file stores active event cooldowns.

Cooldowns are created when an event with cooldown enabled finishes naturally.

Example event config:

cooldown:
enabled: true
duration: 1h
info

You usually do not need to edit cooldowns.yml manually.

If you want to clear a cooldown, use the plugin command or compatible addon tools instead of editing the file while the server is running.


events folder

plugins/EventForge/events/

This folder stores standalone event files.

Example:

plugins/EventForge/events/mining_rush.yml
plugins/EventForge/events/mob_hunt.yml
plugins/EventForge/events/relic_hunt.yml

Each event file usually contains:

id
enabled
display-name
duration
metadata
variables
schedule
cooldown
conditions
objectives
rewards
bossbar
sidebar
messages
announcements
triggers
dialogues

Not every event needs every section.


packs folder

plugins/EventForge/packs/

Event packs let you group multiple event files together.

Example:

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

This is useful for:

seasonal packs
server mode packs
premium event packs
addon examples
drag-and-drop event bundles

pack.yml

Inside an event pack, pack.yml stores pack information.

Example:

id: survival_pack
display-name: "Survival Event Pack"
enabled: true
author: "HxZe"
version: "1.0.0"
description:
- "A small set of survival-friendly events."

If the pack is disabled, events inside the pack will not load.


data folder

plugins/EventForge/data/

This folder stores plugin data.

Depending on your setup, this may include player stats, stored event data, or other runtime data.

warning

Do not delete data files unless you are intentionally resetting progress or history.


history folder

plugins/EventForge/history/

This folder stores event history data.

History is used for recent event results, previous winners, stats displays, and admin review.


Editing files safely

When editing EventForge files:

stop the server or make a backup first
use spaces, not tabs
keep YAML indentation consistent
reload EventForge after changes
check console for validation warnings

Reload with:

/eventforge reload

If your setup uses reload confirmation, follow the confirmation message.


What not to edit manually

Avoid manually editing files such as:

cooldowns.yml
history files
runtime data files

unless you know exactly what you are changing.

For normal event setup, you usually only edit:

config.yml
messages.yml
event files
pack.yml files

Troubleshooting

Event file does not load

Check:

The file is inside the correct folder
The file ends with .yml
The YAML spacing is valid
The event has an id
The event is enabled
The objective type is valid

Pack events do not load

Check:

The pack has a pack.yml
The pack is enabled
The events are inside the pack events folder
The event files are valid

Cooldowns disappeared

Check that cooldowns.yml was not deleted or reset.

Cooldowns are only stored if an event with cooldown enabled finishes naturally.

I want to reset cooldowns

Use EventForge commands or compatible addon tools if available.

If editing manually, stop the server first and make a backup.