> For the complete documentation index, see [llms.txt](https://ark-guardian.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ark-guardian.gitbook.io/docs/feature-documentation/commented-config.md).

# Commented Config

This page lists and explains our configuration with comments.

<pre class="language-json" data-title="commented_config.json" data-line-numbers data-full-width="true"><code class="lang-json">{
    <a data-footnote-ref href="#user-content-fn-1">"Debug"</a>: false,
    <a data-footnote-ref href="#user-content-fn-2">"DisableConsoleTitle"</a>: true,
    <a data-footnote-ref href="#user-content-fn-3">"UseGuardianAPI"</a>: false,
    <a data-footnote-ref href="#user-content-fn-4">"LicenseKey"</a>: "PUT_YOUR_LICENSE_HERE",
    <a data-footnote-ref href="#user-content-fn-5">"SteamAPIKey"</a>: "",
    <a data-footnote-ref href="#user-content-fn-6">"Mysql"</a>: {
        "MysqlHost": "localhost",
        "MysqlUser": "plugindb",
        "MysqlPass": "123",
        "MysqlDB": "ark_database",
        "MysqlPort": 3306,
        <a data-footnote-ref href="#user-content-fn-7">"MysqlTable_Bans"</a>: "arkguardian_bans",
        <a data-footnote-ref href="#user-content-fn-8">"MysqlTable_AAS"</a>: "arkguardian_aas",
        <a data-footnote-ref href="#user-content-fn-9">"MysqlTable_ADL"</a>: "arkguardian_adl",
        <a data-footnote-ref href="#user-content-fn-10">"EnableDiscordIntegration"</a>: false,
        <a data-footnote-ref href="#user-content-fn-11">"DiscordIntegrationMysql"</a>: {
            "MysqlTable_Discord": "put_your_table_discord",
            "Discord_IdKey": "put_your_table_discord_id_key",
            "Discord_SteamIdKey": "put_your_table_steam_id_key",
            "UseSecondDatabase": false,
            "MysqlHost": "localhost",
            "MysqlUser": "plugindb",
            "MysqlPass": "123",
            "MysqlDB": "ark_database2",
            "MysqlPort": 3306
        }
    },
    "BanSettings": {
        <a data-footnote-ref href="#user-content-fn-12">"UseIPBan"</a>: true,
        <a data-footnote-ref href="#user-content-fn-13">"UseGlobalBanSystem"</a>: false,
        "GlobalBanSystem": {
            <a data-footnote-ref href="#user-content-fn-14">"IncludeServerTags"</a>: [
                "ALL"
            ],
            <a data-footnote-ref href="#user-content-fn-15">"ExcludeServerTags"</a>: [
                "TEST"
            ],
            <a data-footnote-ref href="#user-content-fn-16">"RestrictJoin"</a>: false,
            <a data-footnote-ref href="#user-content-fn-17">"AlertAdmins"</a>: true,
            <a data-footnote-ref href="#user-content-fn-18">"AlertWebhook"</a>: "PUT_WEBHOOK_HERE",
            <a data-footnote-ref href="#user-content-fn-19">"IgnoreGroup"</a>: "IgnoreGlobal"
        },
        <a data-footnote-ref href="#user-content-fn-20">"Messages"</a>: {
            "GlobalBan": "You are globally banned from the protected server network",
            "LocalBan": "You are banned!\nFor: {}\nTime: {}\nId: {}"
        }
    },
    <a data-footnote-ref href="#user-content-fn-21">"SafeBanSettings"</a>: {
        "MinCycles": 1,
        "MaxCycles": 3
    },
    <a data-footnote-ref href="#user-content-fn-22">"Webhooks"</a>: {
        <a data-footnote-ref href="#user-content-fn-23">"BansWebhook"</a>: "PUT_YOUR_WEBHOOK_HERE",
        <a data-footnote-ref href="#user-content-fn-24">"DetectionWebhook"</a>: "PUT_YOUR_WEBHOOK_HERE",
        <a data-footnote-ref href="#user-content-fn-25">"BehavioralWebhook"</a>: "PUT_YOUR_WEBHOOK_HERE",
        <a data-footnote-ref href="#user-content-fn-26">"SystemWebhook"</a>: "PUT_YOUR_WEBHOOK_HERE",
        <a data-footnote-ref href="#user-content-fn-27">"RedirectWebhooks"</a>: {
            "AntiLongArms": "Disabled",
            "GuardianCrashFixes": "PUT_YOUR_WEBHOOK_HERE",
            "ExplorerNoteTracker": ""
        },
        <a data-footnote-ref href="#user-content-fn-28">"UseServerKey"</a>: false
    },
    <a data-footnote-ref href="#user-content-fn-29">"InGameMessages"</a>: {
        "NotifyBans": true,
        "NotifyDetection": true,
        "NotifyBehavioral": true
    },
    <a data-footnote-ref href="#user-content-fn-30">"ClassMapping"</a>: {
        "BuffTekGloves": "Blueprint'/Game/PrimalEarth/CoreBlueprints/Buffs/Buff_TekArmor_Gloves.Buff_TekArmor_Gloves'",
        "BuffTekShirt": "Blueprint'/Game/PrimalEarth/CoreBlueprints/Buffs/Buff_TekArmor_Shirt_Rework.Buff_TekArmor_Shirt_Rework'",
        "BuffTekSword": "Blueprint'/Game/PrimalEarth/CoreBlueprints/Buffs/Buff_TekArmor_Sword.Buff_TekArmor_Sword'"
    },
    <a data-footnote-ref href="#user-content-fn-31">"SpectatorList"</a>: [
        "PUT_YOUR_STEAMID1_HERE",
        "PUT_YOUR_STEAMID2_HERE"
    ],
    <a data-footnote-ref href="#user-content-fn-32">"Features": {}</a>
}
</code></pre>

[^1]: This option makes plugin display more information when set on **TRUE**, this helps us to find issues and ensure everything is working.&#x20;

    By default we receive brief debug information in our web service, we might ask you to enable this and provide logs if you experience any issues.

[^2]: If you use any additional software that is using console title as method to find application, you might need to set this to **TRUE**, by default it is showing that server is protected by ARK Guardian and it was properly initialized.

[^3]: This option is used to enable our ARK API version, allowing us to do more stuff and fix some crashes/bugs within API code.

[^4]: Get your License Key in <mark style="color:purple;">LicenseMacrops</mark>&#x20;

    You can find bot in [<mark style="color:purple;">**SR's Modding Place**</mark>](https://discord.srdevs.net/)

    Write */licenses* and get your key!

    ![](https://3976480278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSoNyYy9uLQIIIOnH2TiF%2Fuploads%2FDv6oUyuxJs9i9N14PteF%2FLicenseMacrops3.png?alt=media\&token=6d2e64ea-fd38-4d7c-93c5-45503da2d70c)

[^5]: Obtain it on

    <https://steamcommunity.com/dev/apikey>

[^6]: [MySQL Setup](/docs/getting-started/mysql-setup.md)

[^7]: This table saves all ARK Guardian bans.

[^8]: This table saves all Anti Account Sharing entries.

[^9]: This table saves all Anti Double Login entries.

[^10]: Use this if you want to enable Discord Integration.

[^11]: [Installation & Setup](/docs/getting-started/setup.md#setup-discord-integration)

[^12]: Use IP identification in Ban System

[^13]: Use Global Ban System, this will make server download global ban list every saveworld.

[^14]: Include Servers you want to get bans from, you could use our server key list to include some. By default tag "ALL" means: "Include ALL servers"

[^15]: Exclude Server Tags from downloading global ban system entries.

[^16]: Restrict Join for those who are inside global ban system lists.

[^17]: If you are not restricting joins, you may receive notifications about globally banned players.

[^18]: Alert Webhook for `"AlertAdmins"`

[^19]: Permissions Integrations, used to ignore global ban system restrictions and alerts.

    See [Permissions Integration](/docs/feature-documentation/permissions-integration.md)

[^20]: Server Messages on BanSystem, you could localize them.

[^21]: Safe Ban is a system created to delay bans after specific detections, so cheaters don't see a coincidence in specific actions.

    **Each cycle is roughly 15 minutes.**

[^22]: Our webhook system supports double linking, like:

    `"FIRST_HOOK,SECOND_HOOK"`

[^23]: All ban-related actions will be sent here

[^24]: All default detections (no-ban) actions will be sent here.

[^25]: All behavioral actions will be sent here, usually they are providing information to developers, not containing something very illegal.

[^26]: All system notifications such as commands, double login and account sharing will be sent here, this also includes global ban system alerts.

[^27]: Webhook redirection system, if you wish to monitor specific feature or separate it.

    Supports links and could also disable feature notifications, while not disabling feature itself.

    Format is:

    <mark style="color:blue;">`"FeatureName"`</mark>`: "LNK/Disabled"`

[^28]: Uses `-ServerKey=""` startup argument instead of server name.

[^29]: This option lets you choose what in-game messages should plugin provide, this feature is made for rapid reaction on whatever is happening, useable for events or active admin spectating.

    This feature doesn't notify about system stuff, only bans/detections/behavioral.

[^30]: If you are using custom Tek Armor with custom reparented buffs, which is a rare case, you might remap these blueprints to make `TekSuit`/`TekSword` features work again.

[^31]: Enables BetterSpectator/DetectionHelper systems access to non-admin users.

    Could be reloaded with `ArkGuardian.Reload`

[^32]: We are not providing public feature list in configurations, search for them in shipped archive in `config.json`