uio-gaming / uiogaming-bot

Multifunksjonell Discord bot for UiO Gaming

UiO Gaming Discord Bot

UiO Gaming Discord Bot er en chattebot for ulike formål. Hvilke formål det er, er jeg ikke helt sikker på.

Kom i gang

0. Lag en botbruker / skaff en token. Se her

1. Lag en kopi av filen config.yaml.example i "config" mappen og fjern .example fra enden av filnavnet til kopien

2. Fyll inn verdiene i denne konfiguarsjonsfilen

Merk at konfigurasjonsfilen har felt for bl.a. databasekobling. Disse er ikke påkrevd, men du vil derimot miste funksjonalitet om de ikke er fylt inn. Det eneste man må fylle inn, som ikke er fylt inn fra før, er token.

Gitt en bruker med tilgang til å skrive og lese fra databasen vil botten lage alle tabeller den trenger for å fungere.

Når token er fylt inn kan du så bevege deg videre til ett av to alternativer.

Valgmulighet 1 - Docker (Anbefalt)

docker-compose up

Valgmulighet 2 - Manuelt

Du bør ha gjort følgende:

• Installert Python 3.12+

1. Installer avhengigheter

pip install -r requirements.txt -U

2. Kjør bot

python src/run.py

Bidra

Se CONTRIBUTING.md

uiogaming-bot's Issues

Make sure streak is kept, even when bot goes offline

At the time of writing this, if the bot goes offline, it will not count streaks. When coming online again it will check if anyone has posted a message within the last 24 hours, however since the bot hasn't counted it will discard the streaks.

Birthday greetings are not working

For some reason the automatic birthday greeting that checks whether or not it's someone birthday every 24 hours does not work properly. It does not throw any errors meaning there might be a problem with the sql query that checks for the current birthdays.

Support multiple owners

Even though the bot account is owned by a team in the Discord developer dashboard, the bot itself does not support multiple owners. Owner-restricted commands can only be executed by me at the moment.

Black precommit action does not autoformat the code for you

The "black formatting" stage of the precommit action only runs black to ensure that the pushed code is the same as how black would format it, not that it satisfies the linter's rules. This means that the precommit does not fix the code for you, and you have to run black locally before commiting to make sure the action tests don't fail. This is really annoying behaviour

Utilize BytesIO to avoid saving files to disk - Remove assets/temp folder

Docker support

Custom help message

The current u!help responds with the default, built-in discord.py help message. This should be replaced with embeds for a cleaner look.

Use correct cooldown check

Create option to ignore specific cog's logs

Add most played game & who plays command

Add a command that can check which games are currently being played by people on the server ranked from most played to least played. This will be based on discord presence
Example (bad)

Add a command that can check which people on the server plays a specified game at the time of issuing the command.
Example (bad)

Add option to remove yourself from whitelist

I would've done this already if it weren't for the issue of needing a minecraft username in order to run the /whitelist remove command. This means that one would need to run a reverse search for the minecraft username since we only store the id at the time of writing this

Look into alternative solution for the non-existing NotOwner app command check

mbti graph distance is wrong

Set up logging

https://discordpy.readthedocs.io/en/latest/logging.html

Only allow interaction user to use scroller view

make use of parameter descriptors

By utilizing certain helper functions provided by dpy you can use more human readable command parameter names. There is also a feature that adds descriptions to command parameters

• Make use of this feature for every command
• Translate norwegian parameter names to english. I.e translate to norwegian using the describe function while keeping the actual parameter names in code in english

https://discordpy.readthedocs.io/en/latest/interactions/api.html?highlight=describe#discord.app_commands.rename

Move cs2 bingo text placement algorithm to a util module

This makes it available to the meme cog, which is also in need of this algorithm.

Funreplies cooldown

Avoid spamming of funreplies... replies by adding a cooldown to it.

Rewrite legacy mornbot code

A lot of the code contained in this repo is copied from MornBot. This code is poorly written and needs to be rewritten.

Add support for deferred interactions in errors cog

Convert emoji info command to slash commands

Discord does not currently support limitations for emoji only command parameters. Thus we need to handle this ourselves. This is why the command has yet to be converted

Add support for attachments in "the" command

Slash commands support files, which means we can replace the url parameter with a file parameter

@commands.command()
async def yeet(self, image: discord.Attachment):
    ...

Add file/function as argument to logger

Fetch events from google sheets

Fetch events from a google sheets sheet and make announcements at the time of the event.

tempvoice - delete voice channels even if bot goes down

requires writing to the db. The timeout has been decreased to prevent this problem but is not fool proof