wlinator/tux
1
Fork 0
mirror of https://github.com/allthingslinux/tux.git synced 2024-10-02 16:43:12 +00:00
Code Issues Releases Wiki Activity
Tux is an all in one bot for the All Things Linux discord server.
822 commits 28 branches 0 tags 14 MiB
Python 99.7%
Dockerfile 0.2%
Just 0.1%
Find a file
kzndotsh 31597e452a feat(pre-commit-config.yaml): update ruff-pre-commit version to v0.5.5 for latest features and bug fixes 
feat(settings.json): add new image URLs for various case statuses to enhance visual feedback
refactor(cases.py): improve code readability by adding parameter descriptions and breaking down long function calls
feat(cases.py): add active and inactive case icons to embeds for better visual distinction between case statuses
2024-07-25 19:24:41 +00:00
.archive chore: remove unused pagination.py file from .archive directory 2024-07-25 15:04:44 +00:00
.github Delete .github/dependabot.yml 2024-06-21 12:15:50 -04:00
assets feat(pre-commit-config.yaml): update ruff-pre-commit version to v0.5.5 for latest features and bug fixes 2024-07-25 19:24:41 +00:00
config feat(pre-commit-config.yaml): update ruff-pre-commit version to v0.5.5 for latest features and bug fixes 2024-07-25 19:24:41 +00:00
docs style(README.md): replace CRLF line endings with LF for better cross-platform compatibility 2024-04-11 19:24:07 +00:00
prisma refactor(schema.prisma): rename enum values HACK_BAN and TEMP_BAN to HACKBAN and TEMPBAN for consistency 2024-07-22 16:39:18 +00:00
tux feat(pre-commit-config.yaml): update ruff-pre-commit version to v0.5.5 for latest features and bug fixes 2024-07-25 19:24:41 +00:00
.editorconfig feat: add .editorconfig for consistent coding style across different editors 2024-04-11 20:22:47 +00:00
.env.example chore(.env.example): restructure and clean up environment variables for better organization and clarity 2024-07-13 19:21:16 +00:00
.gitignore Added new commands 2024-05-06 18:41:31 -05:00
.mise.toml feat: add .editorconfig for consistent coding style across different editors 2024-04-11 20:22:47 +00:00
.pre-commit-config.yaml feat(pre-commit-config.yaml): update ruff-pre-commit version to v0.5.5 for latest features and bug fixes 2024-07-25 19:24:41 +00:00
docker-compose.yml feat: add Dockerfile and docker-compose.yml for containerization 2024-06-11 05:18:25 +00:00
Dockerfile style(Dockerfile): add line breaks for better readability and maintainability 2024-07-02 21:09:07 +00:00
justfile chore(.env.example): restructure and clean up environment variables for better organization and clarity 2024-07-13 19:21:16 +00:00
LICENSE.md Update LICENSE.md 2024-06-21 23:54:58 -04:00
poetry.lock feat(pre-commit-config.yaml): update ruff-pre-commit version to v0.5.5 for latest features and bug fixes 2024-07-25 19:24:41 +00:00
poetry.toml feat(poetry.toml): add poetry.toml file to create virtual environments within the project directory 2024-07-02 19:19:07 +00:00
pyproject.toml chore: remove unused pagination.py file from .archive directory 2024-07-25 15:04:44 +00:00
README.md Update README.md 2024-06-22 00:07:05 -04:00
renovate.json Add renovate.json 2024-04-11 20:02:04 +00:00

README.md

Tux

A Discord bot for the All Things Linux Discord server

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.