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

formatResultfunction

The line that closes a game, with what it came to.

Import it

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

Definition

function formatResult(result: GameResult): string

Parameters

NameTypeDescription
resultGameResult

The completed native game result to add to a match.

Returns

string

The line that closes a game, with what it came to.

Examples

import { concede, formatResult, newGame, rollOpening, settingsFor } from "@johnmorrisdotca/sugoroku";

const settings = settingsFor("backgammon",{points:5,cube:true});
const game = rollOpening(newGame(settings),[3,1]);
const result = concede(game,"black","single").result!;
console.log(formatResult(result));
result white concede single 1

What it prints (run when this page was built)

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