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

Matchtype

A MATCH: games played one after another to a number of points, or without end in money play. It keeps the score and says which game is the Crawford game. Like everything here it is plain data, and never changed: each function gives back a new match.

Import it

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

Definition

type Match = {
    readonly settings: Settings;
    readonly score: readonly [
        number,
        number
    ];
    readonly results: readonly GameResult[];
    readonly crawfordNext: boolean;
    readonly crawfordPlayed: boolean;
    readonly over: boolean;
    readonly winner: Side | null;
};

Members

NameTypeDescription
settingsSettings
scorereadonly [number, number]

The score, [white, black].

resultsreadonly GameResult[]

Every game finished so far.

crawfordNextboolean

Whether the next game is the Crawford game.

crawfordPlayedboolean

Whether the Crawford game has been played: there is one in a match.

overboolean

Whether the match is decided: a side reached the match length, or a game was drawn. Never in money play.

winnerSide | null

Who won the match; null while it goes on, or when it was drawn.

Examples

import { newMatch, settingsFor } from "@johnmorrisdotca/sugoroku";
import type { Match } from "@johnmorrisdotca/sugoroku";

const settings = settingsFor("backgammon",{points:5,cube:true});
const match = newMatch(settings);
const value: Match = match;
console.log(value);
{
  settings: {
    variant: {
      checkers: 15,
      dice: 2,
      doubles: 'four',
      direction: 'opposed',
      opening: 'roll-off',
      goal: 'first-off',
      holdBelow: 0,
      drawAfter: 0,
      key: 'backgammon',
      layout: [Array]
    },
    rules: {
      points: 5,
      cube: true,
      crawford: true,
      jacoby: false,
      beaver: false,
      gammons: false
    }
  },
  score: [ 0, 0 ],
  results: [],
  crawfordNext: false,
  crawfordPlayed: false,
  over: false,
  winner: null
}

What it prints (run when this page was built)

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