Skip to content

newtox/Mog

Repository files navigation

CC BY-NC-SA 4.0

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

CC BY-NC-SA 4.0

Mog: The Dart Discord Bot

Welcome to the Mog repository! Here, you'll find Mog, a Discord bot crafted in Dart using nyxx and nyxx_commands for seamless integration with Discord's slash command system. Whether you're here to use the bot, extend its functionality, or learn about Dart in a Discord bot context, you're in the right place.

Overview

  • Mog: A versatile Discord bot designed for community engagement, moderation, and entertainment, utilizing slash commands.
  • Technology: Built with Dart, leveraging nyxx for Discord interactions and nyxx_commands for managing slash commands.

How to Use

Prerequisites

  • Dart SDK: Ensure Dart is installed and configured on your system.
  • Discord Developer Account: Have a Developer Application to obtain a Bot Token.

Installation

  1. Clone this repository:

    git clone https://github.com/newtox/Mog.git
    cd Mog
  2. Setup:

    • Create a .env file based on the provided .env.example. Copy the content from:
      .env.example
      
    • Replace the placeholders with your bot details:
      token=your_bot_token_here
      db_host=your_database_host
      db_port=your_database_port
      db_user=your_database_username
      db_password=your_database_password
      db_name=your_database_name
      
  3. Run the Bot:

    • After setting up, run:
      dart run bin/main.dart
    • If dependencies aren't installed, first run:
      dart pub get
      

Usage

Mog uses slash commands. Users can see all commands by typing / in Discord. For instance, to check if Mog is online, use:

/ping

Contributing

Interested in adding features to Mog? Here's how:

  • Fork the repository.
  • Create a new branch: git checkout -b feature/your-feature-name
  • Commit your contributions: git commit -m 'Add new feature: your-feature-name'
  • Push to your branch: git push origin feature/your-feature-name
  • Submit a pull request detailing your script or improvements.

License

This project is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike (CC BY-NC-SA) License. For more details, see:

By contributing, you agree that your contributions will be licensed under the same license.

Contact

Have a feature request or found a bug?

About

Discord Bot

Resources

License

Stars

Watchers

Forks

Languages