This is a documentation for Board Game Arena: play board games online !

Game replay

From Board Game Arena
Jump to navigation Jump to search


Game File Reference



Useful Components

Official

  • Deck: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).
  • Draggable: a JS component to manage drag'n'drop actions.
  • Counter: a JS component to manage a counter that can increase/decrease (ex: player's score).
  • ExpandableSection: a JS component to manage a rectangular block of HTML than can be displayed/hidden.
  • Scrollmap: a JS component to manage a scrollable game area (useful when the game area can be infinite. Examples: Saboteur or Takenoko games).
  • Stock: a JS component to manage and display a set of game elements displayed at a position.
  • Zone: a JS component to manage a zone of the board where several game elements can come and leave, but should be well displayed together (See for example: token's places at Can't Stop).

Undocumented component (if somebody knows please help with docs)

  • Wrapper: a JS component to wrap a <div> element around its child, even if these elements are absolute positioned.

Unofficial



Game Development Process



Guides for Common Topics



Miscellaneous Resources

Game replay is managed by the framework. You do not need to do anything special about it in your code, except taking care of updating the client interface through the framework notification system (and not for example, by using the callback function of an ajaxcall).

The game replay works like this:

  • The static files for the game at the time of the game start are archived
  • All notifications sent to the browser are added to the archive
  • When replaying, the static files are loaded in the browser, then notifications are sent back to replay the game moves.

So in essence, the replay works like an exact recording.

NB: the game replay feature is now available on the studio (since December 2020). Please note that there may be a delay before the replay becomes available.

Preview Videos

Example games are periodically selected from which videos are generated to show off the game on the game panel.

Wingspan: https://x.boardgamearena.net/data/gamepreviews/1635/en-w640.webm

Hiding UI elements from preview video

Some games have pop-up modals which are displayed in some cases, these should be hidden for the replay video so you can show off the gameplay right from the game page!

Mycity-with-modal.png

Previews are generated with a query variable set target=video. You can check for this query param in the following way:

const searchParams = new URLSearchParams(window.location.search);
if (searchParams) {
    const target = searchParams.get('target');
    if (target === "video") {
        // Hide modal popups...
    }
}