Get the full engine definition (topology, render config, pieces, setup FEN) for a game variant. Returns the resolved frontmatter used to render and play the game.

post/api/tools/play_get_definition

Request

  • Base URL: https://tools.moddable.games
  • URL: https://tools.moddable.games/api/tools/play_get_definition
  • Auth: none declared

Request body

familystring required

Game family (chess, draughts, go, reversi, shogi, xiangqi, mancala, morris, hex, landlords-game, backgammon, standard-52, bavarian-32, flower-48, double-six-dominoes, mahjong, standard-dice, agon, asalto, chaupar, dou-shou-qi, fanorona, halma, nyout, pachisi, royal-ur, senet, stern-halma, surakarta, tafl)

variantstring

Variant slug (default: the family's default game)

Response

Tool result

Changes

No recorded changes to this operation across all 1 revision of this API.