Categorygithub.com/ravsii/elgo
modulepackage
0.0.2
Repository: https://github.com/ravsii/elgo.git
Documentation: pkg.go.dev

# README

Elgo - Elo matchmaking module in Go

Go Reference codecov Go Report Card CI

Elgo is a relatively small package that provides a matchmaking pool and a simple calculator for ELO-like rating with configurable K-factor.

It's in the very early stages of development, expect bugs and unfunushed stuff.

Why?

The main idea is to implement some sort of a basic matchmaking tool for 3rd party apps or depelopers to use. There are plans to release it as a CLI, a Docker container and provide a server API for developers to use it as a package.

How it works?

How it works diagram

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

No description provided by the author
NewPool creates a new pool for players.
WithGlobalRetryInterval sets a duration of how much time a pool should wait between iterations if not a single match was found.
WithIncreasePlayerBorderBy sets an amount of points that will be added on a new search, if no opponent was found previously.
WithPlayerRetryInterval sets a duration of how much time a player should wait before a pool would try and find a match for them again.

# Variables

No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
Match is a struct that holds 2 players who should be matched.
No description provided by the author
Pool is a main struct for matchmaking pool.

# Interfaces

Identifier is an interface that helps identify players.
Player is an interface that implements Identifier and Ratinger.
Ratinger is an interface to receive and change player's rating.

# Type aliases

No description provided by the author
No description provided by the author