MAGGIBOT

❯ Made by AG7

Built with the tools and technologies:

🔗 Table of Contents

• 📍 Overview
• 👾 Features
• 📁 Project Structure
  • 📂 Project Index
• 🚀 Getting Started
  • ☑️ Prerequisites
  • ⚙️ Installation
  • 🤖 Usage
  • 🧪 Testing
• 📌 Project Roadmap
• 🔰 Contributing
• 🎗 License
• 🙌 Acknowledgments

---

📍 Overview

Maggibot is a modular Discord bot written in Python using py-cord. It is designed to be extended through cogs and provides a wide range of moderation and community management tools. The bot relies on a small set of configuration and data files (see handlers/config.py) and can be customised via an environment file based on .env.example.

---

👾 Features

• Administration – tools like autoroles, configuration commands and voice gate management.
• Moderation – classic moderation actions (kick, ban, mute) plus community voting utilities.
• Protection – modules for anti-spam, anti-raid, anti-ghost ping and webhook defence.
• Statistics – XP and leaderboard system with adjustable multipliers.
• Ticket system – simple ticket creation workflow for support channels.
• Fun and utilities – quotes, tags, TikTok downloader and more.

---

📁 Project Structure

└── maggibot/
    ├── README.md
    ├── assets
    │   └── All the Mp3 files are stored here
    ├── cogs
    │   └── All Cogs Are Stored here
    │       └── Including all Files
    ├── config
    │   └── All Config Files Are Stored here
    ├── data
    │   └── All data like stats ans so on are stored here
    ├── extensions
    │   └── All extensions are stored here
    ├── handlers
    │   └── All Handlers are here
    ├── main.py
    ├── requirements.txt
    └── start.bat

📂 Project Index

MAGGIBOT/

__root__

main.py	❯ Main entry point of the bot.
requirements.txt	❯ Required packages for the bot.
start.bat	❯ Bat file to start the bot.

handlers

debug.py	❯ Debug Handler
config.py	❯ Handler for config
env.py	❯ env handler

config

voicegateconfig.json	❯ Voicegate config
serverconfig.json	❯ Serverconfig
lockdown.json	❯ Lockdown config

extensions

modextensions.py	❯ Mod extensions
statsextension.py	❯ Stats extension

---

🚀 Getting Started

☑️ Prerequisites

Before getting started with maggibot, ensure your runtime environment meets the following requirements:

• Programming Language: Python
• Package Manager: Pip

⚙️ Installation

See INSTALL.md for a full step-by-step installation guide. In clone the repository, create a virtual environment with python -m venv venv, activate it and install the dependencies with pip install -r requirements.txt, copy .env.example to .env and run python main.py install once to create the default configuration files.

🤖 Usage

Run Maggibot with the helper script:

Run start.bat on Windows or python main.py from an activated virtual environment.

---

📌 Project Roadmap

• Task 1: Main Structure.
• Task 2: Installer.
• Task 3: More Protection Features.

---

🔰 Contributing

• 💬 Join the Discussions: Share your insights, provide feedback, or ask questions.
• 🐛 Report Issues: Submit bugs found or log feature requests for the maggibot project.
• 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/ag7dev/maggibot

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---

🎗 License

This project is protected under the MIT License License. For more details, refer to the LICENSE file.

---

🙌 Acknowledgments

• List any resources, contributors, inspiration, etc. here.

---