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

Tutorials checklist: Difference between revisions

From Board Game Arena
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 7: Line 7:




If a player trying to create a tutorial reports you an issue about 1) or 2), the most likely reason for the issue is that you have triggered this.ajaxcall() programmatically in a notification handling function or a callback instead of only on a user interface action.
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.
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.

Revision as of 14:44, 9 June 2022

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.