Skip to main content

Configuration

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

config.yml
# ══════════════════════════════════════════════════════════
#                   NEXAL ANNOUNCEMENTS
# ══════════════════════════════════════════════════════════
# Free plugin by Nexal Studios — nexalstudios.com
# ══════════════════════════════════════════════════════════

# Storage type: "json" or "sql"
storage:
  type: json

  # SQL settings (used only when type is "sql")
  sql:
    host: localhost
    port: 3306
    database: minecraft
    username: root
    password: ""

# ──────────────────────────────────────────────────────────
#                   ANNOUNCEMENT POOLS
# ──────────────────────────────────────────────────────────
# Each pool is an independent scheduler with its own interval.
# Announcements in a pool rotate either sequentially or randomly.
#
# Pool options:
#   enabled:      true = running, false = paused (pausing in-game sets this)
#   interval:     Seconds between each announcement (minimum 5)
#   order:        sequential | random
#   worlds:       List of worlds to send in (empty = all worlds)
#   permission:   Only send to players WITH this permission (empty = all)
#   announcements: List of message keys from messages.yml
# ──────────────────────────────────────────────────────────
pools:
  tips:
    enabled: true
    interval: 300
    order: sequential
    worlds: []
    permission: ""
    announcements:
      - announcement-tip-1
      - announcement-tip-2
      - announcement-tip-3

  rules:
    enabled: true
    interval: 900
    order: sequential
    worlds: []
    permission: ""
    announcements:
      - announcement-rule-1
      - announcement-rule-2

  new-player:
    enabled: true
    interval: 180
    order: random
    worlds: []
    permission: "nexalannouncements.newplayer"
    announcements:
      - announcement-newplayer-1
      - announcement-newplayer-2

Configuration Options​

Below is a reference of the main configuration sections:

storage​

══════════════════════════════════════════════════════════ NEXAL ANNOUNCEMENTS ══════════════════════════════════════════════════════════ Free plugin by Nexal Studios — nexalstudios.com ══════════════════════════════════════════════════════════

Storage type: "json" or "sql"

pools​

────────────────────────────────────────────────────────── ANNOUNCEMENT POOLS ────────────────────────────────────────────────────────── Each pool is an independent scheduler with its own interval. Announcements in a pool rotate either sequentially or randomly.

Pool options: enabled: true = running, false = paused (pausing in-game sets this) interval: Seconds between each announcement (minimum 5) order: sequential | random worlds: List of worlds to send in (empty = all worlds) permission: Only send to players WITH this permission (empty = all) announcements: List of message keys from messages.yml ──────────────────────────────────────────────────────────