Games Library
@abstractplay/gameslib contains TypeScript implementations of all Abstract Play games. The front end and back end load games through a small public API.
Documentation
- Meta-game catalog — alphabetical display names and
metaGameuids (generated at docs build) - Categories & tags — tag vocabulary and games per tag (
categories.prose.md+ generated lists) - Creating games — workflow, choosing a base class, helpers, renderer, PR
- API —
GameFactory,gameinfo,resolveGameFlags - gameinfo metadata — schema (
gameinfo.json),customizations,playerpalette tags - Game object —
GameBasecontract, turn model, mixin hooks, andrecordExportExcludefor gamerecord export - Flags —
gameinfoflags reference - Variants — optional rules, constraint fields, constructor helper
- Helpers — grids, graphs, serialization, and shared utilities
- i18n — translation files
- Examples by feature — which games use which helpers
Resources
- Renderer docs — board JSON schema
- Renderer playground — experiment with
render()output - Gameslib playground — run games in the browser
- Developer docs — platform overview and repository index
- Discord #dev-curious
Last verified against develop branch.
When changing GameBase, gameinfo.json, or public exports, update /docs in the same PR.