# Siege Matchmaking

The goal of this project is to create a text-based tool to find scrims and custom matches.
It should aim to match teams of possibly equal mmr and equal amount of premade teams.
There should be a way to report toxic or hacking players.

This Pitch assumes integration with discord, but TS should be possible.

**Terms and stuff**:
    Alice + Bob: generic players
    Team Red + Team Blue: generic Teams
    MM: the Matchmaking System
    Role: account-bound tag
    MMR: Matchmaking rating, aka "how good are you"


# Validation

 1. Alice messages bot her current platform name with `!register Alice` (optionally platform + region?)
 2. MM assigns the account a temporary name (e.g `valid-e6eae7f9f1`) and notifies Alice to change her alias
 3. Alice updates her Alias and notifies MM again with `!validate valid-e6eae7f9f1`
 4. MM checks against entry in DB and saves validation status
 4. Alice gets role 'verified'
 5. MM keeps track of Alices MMR and updates her profile

## Entering MM Queue (solo)

 1. Alice (after being verified) messages mm with `!queue`
 2. MM adds her to the List of searching Players
 3. after enough People queue (min. 1 full lobby; preferebly more of course), MM tries to create even Teams by averaging Team-MMR
 3. MM creates a Match and removes the matched Teams form the Queue
 4. every player gets a unique role for the match
 4. MM creates Voice channels for both Teams, as well as a shared text channel  only accessible for people with the match role
 5. Players are notified by the Matchup, as well as any Handicaps
 6. game is played
 7. Players vote to close the Match (needs at least 3 confirmations) `!result win` or `!result loss`
 8. Result is saved to the Match History,
 9. Voice + Text Channels are deleted
 10. Role is removed from all players

## Entering MM Queue (party)

 1. Alice invites Bob to her party `!pinvite  @Bob#1234`
 2. she (as party leader) enters the queue `!queue`
 3. MM adds the party to the Queue
 4. wait...
 5. MM tries to match party against each other and balance MMR with solo-queuers or other parties
 6. follow step 4 of solo-q

## Handicaps
When the MMR disparity between two teams is too big, the lower-seeded Team will receive Boni to try and balance out the disadvantage:

  - **low disparity**: choice of side (atk, def)
  - **medium disparity**: choice of map (possibly limited to a random pool of 3)
  - **large disparity**: 1-2 round advantage

## Reporting Players

Assuming Alice is a 'toxic' player and Bob wants to report her:
 1. Bob messages MM to report Alice `!report @Alice#4321`
 2. the report is logged and after a delay action is taken:
    - few:  Alice receives a message notifying her about player complaints
    - moderate: Alice is banned from Matchmaking for 1day-1 week
    - lots: Alice is banned from Matchmaking and her Account is blacklisted

## Honoring Players
Assuming Alice is a shining example of sportsmanship:
 1. Bob messages MM to honor Alice `!honor @Alice#4321`
 2. Honor is added to Alices Profile
 3. depending on the amount, she receives Boni:

    - more rights in the server
    - listed as 'top' player
    - priority matchmaking (only for top x% of weekly honors)