Skip to the content

Kumimoji組み文字

Build crosswords from seeded English or Japanese tile bags, alone or at a shared table.

Kumimoji means assembled characters in Japanese. About the name

Contents

Reference · Rules, tiles and records

KumimojiExportedtype

A whole JSON export of one game: what kumimojiToJSON writes and kumimojiFromJSON reads.

Import it

import type { KumimojiExported } from "@johnmorrisdotca/kumimoji";

Definition

type KumimojiExported = {
    format: typeof KUMIMOJI_EXPORT_FORMAT;
    game: "kumimoji";
    generator: string;
    size: number;
    level: KumimojiLevel;
    seed: number;
    language: KumimojiLanguage;
    gameLength: KumimojiLength;
    doubleSet: boolean;
    diagonals: boolean;
    progress: string;
    elapsedMs: number;
};

Members

NameTypeDescription
format1

The shape's number: KUMIMOJI_EXPORT_FORMAT.

game"kumimoji"

Always "kumimoji", so a file of this shape is not mistaken for another game's.

generatorstring

The package and version that wrote it, such as "kumimoji 1.1.0". For people; never read back.

sizenumber

The opening hand: 3, 7 or 11.

levelKumimojiLevel

How many of the tiles are wild.

seednumber

The seed the bag is dealt from.

languageKumimojiLanguage

The language of the tiles.

gameLengthKumimojiLength

How much of the set the bag holds.

doubleSetboolean

Two English sets at once.

diagonalsboolean

Whether diagonal runs of three or more must be words too.

progressstring

Where the player has got to, as encodeTileProgress writes it: tiles taken, tiles traded back, the hand, the grid.

elapsedMsnumber

Milliseconds spent so far.

Examples

import { deal, generateKumimoji, kumimojiExported } from "@johnmorrisdotca/kumimoji";
import type { KumimojiExported } from "@johnmorrisdotca/kumimoji";
import { loadTileWordsFromModule } from "@johnmorrisdotca/kumimoji/words";

await loadTileWordsFromModule("english");
const play = deal("catdog",3);
const dealt = generateKumimoji(3,"hard",44);
const saved = {deal:dealt,play:deal(dealt.givens,dealt.size),elapsedMs:0};
const value: KumimojiExported = kumimojiExported(saved);
console.log(value);
{
  format: 1,
  game: 'kumimoji',
  generator: 'kumimoji 1.6.0',
  size: 3,
  level: 'hard',
  seed: 44,
  language: 'english',
  gameLength: 'short',
  doubleSet: false,
  diagonals: false,
  progress: '3::nwo:',
  elapsedMs: 0
}

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/kumimoji 1.6.0.