Create games page

[midorimici]

/games Fetch game data and display game informations.

from GraphCMS (static data)

name: string
description: string
boardSize: int
withCastling: bool
promotionCandidates: string list  # piece ids
initialBoardImage: one file media
isAsymmetric: bool
initialPiecePositions: JSON object
  [rank]:
    - pieceName | null

pieceName  ::= pieceColor pieceId | pieceId  # pieceColor must be omitted when it is symmetric game
pieceColor ::= 'W' | 'B'
pieceId    ::= [A-Z][a-zA-Z0-9]*

from Realtime Database (dynamic data), in later PR

• Whether there is a player waiting for another player in a public room: boolean

[midorimici]

Add piece model and contents to GraphCMS.

piece expandMoves is useful to omit duplicated moves.

abbr: enum (piece id)
value: float
moves: JSON object (list of moveNode)
expandMoves?: enum['V' | 'H' | 'X']  # Add reversed moves of "moves" V: ↕, H: ↔, X: ↕↔ ↖↘ ↙↗

moveNode tree structure

move: move
children?: moveNode[]
when?: string

move Either the ref field, or type and direction fields are required. Fields for hopper and penetration will not be implemented at this stage.

ref?: pieceId                    # Id of a piece to copy.
type?: enum['leaper' | 'rider']  # Required when ref is not specified.
direction?: [int, int]           # The direction seen from a white player. Top-right will be greater. Required when ref is not specified.
length?: number (0 -)            # The distance to run (for riders and hoppers). 0 or unspecified means infinity.
# Fields for hopper
# reach?: number
# captureHurdle?: boolean
# Fields for penetration
# penetrationLimit?: number (0 -) # The number of pieces that the piece penetrates. 0 means infinity.
reflectionLimit?: number (1 - 3)  # The times that the piece reflects on the edge of the board.
option?: enum['move-only' | 'capture-only']

[midorimici]

For instance, moves of a knight become like this:

{
  "moves": [
    {
      "move": {
        "type": "leaper",
        "direction": [1, 2],
      },
    },
    {
      "move": {
        "type": "leaper",
        "direction": [2, 1],
      },
    },
    {
      "move": {
        "type": "leaper",
        "direction": [2, -1],
      },
    },
    // ... 5 more ...
  ],
}

// More short with expandMoves:

{
  "moves": [
    {
      "move": {
        "type": "leaper",
        "direction": [1, 2],
      },
    },
  ],
  "expandMoves": "X",
}

griffin:

{
  "moves": [
    {
      "move": {
        "type": "leaper",
        "direction": [1, 1],
        "option": "move-only",
      },
      "children": [
        {
          "move": {
            "type": "rider",
            "direction": [1, 0],
          },
        },
        {
          "move": {
            "type": "rider",
            "direction": [0, 1],
          },
        },
      ],
    },
  ],
  "expandMoves": "X",
}

[midorimici]

Use when field to specify the condition that the move is applied. This is convenient for pieces that alter moves depending on how many times they have moved. For instance, moves of an imitator become like this:

{
  "moves": [
    {
      "move": {
        "ref": "N",
      },
      "when": "piece.moveCount % 5 === 0",
    },
    {
      "move": {
        "ref": "B",
      },
      "when": "piece.moveCount % 5 === 1",
    },
    // ... 3 more ...
  ],
}

[midorimici]

A complex example: pawn

{
  "moves": [
    {
      "move": {
        "type": "rider",
        "direction": [0, 1],
        "length": 2,
        "option": "move-only",
      },
      "when": "piece.moveCount === 0",
    },
    {
      "move": {
        "type": "leaper",
        "direction": [0, 1],
        "option": "move-only",
      },
    },
    {
      "move": {
        "type": "leaper",
        "direction": [1, 1],
        "option": "capture-only",
      },
    },
    {
      "move": {
        "type": "leaper",
        "direction": [-1, 1],
        "option": "capture-only",
      },
    },
  ],
}

[midorimici]

initialPiecePositions of the normal game would be like this:

{
  "1": ["P", "P", "P", "P", "P", "P", "P", "P"],
  "0": ["R", "N", "B", "Q", "K", "B", "N", "R"],
}