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

parsePlayfunction

The moves a written play makes with a roll, or null if it is not a legal play of that roll. Checks every rule: it is found by making each named move in some order, each one legal when it is made, until the roll is played as the rules require. A checker that plays both dice may be written as one move, 24/14 for a 6 and a 4, as well as through the point it passes.

Import it

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

Definition

function parsePlay(spec: VariantSpec, position: Position, side: Side, roll: readonly number[], text: string): Move[] | null

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.

rollreadonly number[]

The valid dice as thrown, in throw order.

textstring

Native move notation, position text or full record specified by the signature.

Returns

Move[] | null

The moves a written play makes with a roll, or null if it is not a legal play of that roll. Checks every rule: it is found by making each named move in some order, each one legal when it is made, until the roll is played as the rules require. A checker that plays both dice may be written as one move, 24/14 for a 6 and a 4, as well as through the point it passes.

Examples

import { formatPlay, legalPlaysOf, newGame, parsePlay, rollOpening, settingsFor, startPosition } from "@johnmorrisdotca/sugoroku";

const settings = settingsFor("backgammon",{points:5,cube:true});
const spec = settings.variant;
const position = startPosition(spec);
const game = rollOpening(newGame(settings),[3,1]);
const play = legalPlaysOf(game)[0];
console.log(parsePlay(spec,position,"white",[3,1],formatPlay(play.moves)));
[
  { from: 24, to: 21, die: 3, hit: false },
  { from: 24, to: 23, die: 1, hit: false }
]

What it prints (run when this page was built)

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