BGA Studio Migration Guide - Revision history

Thoun at 13:50, 6 November 2026

2026-11-06T13:50:11Z

← Older revision		Revision as of 13:50, 6 November 2026
Line 1:		Line 1:
			{{InfoBox\|title=Documentation moved\|body='''See new documentation here, AI oriented: https://doc.studio.boardgamearena.com/framework-documentation/ai-tooling/#modernize-bga-game-project '''}}

	This page is only for people who started long time ago and now need to re-write older projects into more modern versions.		This page is only for people who started long time ago and now need to re-write older projects into more modern versions.
	Also if you trying to fix older game you may have to look here.		Also if you trying to fix older game you may have to look here.

Thoun at 16:13, 5 November 2026

2026-11-05T16:13:40Z

← Older revision		Revision as of 16:13, 5 November 2026
Line 602:		Line 602:
	/* Note: you must not use any @import directive other than this one */		/* Note: you must not use any @import directive other than this one */

	===~~Future support~~ of dark mode===		===Support of dark mode===
	BGA ~~doesn't~~ support dark mode ~~yet~~. To have ~~some~~ games compatible ~~when we do~~, we added a theme data tag you can use as described here:		BGA support dark mode. To have games compatible, we added a theme data tag you can use as described here:

	https://en.doc.boardgamearena.com/Game_interface_stylesheet:_yourgamename.css#Support_of_the_Dark_mode		https://en.doc.boardgamearena.com/Game_interface_stylesheet:_yourgamename.css#Support_of_the_Dark_mode
	[[Category:Studio]]		[[Category:Studio]]

Thoun at 14:51, 5 November 2026

2026-11-05T14:51:13Z

← Older revision		Revision as of 14:51, 5 November 2026
Line 173:		Line 173:
	New notify function that handles decorators, reducing the duplicate code on notification args.		New notify function that handles decorators, reducing the duplicate code on notification args.

	https://en.~~doc~~.boardgamearena.com/~~Main_game_logic:_Game.php~~#~~Notification_decorators~~		https://doc.studio.boardgamearena.com/framework-documentation/back-end/main-game-logic/notify/#notification-decorator

	====Notification args consistency====		====Notification args consistency====

Thoun at 14:44, 5 November 2026

2026-11-05T14:44:11Z

← Older revision		Revision as of 14:44, 5 November 2026
Line 110:		Line 110:
	Game class from '''''<gamename>.game.php''''' are now namespaced (and moved to modules/php/Game.php) and can autoload other classes of the same namespace		Game class from '''''<gamename>.game.php''''' are now namespaced (and moved to modules/php/Game.php) and can autoload other classes of the same namespace

	[[Main game logic: ~~Game.php#~~Creating other classes]]		[https://doc.studio.boardgamearena.com/framework-documentation/back-end/main-game-logic/#creating-other-classes Main game logic: Creating other classes]

	📌 The class file should be moved to modules/php/Game.php and adopted		📌 The class file should be moved to modules/php/Game.php and adopted
Line 156:		Line 156:
	Simplify the action calls by removing '''<gamename>.action.php''' file		Simplify the action calls by removing '''<gamename>.action.php''' file

	https://en.~~doc~~.boardgamearena.com/~~Main_game_logic:_Game.php#Actions_%28autowired%29~~		https://doc.studio.boardgamearena.com/framework-documentation/back-end/main-game-logic/actions/

	📌 Autowired actions needs to start with "act", so it's risky to change them (if you change all actions names in the states.php, game, action and JS file, Real-time players will call the old name until they refresh. So, it needs to be done in two steps with duplicates on back side, or to be deployed when there is no Realt-time table running.		📌 Autowired actions needs to start with "act", so it's risky to change them (if you change all actions names in the states.php, game, action and JS file, Real-time players will call the old name until they refresh. So, it needs to be done in two steps with duplicates on back side, or to be deployed when there is no Realt-time table running.
Line 162:		Line 162:
	When migration is done, the action.php file can be deleted.		When migration is done, the action.php file can be deleted.

	Deprecation warning: Actions detected on .action.php file. You can now use [~~[Main~~ game logic~~: Game.php#Actions (autowired)\|~~Auto-wired actions]] to avoid pass-through functions in .action.php file. If you transform your project to use only auto-wired actions, you can then delete the .action.php file.		Deprecation warning: Actions detected on .action.php file. You can now use [https://doc.studio.boardgamearena.com/framework-documentation/back-end/main-game-logic/actions/ Auto-wired actions] to avoid pass-through functions in .action.php file. If you transform your project to use only auto-wired actions, you can then delete the .action.php file.

	=== Notifications===		=== Notifications===
Line 274:		Line 274:

	The stats function such as initStat, setStat and getStat are also deprecated in favor of access via the objects <code>$this->tableStats and $this->playerStats</code>		The stats function such as initStat, setStat and getStat are also deprecated in favor of access via the objects <code>$this->tableStats and $this->playerStats</code>
	See https://en.~~doc~~.boardgamearena.com/~~index~~.~~php?title=Main_game_logic:_Game~~.~~php#Game_statistics~~		See https://doc.studio.boardgamearena.com/framework-documentation/back-end/main-game-logic/table-stats/ and https://doc.studio.boardgamearena.com/framework-documentation/back-end/main-game-logic/player-stats/

	===Legacy===		===Legacy===
	New object to access the legacy functions, removing the need to manually decode the JSON result when getting the values.		New object to access the legacy functions, removing the need to manually decode the JSON result when getting the values.

	[~~[Main game logic: Game.php#Legacy games API\|~~https://en.~~doc~~.boardgamearena.com/~~Main_game_logic~~:~~_Game.php#Legacy_games_API]~~]		[https://doc.studio.boardgamearena.com/framework-documentation/back-end/main-game-logic/legacy/ Main game logic: Legacy]

	📌 Use $this->legacy->actionname instead of $this->actionnameLegacy and remove JSON decoding on getters		📌 Use $this->legacy->actionname instead of $this->actionnameLegacy and remove JSON decoding on getters
Line 286:		Line 286:
	New database table and API to handle any type variables instead of numerical values only		New database table and API to handle any type variables instead of numerical values only

	https://en.~~doc~~.boardgamearena.com/~~Main_game_logic:_Game.php#Use_globals~~		https://doc.studio.boardgamearena.com/framework-documentation/back-end/main-game-logic/globals/

	📌 If you had custom tables just for that you can drop them and use standard table		📌 If you had custom tables just for that you can drop them and use standard table

Thoun at 14:39, 5 November 2026

2026-11-05T14:39:46Z

← Older revision		Revision as of 14:39, 5 November 2026
Line 89:		Line 89:
	$this->tableOptions->get(int $optionId)		$this->tableOptions->get(int $optionId)

	This new object can also return the Real-time/Turn-based setting: https://en.~~doc~~.boardgamearena.com/~~Main_game_logic:_Game.php#Reflexion_time~~		This new object can also return the Real-time/Turn-based setting: https://doc.studio.boardgamearena.com/framework-documentation/back-end/main-game-logic/table-options/

	==Server parts (php, sql, etc)==		==Server parts (php, sql, etc)==

Victoria La: update gamestate migration

2026-11-03T17:56:08Z

update gamestate migration

← Older revision		Revision as of 17:56, 3 November 2026
Line 197:		Line 197:

	📌		📌
	* Replace <code>$this->gamestate->state()</code> with <code>$this->getCurrentMainState()</code> or <code>$this->getCurrentState(int $playerId)</code>		* Replace <code>$this->gamestate->state()</code> with <code>$this->gamestate->getCurrentMainState()</code> or <code>$this->gamestate->getCurrentState(int $playerId)</code>
	* Replace <code>$this->~~getState~~()</code> with <code>$this->getCurrentMainStateId()</code> or <code>$this->getCurrentStateId(int $playerId)</code>		** They return a <code>GameState</code> object, not an array: <code>type</code> is a <code>StateType</code> enum, so a string compare like <code>$state["type"] == "multipleactiveplayer"</code> becomes <code>$this->gamestate->isMultiactiveState()</code> or <code>$state->type === StateType::MULTIPLE_ACTIVE_PLAYER</code>. <code>->toArray()</code> gives the old array shape with string <code>type</code> (what <code>zombieTurn</code> expects).
	* Replace <code>$this->getPrivateState($playerId)</code> with <code>$this->getCurrentState($playerId)</code>		** Unlike <code>state()</code>, they do not re-run the state's args method.
	* Replace <code>$this->gamestate->states</code> access with <code>$this->getCurrentMainState()</code> or <code>$this->getCurrentState(int $playerId)</code>		* Replace <code>$this->gamestate->state_id()</code> with <code>$this->gamestate->getCurrentMainStateId()</code> or <code>$this->gamestate->getCurrentStateId(int $playerId)</code>
	* Replace <code>$this->isMutiactiveState()</code> (misspelled) with <code>$this->isMultiactiveState()</code>		* Replace <code>$this->gamestate->getPrivateState($playerId)</code> with <code>$this->gamestate->getCurrentState($playerId)</code>
			* Replace <code>$this->gamestate->states</code> access with <code>$this->gamestate->getCurrentMainState()</code> or <code>$this->gamestate->getCurrentState(int $playerId)</code>
			* Replace <code>$this->gamestate->isMutiactiveState()</code> (misspelled) with <code>$this->gamestate->isMultiactiveState()</code>

	===Player Information Functions===		===Player Information Functions===

BoontjieBoon: dojo.position

2026-07-30T13:44:17Z

dojo.position

← Older revision		Revision as of 13:44, 30 July 2026
Line 564:		Line 564:

	For translations use `this.bga.gameui.format_string` or `this.bga.gameui.format_string_recursive`		For translations use `this.bga.gameui.format_string` or `this.bga.gameui.format_string_recursive`
			\|-
			\|dojo.position(node)
			\|DOM
			\|Returns the DOM node's position and size
			\|node.getBoundingClientRect()
			Bounding rect's left, top, width, height correspond to dojo.pos' x, y, w, h respectively
	\|}		\|}

BoontjieBoon: dojo.style getter replacement

2026-07-30T12:00:02Z

dojo.style getter replacement

← Older revision		Revision as of 12:00, 30 July 2026
Line 507:		Line 507:
	\| Sets an inline CSS property on a DOM node. <b>CAUTION:</b> <code>dojo.style(node, "left")</code> (and "right", "width", etc) return lengths in pixels as numbers, not the set CSS style.		\| Sets an inline CSS property on a DOM node. <b>CAUTION:</b> <code>dojo.style(node, "left")</code> (and "right", "width", etc) return lengths in pixels as numbers, not the set CSS style.
	\| <code>node.style.color = "red"</code>		\| <code>node.style.color = "red"</code>
			\|-
			\|dojo.style(node, "color")
			\|Styling
			\|Gets the computed CSS value on a DOM node.
			\|getComputedStyle(node).color
	\|-		\|-
	\| <code>dojo.hasClass(node, "className")</code>		\| <code>dojo.hasClass(node, "className")</code>

Victoria La: /* Dojo usage */

2026-07-22T12:58:57Z

Dojo usage

← Older revision		Revision as of 12:58, 22 July 2026
Line 459:		Line 459:

	===Dojo usage===		===Dojo usage===
	Dojo usage has been ~~reduced to minimum~~ in the new project template and the doc~~, as native JS~~ is ~~now able to do almost the same things, with better performance and more knowledge for newcomers of the native (vanilla) JS~~.		Dojo usage has been removed in the new project template and the doc. Old game can still use it but its best to migrate. This is migration table.

	📌 Replace dojo by vanilla JS where possible		📌 Replace dojo by vanilla JS where possible

BoontjieBoon: Mentioned using this.bga.gameui.format_string instead of dojo.string.substitute

2026-07-22T11:08:09Z

Mentioned using this.bga.gameui.format_string instead of dojo.string.substitute

← Older revision		Revision as of 11:08, 22 July 2026
Line 558:		Line 558:
	\|<code>Use JS template strings, i.e. `<div id=${id}></div>`. Note: not suitable for translations if variables are used inside</code>		\|<code>Use JS template strings, i.e. `<div id=${id}></div>`. Note: not suitable for translations if variables are used inside</code>

			For translations use `this.bga.gameui.format_string` or `this.bga.gameui.format_string_recursive`
	\|}		\|}