GroupUp/config.example.ts

export const config = { // !! NOTICE !! All fields below are required unless they are explicitly noted as OPTIONAL.  If a field is OPTIONAL, do not remove it from this file, just leave it at the default value
	'name': 'Group Up', // Name of the bot
	'version': '1.1.2', // Version of the bot
	'token': 'the_bot_token', // Discord API Token for this bot
	'localToken': 'local_testing_token', // Discord API Token for a secondary OPTIONAL testing bot, THIS SHOULD BE DIFFERENT FROM "token"
	'prefix': '/', // Prefix for all commands, as this bot uses slash commands, this needs to be '/'
	'db': { // Settings for the MySQL database, this is required to keep track of the currently active events.
		'host': '', // IP address for the db, usually localhost
		'localhost': '', // IP address for a secondary OPTIONAL local testing DB, usually also is localhost, but depends on your dev environment
		'port': 3306, // Port for the db
		'username': '', // Username for the account that will access your DB, this account will need "DB Manager" admin rights and "REFERENCES" Global Privileges
		'password': '', // Password for the account, user account may need to be authenticated with the "Standard" Authentication Type if this does not work out of the box
		'name': '', // Name of the database Schema to use for the bot
	},
	'links': { // Links to various sites
		'sourceCode': 'https://github.com/Burn-E99/GroupUp', // Link to the repository, OPTIONAL
		'supportServer': '', // Invite link to the Discord support server, OPTIONAL
		'addToCalendar': '', // Link to where the icsGenerator is hosted, OPTIONAL
		'creatorIcon': '', // Link to where the GroupUpSinglePerson.png (or similar image) is hosted
	},
	'defaultDateFormat': 'MONTH/DAY/YEAR', // Default format that Group Up will suggest to the user.  Must match one of the options in the 'DateTimeFormats' enum inside 'src/buttons/event-creation/dateTimeUtils.ts'
	'logChannel': 0n, // Discord channel ID where the bot should put startup messages and other error messages needed, OPTIONAL
	'reportChannel': 0n, // Discord channel ID where reports will be sent when using the built-in report command, OPTIONAL
	'devServer': 0n, // Discord guild ID where testing of indev features/commands will be handled, used in conjunction with the DEVMODE bool in mod.ts, OPTIONAL
	'owner': 0n, // Discord user ID of the bot admin
	'botLists': [ // Array of objects containing all bot lists that stats should be posted to, OPTIONAL
		{ // Bot List object, duplicate for each bot list
			'name': 'Bot List Name', // Name of bot list, not used
			'enabled': false, // Should statistics be posted to this list?
			'apiUrl': 'https://example.com/api/bots/?{bot_id}/stats', // API URL, use ?{bot_id} in place of the bot id so that it can be dynamically replaced
			'headers': [ // Array of headers that need to be added to the request
				{ // Header Object, duplicate for every header needed
					'header': 'header_name', // Name of header needed, usually Authorization is needed
					'value': 'header_value', // Value for the header
				},
			],
			'body': { // Data payload to send to the bot list, will be turned into a string and any ?{} will be replaced with the required value, currently only has ?{server_count}
				'param_name': '?{param_value}', // Add more params as needed
			},
		},
	],
};

export default config;