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

diceMustPlayfunction

WHICH DICE MUST BE PLAYED. A side must play as many of its dice as it can; where it cannot play them all and could play either of two (or more) sets, it must play the higher: with two dice, if only one can be played, it is the larger one when it can. Returned highest first, from the dice as diceToPlay gives them.

Import it

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

Definition

function diceMustPlay(spec: VariantSpec, position: Position, side: Side, dice: readonly number[]): number[]

Parameters

NameTypeDescription
specVariantSpec

The native variant specification.

positionPosition

The native checker counts, bar, reserve and borne-off counts.

sideSide

The side being examined: white or black.

dicereadonly number[]

Dice values as thrown, or a reproducible source specified by the signature.

Returns

number[]

WHICH DICE MUST BE PLAYED. A side must play as many of its dice as it can; where it cannot play them all and could play either of two (or more) sets, it must play the higher: with two dice, if only one can be played, it is the larger one when it can. Returned highest first, from the dice as diceToPlay gives them.

Examples

import { diceMustPlay, settingsFor, startPosition } from "@johnmorrisdotca/sugoroku";

const settings = settingsFor("backgammon",{points:5,cube:true});
const spec = settings.variant;
const position = startPosition(spec);
console.log(diceMustPlay(spec,position,"white",[3,1]));
[ 3, 1 ]

What it prints (run when this page was built)

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