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

multiplierOffunction

What a win of kind is worth, after the rules: a single win when gammons do not count, or when the Jacoby rule holds them back because the cube was never turned.

Import it

import { multiplierOf } from "@johnmorrisdotca/sugoroku";

Definition

function multiplierOf(game: GameState, kind: WinKind): number

Parameters

NameTypeDescription
gameGameState

The current immutable native game state.

kindWinKind

The native single, gammon or backgammon result.

Returns

number

What a win of kind is worth, after the rules: a single win when gammons do not count, or when the Jacoby rule holds them back because the cube was never turned.

Examples

import { multiplierOf, newGame, rollOpening, settingsFor } from "@johnmorrisdotca/sugoroku";

const settings = settingsFor("backgammon",{points:5,cube:true});
const game = rollOpening(newGame(settings),[3,1]);
console.log(multiplierOf(game,"gammon"));
1

What it prints (run when this page was built)

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