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

Positiontype

WHERE THE CHECKERS ARE. Every count is in the side's own numbering: own point 1 is the one nearest its bearing-off and own point 24 the one farthest from it, so points[side][n - 1] is how many of that side's checkers stand on its own point n. A position is plain data and is never changed: every function that moves a checker returns a new one.

Import it

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

Definition

type Position = {
    readonly points: readonly [
        readonly number[],
        readonly number[]
    ];
    readonly bar: readonly [
        number,
        number
    ];
    readonly reserve: readonly [
        number,
        number
    ];
    readonly off: readonly [
        number,
        number
    ];
};

Members

NameTypeDescription
pointsreadonly [readonly number[], readonly number[]]

[white, black], each 24 counts, index 0 being own point 1.

barreadonly [number, number]

Checkers hit and waiting to enter, [white, black].

reservereadonly [number, number]

Checkers that have never entered, [white, black]: all of them at the start of a race.

offreadonly [number, number]

Checkers borne off, [white, black].

Examples

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

const settings = settingsFor("backgammon",{points:5,cube:true});
const spec = settings.variant;
const position = startPosition(spec);
const value: Position = position;
console.log(value);
{
  points: [
    [
      0, 0, 0, 0, 0, 5, 0, 3,
      0, 0, 0, 0, 5, 0, 0, 0,
      0, 0, 0, 0, 0, 0, 0, 2
    ],
    [
      0, 0, 0, 0, 0, 5, 0, 3,
      0, 0, 0, 0, 5, 0, 0, 0,
      0, 0, 0, 0, 0, 0, 0, 2
    ]
  ],
  bar: [ 0, 0 ],
  reserve: [ 0, 0 ],
  off: [ 0, 0 ]
}

What it prints (run when this page was built)

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