Revise README for clarity and structure

Updated the README to provide a clearer structure and detailed descriptions of the services and features.
This commit is contained in:
Matt DiMeglio 2026-03-15 22:51:12 -04:00 committed by GitHub
parent 75ab46aa5f
commit 1cce086b76
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

112
README.md
View file

@ -1,50 +1,78 @@
# MatchingMakingService # MatchingMakingService
[1] Website Service ## Overview
- Simple Login Screen This project is composed of three main services:
- Profile
- Displays Stats
- Shop
- Queue Button
- Game Options (Competitive)
- Leaderboard
- Ranking System
[2.1] Matchmaking Service 1. **Website Service**
- Pool of Data 2. **Matchmaking Service**
- Kafka Service to Manage Pools 3. **Game Service**
- Websocket Connection
- To establish a queue to show who is in the queue.
- Figure out an algorithm
- Based on Rank
- 10 People
- Connection to our server and spin up a server.
- Once done send an ip to distribute
[2.2] Matchmaking Service It also targets support for multiple games (listed below).
- Close service with the ip
- Once clicking accept run command to join IP Address - Create script for each game.
[3] Game Service ---
- Create plugin to connect to our databases for realtime match data.
## 1) Website Service
Planned features:
- **Authentication**
- Simple login screen
- **Profile**
- Display player stats
- **Shop**
- **Queue**
- Queue button
- Game options (e.g., *Competitive*)
- **Leaderboard**
- **Ranking system**
[X] Games ---
- CS2
- League of Legends ## 2) Matchmaking Service
- Valorant
- Overwatch ### 2.1 Queue + Match Setup
[Questionables] - **Player pool management**
- TFT - Pool of data
- Dota 2 - Kafka service to manage pools
- Deadlock - **WebSocket connection**
- Brawl Stars - Establish a queue and show who is currently queued
- Clash Royale - **Match algorithm**
- Madden - Rank-based
- FC - Groups of **10 players**
- 2K - **Server provisioning**
- The Show - Connect to our server and spin up a game server
- Fall Guys - Once ready, send an IP to distribute to players
[LAST]
- Minecraft (Hunger Games) ### 2.2 Accept + Join Flow
- Close service with the IP
- On **Accept**, run a command/script to join the IP address
- Create a join script for each game
---
## 3) Game Service
- Create a plugin to connect to our databases for real-time match data
---
## Games
### Target Games
- CS2
- League of Legends
- Valorant
- Overwatch
### Questionable / Maybe
- TFT
- Dota 2
- Deadlock
- Brawl Stars
- Clash Royale
- Madden
- FC
- 2K
- The Show
- Fall Guys
### Last Priority
- Minecraft (Hunger Games)