Merge pull request #78 from Tibo-Ulens/hotfix

General maintenance fixes

Author: Tibo-Ulens

CONTRIBUTING.md

@@ -16,7 +16,7 @@ intended to be used in context managers.
 ## Getting started
 
 You will need to be on a *nix operating system, with docker, docker compose,
-make, and python installed.
+make, python, and poetry installed.
 
 You can set up the project locally by running `make setup`.
 
@@ -29,10 +29,14 @@ container, run the migrations, and then stop the container again.
 
 ### Utilities
 
- - `make setup` will create/download the stuff needed to work on the project
+ - `make` will pull the latest docker image from GHCR and run it
+ - `make dev` will build a docker image from the local code and run it
+ - `make down` will stop all running containers
  - `make dbd` will spin up a headless instance of the database container
+ - `make chd` will spin up a headless instance of the cache container
  - `make psql` will start a psql instance in the database container
- - `make down` will stop all running containers
+ - `make redis` will start a redis CLI instance in the cache container
+ - `make setup` will create/download the stuff needed to work on the project
 
 ### Issues
 

Dockerfile.bot

@@ -2,7 +2,7 @@ FROM python:3.11.5-slim
 
 ENV DEBIAN_FRONTEND=noninteractive
 RUN apt update \
-	&& apt install -y libpq5 libpq-dev python3-dev gcc wget firefox-esr \
+	&& apt install -y libpq5 libpq-dev python3-dev gcc \
 	&& rm -rf /var/lib/apt/lists/*
 
 # Disable pip cache and poetry venvs
@@ -12,13 +12,6 @@ ENV PIP_NO_CACHE_DIR=false \
 # Get poetry
 RUN pip install -U poetry
 
-# Get selenium webdriver
-RUN wget \
-	https://github.com/mozilla/geckodriver/releases/download/v0.31.0/geckodriver-v0.31.0-linux64.tar.gz
-RUN tar xvzf geckodriver-v0.31.0-linux64.tar.gz
-RUN rm -rf geckodriver-v0.31.0-linux64.tar.gz
-RUN mv geckodriver /usr/bin && chmod +x /usr/bin/geckodriver
-
 WORKDIR /freud_bot
 
 # Install deps

Dockerfile.webconfig

@@ -2,7 +2,7 @@ FROM python:3.11.5-slim
 
 ENV DEBIAN_FRONTEND=noninteractive
 RUN apt update \
-	&& apt install -y libpq5 libpq-dev python3-dev gcc wget firefox-esr \
+	&& apt install -y libpq5 libpq-dev python3-dev gcc \
 	&& rm -rf /var/lib/apt/lists/*
 
 # Disable pip cache and poetry venvs

README.md

@@ -1,6 +1,6 @@
 # FreudBot
 
-UGent Psychology Discord server bot
+UGent Discord verification and shenanigans bot
 
 ## Contributing
 
@@ -10,47 +10,134 @@ See [the contributing guide](CONTRIBUTING.md) for instructions on how to contrib
 
 Unless stated otherwise all commands are slash commands
 
+### Hooks
+
+ - bot mentioned: Responds to the message with a random Freud quote
+
+ - new member joins: Sends the member a DM with verification instructions or verifies them
+ automatically if they are already verified in another Freud-enabled server
+
+ - 📌 emoji reaction: If enough people react to a message with this emoji it will be pinned
+ automatically.
+ The amount of reactions needed for this is configurable on the website.
+
 ### Commands
 
 #### Configuration
 
- - `$freud_sync` (MESSAGE COMMAND) (OWNER ONLY) - force-syncs the bot's slash commands to
- whatever guild it's connected to
- - `/config admin_role` (OWNER ONLY) - Set the role that 'admin' members will have
- - `/config verified_role` (ADMIN ONLY) - Set the role that's given to verified members
- - `/config verification_channel` (ADMIN ONLY) - Set the channel in which the `/verify`
- command may be used
- - `/config logging_channel` (ADMIN ONLY) - Set the channel into which log messages will be
+***The configuration commands are largely deprecated and have been replaced by the config website
+https://freudbot.org***
+
+ - `$freud_sync` \
+ (MESSAGE COMMAND) \
+ (MANAGE GUILD) \
+ force-syncs the bot's slash commands to
+ whatever guild it's connected to. This can be used after a new version of the bot goes live to
+ ensure all commands are up to date, however just waiting for around an hour will achieve the same
+ goal.
+
+ - `/config admin_role` \
+ (MANAGE GUILD) \
+ Set the role that 'admin' members will have, this is used to check permissions for the other
+ `/config` commands
+
+ - `/config verified_role` \
+ (ADMIN) \
+ Set the role that's given to verified members
+
+ - `/config logging_channel` \
+ (ADMIN) \
+ Set the channel into which log messages will be
  posted
 
-#### Calendar
+ - `/config confession_channel` \
+ (ADMIN) \
+ Set the channel where approved confessions will be posted
 
- - `/calendar` - Build an image to show your calendar for this week
- - `/course enroll` - Set yourself as enrolled in a course
- - `/course drop` - Unset yourself as enrolled in a course
- - `/course overview` - Send a list of all courses you are enrolled in
- - `/course add` (ADMIN ONLY) - Add an available course and scrape its lecture dates
- - `/course remove` (ADMIN ONLY) - Remove an available course
- - `/course list` (ADMIN ONLY) - List all available Courses
+ - `/config confession_approval_channel` \
+ (ADMIN) \
+ Set the channel where confessions awaiting approval will be posted (this should be a channel only
+ admins can access)
 
 #### Verification
 
- - `/verify <email>` - Sends an email to `<email>` containing a verification
- code the user can then use in the `/verify <code>` command
- - `/verify <code>` - Checks if the supplied code is valid for a given user
- and gives them the 'Verified' role if it is.
+ - `/verify` - Sends a DM to the user with verification instructions, this can be used in case the
+ user didn't receive a DM or if the previous messsages buttons have expired.
+
+#### Confessions
+
+Confessions can be sent as replies to other confessions by adding the confession ID as an optional
+argument.
+
+eg.
+You can reply to "Anonymous Confession (#14) - I like ducks"
+with `/confess normal "So do I" "14"`
+
+Note: this is a bit scuffed at the moment and might not work exceptionally well, bugfixes pending.
+
+ - `/confess normal <confession> [<reply>]` - Sends a normal, anonymous confession.
+
+ - `/confess russian <confession> [<reply>]` - Sends a russian roulette confession with a 1/6
+ chance of exposing the user who sent it
+
+ - `/confess extreme <confession> [<reply>]` - Sends an extreme roulette confession with a 1/2
+ chance of exposing the user who sent it
+
+#### Message Scheduling
+
+Working with time in python is pain, so this command is also pain.
+Use at your own risk.
+
+ - `/schedule <channel> <time> [<timezone>] [<message>]` - Schedules a message to be sent in
+ `<channel>` at a given `<time>` \
+   - `<time>` is a string in the format "%Y/%m/%d %H:%M"
+   - `<timezone>` is the timezone of your timestamp (default UTC)
+   (UTC = 0000, CET = 0100, CEST = 0200)
+   - `<message>` can be given inline or left empty, if left empty a popup will appear with more
+   space to type your message.
+
+#### FreudPoints
+
+FreudPoints aren't exceptionally useful at this point, but hopefully they will eventually have
+some purpose like a shop mechanic.
+
+ - `/freudpoint award <user> [<amount>]` - Awards `<user>` `<amount>` (default 1) FreudPoint(s)
+
+#### Freudr
+
+Freudr Dating Service, because discord users are too afraid of actual social interaction.
+When 2 users match, FreudBot will send them both a DM to congratulate them on their newfound
+love.
+
+ - `/freudr like <user>` - Adds a user to your likes (you can only like the same user once every
+ 24 hours)
+
+ - `/freudr unlike <user>` - Removes a user from your likes
+
+ - `/freudr list` - See a list of your likes and matches
+
+#### Statistics
+
+At the moment FreudBot doesn't keep track of a whole lot of statistics, but this should change in
+the "near" future.
+
+ - `/freudstat me` - See an overview of the statistics FreudBot tracks about you
+
+ - `/freudstat profile <user>` - See an overview of the statistics FreudBot tracks about another
+ user
+
+ - `/freudstat leaderboard` - See the leaderboards for the stats FreudBot tracks, selectable with a
+ dropdown menu
 
 #### Random
 
 - `/mommy` - You can figure this one out for yourself
 
 #### Link Shortcuts (DEPRECATED)
 
- - `/drive <course>` - Send a link to a google drive for that course
-
-### Hooks
-
- - on mention: Responds to the message with a random Freud quote
+ - `/drive <shortcut>` - Send a link to a hardcoded google drive folder
+ At the moment this is only useful for the psychology discord, so other servers should disable this
+ command
 
 ## Running
 

alembic.ini

@@ -6,7 +6,7 @@ script_location = alembic
 
 # template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
 # Uncomment the line below if you want the files to be prepended with date and time
-# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+file_template = %%(year)d-%%(month).2d-%%(day).2d_%%(hour).2d:%%(minute).2d_%%(rev)s_%%(slug)s
 
 # sys.path path, will be prepended to sys.path if present.
 # defaults to the current working directory.