Merge branch 'main' into renovate/pyright-1.x-lockfile

Author: electron271

.env.example

@@ -20,7 +20,7 @@ DEV_TOKEN=""
 
 SENTRY_URL=""
 
-PROD_COG_IGNORE_LIST=
+PROD_COG_IGNORE_LIST="rolecount,mail" # These are ATL specific cogs that are not needed in Tux unless you are ATL
 DEV_COG_IGNORE_LIST=
 
 GITHUB_APP_ID=

Dockerfile

@@ -1,13 +1,16 @@
 # Base stage:
 # - Pin the Python base image for all stages
-# - Install only the common runtime dependencies
-#   - git
-#   - tealdeer
+# - Install only the common runtime dependencies and shared libraries
 FROM python:3.13-slim AS base
 
 RUN apt-get update && \
     apt-get install -y --no-install-recommends \
         git \
+        libcairo2 \
+        libgdk-pixbuf2.0-0 \
+        libpango1.0-0 \
+        libpangocairo-1.0-0 \
+        shared-mime-info \
         tealdeer && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/* && \
@@ -21,23 +24,17 @@ ENV PYTHONUNBUFFERED=1 \
 
 # Build stage:
 # - Install build tools (for packages with native dependencies)
+# - Install dev headers for packages with native dependencies
 # - Install poetry (for managing app's dependencies)
 # - Install app's main dependencies
 # - Install the application itself
 # - Generate Prisma client
 FROM base AS build
 
-# TODO: Are these needed?
-# - curl
-# - libgdk-pixbuf2.0-0
-# - libpango1.0-0
-# - libpangocairo-1.0-0
-# - shared-mime-info
-
 RUN apt-get update && \
     apt-get install -y --no-install-recommends \
         build-essential \
-        libcairo2 \
+        libcairo2-dev \
         libffi-dev && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/*

README.md

@@ -16,11 +16,11 @@
 </div>
 
 > [!WARNING]
-**This bot (without plenty of tweaking) is not ready for production use, we suggest against using it until announced. Join our support server: [atl.dev](https://discord.gg/gpmSjcjQxg) for more info!**
+**This bot is still a work in progress and issues are expected. If you self-host our bot please join our support server [here](https://discord.gg/gpmSjcjQxg) for announcements and support.**
 
 ## About
 
-Tux is an all in one Discord bot for the All Things Linux Discord server.
+Tux is an all in one Discord bot originally designed 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.
 
@@ -31,7 +31,6 @@ It is designed to provide a variety of features to the server, including moderat
 - 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
@@ -56,7 +55,7 @@ It is designed to provide a variety of features to the server, including moderat
 
 - Python 3.13
 - [Poetry](https://python-poetry.org/docs/)
-- [Supabase](https://supabase.io/)
+- [Supabase](https://supabase.io/) or any PostgreSQL database
 - Optional: [Docker](https://docs.docker.com/get-docker/)
 - Optional: [Docker Compose](https://docs.docker.com/compose/install/) (see the [development notes](#development-notes) for more information)
 - Optional: [Just](https://github.com/casey/just/)
@@ -73,35 +72,31 @@ Further detailed instructions can be found in the [development guide](docs/devel
    git clone https://github.com/allthingslinux/tux && cd tux
    ```
 
-2. Install the project's dependencies
+2. Install the project's dependencies and set up the virtual environment
 
     ```bash
     poetry install
+    poetry env use 3.13
     ```
 
-3. Activate the virtual environment
-
-    ```bash
-    poetry shell
-    ```
-
-4. Install the pre-commit hooks
+3. Install the pre-commit hooks (optional unless you are contributing)
 
     ```bash
     pre-commit install
     ```
 
-5. Generate the prisma client
+4. Generate the prisma client and push the database schema
 
     ```bash
     prisma generate
+    prisma db push
     ```
 
     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.
+5. Copy the `.env.example` file to `.env` and fill in the required values.
 
     ```bash
     cp .env.example .env
@@ -111,7 +106,7 @@ Further detailed instructions can be found in the [development guide](docs/devel
 
     We offer dev tokens on request in our Discord server.
 
-7. Copy the `config/settings.yml.example` file to `config/settings.yml` and fill in the required values.
+6. Copy the `config/settings.yml.example` file to `config/settings.yml` and fill in the required values.
 
     ```bash
     cp config/settings.yml.example config/settings.yml
@@ -121,16 +116,16 @@ Further detailed instructions can be found in the [development guide](docs/devel
 
     You can also add your custom prefix here.
 
-8. Start the bot!
+7. Start the bot!
 
     ```bash
     poetry run python tux/main.py
     ```
 
-9. Run the sync command in the server to sync the slash command tree.
+8. Run the clear tree command in the server to sync the slash command tree.
 
    ```bash
-   {prefix}dev sync <server id>
+   {prefix}dev ct
    ```
 
 ## Development Notes

config/settings.yml.example

@@ -1,24 +1,67 @@
-# config/settings.yml
+# This is a example configuration file for Tux
+# Change the values to your liking and rename the file to settings.yml
+
+BOT_INFO:
+  PROD_PREFIX: "$"
+  DEV_PREFIX: "~" # You can enable dev mode in .env
+  BOT_NAME: "Tux" # This may not apply everywhere, WIP (Best to keep it as Tux for now). Help command will be changed to be less Tux-specific if you change this.
+  BOT_VERSION: "git" # vX.Y.Z or git
+  HIDE_BOT_OWNER: false # Hide bot owner and sysadmin from help command
+  # Available substitutions:
+  # {member_count} - total member count of all guilds
+  # {guild_count} - total guild count
+  # {bot_name} - bot name
+  # {bot_version} - bot version
+  # {prefix} - bot prefix
+  ACTIVITIES: |
+    [
+      {"type": "watching", "name": "{member_count} members"},
+      {"type": "listening", "name": "{guild_count} guilds"},
+      {"type": "playing", "name": "{bot_name} {bot_version}"},
+      {"type": "watching", "name": "All Things Linux"},
+      {"type": "playing", "name": "with fire"},
+      {"type": "watching", "name": "linux tech tips"},
+      {"type": "listening", "name": "mpd"},
+      {"type": "watching", "name": "a vast field of grain"},
+      {"type": "playing", "name": "i am calling about your car's extended warranty"},
+      {"type": "playing", "name": "SuperTuxKart"},
+      {"type": "playing", "name": "SuperTux 2"},
+      {"type": "watching", "name": "Gentoo compile..."},
+      {"type": "watching", "name": "Brodie Robertson"},
+      {"type": "listening", "name": "Terry Davis on YouTube"},
+      {"type": "playing", "name": "with Puffy"},
+      {"type": "watching", "name": "the stars"},
+      {"type": "watching", "name": "VLC"},
+      {"type": "streaming", "name": "SuperTuxKart", "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"}
+    ]
 
-DEFAULT_PREFIX:
-  PROD: "$"
-  DEV: "~"
 
 USER_IDS:
-  SYSADMINS:
+  SYSADMINS: # WARNING! This grants dangerous permissions such as eval and jsk which can be used to execute arbitrary code.
     - 123456789012345679
     - 123456789012345679
-  BOT_OWNER: 123456789012345679
+  BOT_OWNER: 123456789012345679 # This is the user who has the highest level of control over the bot. Only one user can be the bot owner.
 
+# This adds a temporary voice channel feature to the bot, you can join the channel to create a channel called /tmp/<username> and move to it.
+# Channels are deleted when the last person leaves them.
+# Set this to the category ID where you want the temporary voice channels to be created.
+# Temporary channels will be put at the bottom of the category.
 TEMPVC_CATEGORY_ID: 123456789012345679
+# Set this to the channel ID where you want the temporary voice channels to be created.
 TEMPVC_CHANNEL_ID: 123456789012345679
 
 
+SNIPPETS:
+  LIMIT_TO_ROLE_IDS: false # Only allow users with the specified role IDs to use the snippet command
+  ACCESS_ROLE_IDS:
+    - 123456789012345679
+    - 123456789012345679
+
 XP:
-  XP_BLACKLIST_CHANNELS:
+  XP_BLACKLIST_CHANNELS: # Channels where XP will not be counted
     - 123456789012345679
     - 123456789012345679
-  XP_ROLES:
+  XP_ROLES: # Roles that will be given to users when they reach a certain level
     - level: 5
       role_id: 123456789012345679
     - level: 10
@@ -30,18 +73,17 @@ XP:
     - level: 25
       role_id: 123456789012345679
 
-  XP_MULTIPLIERS:
+  XP_MULTIPLIERS: # Multipliers for certain roles
     - role_id: 123456789012345679
       multiplier: 1.5
 
-  XP_COOLDOWN: 1 # In seconds
+  XP_COOLDOWN: 1 # Delay in seconds between XP messages
 
-  LEVELS_EXPONENT: 1
-  SHOW_XP_PROGRESS: false
-  # if true, XP will still be counted, but not shown beyond the cap in the level command
-  ENABLE_XP_CAP: false
+  LEVELS_EXPONENT: 1 # Exponent for the level formula
+  SHOW_XP_PROGRESS: false # Shows required XP for the next level in the level command
+  ENABLE_XP_CAP: false # if true, XP will still be counted, but not shown beyond the cap in the level command
 
-GIF_LIMITER:
+GIF_LIMITER: # Limits the amount of gifs a user can send in a channel
   RECENT_GIF_AGE: 60
 
   GIF_LIMIT_EXCLUDE: