config-default.json

{
  "usageGuide": [
    "This file is designed to have a bare-metal working fork of Supibot.",
    "If you want to configure your fork further, copy this file as \"config.json\" and edit as desired.",
    "Do not add the new file to Git.",
    "If no such \"custom configuration\" file exists, this default will be used instead.",
    "The \"disableAll\" flag overrides the black/whitelists completely.",
    "If that flag is \"false\" and both the arrays are empty, it is assumed all modules should be loaded.",
    "",
    "For commands, the \"bannedCombinations\" array contains a list of commands that cannot be executed together in one meta-command execution.",
    "E.g. ['fish', 'translate'] would prevent those two commands from being executed in one pipe or alias combination",
    "",
    "The \"logging\" setup contains separate configurations for each bot-wide logging type.",
    "Each type is an object that contains the \"cron\" property which defines the cron expression on how often each type will be saved to database.",
    "If you would like the type to not be logged, change the \"enabled\" property to `false`."
  ],
  "basePath": "/home/supibot",
  "responses": {
    "defaultBanphrase": "[Banphrased]",
    "commandErrorResponse": "An error occured while executing the command!"
  },
  "values": {
    "pendingCommandTimeout": 300000,
    "pajbotBanphraseRequestTimeout": 5000,
    "commandCodeUrlPrefix": "https://supinic.com/bot/command/detail",
    "commandDetailUrlPrefix": "https://github.com/Supinic/Supibot/tree/master/commands",
    "maxIncomingActiveReminders": 10,
    "maxOutgoingActiveReminders": 10,
    "maxIncomingScheduledReminders": 5,
    "maxOutgoingScheduledReminders": 5,
    "userAdditionHighLoadThreshold": 50,
    "userAdditionCriticalLoadThreshold": 200,
    "massPingBanphraseThreshold": 10
  },
  "local": {
    "epalAudioChannels": [],
    "listenerAddress": null,
    "listenerPort": null,
    "ttsVolume": null,
    "ttsLengthLimit": null,
    "ttsListUrl": null,
    "playsoundListUrl": null,
    "vlcPassword": null,
    "vlcPort": null,
    "vlcUrl": null,
    "vlcUsername": null,
    "vlcBaseUrl": null,
    "vlcIp": null
  },
  "api": {
    "secure": false,
    "port": 11000
  },
  "modules": {
    "chat-modules": {
      "disableAll": true,
      "blacklist": [],
      "whitelist": []
    },
    "commands": {
      "prefix": "$",
      "disableAll": false,
      "blacklist": [],
      "whitelist": [
        "debug",
        "help",
        "ping",
        "pipe",
        "reload"
      ],
      "bannedCombinations": []
    },
    "crons": {
      "disableAll": true,
      "blacklist": [],
      "whitelist": []
    },
    "gots": {
      "defaultUserAgent": "Custom fork of Supibot: github.com/supinic/supibot",
      "disableAll": false,
      "blacklist": [
        "RaspberryPi4",
        "Supinic",
        "TwitchGQL"
      ],
      "whitelist": []
    }
  },
  "platforms": [
    {
      "ID": 1,
      "active": true,
      "type": "twitch",
      "host": null,
      "selfName": "(BOT_ACCOUNT_NAME_HERE)",
      "selfId": "(BOT_ACCOUNT_ID_HERE)",
      "messageLimit": 500,
      "mirrorIdentifier": "(T)",
      "platform": {
        "modes": {
          "Moderator": {
            "queueSize": 1e6,
            "cooldown": 50
          },
          "VIP": {
            "queueSize": 50,
            "cooldown": 150
          },
          "Write": {
            "queueSize": 5,
            "cooldown": 1250
          }
        },
        "subscriptionPlans": {
          "1000": "$5",
          "2000": "$10",
          "3000": "$25",
          "Prime": "Prime"
        },
        "partChannelsOnPermaban": true,
        "clearRecentBansTimer": 60000,
        "recentBanThreshold": null,
        "updateAvailableBotEmotes": false,
        "ignoredUserNotices": [],
        "sameMessageEvasionCharacter": "󠀀",
        "rateLimits": "default",
        "reconnectAnnouncement": {},
        "emitLiveEventsOnlyForFlaggedChannels": false,
        "suspended": false,
        "joinChannelsOverride": [],
        "spamPreventionThreshold": 100,
        "sendVerificationChallenge": false,
        "whisperMessageLimit": 500,
        "privateMessageResponseUnrelated": "Your message has been logged.",
        "privateMessageResponseFiltered": "That command is not available via private messages.",
        "privateMessageResponseNoCommand": "That command does not exist. Please use the commands command to get a list."
      },
      "logging": {
        "bits": false,
        "channelJoins": false,
        "clearchat": false,
        "giftSubs": false,
        "rituals": true,
        "messages": true,
        "subs": false,
        "whispers": true
      }
    },
    {
      "ID": 2,
      "active": false,
      "type": "discord",
      "host": null,
      "selfName": "(BOT_ACCOUNT_NAME_HERE)",
      "selfId": "(BOT_ACCOUNT_ID_HERE)",
      "messageLimit": 2000,
      "mirrorIdentifier": "(D)",
      "platform": {
        "sendVerificationChallenge": false,
        "guildCreateAnnounceChannel": null
      },
      "logging": {
        "messages": false,
        "whispers": true
      }
    }
  ],
  "rustlog": {
    "readme": "This config lets you manage your custom list of Rustlog instances for the $randomline command.",
    "instances": {
      "ivr": {
        "url": "logs.ivr.fi",
        "default": true
      }
    }
  },
  "logging": {
    "messages": {
      "enabled": true,
      "cron": "0 * * * * *"
    },
    "commands": {
      "enabled": true,
      "cron": "30 * * * * *"
    },
    "lastSeen": {
      "enabled": true,
      "cron": "0 */5 * * * *"
    },
    "errors": {
      "enabled": true
    }
  }
}