README.md

MoBot

Modular Discord Bot · Report Bug · Request Feature

Overview

MoBot is a modular bot framework for Discord. It allows developers to create, extend, and manage custom modules that hook into the bot to add rich, interactive features.

---

📋 Table of Contents

• Installation
• Creating a Module

---

Installation

To set up MoBot, download the latest release from the releases page.

java -jar MoBot.jar

Creating a Module

To create a module for MoBot, follow these steps:

1. Create a Java Project (Maven/Gradle):

• Maven: Add the MoBot dependency in pom.xml:

  <dependency>
      <groupId>com.pixelservices</groupId>
      <artifactId>MoBot</artifactId>
      <version>VERSION</version> <!-- Replace VERSION -->
  </dependency>

• Gradle: Add the dependency in build.gradle:

  dependencies {
      implementation "com.pixelservices:MoBot:VERSION"  // Replace VERSION
  }

Find the latest version here.

2. Create Main Class: Extend the MbModule class and override the onEnable and onDisable methods:

   public class WelcomeModule extends MbModule {
       @Override
       public void onEnable() {
           //Do something
       }
   
       @Override
       public void onDisable() {
           //Do something
       }
   }

3. Create module.yml: Add a module.yml file in the resources folder and define the module details:

   name: WelcomeModule
   version: 1.0.0
   main: com.example.WelcomeModule
   authors: ["author1", "author2"]
   license: "MIT"
   description: "A welcome module for MoBot"
   dependencies: []