Skip to the content

Sugoroku双六

Play backgammon and its relatives with native rules, cube and match scoring, seeded dice and replayable records.

Sugoroku is the Japanese name 双六 for games of tables. About the name

Contents

Reference · Rules, games and records

GameResulttype

The decided winner, ending, win kind, cube multiplier and points.

Import it

import type { GameResult } from "@johnmorrisdotca/sugoroku";

Definition

type GameResult = {
    readonly winner: Side | null;
    readonly how: HowItEnded;
    readonly kind: WinKind;
    readonly multiplier: number;
    readonly cube: number;
    readonly points: number;
};

Members

NameTypeDescription
winnerSide | null

The side that won, or null for a draw.

howHowItEnded
kindWinKind
multipliernumber

1 for a single win, 2 for a gammon, 3 for a backgammon, after the Jacoby rule and the choice of rules.

cubenumber

The cube's value when it ended.

pointsnumber

What the winner scores: the multiplier times the cube. 0 for a draw.

Examples

import { concede, newGame, rollOpening, settingsFor } from "@johnmorrisdotca/sugoroku";
import type { GameResult } from "@johnmorrisdotca/sugoroku";

const settings = settingsFor("backgammon",{points:5,cube:true});
const game = rollOpening(newGame(settings),[3,1]);
const result = concede(game,"black","single").result!;
const value: GameResult = result;
console.log(value);
{
  winner: 'white',
  how: 'concede',
  kind: 'single',
  multiplier: 1,
  cube: 1,
  points: 1
}

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/sugoroku 1.1.1.