Add plugin manager

.gitignore

@@ -133,3 +133,7 @@ dist
 .svelte-kit
 
 # End of https://www.toptal.com/developers/gitignore/api/node
+
+# Plugins (These are to be handled in separate repos)
+plugins/*
+!plugins/README.md

package.json

@@ -26,6 +26,7 @@
     "discord-api-types": "^0.25.2",
     "discord.js": "^13.3.1",
     "dotenv": "^10.0.0",
+    "glob": "^8.0.3",
     "piston-client": "^1.0.2",
     "winston": "^3.3.3",
     "winston-daily-rotate-file": "^4.5.5"

plugins/README.md

@@ -0,0 +1,23 @@
+# MoDiBo Plugins
+
+## File Structure
+
+Plugins should be placed here, each in their own directory. In that directory should be a `main.js` file with the required blueprint components.
+
+```
+plugins/
+- testPlugin/
+-- main.js
+-- supportingFile.js
+-- data.json
+- testPlugin2/
+-- main.js
+```
+
+## To Enable a Plugin Installed Here...
+
+`//TODO`
+
+## Other `//TODO`
+
+- Finalize the wording of this document. Limited information about developing plugins should be placed here; the bulk of that should be in the actual documentation somewhere, either in the wiki or website.

src/main.js

@@ -13,6 +13,7 @@ const winston = require("winston");
 const winstonDiscord = require("./CustomDiscordWebhookTransport.js");
 const winstonRotateFile = require("winston-daily-rotate-file");
 const utils = require("./utils.js");
+const pluginManager = require("./plugin-manager.js");
 
 const PREFIX = "$";
 
@@ -115,6 +116,9 @@ const bot = new Client({
 bot.on("ready", async () => {
   // when loaded (ready event)
   bot.user.setActivity(`${PREFIX}help | ${PREFIX}info`, { type: "PLAYING" });
+
+  pluginManager.load();
+
   utils.logger.log("debug", `${bot.user.username} is ready...`);
 });
 

src/plugin-manager.js

@@ -0,0 +1,67 @@
+const glob = require("glob");
+const utils = require("./utils.js");
+const PLUGIN_FILES = "../plugins/*/main.js";
+
+/**
+ * Load plugin modules
+ * @param {Discord.Client} bot The instantiated Discord Bot object, for use in calling module onLoad
+ */
+function load(bot) {
+  //TODO Integrate with Config to only load enabled plugins
+
+  utils.logger.log("debug", "Loading Plugins...");
+
+  glob.sync(PLUGIN_FILES).forEach((file) => {
+    let dash = file.split("/");
+    if (dash.length !== 4) {
+      return;
+    }
+
+    let dot = dash[3].split(".");
+    if (dot.length !== 2) {
+      return;
+    }
+
+    let module = require(file);
+    let key = module.SLUG;
+    let loaded = false;
+
+    if (module.processCommand) {
+      utils.plugins.command[key] = module;
+      loaded = true;
+      utils.logger.log("debug", `Loaded "${module.NAME}" as a Command Plugin`);
+      utils.plugins.command[key].processCommand();
+    }
+
+    if (module.processMessage) {
+      utils.plugins.message[key] = module;
+      loaded = true;
+      utils.logger.log("debug", `Loaded "${module.NAME}" as a Message Plugin`);
+      utils.plugins.message[key].processMessage();
+    }
+
+    if (module.startCron) {
+      utils.plugins.cron[key] = module;
+      loaded = true;
+      utils.logger.log("debug", `Loaded "${module.NAME}" as a Cron Plugin`);
+    }
+
+    if (loaded && module.onLoad) {
+      utils.logger.log("debug", `Running "${module.NAME}" onLoad function...`);
+      module.onLoad(bot);
+    }
+  });
+
+  utils.logger.log("debug", "All Plugins Loaded");
+  for (const [pluginType, list] of Object.entries(utils.plugins)) {
+    const pluginNames = Object.values(list).map((p) => `"${p.NAME}"`);
+    utils.logger.log(
+      "debug",
+      `${pluginType} plugins: ${pluginNames.join(", ")}`
+    );
+  }
+}
+
+module.exports = {
+  load,
+};

src/utils.js

@@ -16,6 +16,13 @@ const SECOND = 1000;
 const MINUTE = 60 * SECOND;
 const HOUR = 60 * MINUTE;
 
+// Loaded Plugin storage
+let plugins = {
+  command: {},
+  message: {},
+  cron: {},
+};
+
 /**
  * Send a message to a channel of your choice.
  * @param {Discord.MessageEmbed|String} content The content to include in the message.
@@ -141,4 +148,5 @@ module.exports = {
   reply,
   createEmbed,
   logger,
+  plugins,
 };