search

allthingslinux / tux

Tux is an all in one bot for the All Things Linux discord server.
https://discord.gg/linux
GNU General Public License v3.0
20 stars 8 forks source link
asyncio discord discord-py docker dotenv httpx just linux loguru mypy poetry pre-commit prisma pyright python renovate ruff supabase

readme

Tux

A Discord bot for the All Things Linux Discord server

Forks Repo size Issues License Discord

NOTE: This bot (without plenty of tweaking) is not ready for multi-server use, we recommend against using it until it is more complete

About

Tux is a Discord bot for the All Things Linux Discord server. It is designed to provide a variety of features to the server, including moderation, support, utility, and various fun commands. The bot is written in Python using the discord.py library.

Installation

Prerequisites

Steps

  1. Clone the repository

    git clone https://github.com/allthingslinux/tux && cd tux
  2. Install the dependencies 
    poetry install
  3. Activate the virtual environment 
    poetry shell
  4. Install the pre-commit hooks 
    pre-commit install
  5. Generate the prisma client 
    prisma generate
  6. Copy the .env.example file to .env and fill in the required values 
    cp .env.example .env
  7. Run the sync command in the server to sync the slash command tree. 
    {prefix}sync <server id>
  8. Review all useful CLI commands by visiting the useful CLI commands file.

License

This project is licensed under the terms of the The GNU General Public License v3.0. See the LICENSE file for details.