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.
1032 commits 28 branches 0 tags 14 MiB
Python 99.7%
Dockerfile 0.2%
Just 0.1%
Find a file
Atmois 6d0cd2654f
Merge remote-tracking branch 'origin/main' into suggestioncmd
2024-08-18 06:05:39 +01:00
.archive refactor: remove dollar sign from usage instructions in various commands for consistency 2024-08-15 06:33:00 +00:00
.github docs(CODE_OF_CONDUCT.md, CONTRIBUTING.md): wrap email and URLs in angle brackets for better markdown rendering 2024-08-17 08:27:13 +00:00
assets feat(emojis): add new tux_notify and tux_tag emojis for better visual representation 2024-08-17 23:16:32 +00:00
config Create suggestion command based on the reporting command 2024-08-13 00:09:21 +01:00
docs docs(CODE_OF_CONDUCT.md, CONTRIBUTING.md): wrap email and URLs in angle brackets for better markdown rendering 2024-08-17 08:27:13 +00:00
prisma Add in the controller and db model for suggest command, to be finished by kaizen 2024-08-18 06:03:53 +01:00
tux Merge remote-tracking branch 'origin/main' into suggestioncmd 2024-08-18 06:05:39 +01:00
.editorconfig feat: add .editorconfig for consistent coding style across different editors 2024-04-11 20:22:47 +00:00
.env.example refactor(.env.example): reorder and clean up environment variables for better readability 2024-08-11 02:47:24 +00:00
.gitignore chore: add .DS_Store to .gitignore 2024-08-15 09:43:39 +01:00
.markdownlint.yaml docs(CODE_OF_CONDUCT.md, CONTRIBUTING.md): wrap email and URLs in angle brackets for better markdown rendering 2024-08-17 08:27:13 +00: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 chore(.pre-commit-config.yaml): update ruff-pre-commit version from v0.5.7 to v0.6.1 for latest features and bug fixes 2024-08-17 00:16:16 +00:00
docker-compose.yml fix(Dockerfile): remove entrypoint and use CMD for better debugging 2024-08-06 15:45:49 +00:00
Dockerfile Alphabetise RUN instructions 2024-08-11 19:14:20 +01:00
justfile feat(docs): add MkDocs documentation with initial pages 2024-07-31 01:38:07 +00:00
LICENSE.md Update LICENSE.md 2024-06-21 23:54:58 -04:00
mkdocs.yml feat(docs): add MkDocs documentation with initial pages 2024-07-31 01:38:07 +00:00
poetry.lock chore(.pre-commit-config.yaml): update ruff-pre-commit version from v0.5.7 to v0.6.1 for latest features and bug fixes 2024-08-17 00:16:16 +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 fix(deps): update dependency prisma to ^0.15.0 2024-08-17 00:11:53 +00:00
README.md docs(CODE_OF_CONDUCT.md, CONTRIBUTING.md): wrap email and URLs in angle brackets for better markdown rendering 2024-08-17 08:27:13 +00:00
renovate.json Add renovate.json 2024-04-11 20:02:04 +00:00
SECURITY.md Create SECURITY.md 2024-08-15 21:31:15 -05:00

README.md

Tux

A Discord bot for the All Things Linux Discord server

Warning

This bot (without plenty of tweaking) is not ready for production use, we recommend against using it until it is more complete.

About

Tux is an all in one 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.

Tech Stack

  • Python 3.12 alongside the Discord.py library
  • Poetry for dependency management
  • Docker and Docker Compose for development and deployment
  • Strict typing with Pyright and type hints
  • Type safe ORM using Prisma
  • PostgreSQL database with Supabase
  • Linting and formatting via Ruff and Pre-commit
  • Justfile for easy CLI commands
  • Beautiful logging with Loguru
  • Exception handling with Sentry

Bot Features

  • Asynchronous codebase
  • Hybrid command system with both slash commands and traditional commands
  • Cog loading system with hot reloading
  • Branded embeds and messages
  • Robust error handling
  • Activity rotation
  • Custom help command
  • Configuration system
  • Dynamic role-based (access level) permission system

Installation

Prerequisites

Steps to Install

Assuming you have the prerequisites installed, follow these steps to get started with the development of the project:

Further detailed instructions can be found in the development guide.

  1. Clone the repository

    git clone https://github.com/allthingslinux/tux && cd tux

  2. Install the project's 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

    Currently, you will need to have a Supabase database set up and the URL set in the DATABASE_URL environment variable.

    In the future, we will provide a way to use a local database. We can provide a dev database on request.

  6. Copy the .env.example file to .env and fill in the required values.

    cp .env.example .env

    You'll need to fill in your Discord bot token here, as well as the Sentry DSN if you want to use Sentry for error tracking.

    We offer dev tokens on request in our Discord server.

  7. Copy the config/settings.json.example file to config/settings.json and fill in the required values.

    cp config/settings.json.example config/settings.json

    Be sure to add your Discord user ID to the BOT_OWNER key in the settings file.

    You can also add your custom prefix here.

  8. Start the bot!

    poetry run python tux/main.py

  9. Run the sync command in the server to sync the slash command tree.

    {prefix}dev sync <server id>

Development Notes

Note

Make sure to add your discord ID to the sys admin list if you are testing locally.

Note

Make sure to set the prisma schema database ENV variable to the DEV database URL.

License

This project is licensed under the terms of the The GNU General Public License v3.0.

See LICENSE for details.

Metrics

Alt