This is a documentation for Board Game Arena: play board games online !
Tutorials checklist: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
In order to allow for a full-fledged tutorial to be built for the game you have adapted on BGA studio: | In order to allow for a full-fledged tutorial to be built for the game you have adapted on BGA studio: | ||
# 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) | # 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) | ||
# each action of the replay should be replayable by triggering it manually ( | # 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 | ||
# each element of the game interface should be available for attaching a comment or a highlight | # 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 | You can read more about building tutorials in practice here: https://boardgamearena.com/tutorialfaq | ||
Revision as of 14:14, 9 June 2022
In order to allow for a full-fledged tutorial to be built for the game you have adapted on BGA studio:
- 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)
- 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
- 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 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 3), you might have some overlapping elements preventing to access the "div" tag of an important interface element to attach tutorial content to it.