Aidyn: Discord Bot Framework

Common errors

• DiscordAPIError: Missing Access

  cause The bot token provided is invalid, missing, or has incorrect permissions for the requested operation.
  fix Verify that `BotToken` in the Aidyn constructor is correct and that your bot has all necessary intents and permissions enabled in the Discord Developer Portal.

• MongoServerSelectionError: connect ECONNREFUSED <IP>:<PORT>

  cause The MongoDB `ConnectionString` provided is incorrect, the MongoDB server is not running, or there's a network issue preventing connection.
  fix Double-check your `ConnectionString` in the Aidyn constructor. Ensure the MongoDB server is accessible from where your bot is hosted and that no firewalls are blocking the connection.

• ReferenceError: Command is not defined

  cause The `Command` base class was not imported before being extended.
  fix Add `import { Command } from 'aidyn';` to the top of your file where you define custom commands.

• TypeError: aidyn.start is not a function

  cause The `aidyn` instance was not correctly initialized, or `start` was called on a non-Aidyn object.
  fix Ensure you have `const aidyn = new Aidyn({...});` before calling `aidyn.start(commands);`. Double-check the casing and spelling of the method name.

Warnings

• gotcha The `Logging` parameter in the Aidyn constructor has a level `2` which is explicitly 'NOT RECOMMENDED' due to excessive verbosity. Stick to `0` for no logging or `1` for command logging to avoid performance issues or overwhelming console output.
  Fix: Set `Logging: 0` or `Logging: 1` in the Aidyn constructor. Avoid `Logging: 2` unless specifically debugging a critical issue and understand the performance implications.
• gotcha Aidyn currently supports only MongoDB for its database features, including automatic backups. If your project requires a different database system, you will need to manage its integration externally without leveraging Aidyn's built-in capabilities.
  Fix: Ensure you have a MongoDB instance and a valid connection string if you plan to use Aidyn's database features. For other databases, implement custom data handling outside of Aidyn's provided mechanisms.
• gotcha The framework primarily uses modern JavaScript (ESM) import syntax. Attempting to use CommonJS `require()` syntax for core `aidyn` modules may lead to runtime errors or unexpected behavior, especially in environments configured for ESM.
  Fix: Always use `import ... from 'aidyn'` for importing Aidyn components. Ensure your project's `package.json` is configured for ESM where appropriate (e.g., `"type": "module"`).
• breaking Aidyn requires Node.js v8 LTS or higher. While this is an older version, running on unsupported or significantly older Node.js versions may lead to compatibility issues or missing features, as Discord.js and its dependencies evolve.
  Fix: Ensure your Node.js environment is at least v8 LTS. For best compatibility and security, it is recommended to use an active LTS version of Node.js (e.g., Node.js 18 or 20).

Install

• npm install aidyn npm
• yarn add aidyn yarn
• pnpm add aidyn pnpm

Imports

• Aidyn
  wrong:

  const { Aidyn } = require('aidyn');

  correct:

  import { Aidyn } from 'aidyn';

  Aidyn is primarily designed for modern JavaScript and TypeScript environments, favoring ESM imports.
• Command
  wrong:

  const { Command } = require('aidyn');

  correct:

  import { Command } from 'aidyn';

  The base class for all custom bot commands. Extends this class to define command logic.
• Message
  wrong:

  import { Message } from 'aidyn';

  correct:

  import { Message } from 'discord.js';

  While Aidyn wraps Discord.js, core Discord.js types like `Message` are imported directly from `discord.js` itself for type accuracy and direct API access.

Quickstart

Initializes and starts a Discord bot using Aidyn, defining a simple command that responds with processed message content. This example demonstrates class-based command creation and bot setup with environment variables for credentials.

import { Aidyn, Command } from 'aidyn';
import { Message } from 'discord.js'; // Assuming discord.js is installed

class ExampleCommand extends Command {
    static NAME = 'example';

    public Name(): string {
        return ExampleCommand.NAME;
    }
    public Namespace(): string {
        return 'ExampleNamespace';
    }

    public async Run(message: Message): Promise<any> {
        const context = this.GetContext(message); // Process message content for args/flags

        return message.channel.send(`Command: %example was called with content ${JSON.stringify(context)}`);
    }
}

const commands: { [key: string]: typeof Command } = {};
commands[ExampleCommand.NAME] = ExampleCommand;

// Ensure you have these environment variables set
const botToken = process.env.DISCORD_BOT_TOKEN ?? 'YOUR_BOT_TOKEN_HERE';
const mongoConnectionString = process.env.MONGO_CONNECTION_STRING ?? '';

const aidyn = new Aidyn({
    Prefix: '%',
    ConnectionString: mongoConnectionString, // Required for database features (MongoDB only)
    BotToken: botToken,
    Logging: 1 // Log commands. Use 0 for no logging, 2 for verbose (not recommended)
});

aidyn.start(commands);
console.log('Aidyn bot started with example command!');