chrxmaticc-framework 1.1.3 → 1.2.0

package/README.md

@@ -183,4 +183,78 @@ AI_KEY=your_ai_key
 ```
 ---
 
-## Made by Chrxmee-Bits
+## Slash Command Addon
+
+## chrxmaticc-framework v2.0.0
+
+### What's new
+
+**ChrxCommandBuilder** — write commands in as little as 6 lines.
+
+No more `SlashCommandBuilder` boilerplate, no more manual `module.exports = { data, execute }`, no more writing cooldowns and permission checks yourself. Just name, description, and your logic.
+
+### How it works
+```js
+const { ChrxCommandBuilder } = require("chrxmaticc-framework");
+
+module.exports = new ChrxCommandBuilder({
+  name: "balance",
+  description: "Check your coin balance",
+  cooldown: 5,
+  options: [
+    { name: "user", description: "User to check", type: "user", required: false }
+  ],
+  async run(interaction, { economy }) {
+    const target = interaction.options.getUser("user") ?? interaction.user;
+    const data = await economy.getBalance(target.id, interaction.guild.id);
+    interaction.reply(`💰 **${target.username}** — ${data.balance} coins`);
+  }
+});
+```
+
+### Features
+
+- **Auto option type mapping** — write `"user"` instead of `ApplicationCommandOptionType.User`. Supports `string`, `number`, `integer`, `boolean`, `user`, `channel`, `role`, `mentionable`, `attachment`
+- **Built-in cooldowns** — just pass `cooldown: 5` (seconds), handled automatically per user
+- **Built-in permission checks** — pass `permission: "BanMembers"` and it checks before running
+- **Built-in error handling** — any error in `run()` is caught and sends a clean error message automatically. Custom errors via `throw new Error("your message")`
+- **Plugin injection** — all plugins injected into `run()` automatically, no manual requires needed. Access `economy`, `moderation`, `giveaways`, `tickets`, `welcome`, `polls`, `reminders`, `starboard`, `automod`, `xp`, `ai`, `db`
+- **Owner only** — pass `ownerOnly: true` to restrict a command to the bot owner
+- **Choices** — pass `choices: [{ name, value }]` on string/integer/number options for dropdown menus
+- **Still fully flexible** — `run()` is raw discord.js, no ceiling, do anything you could do in a normal command
+
+### Changes
+- Added `ChrxCommandBuilder` to core
+- Updated `Client.js` with `registerPlugin()` method for automatic plugin injection
+- Updated `index.js` to export `ChrxCommandBuilder`
+- Added `GuildMessageReactions` intent and `Partials.Reaction` automatically for Starboard plugin
+
+### Breaking changes
+- None — all v1.x code works as is
+
+### Migration from raw commands
+
+**Before:**
+```js
+const { SlashCommandBuilder } = require("discord.js");
+module.exports = {
+  data: new SlashCommandBuilder()
+    .setName("ping")
+    .setDescription("Pong!"),
+  async execute(interaction) {
+    interaction.reply("Pong!");
+  }
+}
+```
+
+**After:**
+```js
+module.exports = new ChrxCommandBuilder({
+  name: "ping",
+  description: "Pong!",
+  cooldown: 5,
+  async run(interaction) {
+    interaction.reply("Pong!");
+  }
+});
+```

package/core/AIWrapper.js

@@ -1,7 +1,7 @@
 /**
  * src/modules/AIWrapper.js
- * Lightweight wrapper for AI completions.
- * Pass your API key and model in the options.
+ * Lightweight wrapper for AI completions. Nothing big.
+ * Put in your API key and model in the options. 
  */
 
 class AIWrapper {
@@ -70,4 +70,4 @@ class AIWrapper {
   }
 }
 
-module.exports = AIWrapper;
+module.exports = AIWrapper;

package/core/ChrxCommandBuilder.js

@@ -0,0 +1,155 @@
+/**
+ * core/ChrxCommandBuilder.js
+ * Simple command builder — write a command in 10 lines.
+ * Handles SlashCommandBuilder, option types, and plugin injection automatically.
+ */
+
+const { SlashCommandBuilder, PermissionFlagsBits } = require("discord.js");
+
+// ── Option type map ───────────────────────────────────────────────────────
+// Write "user" instead of ApplicationCommandOptionType.User etc.
+const TYPE_MAP = {
+  string:      "addStringOption",
+  number:      "addNumberOption",
+  integer:     "addIntegerOption",
+  boolean:     "addBooleanOption",
+  user:        "addUserOption",
+  channel:     "addChannelOption",
+  role:        "addRoleOption",
+  mentionable: "addMentionableOption",
+  attachment:  "addAttachmentOption",
+};
+
+class ChrxCommandBuilder {
+  /**
+   * @param {object} options
+   * @param {string}   options.name                  Command name (lowercase, no spaces)
+   * @param {string}   options.description            Command description
+   * @param {object[]} [options.options]              Command options/arguments
+   * @param {string}   options.options[].name         Option name
+   * @param {string}   options.options[].description  Option description
+   * @param {string}   options.options[].type         Option type — "string" | "number" | "integer" | "boolean" | "user" | "channel" | "role" | "mentionable" | "attachment"
+   * @param {boolean}  [options.options[].required]   Whether option is required (default: false)
+   * @param {Array}    [options.options[].choices]     Choices array [{ name, value }]
+   * @param {string}   [options.category]             Category label for help menus
+   * @param {string}   [options.permission]           Required permission e.g. "BanMembers"
+   * @param {boolean}  [options.ownerOnly]            Restrict to bot owner
+   * @param {boolean}  [options.guildOnly]            Restrict to guilds only (default: true)
+   * @param {number}   [options.cooldown]             Cooldown in seconds
+   * @param {Function} options.run                    Command function (interaction, plugins) => void
+   */
+  constructor(options = {}) {
+    if (!options.name)        throw new Error("[ChrxCommand] name is required.");
+    if (!options.description) throw new Error("[ChrxCommand] description is required.");
+    if (!options.run)         throw new Error("[ChrxCommand] run function is required.");
+
+    this._options   = options;
+    this._cooldowns = new Map();
+
+    // ── Build SlashCommandBuilder ─────────────────────────────────────────
+    const builder = new SlashCommandBuilder()
+      .setName(options.name)
+      .setDescription(options.description);
+
+    if (options.permission) {
+      builder.setDefaultMemberPermissions(PermissionFlagsBits[options.permission]);
+    }
+
+    if (options.guildOnly !== false) {
+      builder.setDMPermission(false);
+    }
+
+    // ── Add options ───────────────────────────────────────────────────────
+    for (const opt of options.options ?? []) {
+      const method = TYPE_MAP[opt.type ?? "string"];
+      if (!method) throw new Error(`[ChrxCommand] Unknown option type: "${opt.type}"`);
+
+      builder[method]((o) => {
+        o.setName(opt.name).setDescription(opt.description);
+        if (opt.required) o.setRequired(true);
+        if (opt.choices && (opt.type === "string" || opt.type === "integer" || opt.type === "number")) {
+          o.addChoices(...opt.choices);
+        }
+        return o;
+      });
+    }
+
+    this.data = builder;
+  }
+
+  /**
+   * Called by CommandLoader automatically.
+   * Handles cooldowns, permissions, ownerOnly, then calls run().
+   */
+  async execute(interaction) {
+    const client = interaction.client;
+    const opts   = this._options;
+
+    // ── Guild only ────────────────────────────────────────────────────────
+    if (opts.guildOnly !== false && !interaction.guild) {
+      return interaction.reply({ content: "❌ This command can only be used in a server.", ephemeral: true });
+    }
+
+    // ── Owner only ────────────────────────────────────────────────────────
+    if (opts.ownerOnly && interaction.user.id !== process.env.OWNER_ID) {
+      return interaction.reply({ content: "❌ This command is restricted to the bot owner.", ephemeral: true });
+    }
+
+    // ── Permission check ──────────────────────────────────────────────────
+    if (opts.permission) {
+      const member = interaction.member;
+      if (!member?.permissions.has(PermissionFlagsBits[opts.permission])) {
+        return interaction.reply({ content: `❌ You need the **${opts.permission}** permission to use this.`, ephemeral: true });
+      }
+    }
+
+    // ── Cooldown ──────────────────────────────────────────────────────────
+    if (opts.cooldown) {
+      const key = `${interaction.user.id}-${opts.name}`;
+      const now = Date.now();
+      if (this._cooldowns.has(key)) {
+        const remaining = (opts.cooldown * 1000) - (now - this._cooldowns.get(key));
+        if (remaining > 0) {
+          return interaction.reply({
+            content: `⏱ Slow down! Wait **${(remaining / 1000).toFixed(1)}s** before using this again.`,
+            ephemeral: true,
+          });
+        }
+      }
+      this._cooldowns.set(key, now);
+      setTimeout(() => this._cooldowns.delete(key), opts.cooldown * 1000);
+    }
+
+    // ── Inject plugins from client ────────────────────────────────────────
+    // Plugins are attached to client.chrx.* if using ChrxClient
+    const plugins = {
+      economy:    client.chrx?.economy,
+      moderation: client.chrx?.moderation,
+      giveaways:  client.chrx?.giveaways,
+      tickets:    client.chrx?.tickets,
+      welcome:    client.chrx?.welcome,
+      polls:      client.chrx?.polls,
+      reminders:  client.chrx?.reminders,
+      starboard:  client.chrx?.starboard,
+      automod:    client.chrx?.automod,
+      xp:         client.chrx?.xp,
+      ai:         client.chrx?.ai,
+      db:         client.db,
+    };
+
+    // ── Run ───────────────────────────────────────────────────────────────
+    try {
+      await opts.run(interaction, plugins);
+    } catch (err) {
+      console.error(`[ChrxCommand] Error in /${opts.name}:`, err);
+      const msg = { content: "❌ Something went wrong running this command.", ephemeral: true };
+      if (interaction.replied || interaction.deferred) {
+        interaction.followUp(msg).catch(() => {});
+      } else {
+        interaction.reply(msg).catch(() => {});
+      }
+    }
+  }
+}
+
+module.exports = ChrxCommandBuilder;

package/core/Client.js

@@ -1,9 +1,9 @@
 /**
- * src/core/Client.js
- * The main ChrxClient class — wraps discord.js Client with
- * auto loaders, Lavalink, and optional modules.
+ * core/Client.js
+ * The main ChrxClient class.
  */
 
+require("dotenv").config();
 const { Client, GatewayIntentBits, Collection, Partials } = require("discord.js");
 const { LavalinkManager } = require("lavalink-client");
 const CommandLoader = require("./CommandLoader");
@@ -14,29 +14,12 @@ const XPSystem = require("./XPSystem");
 const AIWrapper = require("./AIWrapper");
 
 class ChrxClient {
-  /**
-   * @param {object} options
-   * @param {string} options.token                  - Bot token
-   * @param {string} [options.commandsPath]         - Path to commands folder (default: ./commands)
-   * @param {string} [options.eventsPath]           - Path to events folder (default: ./events)
-   * @param {object} [options.lavalink]             - Lavalink config
-   * @param {string} options.lavalink.host
-   * @param {number} [options.lavalink.port]
-   * @param {string} options.lavalink.password
-   * @param {boolean} [options.lavalink.secure]
-   * @param {object} [options.modules]              - Optional modules to enable
-   * @param {boolean} [options.modules.music]       - Enable music system
-   * @param {boolean} [options.modules.xp]          - Enable XP system
-   * @param {boolean} [options.modules.ai]          - Enable AI wrapper
-   * @param {string}  [options.modules.database]    - Postgres connection string
-   * @param {number[]} [options.intents]            - Override default intents
-   */
   constructor(options = {}) {
-    if (!options.token) throw new Error("[ChrxClient] token is required.");
+    if (!options.token) throw new Error("[ChrxClient] token is required. Check your bot token or this must be a error with the package.");
 
     this._options = options;
 
-    // ── Discord client ───────────────────────────────────────────────────
+    // ── Discord client ────────────────────────────────────────────────────
     this.client = new Client({
       intents: options.intents ?? [
         GatewayIntentBits.Guilds,
@@ -45,19 +28,32 @@ class ChrxClient {
         GatewayIntentBits.GuildMembers,
         GatewayIntentBits.GuildVoiceStates,
         GatewayIntentBits.DirectMessages,
+        GatewayIntentBits.GuildMessageReactions,
       ],
-      partials: [Partials.Channel, Partials.Message],
+      partials: [Partials.Channel, Partials.Message, Partials.Reaction],
     });
 
     this.client.commands = new Collection();
-    this.client.chrx = this; // expose framework on client for use in commands/events
-
-    // ── Lavalink ─────────────────────────────────────────────────────────
+    this.client.chrx     = this; // expose framework on client for plugin injection
+
+    // ── Plugin registry ───────────────────────────────────────────────────
+    // Plugins attach themselves here via registerPlugin()
+    this.economy    = null;
+    this.moderation = null;
+    this.giveaways  = null;
+    this.tickets    = null;
+    this.welcome    = null;
+    this.polls      = null;
+    this.reminders  = null;
+    this.starboard  = null;
+    this.automod    = null;
+
+    // ── Lavalink ──────────────────────────────────────────────────────────
     if (options.lavalink && options.modules?.music !== false) {
       this._setupLavalink(options.lavalink);
     }
 
-    // ── Optional modules ─────────────────────────────────────────────────
+    // ── Built-in modules ──────────────────────────────────────────────────
     if (options.modules?.database) {
       this.db = new Database(options.modules.database);
       this.client.db = this.db;
@@ -74,9 +70,9 @@ class ChrxClient {
 
     // ── Loaders ───────────────────────────────────────────────────────────
     this._commandLoader = new CommandLoader(this.client, options.commandsPath);
-    this._eventLoader = new EventLoader(this.client, options.eventsPath);
+    this._eventLoader   = new EventLoader(this.client, options.eventsPath);
 
-    // ── Ready event ───────────────────────────────────────────────────────
+    // ── Ready ─────────────────────────────────────────────────────────────
     this.client.once("ready", async () => {
       if (this.client.lavalink) {
         await this.client.lavalink.init({
@@ -94,7 +90,7 @@ class ChrxClient {
       console.log(`[ChrxClient] Ready! Logged in as ${this.client.user.tag}`);
     });
 
-    // ── Voice state forwarding for Lavalink ───────────────────────────────
+    // ── Voice state forwarding ────────────────────────────────────────────
     this.client.on("raw", (d) => {
       if (d.t === "VOICE_SERVER_UPDATE" || d.t === "VOICE_STATE_UPDATE") {
         this.client.lavalink?.sendRawData(d);
@@ -111,8 +107,16 @@ class ChrxClient {
   }
 
   /**
-   * Set up the LavalinkManager and attach it to the client.
+   * Register a plugin so it gets injected into ChrxCommand run() calls.
+   * Called automatically when you do new Economy(bot.client) etc.
+   * Or call manually: bot.registerPlugin("economy", economyInstance)
    */
+  registerPlugin(name, instance) {
+    this[name] = instance;
+    this.client.chrx[name] = instance;
+    console.log(`[ChrxClient] Plugin registered: ${name}`);
+  }
+
   _setupLavalink(cfg) {
     this.client.lavalink = new LavalinkManager({
       nodes: [
@@ -139,7 +143,6 @@ class ChrxClient {
       },
     });
 
-    // Attach music manager (handles events + marker system)
     this.music = new MusicManager(this.client);
 
     this.client.lavalink.on("nodeConnect", (node) =>
@@ -150,9 +153,6 @@ class ChrxClient {
     );
   }
 
-  /**
-   * Load commands and events then log in.
-   */
   async start() {
     this._commandLoader.load();
     this._eventLoader.load();

package/core/CommandLoader.js

@@ -1,6 +1,7 @@
 /**
  * src/core/CommandLoader.js
  * Auto-loads slash commands from the user's commands folder.
+ * Also. Please have a deploy-commands.js file or anything that refreshes (loads) commands.
  */
 
 const fs = require("fs");
@@ -14,7 +15,7 @@ class CommandLoader {
 
   load() {
     if (!fs.existsSync(this.commandsPath)) {
-      console.warn(`[CommandLoader] Commands folder not found at ${this.commandsPath}`);
+      console.warn(`[CommandLoader] Commands folder not found at ${this.commandsPath}. Make a commands folder with your remaining commands.`);
       return;
     }
 
@@ -48,4 +49,4 @@ class CommandLoader {
   }
 }
 
-module.exports = CommandLoader;
+module.exports = CommandLoader;

package/core/EventLoader.js

@@ -1,6 +1,7 @@
 /**
  * src/core/EventLoader.js
  * Auto-loads events from the user's events folder.
+ * Make a events folder, its not needed but can be useful for other materials if making a discord bot.
  */
 
 const fs = require("fs");
@@ -35,4 +36,4 @@ class EventLoader {
   }
 }
 
-module.exports = EventLoader;
+module.exports = EventLoader;

package/core/MusicManager.js

@@ -1,6 +1,7 @@
 /**
  * src/music/MusicManager.js
  * Handles all Lavalink events and wires in the song marker system.
+ * Make music commands, this wont have pre-commands. Make an /play command, /stop and extras if needed.
  */
 
 const { EmbedBuilder } = require("discord.js");
@@ -75,4 +76,4 @@ class MusicManager {
   }
 }
 
-module.exports = MusicManager;
+module.exports = MusicManager;

package/core/index.js

@@ -1,6 +1,7 @@
 /**
  * src/index.js
  * Main entry point — exports everything the user needs.
+ * An duplicate of index.js. You can delete if you want.
  */
 
 const { ChrxClient } = require("./Client");
@@ -38,4 +39,4 @@ module.exports = {
   applyStartMarker,
   startEndMarkerWatcher,
   stopEndMarkerWatcher,
-};
+};

package/core/songMarkers.js

@@ -3,7 +3,7 @@
  * Per-track start/end marker system — lavalink-client v2 compatible.
  *
  * Markers are stored in memory. They persist as long as the bot is running
- * but reset on restart. Swap the Map for Postgres if you want them permanent.
+ * but reset on restart. Swap the Map for Postgres or MongoDB if you want them permanent.
  */
 
 // Key: track URI (or title fallback) → { start?: ms, end?: ms, loop?: bool }

package/index.js

@@ -1,10 +1,15 @@
-// FINALLY IT L0ADS FUCKING PLUGINS AND FUCKING CORE SHIT
-// Chrxmaticc Framework is so tuff gng💔
+/**
+ * index.js (not for a discord bot)
+ * Main entry point, will ALWAYS export everything.
+ * Listen to Project4play / SVJ at SoundCloud NOW! 
+ */
+
 const { ChrxClient } = require("./core/Client");
 const Database = require("./core/Database");
 const XPSystem = require("./core/XPSystem");
 const AIWrapper = require("./core/AIWrapper");
 const MusicManager = require("./core/MusicManager");
+const ChrxCommandBuilder = require("./core/ChrxCommandBuilder");
 const {
   parseTime,
   formatTime,
@@ -17,22 +22,28 @@ const {
 } = require("./core/songMarkers");
 
 // ── Plugins ───────────────────────────────────────────────────────────────
-const Economy = require("./plugins/Economy");
+const Economy    = require("./plugins/Economy");
 const Moderation = require("./plugins/Moderation");
-const Giveaways = require("./plugins/Giveaways");
-const Tickets = require("./plugins/Tickets");
-const Welcome = require("./plugins/Welcome");
-const Polls = require("./plugins/Polls");
-const Reminders = require("./plugins/Reminders");
-const Starboard = require("./plugins/Starboard");
-const AutoMod = require("./plugins/AutoMod");
+const Giveaways  = require("./plugins/Giveaways");
+const Tickets    = require("./plugins/Tickets");
+const Welcome    = require("./plugins/Welcome");
+const Polls      = require("./plugins/Polls");
+const Reminders  = require("./plugins/Reminders");
+const Starboard  = require("./plugins/Starboard");
+const AutoMod    = require("./plugins/AutoMod");
 
 module.exports = {
+  // Core
   ChrxClient,
+  ChrxCommandBuilder,
+
+  // Modules
   Database,
   XPSystem,
   AIWrapper,
   MusicManager,
+
+  // Song marker utilities
   parseTime,
   formatTime,
   setMarker,
@@ -41,6 +52,8 @@ module.exports = {
   applyStartMarker,
   startEndMarkerWatcher,
   stopEndMarkerWatcher,
+
+  // Plugins
   Economy,
   Moderation,
   Giveaways,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chrxmaticc-framework",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "A batteries-included Discord bot framework with music, AI, XP and database support.",
   "main": "index.js",
   "files": [