From f99f67789d84c1ec5719ce59ed01be04ea108947 Mon Sep 17 00:00:00 2001 From: Marc Di Luzio Date: Sun, 11 Aug 2024 17:58:21 +0100 Subject: [PATCH] Update the readme for the new commands and formats --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d0ec770..c729f5e 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,14 @@ Matchy matches matchees. Matchy is a Discord bot that groups up users for fun and vibes. Matchy can be installed by clicking [here](https://discord.com/oauth2/authorize?client_id=1270849346987884696). ## Commands -### /match [group_min: int(3)] [matchee_role: str(@Matchee)] -Matches groups of users with a given role and posts those groups to the channel. Tracks historical matches and attempts to match users to make new connections with people with divergent roles, in an attempt to maximise diversity. +### /match [group_min: int(3)] +Matches groups of users in a channel and offers a button to pose those groups to the channel to users with `matcher` auth scope. Tracks historical matches and attempts to match users to make new connections with people with divergent roles, in an attempt to maximise diversity. + +### /join and /leave +Allows users to sign up and leave the group matching in the channel the command is used ### $sync and $close -Only usable by `OWNER` users, reloads the config and syncs commands, or closes down the bot. Only usable in DMs with the bot user. +Only usable by `OWNER` users, reloads the config and syncs commands, or closes down the bot. Only usable in DMs with the bot user. ## Dependencies * `python3` - Obviously @@ -24,12 +27,11 @@ Matchy is configured by a `config.json` file that takes this format: "token": "<>", } ``` -User IDs can be grabbed by turning on Discord's developer mode and right clicking on a user. ## TODO * Write bot tests with [dpytest](https://dpytest.readthedocs.io/en/latest/tutorials/getting_started.html) * Implement /pause to pause a user for a little while * Move more constants to the config * Add scheduling functionality -* Fix logging in some sub files +* Fix logging in some sub files (doesn't seem to actually be output?) * Improve the weirdo \ No newline at end of file