Create a game in BGA Studio: Complete Walkthrough - Revision history

Thoun at 11:59, 16 September 2026

2026-09-16T11:59:28Z

← Older revision		Revision as of 13:59, 16 September 2026
Line 544:		Line 544:
	$result['token_types'] = $this->token_types;		$result['token_types'] = $this->token_types;
	// 3. Game options		// 3. Game options
	$table_options = $this->~~getTableOptions~~();		$table_options = $this->getGameOptions();
	$result ['table_options'] = [];		$result ['table_options'] = [];
	foreach ( $table_options as $option_id => $option ) {		foreach ( $table_options as $option_id => $option ) {

Thoun at 12:11, 27 August 2026

2026-08-27T12:11:32Z

← Older revision		Revision as of 14:11, 27 August 2026
Line 781:		Line 781:
	*UI elements which are images (i.e. tokens, cards) should have tooltips.		*UI elements which are images (i.e. tokens, cards) should have tooltips.

	==~~Alpha~~==		==Private alpha==
	When you ~~think you~~ game ~~is completely working there is still bunch of stuff you have~~ to ~~do/check before telling admin that game is ready~~, ~~please go though this [[Pre-release checklist]].~~		When you want to show case some part of your game to the publisher or friends, you can request a private alpha : create a build and click on the "Request PRIVATE ALPHA status" button and admins will check your game starts, has something to show, and push it to private alpha.

	If you ~~think its completely ready,~~ create a build and click on the "Request ALPHA status" button and admins will check your game and push it to alpha.

	~~Finally~~, visit the game page for your alpha game (https://boardgamearena.com/gamepanel?game=…) to add the following information if you can:		When it's published as private alpha, visit the game page for your alpha game (https://boardgamearena.com/gamepanel?game=…) to add the following information if you can:
	*Links to the rules (in multiple languages if available).		*Links to the rules (in multiple languages if available).
	* Links to teaching videos.		* Links to teaching videos.
Line 795:		Line 793:

	Note: later can be done by community members, you don't actually have to do it yourself		Note: later can be done by community members, you don't actually have to do it yourself

			==Alpha==
			When you think you game is completely working there is still bunch of stuff you have to do/check before telling admin that game is ready, please go though this [[Pre-release checklist]].

			If you think its completely ready, create a build and click on the "Request PUBLIC ALPHA status" button and admins will check your game and push it to alpha.

			==Beta==
			When your game has enough reviewers approvals, and the publisher has approved it too, you can "Request BETA status".

	==Level Up==		==Level Up==

Victoria La: /* Create a project */

2026-07-14T01:42:10Z

Create a project

← Older revision		Revision as of 03:42, 14 July 2026
Line 33:		Line 33:
	== Create a project ==		== Create a project ==

	If you have not already, you have to create a project in BGA Studio for this game. If the original game name is taken, check the previous paragraph about existing projects.		If you have not already, you have to create a project in BGA Studio for this game. If the original game name is taken, check the previous paragraph about existing projects. To see how to create a new game here [https://en.doc.boardgamearena.com/First_steps_with_BGA_Studio Create a new game]

	Find and start the game in turn based mode, make sure it works.		Find and start the game in turn based mode, make sure it works.

Rushilu: typo

2026-05-03T19:12:56Z

typo

← Older revision		Revision as of 21:12, 3 May 2026
Line 38:		Line 38:

	Second, modify the text in your client source (.ts or .js file) to output hello world or something, build, reload the page in the browser and make sure your ftp sync works as expected.		Second, modify the text in your client source (.ts or .js file) to output hello world or something, build, reload the page in the browser and make sure your ftp sync works as expected.
	Note: if you have not setup [http://en.doc.boardgamearena.com/Tools_and_tips_of_BGA_Studio#File_Sync FTP auto-sync] yet, do it now, manually copying files is a no-starter.		Note: if you have not setup [http://en.doc.boardgamearena.com/Tools_and_tips_of_BGA_Studio#File_Sync FTP auto-sync] yet, do it now, manually copying files is a non-starter.

	Update your project status on [http://studio.boardgamearena.com/#!studio Control Panel > Manage games] page, you can say "development started" or "waiting for the license" or "waiting for graphics" or a combination of those.		Update your project status on [http://studio.boardgamearena.com/#!studio Control Panel > Manage games] page, you can say "development started" or "waiting for the license" or "waiting for graphics" or a combination of those.

Thoun at 10:12, 20 April 2026

2026-04-20T10:12:50Z

← Older revision		Revision as of 12:12, 20 April 2026
Line 96:		Line 96:
	Even if is not playable yet, start with making sure the game looks descent in the game selector, meaning it has nice box graphics and the information is correct.		Even if is not playable yet, start with making sure the game looks descent in the game selector, meaning it has nice box graphics and the information is correct.

	For that we need to edit [[Game_meta-information: gameinfos.~~inc.php~~\|gameinfos.~~inc.php~~]].		For that we need to edit [[Game_meta-information: gameinfos.jsonc\|gameinfos.jsonc]].
	What you would do for the real game you would go to http://boardgamegeek.com find the game and use information from the website to fill the gameinfos.		What you would do for the real game you would go to http://boardgamegeek.com find the game and use information from the website to fill the gameinfos.

Thoun at 09:29, 12 March 2026

2026-03-12T09:29:37Z

← Older revision		Revision as of 11:29, 12 March 2026
Line 453:		Line 453:
	} catch ( Exception $e ) {		} catch ( Exception $e ) {
	// logging does not actually work in game init :(		// logging does not actually work in game init :(
	~~// but if you calling from php chat it will work~~
	$this->error("Fatal error while creating game");		$this->error("Fatal error while creating game");
	$this->dump('err', $e);		$this->dump('err', $e);

Victoria La: updated to new framework

2026-02-23T13:27:27Z

updated to new framework

Show changes

Thoun at 11:54, 22 October 2025

2025-10-22T11:54:22Z

← Older revision		Revision as of 13:54, 22 October 2025
Line 476:		Line 476:
	foreach ($player_stats as $key => $value) {		foreach ($player_stats as $key => $value) {
	if (str_starts_with($key, 'game_')) {		if (str_starts_with($key, 'game_')) {
	$this->~~initStat~~(~~'player',~~ $key, 0);		$this->playerStats->init($key, 0);
	}		}
	if ($key === 'turns_number') {		if ($key === 'turns_number') {
	$this->~~initStat~~(~~'player',~~ $key, 0);		$this->playerStats->init($key, 0);
	}		}
	}		}
Line 485:		Line 485:
	foreach ($table_stats as $key => $value) {		foreach ($table_stats as $key => $value) {
	if (str_starts_with($key, 'game_')) {		if (str_starts_with($key, 'game_')) {
	$this->~~initStat~~(~~'table',~~ $key, 0);		$this->tableStats->init($key, 0);
	}		}
	if ($key === 'turns_number') {		if ($key === 'turns_number') {
	$this->~~initStat~~(~~'table',~~ $key, 0);		$this->tableStats->init($key, 0);
	}		}
	}		}

Thoun at 11:53, 22 October 2025

2025-10-22T11:53:19Z

← Older revision		Revision as of 13:53, 22 October 2025
Line 453:		Line 453:
	// beggining of the turn for active player (if player state if first state)		// beggining of the turn for active player (if player state if first state)
	$player_id = $this->getActivePlayerId();		$player_id = $this->getActivePlayerId();
	$this->~~incStat~~(1, 'turns_number', $player_id);		$this->playerStats->inc('turns_number', 1, $player_id, true);
	~~$this->incStat(1~~, ~~'turns_number'~~);
	} catch ( Exception $e ) {		} catch ( Exception $e ) {
	// logging does not actually work in game init :(		// logging does not actually work in game init :(

Thoun: /* Create State Machine */

2025-09-19T14:40:14Z

Create State Machine

← Older revision		Revision as of 16:40, 19 September 2025
Line 566:		Line 566:
	== Create State Machine ==		== Create State Machine ==

	Now you need to create a game state machine.		Now you need to create a game state machine. Create one file for each game state, following [[State classes: State directory]] documentation.

	~~The state handling is spread across 4 files, so you have to make sure all the pieces are connected together. The~~ state ~~machine <code>states.inc.php</code> defines all the states~~, ~~and function handlers on php side in a form of string, and if any of these functions are not implemented it would be very hard to debug because it will break in random places.~~

	~~Please first watch this again [http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine BGA game state machine] and then please read~~ [[~~Your game state machine~~: ~~states.inc.php~~]].

	Now the state machine should be relatively simple. If you find yourself with machine with more than 20 states its probably not the way to go. Not all the player interactions need separate states, a lot of things can be implemented directly on client, i.e. if your player need to select a reward token, which offers choice of resource, instead of two states on server just have one state on server and possible few states on client (client side states) to collect this info.		Now the state machine should be relatively simple. If you find yourself with machine with more than 20 states its probably not the way to go. Not all the player interactions need separate states, a lot of things can be implemented directly on client, i.e. if your player need to select a reward token, which offers choice of resource, instead of two states on server just have one state on server and possible few states on client (client side states) to collect this info.
Line 603:		Line 599:

	</pre>		</pre>
	== Handle Turn Order ==

			==Handle Turn Order==

	If your game goes in clockwise order in natural sitting position nothing is really needed, you just use standard API and you are good. However if position is complicated it may require some trickery.		If your game goes in clockwise order in natural sitting position nothing is really needed, you just use standard API and you are good. However if position is complicated it may require some trickery.

	Usually turn order is done by "game state" (see state machine above). Basically it would be two choices:		Usually turn order is done by "game state" (see state machine above). Basically it would be two choices:
	* Turn order depends on game situation (such as we take player with highest number of red cubes).		*Turn order depends on game situation (such as we take player with highest number of red cubes).
	* Turn order is custom and assign on previous step - i.e. we not playing in clockwise order anymore. In this case you either need to extend player table with new order info (CANNOT use <code>player_no</code> column) or use order markers that come with game (i.e. <code>marker_ff0000</code> on <code>position_1</code>). In this we can build player array in right order and pick next player based on previous player using existing helper function such as <code>$this->createNextPlayerTable($player_ids)</code>.		*Turn order is custom and assign on previous step - i.e. we not playing in clockwise order anymore. In this case you either need to extend player table with new order info (CANNOT use <code>player_no</code> column) or use order markers that come with game (i.e. <code>marker_ff0000</code> on <code>position_1</code>). In this we can build player array in right order and pick next player based on previous player using existing helper function such as <code>$this->createNextPlayerTable($player_ids)</code>.

	Handling turn order would go to the game state which is usually follows active player state.		Handling turn order would go to the game state which is usually follows active player state.

	== Hook User Input ==		==Hook User Input==

	This step can be done before or after some of the server steps, or you go in iterations switching back and forward until you get it done, up to you.		This step can be done before or after some of the server steps, or you go in iterations switching back and forward until you get it done, up to you.
Line 687:		Line 685:

	In BGA there is only two ways interact with the server (officially)		In BGA there is only two ways interact with the server (officially)
	* Initial data dump - when JS client starts it gets all current data via setup() method		*Initial data dump - when JS client starts it gets all current data via setup() method
	* Game actions - <code>bgaPerformAction</code>/ajaxcall from client, it returns error or ok (not data), then server send butch of notifications to client		*Game actions - <code>bgaPerformAction</code>/ajaxcall from client, it returns error or ok (not data), then server send butch of notifications to client

	Note current ajaxcall is super vebosy, <code>bgaPerformAction</code> should be used instead.		Note current ajaxcall is super vebosy, <code>bgaPerformAction</code> should be used instead.

	When you insert a single action you have to update multiples files:		When you insert a single action you have to update multiples files:
	* in ggg.js add bgaPerformAction, i.e. something like		*in ggg.js add bgaPerformAction, i.e. something like
	this.addActionButton('pass', _('Pass'), () => this.bgaPerformAction('actPass'));		this.addActionButton('pass', _('Pass'), () => this.bgaPerformAction('actPass'));
	* in states.php - add action 'actPass' to list of possible actions		* in states.php - add action 'actPass' to list of possible actions
	'possibleactions' => ['actPass','actPlayCard']		'possibleactions' => ['actPass','actPlayCard']
	* in <code>game.php</code> - add action handler, there you must do the following:		*in <code>game.php</code> - add action handler, there you must do the following:
	** possible do game specific check to validate what player doing is legal (even its not possible from your js side - player can cheat - not allow that).		**possible do game specific check to validate what player doing is legal (even its not possible from your js side - player can cheat - not allow that).
	** do some database manipulations, using access API.		**do some database manipulations, using access API.
	** send notifications - this is the "reply" for action.		**send notifications - this is the "reply" for action.
	** transition to new state (it very rare that user will remain in the same state, except for multi-active states).		**transition to new state (it very rare that user will remain in the same state, except for multi-active states).
	* back to ggg.js add notification subscription and notification handler (two separate things).		*back to ggg.js add notification subscription and notification handler (two separate things).

	== Implement Notification handling and Animation ==		==Implement Notification handling and Animation==

	To handle notification you have to subscribe to it and implement the handlers, see [[Game_interface_logic:_yourgamename.js#Notifications\|JS Notifications]].		To handle notification you have to subscribe to it and implement the handlers, see [[Game_interface_logic:_yourgamename.js#Notifications\|JS Notifications]].
Line 713:		Line 711:

	See [[Game_interface_logic:_yourgamename.js#Access_and_manipulate_the_DOM\|Animation and DOM Manipulation]] for JS reference.		See [[Game_interface_logic:_yourgamename.js#Access_and_manipulate_the_DOM\|Animation and DOM Manipulation]] for JS reference.
	== Wrap Up ==		==Wrap Up==

	* Implement game progression (<code>getGameProgression()</code> in php).		*Implement game progression (<code>getGameProgression()</code> in php).
	* Implement the [[Zombie Mode\|Zombie mode]]. (<code>zombieTurn()</code> in php).		*Implement the [[Zombie Mode\|Zombie mode]]. (<code>zombieTurn()</code> in php).
	* Define and implemented some meaningful statistics for your game (i.e. total points, point from source A, B, C...).		*Define and implemented some meaningful statistics for your game (i.e. total points, point from source A, B, C...).
	* The games logs should explain what happened if player was not looking.		*The games logs should explain what happened if player was not looking.
	* You need to implemented tiebreaking (using aux score field) and updated tiebreaker description in meta-data.		*You need to implemented tiebreaking (using aux score field) and updated tiebreaker description in meta-data.
	* Make sure all UI strings are marked for translation.		*Make sure all UI strings are marked for translation.
	* UI elements which are images (i.e. tokens, cards) should have tooltips.		*UI elements which are images (i.e. tokens, cards) should have tooltips.

	== Alpha ==		==Alpha==
	When you think you game is completely working there is still bunch of stuff you have to do/check before telling admin that game is ready, please go though this [[Pre-release checklist]].		When you think you game is completely working there is still bunch of stuff you have to do/check before telling admin that game is ready, please go though this [[Pre-release checklist]].

Line 729:		Line 727:

	Finally, visit the game page for your alpha game (https://boardgamearena.com/gamepanel?game=…) to add the following information if you can:		Finally, visit the game page for your alpha game (https://boardgamearena.com/gamepanel?game=…) to add the following information if you can:
	* Links to the rules (in multiple languages if available).		*Links to the rules (in multiple languages if available).
	* Links to teaching videos.		* Links to teaching videos.
	* In the "On the web" section, links to:		*In the "On the web" section, links to:
	** The official website for the game (if there is one).		**The official website for the game (if there is one).
	** The BoardGameGeek page for the game.		** The BoardGameGeek page for the game.
	* Consider writing a summary of the rules.		* Consider writing a summary of the rules.
Line 738:		Line 736:
	Note: later can be done by community members, you don't actually have to do it yourself		Note: later can be done by community members, you don't actually have to do it yourself

	== Level Up ==		==Level Up==

	When you successfully created a basic game and you want more, it's time to make it fancy!		When you successfully created a basic game and you want more, it's time to make it fancy!

	* Add game extentions and variants using gameoptions file.		*Add game extentions and variants using gameoptions file.
	* Add user preferences for customizations.		*Add user preferences for customizations.
	* Use theming! That involves replacing hardwood background, changing tooltips, using different sounds, different fonts, changing state prompt and logs.		*Use theming! That involves replacing hardwood background, changing tooltips, using different sounds, different fonts, changing state prompt and logs.
	* You can use fancy scoring board at the end of game instead of default nothing.		*You can use fancy scoring board at the end of game instead of default nothing.
	* And finally super cool dice rolling, card flipping and victory points evaporating effects.		*And finally super cool dice rolling, card flipping and victory points evaporating effects.

	== After the alpha stage ==		==After the alpha stage ==
	If you want to update your game after alpha, please look at the [[Post-release phase]]		If you want to update your game after alpha, please look at the [[Post-release phase]]

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