Have ideas to improve npm?Join in the discussion! »

    ts-trueskill
    TypeScript icon, indicating that this package has built-in type declarations

    3.2.2 • Public • Published

    ts-trueskill npm build status coverage status

    TypeScript port of the python TrueSkill package by Heungsub Lee.

    What's TrueSkill™

    TrueSkill is a rating system for players of a game. It was developed, patented, and trademarked by Microsoft Research and has been used on Xbox LIVE for ranking and matchmaking service. This system quantifies players’ TRUE skill points by the Bayesian inference algorithm. It also works well with any type of match rule including N:N team game or free-for-all. Read about how the trueskill model works

    Install

    Built into es5 and published with typings. Available on npm:

    npm install ts-trueskill

    API

    https://trueskill.netlify.app

    Use

    2 vs 2 example:

    import { rate, Rating, quality } from 'ts-trueskill';
    const team1 = [new Rating(), new Rating()];
    const team2 = [new Rating(), new Rating()];
    
    // q is quality of the match with the players at their current rating
    const q = quality([team1, team2]);
    
    // Assumes the first team was the winner by default
    const [rated1, rated2] = rate([team1, team2]); // rate also takes weights of winners or draw
    // rated1 and rated2 are now arrays with updated scores from result of match
    
    console.log(rated1.toString()) // team 1 went up in rating
    // >> Rating(mu=28.108, sigma=7.774),Rating(mu=28.108, sigma=7.774)
    console.log(rated2.toString()) // team 2 went down in rating
    // >> Rating(mu=21.892, sigma=7.774),Rating(mu=21.892, sigma=7.774)

    1 vs 1 example:
    using shortcut functions for 1vs1 matches

    import { Rating, quality_1vs1, rate_1vs1 } from 'ts-trueskill';
    const p1 = new Rating(40, 4); // 1P's skill
    const p2 = new Rating(10, 4); // 2P's skill
    const q = quality_1vs1(p1, p2); // quality will be low from large difference in scores
    const [newP1, newP2] = rate_1vs1(p1, p2); // get new ratings after p1 wins

    Differences from python version

    • Does not support multiple backends

    License

    This package is Licensed under MIT, but is a port of the BSD licensed python TrueSkill package by Heungsub Lee. The TrueSkill™ brand is not very permissive. Microsoft permits only Xbox Live games or non-commercial projects to use TrueSkill™.

    Install

    npm i ts-trueskill

    DownloadsWeekly Downloads

    326

    Version

    3.2.2

    License

    MIT

    Unpacked Size

    122 kB

    Total Files

    28

    Last publish

    Collaborators

    • avatar