From 50f94b284b2dd277fb8ff3e1ef560fec442097fd Mon Sep 17 00:00:00 2001 From: Marc Di Luzio Date: Mon, 12 Aug 2024 23:17:43 +0100 Subject: [PATCH] Update README.md with info on /schedule command --- README.md | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 410a7d1..6b5993c 100644 --- a/README.md +++ b/README.md @@ -3,23 +3,34 @@ Matchy matches matchees. ![Tests](https://github.com/mdiluz/matchy/actions/workflows/test.yml/badge.svg) -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). +Matchy is a Discord bot that groups up users for fun and vibes. Matchy can be installed on your server by clicking [here](https://discord.com/oauth2/authorize?client_id=1270849346987884696). ## Commands -### /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. +Unless otherwise specified all commands are only usable in channels. -### /join and /leave +### Usable by anyone +#### /join and /leave Allows users to sign up and leave the group matching in the channel the command is used -### /pause [days: int(7)] +#### /pause [days: int(7)] Allows users to pause their matching in a channel for a given number of days. Users can use `/join` to re-join before the end of that time. -### $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. +#### /list +List the current matchees in the channel as well as any current scheduled runes. + +### Usable by "matchers" +#### /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. + +#### /schedule [group_min: int(3)] [weekday: int(0)] [hour: int(9)] [cancel: bool(False)] +Allows a matcher to set a weekly schedule for matches in the channel, cancel can be used to remove a scheduled run + +### Usable by "owners" +#### $sync and $close +Reloads the config and syncs commands, or closes down the bot. Unlike all other commands these are usable in DMs with the bot user. ## Dependencies -* `python3` - Obviously +* `python3` - Obviously, ideally 3.11 * `venv` - Used for the python virtual env, specs in `requirements.txt` ## Config @@ -42,9 +53,8 @@ Matchy is configured by a `config.json` file that takes this format: Only token and version are required. See [`py/config.py`](py/config.py) for explanations for any of these. ## TODO -* Add scheduling functionality * Write integration tests (maybe with [dpytest](https://dpytest.readthedocs.io/en/latest/tutorials/getting_started.html)?) * Implement a .json file upgrade test * Track if meets were sucessful * Send reminder messages -* Improve the weirdo \ No newline at end of file +* Improve the weirdo