1.0.1 • Published 6 months ago

echo-discord-template v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

Discord Bot Package

A highly featured, advanced Discord bot framework that simplifies bot development with a modular and extensible architecture.

Features

  • šŸš€ Easy setup with npx echo-discord-template
  • šŸ“‚ Modular command handling system
  • šŸ”„ Event-driven architecture
  • šŸ› ļø Built-in component management
  • ⚔ Efficient command and event loading
  • šŸ”Œ Plugin support through handlers
  • šŸ“ Extensive logging capabilities

Installation

npx echo-discord-template

This will set up all the necessary files and structure for your Discord bot project.

Project Structure

discord-bot-package-v1/
ā”œā”€ā”€ src/
│   ā”œā”€ā”€ bot/
│   │   ā”œā”€ā”€ botClientOptions.js
│   │   └── loadHandlers.js
│   ā”œā”€ā”€ commands/
│   │   └── ping.js
│   ā”œā”€ā”€ components/
│   ā”œā”€ā”€ config/
│   ā”œā”€ā”€ events/
│   │   ā”œā”€ā”€ client/
│   │   │   ā”œā”€ā”€ onCreate.js
│   │   │   ā”œā”€ā”€ interactionCreate.js
│   │   │   └── ready.js
│   └── handlers/
│   │   ā”œā”€ā”€ loaders/
│   │       ā”œā”€ā”€ deployCommands.js
│   │       ā”œā”€ā”€ loadCommands.js
│   │       ā”œā”€ā”€ loadComponents.js
│   │       └── loadEvents.js
│   ā”œā”€ā”€ index.js
│   ā”œā”€ā”€ logger.js
│   └── shared.js

Getting Started

  1. Install the package using npx:
npx echo-discord-template
  1. Configure your bot token and other settings in .env file:
BOT_TOKEN=Enter-your-bot-Token
DISCORD_ID=Enter-your-bot-id
BOT_ERROR_LOG_CHANNEL=Enter-the-log-channel
NODE_ENV=
  1. Start developing your commands in the commands directory
  2. Add custom events in the events directory
  3. Run your bot:
npm start

Contributing

We welcome contributions! If you'd like to contribute:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Issues and Bug Reports

Found a bug or have a suggestion? Please open an issue on GitHub with:

  • A clear description of the problem
  • Steps to reproduce
  • Expected behavior
  • Screenshots (if applicable)

License

This project is open-source and available under the MIT License. See the LICENSE file for more details.

Support

Need help? You can:

  • Open an issue on GitHub
  • Join our Discord community (coming soon)
  • Check out the documentation (coming soon)

Acknowledgments

  • Thanks to all contributors who help make this project better
  • Discord.js community for their excellent documentation
  • All users who provide valuable feedback

Made with ā¤ļø by the Discord Bot Package community