Update the README with more infomation
This commit is contained in:
parent
351dccf9e2
commit
30ddc4a448
2 changed files with 20 additions and 13 deletions
29
README.md
29
README.md
|
@ -4,25 +4,30 @@ 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
|
### /match [group_min: int(3)] [matchee_role: str(@Matchee)]
|
||||||
Matches groups of users with a given role and posts those groups to the channel.
|
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
|
### $sync and $close
|
||||||
Only usable by `OWNER` users, reloads the config and syncs commands. 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
|
||||||
* `discord.py` python module
|
|
||||||
* `pytest` for testing
|
### Python modules
|
||||||
* `schema` python module for file validation
|
* `discord.py` - Discord bot functionality
|
||||||
|
* `pytest` - Testing
|
||||||
|
* `schema` - File format validation
|
||||||
|
* `pytest-cov` - Code coverage testing
|
||||||
|
|
||||||
## Config
|
## Config
|
||||||
Matchy is configured by a `config.py` file that takes this format:
|
Matchy is configured by a `config.json` file that takes this format:
|
||||||
```
|
```
|
||||||
TOKEN = "<<TOKEN>>"
|
{
|
||||||
OWNERS = [
|
"token": "<<github bot token>>",
|
||||||
<<USER ID>>,
|
"owners": [
|
||||||
|
<<owner id>>
|
||||||
]
|
]
|
||||||
|
}
|
||||||
```
|
```
|
||||||
User IDs can be grabbed by turning on Discord's developer mode and right clicking on a user.
|
User IDs can be grabbed by turning on Discord's developer mode and right clicking on a user.
|
||||||
|
|
||||||
|
|
2
coverage.sh
Executable file
2
coverage.sh
Executable file
|
@ -0,0 +1,2 @@
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
pytest --cov=. --cov-report=html
|
Loading…
Add table
Reference in a new issue