config.sample.json

// This is a sample config with dummy values
// You can copy this into a `config.json`, which will be loaded by the bot
// Comments are not supported in the real config.json
// These comments are for purely explanatory reasons
{
    "TWINKLE": {
        // The Discord bot token
        "TOKEN": "Discord bot token",
        // When the bot is in development, it will only respond
        // to messages in the DEV.GUILD guild, or from DMs by operators
        "ENV": "production / development",
        "DEV": {
            // Development guild
            "GUILD": "359875425322663940"
        },
        "REPORTING": {
            // Channel where unhandled errors will be reported
            "CHANNEL": "476452336282107925"
        },
		"PRELOAD": {
            // Guilds who's member list will be fully preloaded
            // This is to make JOIN_LEAVE work
			"GUILDS": [
				"246075715714416641"
			]
		},
        // For the !github command, information on the source repository
        "SOURCE": {
            "TYPE": "github",
            "PATH": "Dorumin/Twinkle",
            "URL": "https://github.com/Dorumin/Twinkle"
        },
        // Logger config, channel to post in and whether to use subcategories
        // Categories don't work yet, so don't set it to true
        "LOGGER": {
            "CHANNEL": "637133740593905665",
            "CATEGORIES": false
        },
        // The list of snowflakes of bot operators
        "OPERATORS": [
            "148231501413089280",
            "155545848812535808",
            "195712766214930432"
        ],
        "STARBOARD": {
            "THRESHOLD": 4,
            "STARBOARD_ID": "911674376246689853"
        },
        "GUILD_LOGGER": {
            "GUILDS": {
                "246075715714416641": {
                    "CHANNELS": {
                        "918373559246659584": {
                            "LOG_TYPES": [
                                "VOICE_JOIN",
                                "VOICE_LEAVE",
                                "STREAM_START",
                                "STREAM_END",
                                "MESSAGE_DELETE",
                                "MESSAGE_UPDATE",
                                "ROLES_UPDATE",
                                "EMOJI_CREATE",
                                "NICKNAME_CHANGE",
                                "GUILD_ICON_CHANGE"
                            ]
                        }
                    }
                }
            }
        },
        // Settings for the commander plugin
        "COMMANDER": {
            "MENTION": true,
            "INLINE_ERRORS": true,
            // Default prefixes
            "PREFIXES": [
                "!",
                ">"
            ]
        },
        // Settings for the linker plugin
        "LINKER": {
            "WIKIS": {
                "default": "dev"
            },
            "USERNAME": "Wikia username",
            "PASSWORD": "Wikia password"
        },
        "QUOTER": {
            "MAX": 3
        },
        "SQL": {
            // Where the SQL file will be kept
            "PATH": "./tmp/sql.db",
            "PERSISTENCE": {
                // Custom settings for a persistence layer
                // Heroku has an ephemeral db, so this is needed
                "TYPE": "dropbox",
                "DELAY": 300000,
                "PATH": "/sql.db",
                "TOKEN": "Dropbox token"
            }
        },
        "JOIN_LEAVE": {
            "CHANNEL": "246075715714416641",
            "JOIN_MESSAGE": "Hello <@$USERID> and welcome to the Fandom Developers server! You can read useful information about the server in <#246663167537709058>",
            "LEAVE_MESSAGE": "client.emit(Events.GUILD_LEAVE, $USERID); // $USERNAME#$USERDISCRIM"
        },
        "AUTOMOD": {
            "LOGGING": "Default log channel ID",
            "FILTERS": [
                "MassMention",
                "Zalgo",
                "Invites",
                "BadWords"
            ],
            "ZALGO": {
                "MIN": 8
            },
            "INVITES": {
                "WHITELIST": [
                    "563020189604773888"
                ]
            },
            "BAD_WORDS": {
                "PATTERNS": [
                    "test1",
                    ["\\btest2\\b", "i"]
                ],
                "POST_CCNORM_PATTERNS": [
                ]
            }
        }
    }
}