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

Game replay: Difference between revisions

From Board Game Arena
Jump to navigation Jump to search
Victoria La (talk | contribs)
No edit summary
Archduke (talk | contribs)
No edit summary
Line 12: Line 12:
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.
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
These previews are generated with a query variable set <code>target=video</code> in order that you can hide parts of the UI for this video. This should only be done in specific cases, such as to remove modal popups which the player would normally manually dismiss. These modal popups will otherwise remain visible and obscure the video preview.
const searchParams = new URLSearchParams(window.location.search);
if (searchParams) {
    const target = searchParams.get('target');
    if (target === "video") {
        // Hide modal popups...
    }
}
[[Category:Studio]]
[[Category:Studio]]

Revision as of 13:18, 9 May 2023


Official documentation


Useful Components

Official

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

These previews are generated with a query variable set target=video in order that you can hide parts of the UI for this video. This should only be done in specific cases, such as to remove modal popups which the player would normally manually dismiss. These modal popups will otherwise remain visible and obscure the video preview.

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