Skip to content

@axrxvm/betterdiscordjs Documentation

Welcome to the comprehensive documentation for @axrxvm/betterdiscordjs - a modern, modular, and extensible Discord bot framework for Node.js.

📚 Documentation Structure

Getting Started

Core Concepts

Plugin System

Utilities

Advanced Features

Examples

API Reference

Deployment Guide

🚀 What is @axrxvm/betterdiscordjs?

@axrxvm/betterdiscordjs is a powerful Discord bot framework built on top of discord.js that provides:

  • 🎯 Unified Command System: Support for both prefix and slash commands
  • 🔧 Advanced Context Object: Simplified Discord API interactions
  • 📦 Plugin Architecture: Modular, reusable components
  • ⚡ Built-in Utilities: Caching, rate limiting, scheduling, and more
  • 🎨 Rich Embed Builder: Intuitive embed creation with fluent API
  • 🔄 Hot Reloading: Development-friendly command and event reloading
  • 📊 Statistics & Logging: Built-in command tracking and beautiful logs
  • 🛡️ Error Handling: Comprehensive error management system

🎯 Key Features

Modern JavaScript

  • ES6+ syntax support
  • Promise-based architecture
  • Async/await throughout

Developer Experience

  • Intuitive API design
  • Comprehensive error messages
  • Hot reloading for development
  • Beautiful, color-coded logging

Production Ready

  • Built-in rate limiting
  • Database integration
  • Plugin system for modularity
  • Graceful error handling
  • Performance optimizations

Discord.js Integration

  • Full discord.js v14 compatibility
  • Enhanced with additional utilities
  • Maintains all original functionality

🏗️ Architecture

@axrxvm/betterdiscordjs follows a modular architecture:

┌─────────────────┐
│   Your Bot      │
├─────────────────┤
│   @axrxvm/betterdiscordjs    │
│   Framework     │
├─────────────────┤
│   discord.js    │
├─────────────────┤
│   Node.js       │
└─────────────────┘

📖 Quick Example

const { Bot } = require('@axrxvm/betterdiscordjs');

const bot = new Bot(process.env.DISCORD_TOKEN, {
  prefix: '!',
  commandsDir: './commands',
  eventsDir: './events'
});

// Inline command
bot.command('hello', async (ctx) => {
  await ctx.reply('Hello, World!');
});

// Event handler
bot.on('ready', (ctx) => {
  console.log(`${ctx.user.tag} is ready!`);
});

bot.start();

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

📄 License

@axrxvm/betterdiscordjs is licensed under the MIT License. See LICENSE for details.

🆘 Support

Built with ❤️ for the Discord developer community#

Next Steps

Ready to start building? Here's your learning path:

  1. 🚀 Quick Start - Get up and running in minutes
  2. 📦 Installation Guide - Detailed setup instructions
  3. 🏗️ Your First Bot - Build your first bot step by step
  4. ⚙️ Configuration - Master bot configuration options