python-app-rocketbot/config.sample.py

# Copy this file to config.py and fill in "<REQUIRED>" values
CONFIG = {
	'__config_version': 5,

    # -----------------------------------------------------------------------
    # General

	# Client token obtained from the Discord application dashboard. See setup documentation.
	'client_token': '<REQUIRED>',
    # Path to a directory where guild-specific preferences will be stored.
    # Each guild's settings will be saved as a JSON file. Path should end with a slash.
	'config_path': 'config/',
    # Limit on how many users are tagged in one message.
	'max_members_per_message': 20,
	# Minimum seconds between warnings about the same member.
	'squelch_warning_seconds': 300,
	# Whether the Discord app has Message Content intent enabled. Enables more
	# features but requires applying for access for bots serving 10k or more users.
	'has_message_content_intent': False,
	# Whether the Discord app has Server Members intent enabled. Enables more
	# features but requires applying for access for bots serving 10k or more users.
	'has_members_intent': False,

    # -----------------------------------------------------------------------
    # Emojis used for performing actions on flagged activities. The bot will
    # post a message in the designated logging channel with one or more
    # reaction emojis and an explanation of each action. Adding that emoji
    # will perform that action.

    # Reaction for kicking a user from the server
	'kick_emoji': '👢',
	# Reaction for banning a user from the server
	'ban_emoji': '🚫',
	# Reaction for deleting a message
	'trash_emoji': '🗑',
	# Reaction for acknowledging a warning but deciding to take no action
	'ignore_emoji': '👍',

    # -----------------------------------------------------------------------
    # Emojis added to bot messages as general categories. These are just
    # decorative for quickly scanning log message types.

	# A bot operation completed successfully
	'success_emoji': '✅',
	# A bot operation failed
	'failure_emoji': '❌',
	# Something happened that mods should probably pay attention to
	'warning_emoji': '⚠️',
	# Non-critical information
	'info_emoji': 'ℹ️',
	# Logging something that happened on the server (e.g. a user joined the server)
	'log_emoji': '📋',
	# A task is in progress
	'wait_emoji': '⏳',

    # -----------------------------------------------------------------------
    # Default values for cog-specific settings that a guild has not overridden
    # through configuration commands. More information about these is available
    # from the runtime help commands for each cog.
	'cog_defaults': {
		'AutoKickCog': {
		    'enabled': False,
			'bancount': 0,
			'offlineonly': False,
		},
		'CrossPostCog': {
			'enabled': False,
			'dupewarncount': 3,
			'warncount': 5,
			'dupebancount': 9999,
			'bancount': 9999,
			'minlength': 1,
			'timespan': 60,
		},
		'JoinAgeCog': {
		    'enabled': False,
			'jointime': 3600,
		},
		'JoinRaidCog': {
			'enabled': False,
			'joincount': 5,
			'jointime': 5,
		},
		'LoggingCog': {
		    'enabled': False,
		},
		'URLSpamCog': {
			'enabled': False,
			'joinage': 900,  # Should be > 600 due to Discord-imposed waiting period
			'action': 'nothing',  # "nothing" | "modwarn" | "delete" | "kick" | "ban"
			'deceptiveaction': 'nothing',  # "nothing" | "modwarn" | "delete" | "kick" | "ban"
		},
	},
}