RaidAlarm configuration

The RaidAlarm config.json controls how the plugin runs on your Ark Survival Ascended server. Every setting is listed below with what it does and its default value.

Open the configuration editorPrefer clicking to typing? Build the file with sliders and toggles.

Where it lives

Drop the file on your server at ArkApi/Plugins/RaidAlarm/config.json then reload the plugin or restart the server. Keep a backup before large changes.

Every setting

Language

LangAutoFill

SenderName

General

Debug: Debug: flip to true when you want RaidAlarm to log more to ArkApi.log while you sort a problem. Leave it off for normal runs.

Commands

AlarmCMD

RaidAlarm

RaidAlarm: the rules. This plugin listens for structure damage and batches it, so one raid is one alert, not a hundred pings.

BatchSeconds: BatchSeconds: the length of one alert window, in seconds. All hits on one tribe inside this window become a single alert. 60 means at most one alert per tribe per minute during a raid. A raid that lasts ten minutes sends about ten alerts, one a minute, so you see it is ongoing.
MinHitsToAlert: MinHitsToAlert: how many hits a window needs before it sends an alert. This keeps a single stray hit quiet. 5 is a good floor. A bigger number needs a heavier attack to alert.
IgnoreSelfDamage: IgnoreSelfDamage: set to true so a tribe hitting its own build does not alert. This uses the attacker's team, so demolishing or picking up your own base stays quiet.
PlayerAttackersOnly: PlayerAttackersOnly: set to true so only a player raid triggers an alert. This skips a wild dino that wanders into a base. Set to false to also alert on wild creature attacks.
LogCoords: LogCoords: set to true to add the map spot of the attacker (who stands at your base) to the alert, so you know where the raid is. Set to false to leave coords out.
WarnOnlineTribe: WarnOnlineTribe: set to true to also warn any tribe members who are online, in game, when their base is hit. Set to false for a Discord only alert.
PingEveryRaid: PingEveryRaid: set to true to add an @here ping to each Discord alert. Set to false for a quiet post.
MinTeamId: MinTeamId: only alert for structures owned by a team id above this number. 0 means alert for any owned structure. Raise it if you find wild or neutral builds are triggering alerts. Most servers can leave it at 0.
BreachHits
BreachMinutes
RaidOverSeconds
UpdateSeconds
LiveMessage
PostRecap

Routes

Enabled
AllowedHosts
AllowThreads
MaxUrlLength
ConfirmMinutes
KeeperStaleDays
HandoverHours
HardStrikesToDrop
HeartbeatDays
MaxMuteMinutes
QuietBlocksAll
FastBatchSeconds
SetCooldownSeconds
TestCooldownSeconds
MaxPostsPerTick
MaxInFlight
MaxQueued
TierCacheSeconds
KeepCallsDays

Show

Server
Tribe
Player

Tiers

Default
vip
vip2

Permissions

Enabled
Strict
UseNode
PersonalNode
TribeNode
MentionNode
QuietNode
FastNode
AdminNode

Database

UseMySQL
Host
Port
User
Password
Database
TableName
SQLiteDatabasePath

Server

Name
NameFromParams
UseSessionName
Id

ApiUtilsMod

Enabled
BackdropColor
ScreenPosition
TextAlign
TextScale
MessageSeconds
AlsoShowInChat

MapName

Pretty
Overrides

The full commented config

This is a reading copy with notes. It is not valid JSON, so do not load it. Use the editor or the plain config.json instead.

{
  // A guided tour of RaidAlarm's config.json. The notes below make it fail as JSON, so put your
  // real changes in config.json and keep this one just for reading.

  "General": {
    // Debug: flip to true when you want RaidAlarm to log more to ArkApi.log while you sort a problem.
    // Leave it off for normal runs.
    "Debug": false
  },

  // RaidAlarm: the rules. This plugin listens for structure damage and batches it, so one raid
  // is one alert, not a hundred pings.
  "RaidAlarm": {
    // BatchSeconds: the length of one alert window, in seconds. All hits on one tribe inside this
    // window become a single alert. 60 means at most one alert per tribe per minute during a raid.
    // A raid that lasts ten minutes sends about ten alerts, one a minute, so you see it is ongoing.
    "BatchSeconds": 60,

    // MinHitsToAlert: how many hits a window needs before it sends an alert. This keeps a single
    // stray hit quiet. 5 is a good floor. A bigger number needs a heavier attack to alert.
    "MinHitsToAlert": 5,

    // IgnoreSelfDamage: set to true so a tribe hitting its own build does not alert. This uses the
    // attacker's team, so demolishing or picking up your own base stays quiet.
    "IgnoreSelfDamage": true,

    // PlayerAttackersOnly: set to true so only a player raid triggers an alert. This skips a wild
    // dino that wanders into a base. Set to false to also alert on wild creature attacks.
    "PlayerAttackersOnly": true,

    // LogCoords: set to true to add the map spot of the attacker (who stands at your base) to the
    // alert, so you know where the raid is. Set to false to leave coords out.
    "LogCoords": true,

    // WarnOnlineTribe: set to true to also warn any tribe members who are online, in game, when
    // their base is hit. Set to false for a Discord only alert.
    "WarnOnlineTribe": true,

    // PingEveryRaid: set to true to add an @here ping to each Discord alert. Set to false for a
    // quiet post.
    "PingEveryRaid": true,

    // MinTeamId: only alert for structures owned by a team id above this number. 0 means alert for
    // any owned structure. Raise it if you find wild or neutral builds are triggering alerts. Most
    // servers can leave it at 0.
    "MinTeamId": 0
  },

  // Discord: the whole point of the plugin. One clean alert per raid window.
  "Discord": {
    // Enabled: true lets the raid alerts go out to Discord. When it is off, tribes only get the
    // in game warning.
    "Enabled": false,

    // WebhookURL: drop in the webhook link for the channel where raids should show up. Splitting it
    // by tribe comes later, for now every alert lands on this one hook.
    "WebhookURL": "",

    // Username: whatever name you want on the bot when it drops a raid alert.
    "Username": "RaidAlarm",

    // ServerName: the footer name on each alert. Put your server here.
    "ServerName": "My ARK Server"
  }
}