matchy/README.md
2024-08-10 22:49:50 +01:00

1.3 KiB

Matchy

Matchy matches matchees.

Tests

Matchy is a Discord bot that groups up users for fun and vibes. Matchy can be installed by clicking here.

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

Python modules

  • discord.py - Discord bot functionality
  • pytest - Testing
  • schema - File format validation
  • pytest-cov - Code coverage testing

Config

Matchy is configured by a config.json file that takes this format:

{
    "token": "<<github bot token>>",
    "owners": [
        <<owner 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
  • Add scheduling functionality
  • Improve the weirdo