Skip to main content

Start Requirements

Conditions section

Conditions decide whether an event is allowed to start.

conditions:
  minimum-players: 2
  worlds:
    - world

  permissions: []
  blocked-permissions: []

  require-op: false
  require-non-op: false

  time:
    enabled: false
    min: 0
    max: 23999

  weather:
    allowed: []

Minimum players

Require a minimum number of online players.

conditions:
  minimum-players: 5

If fewer than 5 players are online, the event will not start.

World conditions

Limit an event to certain worlds.

conditions:
  worlds:
    - world
    - world_nether

If the condition is enabled in your event setup, EventForge checks the allowed worlds before starting.

Permission conditions

Require players to have certain permissions.

conditions:
  permissions:
    - eventforge.events.mining

You can also block events for players with specific permissions:

conditions:
  blocked-permissions:
    - eventforge.blocked

OP conditions

Require operators:

conditions:
  require-op: true

Or require non-operators:

conditions:
  require-non-op: true

Most public events should leave both as false.

Time conditions

Minecraft time can be used as a start condition.

conditions:
  time:
    enabled: true
    min: 0
    max: 12000

Common time values:

0 = sunrise
6000 = noon
12000 = sunset
18000 = midnight

Weather conditions

You can restrict events by weather.

conditions:
  weather:
    allowed:
      - CLEAR

Example with rain and thunder:

conditions:
  weather:
    allowed:
      - RAIN
      - THUNDER

Start checks

EventForge checks conditions before starting an event.

The API and compatible addons can read the start result and reason.

This is useful for:

custom GUIs
Discord bots
Skript menus
admin tools
start buttons

Example reason:

Event is currently on cooldown.

or:

Not enough players online.

Full per-event example

id: supply_drop
enabled: true
display-name: "&eSupply Drop"
duration: 10m

cooldown:
  enabled: true
  duration: 2h

schedule:
  enabled: true
  type: INTERVAL
  every: 1h
  announce-before:
    - 5m
    - 1m
    - 30s

conditions:
  minimum-players: 10
  worlds:
    - world

  permissions: []
  blocked-permissions: []

  require-op: false
  require-non-op: false

  time:
    enabled: false
    min: 0
    max: 23999

  weather:
    allowed: []