Marc Di Luzio
d3a22ff090
* Use /join and /leave instead of roles * Use scopes to check for user rights rather than using the config file * Add /list to show the set of current people signed up * Add a bunch more testing for various things * Version both the config and the state
35 lines
No EOL
1.4 KiB
Markdown
35 lines
No EOL
1.4 KiB
Markdown
# Matchy
|
|
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.
|
|
|
|
### $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.
|
|
|
|
## Dependencies
|
|
* `python3` - Obviously
|
|
* `venv` - Used for the python virtual env, specs in `requirements.txt`
|
|
|
|
## Config
|
|
Matchy is configured by a `config.json` file that takes this format:
|
|
```
|
|
{
|
|
"version": 1,
|
|
"token": "<<github bot 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
|
|
* Improve the weirdo |