Tutorials checklist - Revision history

Thoun: /* Tutorial Game release override */

2025-07-02T09:05:39Z

Tutorial Game release override

← Older revision		Revision as of 11:05, 2 July 2025
Line 41:		Line 41:
	* The game version that the tutorial should use		* The game version that the tutorial should use
	If you're the game dev, you can change the version used by the tutorial by clicking "Tutorials" on the Game Metadata Manager then :		If you're the game dev, you can change the version used by the tutorial by clicking "Tutorials" on the Game Metadata Manager then :
			[[File:Tutorial override gameversion.png]]
			After changing the version, make sure the tutorial still works. If it doesn't, repoen this popin and save with an empty value, it will reset the game version used by the tutorial to its original one.

	~~[[File:Tutorial override gameversion.png\|thumb\|1103x1103px]]~~
	[[Category:Studio]]		[[Category:Studio]]

Thoun: /* Tutorial Game release override */

2025-07-02T09:04:26Z

Tutorial Game release override

← Older revision		Revision as of 11:04, 2 July 2025
Line 40:		Line 40:
	* The tutorial ID (you must be the tutorial author or the game adaptation developer)		* The tutorial ID (you must be the tutorial author or the game adaptation developer)
	* The game version that the tutorial should use		* The game version that the tutorial should use
			If you're the game dev, you can change the version used by the tutorial by clicking "Tutorials" on the Game Metadata Manager then :

			[[File:Tutorial override gameversion.png\|thumb\|1103x1103px]]
	[[Category:Studio]]		[[Category:Studio]]

Thoun: /* Tutorial Game release override */

2025-07-02T09:00:53Z

Tutorial Game release override

← Older revision		Revision as of 11:00, 2 July 2025
Line 37:		Line 37:
	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.		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:		As a tutorial author, if you want to do this switch, please contact the game dev (or a support ticket if he doesn't answer) specifying:
	* The tutorial ID (you must be the tutorial author or the game adaptation developer)		* The tutorial ID (you must be the tutorial author or the game adaptation developer)
	* The game version that the tutorial should use		* The game version that the tutorial should use
	* "Tutorial game release override" as email subject


	[[Category:Studio]]		[[Category:Studio]]

Thoun at 12:17, 25 June 2024

2024-06-25T12:17:12Z

← Older revision		Revision as of 14:17, 25 June 2024
Line 8:		Line 8:

	If a player trying to create a tutorial reports you an issue about 1) or 2), the most likely reasons for the issue are:		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.		* that you have triggered this.ajaxcall() / this.bgaPerformAction() 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.		* 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" / "bgaPerformAction" whatever the UX path used.

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

Victoria La at 15:35, 22 June 2024

2024-06-22T15:35:33Z

← Older revision		Revision as of 17:35, 22 June 2024
Line 41:		Line 41:
	* The game version that the tutorial should use		* The game version that the tutorial should use
	* "Tutorial game release override" as email subject		* "Tutorial game release override" as email subject


			[[Category:Studio]]

Archduke at 09:24, 20 February 2024

2024-02-20T09:24:03Z

← Older revision		Revision as of 11:24, 20 February 2024
Line 15:		Line 15:
	* you might have some missing "ID" on elements of the interface, preventing the tutorial author to attach elements to them.		* you might have some missing "ID" on elements of the interface, preventing the tutorial author to attach elements to them.

			== Publishing Tutorials ==
			Tutorials, in general, are only published if they satisfy these conditions:

			* They have an average rating of 4.2 or higher
			* They have been rated at least 10 times (for moving to BETA)
			* They have been rated at least 100 times (for moving to LIVE)

			If a tutorial should be published, but does not meet these requirements, the help of a BGA admin is required.

	== Tutorial Game release override ==		== Tutorial Game release override ==

GTSchemer: /* Tutorial Game release override */

2022-08-16T16:49:27Z

Tutorial Game release override

← Older revision		Revision as of 18:49, 16 August 2022
Line 27:		Line 27:
	* HOWEVER, using Tutorial game release override, you can ask a BGA admin to switch your tutorial to the newer version of the game.		* 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.		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:		As a tutorial author, if you want to do this switch, please write an email to studio(at)boardgamearena.com specifying:

GTSchemer: /* Tutorial Game release override */

2022-08-16T16:49:11Z

Tutorial Game release override

← Older revision		Revision as of 18:49, 16 August 2022
Line 18:		Line 18:
	== Tutorial Game release override ==		== Tutorial Game release override ==

	In ~~the~~ case someone already ~~write~~ 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.		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:		Example:
	* You wrote 90% of a tutorial for game Carcassonne, based on a game replay which is using BGA version V1.		* 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%.		* Because of a problem in the game adaptation, you cannot write the remaining 10%.
	* The developer of the Carcassonne adaptation ~~fix~~ the issue in a new version of Carcassonne for BGA: version V2.		* 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.		* 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.		* HOWEVER, using Tutorial game release override, you can ask a BGA admin to switch your tutorial to the newer version of the game.

Sourisdudesert at 15:57, 16 August 2022

2022-08-16T15:57:03Z

← Older revision		Revision as of 17:57, 16 August 2022
Line 16:		Line 16:


	Tutorial Game release override		== Tutorial Game release override ==

	In the case someone already write 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.		In the case someone already write 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.

Sourisdudesert at 15:56, 16 August 2022

2022-08-16T15:56:18Z

← Older revision		Revision as of 17:56, 16 August 2022
Line 14:		Line 14:
	* 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 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.		* 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 the case someone already write 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 fix 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