From d36304a7745fe7dd25f76653112df9aae452cddd Mon Sep 17 00:00:00 2001
From: Ean Milligan <ean.milligan@gmail.com>
Date: Mon, 20 May 2024 03:16:02 -0400
Subject: [PATCH] Add additional details for self hosting bot

---
 config.example.ts | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/config.example.ts b/config.example.ts
index 8c16502..8a9bc72 100644
--- a/config.example.ts
+++ b/config.example.ts
@@ -1,10 +1,10 @@
-export const config = {
+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.0.4', // 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 MUST BE DIFFERENT FROM "token"
-	'prefix': '/', // Prefix for all commands
-	'db': { // Settings for the MySQL database, this is required for use with the API, if you do not want to set this up, you will need to rip all code relating to the DB out of the 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
@@ -13,16 +13,16 @@ export const config = {
 		'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
-		'supportServer': '', // Invite link to the Discord support server
-		'addToCalendar': '', // Link to where the icsGenerator is hosted
+		'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
 	},
-	'logChannel': 0n, // Discord channel ID where the bot should put startup messages and other error messages needed
-	'reportChannel': 0n, // Discord channel ID where reports will be sent when using the built-in report command
-	'devServer': 0n, // Discord guild ID where testing of indev features/commands will be handled, used in conjunction with the DEVMODE bool in mod.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
+	'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?