Configuration

The configuration file for Nexal Maintenance. Located at plugins/Nexal Maintenance/config.yml.

config.yml

# Storage settings
# json: data.json in the plugin folder
# sql: MariaDB/MySQL; each server loads the stored state when it starts
# To switch: /maintenance admin export, change type, /maintenance admin reload, /maintenance admin import
storage:
  type: json
  sql:
    host: localhost
    port: 3306
    database: minecraft
    username: root
    password: ""

# Maintenance mode settings
maintenance:
  # Reason used when maintenance starts or is scheduled without one (leave empty for none)
  default-reason: ""

  # Custom MOTD during maintenance (MiniMessage)
  motd:
    # Without reason
    no-reason:
      line1: "<gradient:#E67E22:#EB984E><bold>MAINTENANCE</bold></gradient>"
      line2: "<gray>The server is currently under maintenance</gray>"
    # With reason (use %reason%)
    with-reason:
      line1: "<gradient:#E67E22:#EB984E><bold>MAINTENANCE</bold></gradient>"
      line2: "<gray>%reason%</gray>"

  # Max players shown in the server list during maintenance (0 shows 0/0)
  max-players-override: 0

  # Use custom server icon during maintenance
  # Place 'server-icon-maintenance.png' in plugin folder (must be 64x64 pixels)
  custom-icon: true

  # Kick settings
  kick:
    # Kick all non-bypassed players when maintenance starts
    on-enable: true
    # Countdown before kicking (seconds, 0 to kick immediately)
    countdown: 10

# Countdown broadcast intervals (in seconds before scheduled maintenance starts)
countdown:
  intervals:
    - 600  # 10 minutes
    - 300  # 5 minutes
    - 60   # 1 minute
    - 30   # 30 seconds
    - 10   # 10 seconds
    - 5
    - 4
    - 3
    - 2
    - 1

Configuration Options

Below is a reference of the main configuration sections:

storage

Storage settings json: data.json in the plugin folder sql: MariaDB/MySQL; each server loads the stored state when it starts To switch: /maintenance admin export, change type, /maintenance admin reload, /maintenance admin import

maintenance

Maintenance mode settings

countdown

Countdown broadcast intervals (in seconds before scheduled maintenance starts)