WarnSystem configuration

{
  // This file explains every setting in config.json.
  // It has notes in it, so it is NOT valid JSON. Do not load this file.
  // Edit config.json instead. This file is just here to help you.

  "General": {
    // Debug: set to true to write extra lines to ArkApi.log. Leave it false for normal play.
    "Debug": false,

    // AutosaveSeconds: how often the plugin saves warnings and mutes to disk. 30 is fine.
    "AutosaveSeconds": 30
  },

  // Commands: the words staff and players type in chat. Rename them or set one to "" to
  // turn it off. The first five are for staff. The last one is for any player.
  "Commands": {
    "WarnCMD": "/warn",           // staff: add a warning. /warn <player> <reason>
    "WarningsCMD": "/warnings",   // staff: see a player's warnings. /warnings <player>
    "UnwarnCMD": "/unwarn",       // staff: remove the newest warning. /unwarn <player>
    "MuteCMD": "/mute",           // staff: mute a player. /mute <player> <minutes> [reason]
    "UnmuteCMD": "/unmute",       // staff: unmute a player. /unmute <player>
    "MyWarningsCMD": "/mywarnings" // any player: see their own warnings.
  },

  // Warn: how warnings and the auto mute work.
  "Warn": {
    // TellPlayer: set to true so the warned player gets a private message with the reason.
    "TellPlayer": true,

    // AutoMuteAt: how many active warnings before a player is muted on their own.
    // 3 means the third warning triggers a mute. Set it to 0 to turn auto mute off.
    "AutoMuteAt": 3,

    // MuteMinutes: how long the auto mute lasts, in minutes. 30 is half an hour.
    "MuteMinutes": 30,

    // MaxMuteMinutes: the longest any mute can be, in minutes. 1440 is one day. This caps
    // both the auto mute and the /mute command.
    "MaxMuteMinutes": 1440,

    // EscalateMute: set to true so each warning past the limit mutes for longer. The fourth
    // warning mutes for MuteMinutes times 2, the fifth for times 3, and so on, up to the cap.
    // Set it to false for a flat mute time every time.
    "EscalateMute": true,

    // ExpireDays: warnings older than this many days no longer count toward the auto mute.
    // They still show in the history. 0 means warnings never expire.
    "ExpireDays": 0
  },

  // Mute: how a mute behaves.
  "Mute": {
    // MuteBlocksCommands: set to true so a muted player can not use chat commands either.
    // Leave it false so a muted player can still use commands (like /back), and only their
    // normal chat is blocked. False also means a muted staff member can still /unmute.
    "MuteBlocksCommands": false,

    // CommandPrefix: the character a command starts with. Used to tell a command from chat
    // when MuteBlocksCommands is false. Almost always "/".
    "CommandPrefix": "/"
  },

  // Permissions: this plugin needs the Permissions plugin for the staff chat commands.
  "Permissions": {
    // Enabled: set to false to skip Permissions. Note: without Permissions the staff chat
    // commands (/warn, /mute, and so on) will not work for anyone, on purpose, so they can
    // not be abused. The mute itself still works once it is set.
    "Enabled": true,

    // StaffPermission: the node a player needs to use the staff commands. Give it to your
    // mod and admin groups.
    "StaffPermission": "WarnSystem.Use"
  },

  // Discord: post warnings and mutes to a staff webhook. Off by default.
  "Discord": {
    // Enabled: turn Discord posting on. You must also set a WebhookURL.
    "Enabled": false,

    // WebhookURL: paste your staff channel webhook URL here.
    "WebhookURL": "",

    // Username: the name the webhook posts under.
    "Username": "WarnSystem",

    // ServerName: shows in the embed footer. Handy when you run more than one server.
    "ServerName": "My ARK Server"
  }

  // How mute works under the hood: the plugin watches chat and drops messages from a muted
  // player, so no extra plugin is needed. You can target a player by their online name or by
  // their EOS id. An EOS id works even when the player is offline, which is handy for warnings.
}