Update the README with useful info
This commit is contained in:
parent
24026737a7
commit
95cb8bc868
2 changed files with 22 additions and 4 deletions
25
README.md
25
README.md
|
@ -1,13 +1,32 @@
|
||||||
# Matchy
|
# Matchy
|
||||||
Matchy matches matchees
|
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
|
## Commands
|
||||||
### /match
|
### /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
|
## Dependencies
|
||||||
* `python3` obviously
|
* `python3` obviously
|
||||||
* `discord.py` python module
|
* `discord.py` python module
|
||||||
* `pytest` for testing
|
* `pytest` for testing
|
||||||
|
|
||||||
## Token
|
## Config
|
||||||
Create a `config.py` file with a `TOKEN=<token>` entry
|
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
|
|
@ -9,7 +9,6 @@ from discord import app_commands
|
||||||
from discord.ext import commands
|
from discord.ext import commands
|
||||||
# Config contains
|
# Config contains
|
||||||
# TOKEN : str - Discord bot token
|
# TOKEN : str - Discord bot token
|
||||||
# SERVERS : list[int] - ids of the servers to have commands active
|
|
||||||
# OWNERS : list[int] - ids of owners able to use the owner commands
|
# OWNERS : list[int] - ids of owners able to use the owner commands
|
||||||
import config
|
import config
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue