Kumimoji documentation
Kumimoji 組み文字 — Crossword tile game in English and Japanese
Build crosswords from seeded English or Japanese tile bags, alone or at a shared table.
Install
npm install @johnmorrisdotca/kumimoji
Start here
Entry points
| Import it | What it is | Size |
|---|---|---|
@johnmorrisdotca/Server word lists · 1 exports | The word lists where there is no browser: a server checking a finished game, a test, a script. | 662.0 kB |
@johnmorrisdotca/Browser table · 19 exports | Kumimoji played in the browser, in plain DOM: a whole game alone (mountKumimoji), and the window a board shows the grid through (boardModel). | 674.9 kB |
@johnmorrisdotca/React table · 4 exports | 688.6 kB | |
@johnmorrisdotca/Table element · 4 exports | 677.6 kB | |
@johnmorrisdotca/Register the table · 4 exports | 677.7 kB | |
@johnmorrisdotca/Rules, tiles and records · 195 exports | Kumimoji 組み文字: the race to build a crossword from a bag of letter tiles, in English or Japanese, alone or at a table of two to eight, as plain functions over plain data. | 677.3 kB |
Guides
How-to
- Load and judge with word listsLoad word lists in the browser or on the server, judge a layout with them, and keep their notices.
- Build and judge solo progressHold solo progress as a new value, place and move tiles, and check before drawing or finishing.
- Kana, tile faces and wildsTell displayed kana from internal tile codes, and assign readings to wild tiles.
- Use one bag at a shared tableLet two to eight players draw from one bag, apply solo moves to a seat, and handle computer turns.
- Save progress and embed a tableSave and restore progress against the same bag, and mount an asynchronous table.
Explanation
- Grids, runs and viewsRead connected word layouts, rotate and zoom the view, and keep saved forms intact.
- Seeded generation and proofDeal from a generated solution, keep every setting to reproduce it, and handle generation failures.