Skip to content

sudoscrawl/carbon

Banner

Carbon [WIP]

Handle your discord server. Effortlessly.

Carbon is a modern, high-performance Discord management bot designed to streamline moderation. Built with discord.py, SQLAlchemy, and Redis, it offers a robust and scalable solution for communities of all sizes.

✨ Features

  • Kick: Kick someone from the server.
  • Ban: Ban someone from the server.
  • Unban: Unban someone from the server.
  • Timeout: Timeout someone in the server.
  • Warn: Warn a member of the server.
  • Purge: Delete messages in bulk.

🚀 Getting Started

Prerequisites

  • Python: 3.12 or higher
  • Poetry: For dependency management
  • PostgreSQL: For persistent data storage
  • Redis: For caching and performance
  • Discord Bot: From the Discord Developer Portal

Installation

  1. Clone the Repository:

    git clone https://github.com/sudoscrawl/carbon.git
    cd carbon
  2. Install Dependencies:

    poetry install
  3. Configure Environment Variables: Copy the .env.example file and fill in your details:

    cp .env.example .env

    Edit .env and provide your BOT_TOKEN, DB_URL, and Redis credentials.

  4. Run Migrations (if applicable):

    poetry run alembic upgrade head
  5. Start the Bot:

    poetry run python main.py

Running with Docker

You can also run Carbon using Docker Compose:

docker-compose up -d

🛠️ Tech Stack

📜 License

This project is licensed under the GPL-3.0 License.

About

Handle your discord server. Effortlessly.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Contributors