Pre-release checklist - Revision history

Ysubmarine: added hint for all dev accounts to be in the players group in order to test spectator mode

2026-09-17T12:17:06Z

added hint for all dev accounts to be in the players group in order to test spectator mode

← Older revision		Revision as of 12:17, 17 September 2026
Line 39:		Line 39:
	# ''' Special testing '''		# ''' Special testing '''
	## Click "Use minified JS" and "Use minified CSS" buttons on the game management page, then test your game (you have to commit in studio first). This will prevent you from having a panic attack when the game releases in alpha and it is stuck in "Connecting to game".		## Click "Use minified JS" and "Use minified CSS" buttons on the game management page, then test your game (you have to commit in studio first). This will prevent you from having a panic attack when the game releases in alpha and it is stuck in "Connecting to game".
	## Game is tested with spectator (non player observer): click the red arrow next to Test spectator, under player panels. As a spectator, you should be able to see the game as if you were sitting beside of the players at a real table: all public information, no private information.		## Game is tested with spectator (non player observer): click the red arrow next to Test spectator, under player panels. As a spectator, you should be able to see the game as if you were sitting beside of the players at a real table: all public information, no private information. Make sure all your players 0 to 9 are on the players group.
	## Game is tested with in-game replay from last move feature (by clicking on notification log items).		## Game is tested with in-game replay from last move feature (by clicking on notification log items).
	## After finishing a game, it is possible to watch the replay (using the "Replay game" button on the table page) from game start to game end without errors.		## After finishing a game, it is possible to watch the replay (using the "Replay game" button on the table page) from game start to game end without errors.

Thoun: /* Move from Dev to Alpha */

2026-09-16T10:08:23Z

Move from Dev to Alpha

← Older revision		Revision as of 10:08, 16 September 2026
Line 33:		Line 33:
	## If your game elements become blurry or pixelated when using the browser zoom, you may want to consider [[Game_art:_img_directory#Use_background-size \| higher resolution images with background-size]]		## If your game elements become blurry or pixelated when using the browser zoom, you may want to consider [[Game_art:_img_directory#Use_background-size \| higher resolution images with background-size]]
	## Non-self explanatory graphic elements should have tooltips		## Non-self explanatory graphic elements should have tooltips
	## Strings in your source code are ready for translation. See [[Translations]]. You can ~~generate dummy~~ translations ~~for checking that everything is ready for translation from your "Manage game" page~~.		## Strings in your source code are ready for translation. See [[Translations]]. You can test your translations with https://en.doc.boardgamearena.com/Translations#Testing_translations_on_Studio
	## A prefix for example a trigram for your game that you prepend to all the css classes to avoid namespace conflicts, i.e. vla_selected vs selected		## A prefix for example a trigram for your game that you prepend to all the css classes to avoid namespace conflicts, i.e. vla_selected vs selected
	## If you are looking for advice on design and some 3rd party testing you can post a message on the developers forum, and ask other developers, there are a lot of people who will gladly do it.		## If you are looking for advice on design and some 3rd party testing you can post a message on the developers forum, and ask other developers, there are a lot of people who will gladly do it.

Victoria La: add note about committing first when use minificationand other typos

2026-08-01T15:07:28Z

add note about committing first when use minificationand other typos

Thoun at 09:55, 3 July 2026

2026-07-03T09:55:38Z

← Older revision		Revision as of 09:55, 3 July 2026
Line 36:		Line 36:
	## A prefix for example a trigram for your game that you prepend to all the css classes to avoid namespace conflicts, i.e. vla_selected vs selected		## A prefix for example a trigram for your game that you prepend to all the css classes to avoid namespace conflicts, i.e. vla_selected vs selected
	## If you are looking for advice on design and some 3rd party testing you can post a message on the developers forum, and ask other developers, there are a lot of people who will gladly do it.		## If you are looking for advice on design and some 3rd party testing you can post a message on the developers forum, and ask other developers, there are a lot of people who will gladly do it.
			## Test if the game is readable in dark mode. See [[Game interface stylesheet: yourgamename.css#Support of the Dark mode]] for more details
	# ''' Special testing '''		# ''' Special testing '''
	## Click "Use minified JS" and "Use minified CSS" buttons on the game management page, then test your game. This will prevent you from having a panic attack when the game releases in alpha and it is stuck in "Connecting to game".		## Click "Use minified JS" and "Use minified CSS" buttons on the game management page, then test your game. This will prevent you from having a panic attack when the game releases in alpha and it is stuck in "Connecting to game".

Thoun at 10:08, 20 April 2026

2026-04-20T10:08:37Z

← Older revision		Revision as of 10:08, 20 April 2026
Line 7:		Line 7:
	## BGA must have a license for the game for a project to be moved to production, even to alpha. If you don't have license yet you can continue checking other stuff from the list below, but at the end it cannot be moved until license situation is cleared.		## BGA must have a license for the game for a project to be moved to production, even to alpha. If you don't have license yet you can continue checking other stuff from the list below, but at the end it cannot be moved until license situation is cleared.
	# ''' Metadata and game assets '''		# ''' Metadata and game assets '''
	## [[Game_meta-information: gameinfos.~~inc.php~~]] has correct and up to date information about the game.		## [[Game_meta-information: gameinfos.jsonc]] has correct and up to date information about the game.
	## Game box graphics is 3D version of the game box (if available) and publisher icon is correct (see [[Game art: img directory]]). Space around the box has to be transparent, not white.		## Game box graphics is 3D version of the game box (if available) and publisher icon is correct (see [[Game art: img directory]]). Space around the box has to be transparent, not white.
	## You have added the requested images in the Game Metadata Manager to make the game page pretty		## You have added the requested images in the Game Metadata Manager to make the game page pretty

Victoria La at 17:40, 6 April 2026

2026-04-06T17:40:40Z

← Older revision		Revision as of 17:40, 6 April 2026
Line 6:		Line 6:
	# ''' License '''		# ''' License '''
	## BGA must have a license for the game for a project to be moved to production, even to alpha. If you don't have license yet you can continue checking other stuff from the list below, but at the end it cannot be moved until license situation is cleared.		## BGA must have a license for the game for a project to be moved to production, even to alpha. If you don't have license yet you can continue checking other stuff from the list below, but at the end it cannot be moved until license situation is cleared.
	# ''' Metadata and ~~graphics~~ '''		# ''' Metadata and game assets '''
	## [[Game_meta-information: gameinfos.inc.php]] has correct and up to date information about the game.		## [[Game_meta-information: gameinfos.inc.php]] has correct and up to date information about the game.
	## Game box graphics is 3D version of the game box (if available) and publisher icon is correct (see [[Game art: img directory]]). Space around the box has to be transparent, not white.		## Game box graphics is 3D version of the game box (if available) and publisher icon is correct (see [[Game art: img directory]]). Space around the box has to be transparent, not white.

Victoria La: note about fonts and sounds

2026-04-06T17:40:16Z

note about fonts and sounds

← Older revision		Revision as of 17:40, 6 April 2026
Line 14:		Line 14:
	## Each image should not exceed 4Mb		## Each image should not exceed 4Mb
	## Total size should not exceed 15Mb, image compression should be used otherwise (it also helps a lot to re-encode images as indexed palette vs RBG). If you have legitimate reason to have more than 15Mb (i.e. expansions), you have to make a note of that when requesting move to alpha		## Total size should not exceed 15Mb, image compression should be used otherwise (it also helps a lot to re-encode images as indexed palette vs RBG). If you have legitimate reason to have more than 15Mb (i.e. expansions), you have to make a note of that when requesting move to alpha
	## If you use extra fonts, they should be freeware (please include a .txt with the license information in addition to the font files)		## If you use extra fonts, they should be freeware (please include a .txt with the license information in addition to the font files). Fonts should be placed to "fonts" directory
			## Sounds should be placed to "sounds" directory
	# ''' Server side '''		# ''' Server side '''
	## When giving their turn to a player, you give them some extra time with the giveExtraTime() function		## When giving their turn to a player, you give them some extra time with the giveExtraTime() function

Epsilon Theta: Fixed some typos.

2026-03-29T18:04:55Z

Fixed some typos.

Victoria La at 19:19, 15 March 2026

2026-03-15T19:19:48Z

Victoria La: added info on what to include in alpha request

2026-03-15T19:16:12Z

added info on what to include in alpha request

← Older revision		Revision as of 19:16, 15 March 2026
Line 58:		Line 58:
	### If possible (meaning if there is not already a project with that name) copy your project to a new project '''matching exactly the name of the game''' (no prefix or suffix). If not possible move on to the next steps, admin will have to retrieve the other project and overwrite it. In this case, after you request the alpha deployment, please reply to the automatic reply with the correct name.		### If possible (meaning if there is not already a project with that name) copy your project to a new project '''matching exactly the name of the game''' (no prefix or suffix). If not possible move on to the next steps, admin will have to retrieve the other project and overwrite it. In this case, after you request the alpha deployment, please reply to the automatic reply with the correct name.
	## If you DO have the correct formal name of the game for your project, or completed the above steps, create a build for your game from the "manage game" page (using the '''Build a new release version''' section) and check the log to make sure that everything builds fine (after a successful build, you should see a new version in "Versions available for production").		## If you DO have the correct formal name of the game for your project, or completed the above steps, create a build for your game from the "manage game" page (using the '''Build a new release version''' section) and check the log to make sure that everything builds fine (after a successful build, you should see a new version in "Versions available for production").
	## Are you really ready? Click on the '''Request ALPHA status''' button available above your just built version. You cannot deploy yourself from the "manage game" page until this first ALPHA deploy has been done by the admins. Clicking this button will file a request in the BGA ticketing system and you'll receive a confirmation email allowing to reply to add some information on the ticket if needed. Note: you can also ask for moving your project to "private Alpha" - in this case you will invite people manually rather than having your game immediately visible to the whole BGA reviewers community. When you press you button you should receive acknowledgement email, ~~you can~~ reply to this email with more details ~~if needed~~.		## Are you really ready? Click on the '''Request ALPHA status''' button available above your just built version. You cannot deploy yourself from the "manage game" page until this first ALPHA deploy has been done by the admins. Clicking this button will file a request in the BGA ticketing system and you'll receive a confirmation email allowing to reply to add some information on the ticket if needed. Note: you can also ask for moving your project to "private Alpha" - in this case you will invite people manually rather than having your game immediately visible to the whole BGA reviewers community. When you press you button you should receive acknowledgement email, reply to this email with more details.
			* ''' Add Information '''
			Reply to alpha request e-mail with following information
			** Is this final project name or need renaming
			** What is your production BGA user name
			** If private alpha requested - BGA user names of other admins - usually publisher/designer
			** If you have license or/and alpha approval, include approval email (form publisher)
			** If you have exceptions for items from this checklist (i.e. size of assets, custom fonts, etc) add explanations
	* ''' Wait '''		* ''' Wait '''
	** When admins publish (push to alpha) they will send an email to the developer with all relevant information about the next steps.		** When admins publish (push to alpha) they will send an email to the developer with all relevant information about the next steps.

← Older revision		Revision as of 15:07, 1 August 2026
Line 32:		Line 32:
	## If the elements in your game zone don't occupy all the available horizontal space, '''they should be centered'''.		## If the elements in your game zone don't occupy all the available horizontal space, '''they should be centered'''.
	## If your game elements become blurry or pixelated when using the browser zoom, you may want to consider [[Game_art:_img_directory#Use_background-size \| higher resolution images with background-size]]		## If your game elements become blurry or pixelated when using the browser zoom, you may want to consider [[Game_art:_img_directory#Use_background-size \| higher resolution images with background-size]]
	## Non-self explanatory graphic elements should have ~~tool tips~~		## Non-self explanatory graphic elements should have tooltips
	## Strings in your source code are ready for translation. See [[Translations]]. You can generate dummy translations for checking that everything is ready for translation from your "Manage game" page.		## Strings in your source code are ready for translation. See [[Translations]]. You can generate dummy translations for checking that everything is ready for translation from your "Manage game" page.
	## A prefix for example a trigram for your game that you prepend to all the css classes to avoid namespace conflicts, i.e. vla_selected vs selected		## A prefix for example a trigram for your game that you prepend to all the css classes to avoid namespace conflicts, i.e. vla_selected vs selected
Line 38:		Line 38:
	## Test if the game is readable in dark mode. See [[Game interface stylesheet: yourgamename.css#Support of the Dark mode]] for more details		## Test if the game is readable in dark mode. See [[Game interface stylesheet: yourgamename.css#Support of the Dark mode]] for more details
	# ''' Special testing '''		# ''' Special testing '''
	## Click "Use minified JS" and "Use minified CSS" buttons on the game management page, then test your game. This will prevent you from having a panic attack when the game releases in alpha and it is stuck in "Connecting to game".		## Click "Use minified JS" and "Use minified CSS" buttons on the game management page, then test your game (you have to commit in studio first). This will prevent you from having a panic attack when the game releases in alpha and it is stuck in "Connecting to game".
	## Game is tested with spectator (non player observer): click the red arrow next to Test spectator, under player panels. As a spectator, you should be able to see the game as if you were sitting beside of the players at a real table: all public information, no private information.		## Game is tested with spectator (non player observer): click the red arrow next to Test spectator, under player panels. As a spectator, you should be able to see the game as if you were sitting beside of the players at a real table: all public information, no private information.
	## Game is tested with in-game replay from last move feature (by clicking on notification log items).		## Game is tested with in-game replay from last move feature (by clicking on notification log items).
Line 63:		Line 63:
	## Click on the '''Request ALPHA status''' button available above your just built version. You cannot deploy yourself from the "manage game" page until this first ALPHA deploy has been done by the admins. Clicking this button will file a request in the BGA ticketing system and you'll receive a confirmation email allowing to reply to add some information on the ticket if needed. Note: you can also ask for moving your project to "private Alpha" - in this case you will invite people manually rather than having your game immediately visible to the whole BGA reviewers community. When you press you button you should receive acknowledgement email, reply to this email with more details.		## Click on the '''Request ALPHA status''' button available above your just built version. You cannot deploy yourself from the "manage game" page until this first ALPHA deploy has been done by the admins. Clicking this button will file a request in the BGA ticketing system and you'll receive a confirmation email allowing to reply to add some information on the ticket if needed. Note: you can also ask for moving your project to "private Alpha" - in this case you will invite people manually rather than having your game immediately visible to the whole BGA reviewers community. When you press you button you should receive acknowledgement email, reply to this email with more details.
	# Reply to alpha request e-mail with following information		# Reply to alpha request e-mail with following information
	## Is this final project name or need renaming		## Is this final project name or need renaming (this is actually part of submission form now)
	## What is your production BGA user name		## What is your production BGA user name (because they have to link it to be game admin in prod)
	## If private alpha requested - BGA user names of other admins - usually publisher/designer		## If private alpha requested - BGA user names of other admins - usually publisher/designer
	## If you have license or/and alpha approval, include approval email (form publisher)		## If you have license or/and alpha approval, include approval email (form publisher)

← Older revision		Revision as of 18:04, 29 March 2026
Line 14:		Line 14:
	## Each image should not exceed 4Mb		## Each image should not exceed 4Mb
	## Total size should not exceed 15Mb, image compression should be used otherwise (it also helps a lot to re-encode images as indexed palette vs RBG). If you have legitimate reason to have more than 15Mb (i.e. expansions), you have to make a note of that when requesting move to alpha		## Total size should not exceed 15Mb, image compression should be used otherwise (it also helps a lot to re-encode images as indexed palette vs RBG). If you have legitimate reason to have more than 15Mb (i.e. expansions), you have to make a note of that when requesting move to alpha
	## If you use extra fonts, they should be freeware (please include a .txt with the ~~licence~~ information in addition to the font files)		## If you use extra fonts, they should be freeware (please include a .txt with the license information in addition to the font files)
	# ''' Server side '''		# ''' Server side '''
	## When giving their turn to a player, you give them some extra time with the giveExtraTime() function		## When giving their turn to a player, you give them some extra time with the giveExtraTime() function
Line 23:		Line 23:
	## You implemented tiebreaking (using aux score field) and updated tiebreaker description in meta-data		## You implemented tiebreaking (using aux score field) and updated tiebreaker description in meta-data
	## Database: make sure you do not programmatically manage transactions or call queries that change database schema or even TRUNCATE (queries that would cause implicit commit) during normal game opearations		## Database: make sure you do not programmatically manage transactions or call queries that change database schema or even TRUNCATE (queries that would cause implicit commit) during normal game opearations
	## Database: make sure you DB schema would be sufficient to complete the game and good enough for possible ~~expantions~~, changing db schema schema after the release even in alpha is very challenging (it is possible but much better if you don't need to deal with it)		## Database: make sure you DB schema would be sufficient to complete the game and good enough for possible expansions, changing db schema schema after the release even in alpha is very challenging (it is possible but much better if you don't need to deal with it)
	# ''' Client side '''		# ''' Client side '''
	## Check that you use ajaxcall/bgaPerformAction only on player actions and never initiated programmatically. Otherwise, your code will very likely create race conditions resulting in deadlocks or other errors. This can also break replays and tutorials. ''Exception: sometimes you can do no-op moves with timeouts (i.e. user has only one choice, but its unwise to reveal this information by skipping user turn), timeout has to be canceling itself if state transition happen ~~automaticaly~~ (i.e. during replay)''		## Check that you use ajaxcall/bgaPerformAction only on player actions and never initiated programmatically. Otherwise, your code will very likely create race conditions resulting in deadlocks or other errors. This can also break replays and tutorials. ''Exception: sometimes you can do no-op moves with timeouts (i.e. user has only one choice, but its unwise to reveal this information by skipping user turn), timeout has to be canceling itself if state transition happen automatically (i.e. during replay)''
	# ''' User Interface '''		# ''' User Interface '''
	## Review BGA UI design Guidelines [[BGA_Studio_Guidelines]]		## Review BGA UI design Guidelines [[BGA_Studio_Guidelines]]
	## Check all your English messages for proper use of punctuation, capitalization, usage of present tense in notification (not past) and gender neutrality. See [[Translations]] for English rules.		## Check all your English messages for proper use of punctuation, capitalization, usage of present tense in notification (not past) and gender neutrality. See [[Translations]] for English rules.
	## If the elements in your game zone don't occupy all the available horizontal space, '''they should be centered'''.		## If the elements in your game zone don't occupy all the available horizontal space, '''they should be centered'''.
	## If your game elements become blurry or ~~pixellated~~ when using the browser zoom, you may want to consider [[Game_art:_img_directory#Use_background-size \| higher resolution images with background-size]]		## If your game elements become blurry or pixelated when using the browser zoom, you may want to consider [[Game_art:_img_directory#Use_background-size \| higher resolution images with background-size]]
	## Non-self explanatory graphic elements should have ~~tooltips~~		## Non-self explanatory graphic elements should have tool tips
	## Strings in your source code are ready for translation. See [[Translations]]. You can generate dummy translations for checking that everything is ready for translation from your "Manage game" page.		## Strings in your source code are ready for translation. See [[Translations]]. You can generate dummy translations for checking that everything is ready for translation from your "Manage game" page.
	## A prefix for example a trigram for your game that you prepend to all the css classes to avoid namespace conflicts, i.e. vla_selected vs selected		## A prefix for example a trigram for your game that you prepend to all the css classes to avoid namespace conflicts, i.e. vla_selected vs selected

← Older revision		Revision as of 19:19, 15 March 2026
Line 54:		Line 54:
	## There is also "Check project" button (it will open like a game table, and you can type your project and click on Start button to run analysis) - but it may be obsolete		## There is also "Check project" button (it will open like a game table, and you can type your project and click on Start button to run analysis) - but it may be obsolete

	~~# '''~~ Finally move to Alpha status ~~'''~~		=== Finally move to Alpha status ===
	## We want the correct formal name of the game to be used for the project (i.e. '''agricola''', not '''myagricolaproject'''). If you DO NOT have the correct formal name of the game for your project, then		# We want the correct formal name of the game to be used for the project (i.e. '''agricola''', not '''myagricolaproject'''). If you DO NOT have the correct formal name of the game for your project, then
	### If possible (meaning if there is not already a project with that name) copy your project to a new project '''matching exactly the name of the game''' (no prefix or suffix). If not possible move on to the next steps, admin will have to retrieve the other project and overwrite it. In this case, after you request the alpha deployment, please reply to the automatic reply with the correct name.		## If possible (meaning if there is not already a project with that name) copy your project to a new project '''matching exactly the name of the game''' (no prefix or suffix). If not possible move on to the next steps, admin will have to retrieve the other project and overwrite it. In this case, after you request the alpha deployment, please reply to the automatic reply with the correct name.
	## If you DO have the correct formal name of the game for your project, or completed the above steps, create a build for your game from the "manage game" page (using the '''Build a new release version''' section) and check the log to make sure that everything builds fine (after a successful build, you should see a new version in "Versions available for production").		## If you DO have the correct formal name of the game for your project, or completed the above steps, create a build for your game from the "manage game" page (using the '''Build a new release version''' section) and check the log to make sure that everything builds fine (after a successful build, you should see a new version in "Versions available for production").
	## Are you really ready? Click on the '''Request ALPHA status''' button available above your just built version. You cannot deploy yourself from the "manage game" page until this first ALPHA deploy has been done by the admins. Clicking this button will file a request in the BGA ticketing system and you'll receive a confirmation email allowing to reply to add some information on the ticket if needed. Note: you can also ask for moving your project to "private Alpha" - in this case you will invite people manually rather than having your game immediately visible to the whole BGA reviewers community. When you press you button you should receive acknowledgement email, reply to this email with more details.		# Are you really ready?
	* ''' Add Information '''		## Click on the '''Request ALPHA status''' button available above your just built version. You cannot deploy yourself from the "manage game" page until this first ALPHA deploy has been done by the admins. Clicking this button will file a request in the BGA ticketing system and you'll receive a confirmation email allowing to reply to add some information on the ticket if needed. Note: you can also ask for moving your project to "private Alpha" - in this case you will invite people manually rather than having your game immediately visible to the whole BGA reviewers community. When you press you button you should receive acknowledgement email, reply to this email with more details.
	Reply to alpha request e-mail with following information		# Reply to alpha request e-mail with following information
	** Is this final project name or need renaming		## Is this final project name or need renaming
	** What is your production BGA user name		## What is your production BGA user name
	** If private alpha requested - BGA user names of other admins - usually publisher/designer		## If private alpha requested - BGA user names of other admins - usually publisher/designer
	** If you have license or/and alpha approval, include approval email (form publisher)		## If you have license or/and alpha approval, include approval email (form publisher)
	** If you have exceptions for items from this checklist (i.e. size of assets, custom fonts, etc) add explanations		## If you have exceptions for items from this checklist (i.e. size of assets, custom fonts, etc) add explanations
	* ''' Wait ~~'''~~		# Wait
	** When admins publish (push to alpha) they will send an email to the developer with all relevant information about the next steps.		## When admins publish (push to alpha) they will send an email to the developer with all relevant information about the next steps. If you waiting for 2 weeks+ you can ping them again.

	=== Move from Alpha to Beta ===		=== Move from Alpha to Beta ===