Discord Bot
About the Project
During the fall of 2017, a Discord partner had requested me to create a bot for their server. Initially, it was meant just to help moderate the server and record data into files. After finishing the requested features, however, he gave me freedom to add more to the bot that would help improve the Discord server. From then on, this Discord bot has been an ongoing project since. With a project I can continuously build upon at any time, the Discord bot has been an accumulation of all the coding practices and knowledge that I know. In 2019, there was another developer that was interested in helping with the project. Currently, the Discord bot runs daily to moderate servers with more than 4,000 people.
Started development in September 2017 and currently is ongoing.
Role in Development
- Producer: David Liu
- Programmers: David Liu, Photon Chaos
The initial project was created completely on my own. Throughout the years of 2017 and 2018, I created tons of features that utilize threading, file IO, and multiple APIs. After another developer came on board, we decided to recreate the entire bot with a much more efficient structure. Currently, the bot is module-based which works well with Discord's asynchronouse API. The code now runs much more efficiently and is much easier to continue development with the organized structure. We hope to keep expanding and building upon the set of modules and libraries we have created over the past few years, making more features for users on Discord to enjoy.
Script Examples
Program.csGeneralHandler.csMessageEmbed.csReminderManager.csProfileModule.csBotUtils.csusing System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Reflection;
using System.Threading;
using Discord;
using Discord.WebSocket;
using Newtonsoft.Json;
using Kamtro_Bot.Handlers;
using Kamtro_Bot.Managers;
using Kamtro_Bot.Nodes;
using Kamtro_Bot.Util;
using Kamtro_Bot.Items;
namespace Kamtro_Bot
{
/// This is the entry point to the program, and the startup class for the bot.
/// Completed I think.
/// -C
public class Program
{
public const string Version = "1.0";
private const string TokenFile = "token.txt";
public static bool Ready = false;
public static bool Debug = false;
public static bool Experimental = false;
public static BotSettings Settings;
public static Thread Autosave;
public static Thread GarbageCollection;
public static Thread DateCheck;
public static Thread AutobanReset;
public static Thread DailyReset;
public static Thread Reminders;
public static DiscordSocketClient Client;
private DiscordSocketConfig config;
private CommandHandler _commands;
private LogHandler _logs;
private ReactionHandler _reaction;
private GeneralHandler _general;
public static FileManager fileManager;
public static UserDataManager userDataManager;
static void Main(string[] args)
{
Console.Title = $"Kamtro Bot v{Version}"; // Formatted string with $ before the "". Any text in the {} is treated as code. I mostly just use this for variables. -C
Console.WriteLine("╔════════════════╗");
Console.WriteLine("║ Kamtro Bot ║");
Console.WriteLine("╠════════════════╣");
Console.WriteLine("║ By: ║");
Console.WriteLine("║ Arcy ║");
Console.WriteLine("║ Carbon ║");
Console.WriteLine("╚════════════════╝");
Console.WriteLine("\n------------------\n");
SetupFiles(); // This is to keep the Main method more readable
LoadFiles();
new Program().StartAsync().GetAwaiter().GetResult();
}
public async Task StartAsync() {
config = new DiscordSocketConfig() { MessageCacheSize = 1000000 }; // initialize the config for the client, and set the message cache size
Client = new DiscordSocketClient(config); // get the client with the configurations we want
// Managers
userDataManager = new UserDataManager(); // This sets up the user data files and loads them into memory
fileManager = new FileManager(); // initialize the file manager
// Initialize Handlers
_commands = new CommandHandler(Client);
_logs = new LogHandler();
_reaction = new ReactionHandler(Client);
_general = new GeneralHandler(Client);
Client.Ready += OnReady; // Add the OnReady event
BotUtils.SaveReady = true; // Tell the class that the autosave loop should start
BotUtils.GCReady = true;
StartThreads();
await Client.LoginAsync(TokenType.Bot, GetToken());
await Client.StartAsync();
KLog.Important("Logged in!");
await Task.Delay(-1); // Stop this method from exiting.
}
public async Task OnReady() {
SetupGeneral();
await GeneralHandler.UpdateRoleMessage(); // fix the role selection message on startup
Ready = true;
KLog.Important("Ready!");
}
public static void LoadSettings() {
// We need a special case for the config
if (!File.Exists(DataFileNames.GeneralConfigFile)) { // If there isn't a config
File.CreateText(DataFileNames.GeneralConfigFile).Close();
Settings = new BotSettings("!"); // Create a default one
Settings.SaveJson(); // Save it
} else {
Settings = JsonConvert.DeserializeObject(FileManager.ReadFullFile(DataFileNames.GeneralConfigFile)); // Load from the file
}
}
public static void StartThreads() {
Autosave = new Thread(new ThreadStart(BotUtils.AutoSave)); // Create the thread. This will be started in StartAsync.
GarbageCollection = new Thread(new ThreadStart(BotUtils.GarbageCollection));
DateCheck = new Thread(new ThreadStart(BotUtils.WeeklyReset));
AutobanReset = new Thread(new ThreadStart(GeneralHandler.ResetThread));
DailyReset = new Thread(new ThreadStart(BotUtils.DailyReset));
Reminders = new Thread(new ThreadStart(BotUtils.ReminderNotifs));
Autosave.Start();
GarbageCollection.Start();
DateCheck.Start();
AutobanReset.Start();
DailyReset.Start();
Reminders.Start();
}
public static void ReloadConfig() {
LoadSettings();
ServerData.SetupServerData(Settings);
KLog.Info("Settings Reloaded");
}
public static void SaveSettings() {
BotUtils.WriteToJson(Settings, DataFileNames.GeneralConfigFile);
KLog.Info("Settings Saved.");
}
private static void SetupFiles() {
// Check for the appropriate directories.
foreach(string dir in DataFileNames.Folders) { // Check through all the necessary directories
if(!Directory.Exists(dir)) { // If the directory does not exist
Directory.CreateDirectory(dir); // Then create it
}
}
// Special case for Excel files.
// Only used for admin stuff atm
AdminDataManager.InitExcel();
// Now for the files
// This loop uses Reflection to iterate through all of the file paths and create any missing files
// The settings.json file is the only one that needs a default template generated for it, and was handled above.
// The passedFolders variable is so that it skips the folder array.
bool passedFolders = false;
string file;
foreach (FieldInfo fieldInfo in typeof(DataFileNames).GetFields(BindingFlags.Static | BindingFlags.Public)) {
if(!passedFolders) {
passedFolders = true;
continue;
}
file = fieldInfo.GetValue(null) as string;
if(!File.Exists(file)) {
Console.WriteLine($"Generated {file}");
File.CreateText(file).Close(); // This creates the file, then closes the unecessary stream writer
}
}
AchievementManager.LoadNodeMap();
// RESET DATES
LastDateNode dates = JsonConvert.DeserializeObject(FileManager.ReadFullFile(DataFileNames.LastDateFile));
if(dates == null) {
dates = new LastDateNode(DateTime.UtcNow.LastSunday(), DateTime.UtcNow);
dates.Save();
}
BotUtils.LastDate = dates;
}
/// Called after OnReady. For anything that needs discord user info
private static void SetupGeneral() {
ServerData.SetupServerData(Settings);
UserInventoryManager.LoadInventories();
ReminderManager.LoadReminders();
}
private static void LoadFiles() {
LoadSettings();
ItemManager.SetupItems();
ShopManager.LoadShopItems();
}
/// This method reads the token from the file named token.txt
/// -C
/// the token as a string
private string GetToken() {
if (!File.Exists(TokenFile)) {
// if there is no token file -C
Console.WriteLine("\nNo token.txt file found!\nPress any key to exit..."); // notify the user -C
Console.ReadKey(); // wait for the keypress -C
Environment.Exit(0); // then exit -C
}
// If the token file exists, then read it and return the token
return FileManager.ReadFullFile(TokenFile);
}
}
}