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

rollDicefunction

Roll the dice for the side on turn, which must not be waiting on an answer to a double.

Import it

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

Definition

function rollDice(game: GameState, dice: readonly number[]): GameState

Parameters

NameTypeDescription
gameGameState

The current immutable native game state.

dicereadonly number[]

Dice values as thrown, or a reproducible source specified by the signature.

Returns

GameState

Roll the dice for the side on turn, which must not be waiting on an answer to a double.

Examples

import { endTurn, legalPlaysOf, newGame, playTurn, rollDice, 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 beforeRoll = playTurn(game,play.moves);
console.log(rollDice(beforeRoll,[6,2]).dice);
[ 6, 2 ]

What it prints (run when this page was built)

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