tournament-organizer

An Node.js package for organizing tournaments, written in TypeScript.

Installation

All methods require type: "module" as this package is an ECMAScript module.

Using Node.js

Installation:

npm i tournament-organizer
Copy

Importing:

import TournamentOrganizer from 'tournament-organizer';
Copy

Using a CDN

Importing:

import TournamentOrganizer from "https://cdn.jsdelivr.net/npm/tournament-organizer/dist/index.js";
Copy

Additional Imports

By default, the above import statements import the Manager class. There are additional imports available:

import {
    Manager,
    Match,
    Player,
    Tournament
} from 'tournament-organizer/components';

import {
    ExportedTournamentValues,
    LoadableTournamentValues,
    MatchValues,
    PlayerValues,
    SettableMatchValues,
    SettablePlayerValues,
    SettableTournamentValues,
    StandingsValues,
    TournamentValues
} from 'tournament-organizer/interfaces';
Copy

Details

Tournament format options include:

• Single elimination
• Double elimination
• Stepladder
• Round-Robin
• Double Round-Robin
• Swiss

Elimination playoffs can be implemented if using a non-elimination format for the tournament.

Details on the pairing algorithms can be found in the tournament-pairings readme.

The following tiebreakers are supported:

• Solkoff
  • Sum of opponents' match points
• Median-Buchholz
  • Sum of opponents' match points, excluding the maximum and minimum point totals
• Sonneborn-Berger
  • Sum of defeated opponents' match points and half the sum of drawn opponents' match points
• Koya System
  • Match points versus opponents who have at least half the maximum number of match points
• Cumulative
  • Sum of a player's running match points (progressive)
  • Includes a second tiebreaker of the sum of opponents' cumulative scores
• Earned Match Wins
  • Number of match wins earned against opponents
• Earned Match Losses
  • Number of match losses earned against opponents
• Earned Game Wins
  • Number of game wins earned against opponents
• Earned Game Losses
  • Number of game losses earned against opponents
• Game Win Differential
  • Difference between number of earned game wins and earned game losses
• Neighboring Points
  • Record versus opponents with match points equal to the player's total match points
• Versus
  • Records versus opponents who are tied with the player
• Mutual Versus
  • Records versus mutual opponents of opponents who are tied with the player
• Opponents' Match Win Percentage
  • Mean match win percentage of opponents
• Game Win Percentage
  • Percentage of individual games won
• Opponents' Game Win Percentage
  • Mean game win percentage of opponents
• Opponents' Opponents' Match Win Percentage
  • Mean match win percentage of the opponents of all opponents

Source code is available on GitHub.