Rules

Rules execute actions based on triggers, optionally filtered by conditions. They define what should happen when certain events occur.

Rule structure

rules:
  <rule_name>:
    enabled: true        # Optional: Enable/disable rule (default: true)
    triggers: [ ... ]    # What events should fire this rule
    conditions: { ... }  # Optional: Should the action execute
    action: [ ... ]      # What actions to perform

Or use a template:

rules:
  <rule_name>:
    enabled: true              # Optional: Enable/disable rule (default: true)
    template: <template_name>  # Use a built-in template
    # ... template-specific configuration

Rule components

Triggers

Triggers define when a rule should fire. A rule can have multiple triggers, and the rule fires when any trigger activates.

Available triggers:

See the Triggers section for detailed documentation on each trigger type.

Conditions

Conditions define if a rule should execute (optional). They filter triggers to ensure actions only run under specific circumstances.

Available conditions:

Condition evaluation mode

Conditions support two evaluation modes:

• all (default): All conditions must be true for the rule to execute (AND logic)
• any: At least one condition must be true for the rule to execute (OR logic)

See the Conditions section for detailed documentation.

Actions

Actions define what should happen when a rule fires.

Available actions:

See the Actions section for detailed documentation.

Example rules

Simple manual trigger

rules:
  # Triggered by: /autostartstop trigger start_server <server_name>
  manual_start:
    triggers:
      - manual:
          id: 'start_server'
    action:
      - start:
          server: ${manual.args.0}  # Server name from command argument

Stop on proxy shutdown

rules:
  stop_on_shutdown:
    triggers:
      - proxy_shutdown:
    action:
      - stop:
          server: lobby

Scheduled task (cron)

rules:
  nightly_restart:
    triggers:
      - cron:
          expression: '0 3 * * *'  # 3 AM daily
    action:
      - send_message:
          server: survival
          message: "<yellow>Server will restart in 1 minute.</yellow>"
      - sleep:
          duration: 1m
      - restart:
          server: survival

Rule templates

Instead of defining triggers, conditions, and actions manually, you can use built-in templates for common patterns. Templates simplify configuration for frequently used automation scenarios.

Available templates:

Example:

rules:
  start_on_connect:
    template: 'start_on_connection'
    servers: ['survival']
    mode: waiting_server
    waiting_server:
      server: limbo
      start_waiting_server_on_connection: true

See the Templates section for detailed configuration options.