matchy/README.md

# 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
Matches groups of users with a given role and posts those groups to the channel.

### $sync
Only usable by `OWNER` users, reloads the config and syncs commands. Only usable in DMs with the bot user. 

## Dependencies
* `python3` obviously
* `discord.py` python module
* `pytest` for testing

## Config
Matchy is configured by a `config.py` file that takes this format:
```
TOKEN = "<<TOKEN>>"
OWNERS = [
    <<USER ID>>,
]
```
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)
* Add tracking of past groups to ensure unique pairings
* Add scheduling functionality
* Improve the weirdo
Basic bot start from discordpy guide 2024-08-07 22:15:39 +01:00			`# Matchy`
Update the README with useful info 2024-08-09 23:33:39 +01:00			`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).`
Clean up and use role management for permissions 2024-08-08 17:16:59 +01:00
			`## Commands`
			`### /match`
Update the README with useful info 2024-08-09 23:33:39 +01:00			`Matches groups of users with a given role and posts those groups to the channel.`

			`### $sync`
			Only usable by `OWNER` users, reloads the config and syncs commands. Only usable in DMs with the bot user.
Basic bot start from discordpy guide 2024-08-07 22:15:39 +01:00
			`## Dependencies`
Update the README 2024-08-07 23:24:47 +01:00			* `python3` obviously
			* `discord.py` python module
Add pytest to the readme 2024-08-09 23:15:16 +01:00			* `pytest` for testing
Use commands rather than text values * Fix up the group matching to spread more evenly * Also swap to using a config.py rather than .envrc or similar 2024-08-08 00:09:30 +01:00
Update the README with useful info 2024-08-09 23:33:39 +01:00			`## Config`
			Matchy is configured by a `config.py` file that takes this format:
			```
			`TOKEN = "<<TOKEN>>"`
			`OWNERS = [`
			`<<USER ID>>,`
			`]`
			```
			`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)`
			`* Add tracking of past groups to ensure unique pairings`
			`* Add scheduling functionality`
			`* Improve the weirdo`