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

Tutorials checklist

From Board Game Arena
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

In order to allow for a full-fledged tutorial to be built for the game you have adapted on BGA studio:

  1. the game replay archive generated for the game must be valid (you should be able to run the replay from start to finish without errors using the "Replay game" function on a finished table)
  2. each action of the replay should be replayable by triggering it manually (i.e. by reproducing the exact same sequence as done played originally during the game
  3. each element of the game interface should be available for attaching a comment or a highlight component on it.

You can read more about building tutorials in practice here: https://boardgamearena.com/tutorialfaq


If a player trying to create a tutorial reports you an issue about 1) or 2), the most likely reasons for the issue are:

  • that you have triggered this.ajaxcall() programmatically in a notification handling function or a callback instead of only on a user interface action.
  • or (for 2) ), that there are several way to trigger the next action with different URL/arguments. You should make sure that the same game actions are triggered with the same "ajaxcall" whatever the UX path used.

If a player trying to create a tutorial reports you an issue about 3):

  • you might have some overlapping elements preventing to access the "div" tag of an important interface element to attach tutorial content to it.
  • you might have some missing "ID" on elements of the interface, preventing the tutorial author to attach elements to them.


Tutorial Game release override

In case someone already wrote a tutorial that did not work well because something small must be changed in the game adaptation code, it may be possible to make the existing tutorial works with a newer version of the game adaptation.

Example:

  • You wrote 90% of a tutorial for game Carcassonne, based on a game replay which is using BGA version V1.
  • Because of a problem in the game adaptation, you cannot write the remaining 10%.
  • The developer of the Carcassonne adaptation fixes the issue in a new version of Carcassonne for BGA: version V2.
  • You will have to rewrite the entire tutorial using a replay based on a game played with this new version V2.
  • HOWEVER, using Tutorial game release override, you can ask a BGA admin to switch your tutorial to the newer version of the game.

Important: This can only works if the game release updates are limited. To be more specific: the new version must be compatible with the moves notifications sent by the previous version. For example, if on the new version you expect on Client side a new parameter in a move notification, the version override will just break the replay and make your tutorial unplayable.

As a tutorial author, if you want to do this switch, please write an email to studio(at)boardgamearena.com specifying:

  • The tutorial ID (you must be the tutorial author or the game adaptation developer)
  • The game version that the tutorial should use
  • "Tutorial game release override" as email subject