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

How-to

Choose variants and named presets

Resolve a variant separately from cube and match rules.

A variant is a specification

import {settingsFor,variantSpec,startPosition,presetByKey,PRESETS} from "@johnmorrisdotca/sugoroku";
const settings = settingsFor("tabula",{points:1});
console.log(settings.variant.dice,startPosition(settings.variant).reserve);
console.log(variantSpec("hypergammon").checkers,presetByKey(PRESETS[0].key)?.names);
3 [ 15, 15 ]
3 [
  'Backgammon',
  'Backgammon Level 2',
  'Backgammon Level 3',
  'Casual Backgammon'
]

The engine reads checker counts, start layout, dice, direction, opening and goal, not a display name. Seven keys cover backgammon, its bar-start race, anti-backgammon, Nackgammon, Long Gammon, Hypergammon and Tabula. A preset pairs a variant with complete rules, preserving the named play choices documented from older sites.

Validate the requested rules

settingsFor resolves partial rule choices; rulesProblems explains inconsistent complete rules. A single one-point game has no active cube; Crawford, Jacoby and beaver settings have their own applicable contexts. Do not swap a variant's start position without its move rules. presetByName/presetByKey return undefined for unknown names/keys. The variant source notes retain the readings and their reasons, including same-track and reserve-checker distinctions.

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