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

playMovefunction

Make one move for the side on turn, given as the checker's own point it leaves and the one it goes to. The move must be one of legalMoves. Where a checker could be borne off by either of two dice, the smaller is used.

Import it

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

Definition

function playMove(game: GameState, step: { from: number; to: number; }): GameState

Parameters

NameTypeDescription
gameGameState

The current immutable native game state.

step{ from: number; to: number; }

A requested source and destination from the current legal moves.

Returns

GameState

Make one move for the side on turn, given as the checker's own point it leaves and the one it goes to. The move must be one of legalMoves. Where a checker could be borne off by either of two dice, the smaller is used.

Examples

import { legalPlaysOf, newGame, playMove, rollOpening, settingsFor } from "@johnmorrisdotca/sugoroku";

const settings = settingsFor("backgammon",{points:5,cube:true});
const game = rollOpening(newGame(settings),[3,1]);
const play = legalPlaysOf(game)[0];
const move = play.moves[0];
console.log(playMove(game,move).moves.length);
1

What it prints (run when this page was built)

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