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

onBoardfunction

How many checkers side has on the board's points, not counting the bar, the reserve and those borne off.

Import it

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

Definition

function onBoard(position: Position, side: Side): number

Parameters

NameTypeDescription
positionPosition

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

sideSide

The side being examined: white or black.

Returns

number

How many checkers side has on the board's points, not counting the bar, the reserve and those borne off.

Examples

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

const settings = settingsFor("backgammon",{points:5,cube:true});
const spec = settings.variant;
const position = startPosition(spec);
console.log(onBoard(position,"white"));
15

What it prints (run when this page was built)

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