Skip to content

This project provides a template for creating a Discord bot using discordx and discord.js v14.

License

Notifications You must be signed in to change notification settings

Valhalla-Development/ValkyrieCore

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 Cannot retrieve latest commit at this time.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ValkyrieCore Banner

๐Ÿค– ValkyrieCore: Your Gateway to Bot Development! ๐Ÿš€

Discord Stars Forks Issues License
Codacy Powered by discord.js Made with TypeScript

A robust foundation for creating powerful Discord bots with modern features and best practices!


๐ŸŒŸ Welcome to the ValkyrieCore, a Discord Bot Template!

This project provides a solid foundation for creating a Discord bot using discordx and discord.js v14, designed with scalability and ease of use in mind.

๐ŸŽฎ Features That Power Your Bot

๐Ÿ“Š Bot Info Dashboard

Detailed startup metrics showing users, guilds, commands, and system specs.

๐Ÿ›ก๏ธ Robust Error Handling

Comprehensive error tracking with console and Discord channel logging.

๐Ÿ“ Command Logging

Track command usage with formatted embeds sent to your designated channel.

๐Ÿ“š Thorough Documentation

Well-documented code with TSDoc comments for easy understanding and customization.

โšก Performance Optimized

Built with efficiency in mind to handle commands quickly and reliably.

โ“ Interactive Help Menu

Dynamic help command with slash command links for intuitive user experience.

๐Ÿš€ Requirements

๐Ÿ› ๏ธ Setup Guide

  1. Download the latest release (click on 'Source code (zip)').

  2. Extract and move the files to your desired location.

  3. Install Bun:

    • Mac/Linux:
      curl -fsSL https://bun.sh/install | bash
    • Windows:
      powershell -c "irm bun.sh/install.ps1 | iex"
  4. Navigate to your project folder:

    cd /path/to/your/extracted/source
  5. Rename .env.example to .env and fill in your bot's details:

  6. Install dependencies:

    bun install
  7. Start the bot:

    bun start

๐Ÿ“ธ Screenshots

Bot Info
Bot Info
Error Handling
Error Handler
Command Logging
Command Logger
Help Command
Automatically enables pagination when multiple command categories exist
Help Command

๐Ÿค Contributing

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

  1. Fork the repository
  2. Create a new branch for your feature or bug fix:
    git checkout -b feature/your-feature-name
  3. Make your changes and commit them with a clear, descriptive message:
    git commit -m 'Add feature: brief description of your changes'
  4. Push your changes to your fork:
    git push origin feature/your-feature-name
  5. Open a Pull Request against the main repository's main branch

Please ensure your code adheres to the project's coding standards and include tests for new features or bug fixes where applicable. We appreciate detailed descriptions in your Pull Request to help with the review process.

๐Ÿ“œ License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details. (It's mostly "Share the love, and keep it open!")

๐Ÿ™ Acknowledgements

  • discord.js for the powerful Discord API wrapper
  • discordx for the decorator-based command framework
  • Bun for the blazing fast JavaScript runtime
  • All our contributors and supporters who help improve this template

๐Ÿ“ฌ Support & Community

Got questions or need help? Join our Discord server for support and to connect with other bot developers!


About

This project provides a template for creating a Discord bot using discordx and discord.js v14.

Resources

License

Stars

Watchers

Forks