Reference · Rules, games and records
Presettype
A NAMED WAY OF PLAYING: a variant with its rules. The names on the sites
these games were played on (ItsYourTurn.com and GoldToken.com) each lead to
one of these through presetByName, and docs/VARIANTS.md says how each
was read.
Import it
import type { Preset } from "@johnmorrisdotca/sugoroku";
Definition
type Preset = {
key: string;
variant: VariantKey;
rules: Rules;
names: readonly string[];
};
Members
| Name | Type | Description |
|---|---|---|
key | string | In kebab case. |
variant | VariantKey | |
rules | Rules | |
names | readonly string[] | The names this goes by, as the sites print them. |
Examples
import type { Preset } from "@johnmorrisdotca/sugoroku";
import { PRESETS } from "@johnmorrisdotca/sugoroku";
const value: Preset = PRESETS[0];
console.log(value);{
key: 'backgammon',
variant: 'backgammon',
rules: {
points: 1,
cube: false,
crawford: true,
jacoby: false,
beaver: false,
gammons: false
},
names: [
'Backgammon',
'Backgammon Level 2',
'Backgammon Level 3',
'Casual Backgammon'
]
}What it prints (run when this page was built)