RankedMatchmaking

Table of content

• About
• Built With
• Project Structure
• Architecture
• Getting started
• CI/CD
• Roadmap
• Project Status
• References

About

This repo will be used to create groups of players with the same rank hierarchy to have fair fights. For example, this repo will ensure that GOLD ranked lobby matches with GOLD ranked lobby only. No higher or lower ranked players would be included.

Built With

• Apache Flink 1.17.1 ( Datastream API )
• Python 3.10

Project Structure

The project contains source code written in Pyflink.

• source code: under core folder

Architecture

High Level Design ( HLD )

Getting started

1) Clone the RankedMatchmaking repository:
git clone https://github.com/debuggerrr/RankedMatchmaking.git

2) Change into the RankedMatchmaking directory:

cd RankedMatchmaking

3) Install required dependencies:
python -m pip install .

4) Start Kafka Producer:
kafka-console-producer --topic test-topic2 --bootstrap-server localhost:9092

5) Run the invoker:
python core/main/main.py

6) Start Kafka Consumer:
kafka-console-consumer --topic test-topic45 localhost:9092

7) Trigger the records from Kafka Producer with input format as ("user_name", "rank")

CI/CD

CI workflow is implemented via Github Actions.

It covers the following step:

• Test: Source code is tested using tox

Roadmap

• Consider one rank level above or below too
• Implement count window
• Fault tolerance

Project Status

Development phase - Beta version

References

• DataStream API

• Kafka Connector