Creating games

Guide for adding a new game to gameslib. For API details see Game object and Helpers.

Workflow

1. Fork gameslib and work on the develop branch.
2. Before first npm install, run npm run npm-login for GitHub Packages access.
3. Create src/games/<uid>.ts extending GameBase (or GameBaseSimultaneous).
4. Register in src/games/index.ts (import, type union, array entry, GameFactory case).
5. Add i18n strings to locales/en/apgames.json (and apresults.json if needed).
6. Flag new games with experimental in gameinfo.
7. Test locally — Testing.
8. PR against develop; test on play.dev.abstractplay.com after merge.

Implementation checklist

• [ ] static readonly gameinfo: APGamesInformation (flag experimental must be set for all new games)
• [ ] State interfaces (IMoveState, I<Name>State)
• [ ] Constructor (new + deserialize via reviver)
• [ ] move, render, state, load, clone, moveState
• [ ] moves() unless using no-moves flag
• [ ] handleClick for interactive placement
• [ ] validateMove / checkEOG as needed
• [ ] Unit tests under test/games/
• [ ] Renderer JSON validated against renderer schema

Start from /gameslib/templates/new-game-template.ts and Complica.

Choosing helpers

Most board games use either:

• RectGrid — rectangular boards with directions and algebraic coords (Hnefatafl, Go)
• Graph classes — hex, snubsquare, sowing, etc. (Helpers overview)

Use the examples by feature index to find games similar to yours.

Renderer

Implement render(opts?) returning APRenderRep for @abstractplay/renderer. Prototype JSON in the renderer playground.

Example games

• Complica — template baseline
• Yavalath — hex graph game