skillratings

Skillratings allows you to calculate the player's skill in 1v1 matches instantly.
Only player-versus-player matches are currently supported, no teams. Instead of calculating results at the end of rating periods, we deliver the result instantly after a match.

Currently supported algorithms:

These are mainly known from their usage in chess and online games.

Installation

Add the following to your Cargo.toml file:

toml [dependencies] skillratings = "0.7.2"

Usage

For a detailed guide on how to use this crate, head over to the documentation.

Elo rating system

Wikipedia article

```rust extern crate skillratings;

use skillratings::{elo::elo, outcomes::Outcomes, rating::EloRating};

let playerone = EloRating { rating: 1000.0 }; let playertwo = EloRating { rating: 1000.0 };

// The outcome is from the perspective of player one. let outcome = Outcomes::WIN;

let (playeronenew, playertwonew) = elo(playerone, playertwo, outcome, 32.0); assert!((playeronenew.rating - 1016.0).abs() < f64::EPSILON); assert!((playertwonew.rating - 984.0).abs() < f64::EPSILON); ```

Glicko rating system

Wikipedia article

```rust use skillratings::{glicko::glicko, outcomes::Outcomes, rating::GlickoRating};

let playerone = GlickoRating { rating: 1500.0, deviation: 350.0, }; let playertwo = GlickoRating { rating: 1500.0, deviation: 350.0, };

let outcome = Outcomes::WIN;

let (playeronenew, playertwonew) = glicko(playerone, playertwo, outcome);

assert!((playeronenew.rating.round() - 1662.0).abs() < f64::EPSILON); assert!((playeronenew.deviation.round() - 290.0).abs() < f64::EPSILON);

assert!((playertwonew.rating.round() - 1338.0).abs() < f64::EPSILON); assert!((playertwonew.deviation.round() - 290.0).abs() < f64::EPSILON); ```

Glicko-2 rating system

Wikipedia article

```rust extern crate skillratings;

use skillratings::{glicko2::glicko2, outcomes::Outcomes, rating::Glicko2Rating};

let playerone = Glicko2Rating { rating: 1500.0, deviation: 350.0, volatility: 0.06 }; let playertwo = Glicko2Rating { rating: 1500.0, deviation: 350.0, volatility: 0.06 };

let outcome = Outcomes::WIN;

let (playeronenew, playertwonew) = glicko2(playerone, playertwo, outcome, 0.5);

assert!((playeronenew.rating.round() - 1662.0).abs() < f64::EPSILON); assert!((playeronenew.deviation.round() - 290.0).abs() < f64::EPSILON);

assert!((playertwonew.rating.round() - 1338.0).abs() < f64::EPSILON); assert!((playertwonew.deviation.round() - 290.0).abs() < f64::EPSILON); ```

TrueSkill rating system

Wikipedia article

Caution regarding usage of TrueSkill: Microsoft permits only Xbox Live games or non-commercial projects to use TrueSkill(TM). If your project is commercial, you should use another rating system included here.

```rust use skillratings::{trueskill::trueskill, outcomes::Outcomes, rating::TrueSkillRating};

// Initialises a player with rating set to 25.0 and uncertainty set to (25.0 / 3). let playerone = TrueSkillRating::new(); let playertwo = TrueSkillRating { rating: 30.0, uncertainty: 1.2, };

let (p1, p2) = trueskill(playerone, playertwo, Outcomes::WIN);

assert!(((p1.rating * 100.0).round() - 3300.0).abs() < f64::EPSILON); assert!(((p1.uncertainty * 100.0).round() - 597.0).abs() < f64::EPSILON);

assert!(((p2.rating * 100.0).round() - 2983.0).abs() < f64::EPSILON); assert!(((p2.uncertainty * 100.0).round() - 120.0).abs() < f64::EPSILON); ```

DWZ (Deutsche Wertungszahl) rating system

Wikipedia article

```rust use skillratings::{dwz::dwz, outcomes::Outcomes, rating::DWZRating};

let playerone = DWZRating { rating: 1500.0, index: 42, age: 42, }; let playertwo = DWZRating { rating: 1500.0, index: 12, age: 12, };

let outcome = Outcomes::WIN;

let (playeronenew, playertwonew) = dwz(playerone, playertwo, outcome);

assert!((playeronenew.rating.round() - 1519.0).abs() < f64::EPSILON); asserteq!(playerone_new.index, 43);

assert!((playertwonew.rating.round() - 1464.0).abs() < f64::EPSILON); asserteq!(playertwo_new.index, 13); ```

Ingo rating system

Wikipedia article (in german, no english version available)

```rust use skillratings::{ingo::ingo, outcomes::Outcomes, rating::IngoRating};

let playerone = IngoRating { // Note that a lower rating is more desirable. rating: 130.0, age: 40, }; let playertwo = IngoRating { rating: 160.0, age: 40, };

let (p1, p2) = ingo(playerone, playertwo, Outcomes::WIN);

assert!((p1.rating.round() - 129.0).abs() < f64::EPSILON); assert!((p2.rating.round() - 161.0).abs() < f64::EPSILON); ```

License

This project is licensed under the MIT License.