mdiluz/matchy
mdiluz/matchy
1
0
Fork 0
Code Issues 5 Pull requests 7 Packages 1 Activity Actions

Update the readme for the new commands and formats

Browse source
This commit is contained in:
Marc Di Luzio 2024-08-11 17:58:21 +01:00
parent d3a22ff090
commit f99f67789d
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -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). 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 ## Commands
### /match [group_min: int(3)] [matchee_role: str(@Matchee)] ### /match [group_min: int(3)]
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. 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 ### $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 ## Dependencies
* `python3` - Obviously * `python3` - Obviously
@ -24,12 +27,11 @@ Matchy is configured by a `config.json` file that takes this format:
"token": "<<github bot token>>", "token": "<<github bot token>>",
} }
``` ```
User IDs can be grabbed by turning on Discord's developer mode and right clicking on a user.
## TODO ## TODO
* Write bot tests with [dpytest](https://dpytest.readthedocs.io/en/latest/tutorials/getting_started.html) * 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 * Implement /pause to pause a user for a little while
* Move more constants to the config * Move more constants to the config
* Add scheduling functionality * 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 * Improve the weirdo