Studio file reference - Revision history

Thoun at 14:52, 4 November 2026

2026-11-04T14:52:00Z

← Older revision		Revision as of 14:52, 4 November 2026
Line 19:		Line 19:
	In this file you describe the meta-information for your game: game name, publisher name, number of player, etc...		In this file you describe the meta-information for your game: game name, publisher name, number of player, etc...

	See [[Game_meta-information~~:_gameinfos.jsonc]~~].		See [https://doc.studio.boardgamearena.com/framework-documentation/back-end/game-meta-information/ Game_meta-information (gameinfos)].

	=== dbmodel.sql ===		=== dbmodel.sql ===

Thoun at 14:13, 4 November 2026

2026-11-04T14:13:40Z

← Older revision		Revision as of 14:13, 4 November 2026
Line 27:		Line 27:
	When this file changes it requires restart of the game. If game was already in production it requires migration.		When this file changes it requires restart of the game. If game was already in production it requires migration.

	See [[Game database model~~: dbmodel.sql]~~]		See [https://doc.studio.boardgamearena.com/framework-documentation/back-end/game-database-model/ Game database model]

	=== gameoptions.json, gamepreferences.json ===		=== gameoptions.json, gamepreferences.json ===

Thoun at 13:27, 4 November 2026

2026-11-04T13:27:22Z

← Older revision		Revision as of 13:27, 4 November 2026
Line 43:		Line 43:
	When this file changes it requires forced reloading (Ctrl+F5) to clear the cache.		When this file changes it requires forced reloading (Ctrl+F5) to clear the cache.

	See [~~[Game~~ interface stylesheet~~: yourgamename.css]~~].		See [https://doc.studio.boardgamearena.com/framework-documentation/front-end/game-interface-stylesheet/ Stylesheet (CSS)].

	=== modules/php/Game.php ===		=== modules/php/Game.php ===

Thoun at 09:04, 4 November 2026

2026-11-04T09:04:09Z

← Older revision		Revision as of 09:04, 4 November 2026
Line 13:		Line 13:
	When game graphics changes it require full reload in browser (Ctrl+F5) to clear the cache. Changing marketing graphics and deleting files require extra actions from control panel.		When game graphics changes it require full reload in browser (Ctrl+F5) to clear the cache. Changing marketing graphics and deleting files require extra actions from control panel.

	See [[Game art: img directory]]		See [https://doc.studio.boardgamearena.com/framework-documentation/front-end/game-art/ Game art: img directory]

	=== gameinfos.jsonc ===		=== gameinfos.jsonc ===

Thoun at 10:05, 20 April 2026

2026-04-20T10:05:13Z

← Older revision		Revision as of 10:05, 20 April 2026
Line 15:		Line 15:
	See [[Game art: img directory]]		See [[Game art: img directory]]

	=== gameinfos.~~inc.php~~ ===		=== gameinfos.jsonc ===

	In this file you describe the meta-information for your game: game name, publisher name, number of player~~, game categories~~, etc...		In this file you describe the meta-information for your game: game name, publisher name, number of player, etc...

	~~When this file changes it requires special reloading using control panel.~~		See [[Game_meta-information:_gameinfos.jsonc]].

	See [[Game_meta-information:_gameinfos.~~inc.php~~]].

	=== dbmodel.sql ===		=== dbmodel.sql ===

Thoun at 09:21, 16 December 2025

2025-12-16T09:21:19Z

← Older revision		Revision as of 09:21, 16 December 2025
Line 55:		Line 55:
	See [[Main game logic: Game.php]].		See [[Main game logic: Game.php]].

	=== ~~<gamename>~~.js ===		=== modules/js/Game.js ===

	This is the main file for your game interface. Here you will define:		This is the main file for your game interface. Here you will define:

Thoun at 07:52, 19 September 2025

2025-09-19T07:52:43Z

← Older revision		Revision as of 07:52, 19 September 2025
Line 31:		Line 31:
	See [[Game database model: dbmodel.sql]]		See [[Game database model: dbmodel.sql]]

	=== gameoptions.json, gamepreferences.json ~~(was: gameoptions.inc.php)~~ ===		=== gameoptions.json, gamepreferences.json ===

	File for describing your game options (or game variants).		File for describing your game options (or game variants).
Line 38:		Line 38:

	See [[Options_and_preferences: gameoptions.json, gamepreferences.json]].		See [[Options_and_preferences: gameoptions.json, gamepreferences.json]].

	~~=== <gamename>.action.php ===~~
	~~'''IMPORTANT NOTE:''' This file is deprecated, you shouldn't need to use it if you use autowired actions. See the dedicated page about it for more information.~~

	~~File used to describe methods that can be called from the client interface through javascript, get parameters and call the appropriate game functions.~~

	~~When this file changes reloading is not required.~~

	~~See [[Players actions: yourgamename.action.php]].~~

	=== <gamename>.css ===		=== <gamename>.css ===
Line 91:		Line 82:

	See [[Game material description: material.inc.php]].		See [[Game material description: material.inc.php]].
			=== modules/php/States ===

			The classes describing the states of your game.

			See [[State classes: State directory\|State classes: States directory]]

	=== states.inc.php ===		=== states.inc.php ===
			'''IMPORTANT NOTE:''' This file is deprecated, you shouldn't need to change it if you use State classes

	This file describes the game states machine of your game (all the game states properties, and the transitions to get from one state to another).		This file describes the game states machine of your game (all the game states properties, and the transitions to get from one state to another).
Line 100:		Line 97:
	See [[Your game state machine: states.inc.php]].		See [[Your game state machine: states.inc.php]].

	=== stats.json ~~(was: stats.inc.php)~~ ===		=== stats.json ===

	File used to list statistics that you want to update during the game to be presented to players at the end of the game.		File used to list statistics that you want to update during the game to be presented to players at the end of the game.

Thoun at 15:00, 30 January 2025

2025-01-30T15:00:12Z

← Older revision		Revision as of 15:00, 30 January 2025
Line 107:		Line 107:

	See [[Game statistics: stats.json]].		See [[Game statistics: stats.json]].

	~~=== version.php ===~~

	~~Don't edit this file. It is used internally by the build system.~~


	=== modules/ ===		=== modules/ ===

Thoun: /* .action.php */

2024-11-27T10:05:10Z

.action.php

← Older revision		Revision as of 10:05, 27 November 2024
Line 40:		Line 40:

	=== <gamename>.action.php ===		=== <gamename>.action.php ===
	'''IMPORTANT NOTE:''' This file is deprecated, you shouldn't need to use it if you use autowired actions.		'''IMPORTANT NOTE:''' This file is deprecated, you shouldn't need to use it if you use autowired actions. See the dedicated page about it for more information.

	File used to describe methods that can be called from the client interface through javascript, get parameters and call the appropriate game functions.		File used to describe methods that can be called from the client interface through javascript, get parameters and call the appropriate game functions.

Thoun at 10:04, 27 November 2024

2024-11-27T10:04:41Z

← Older revision		Revision as of 10:04, 27 November 2024
Line 40:		Line 40:

	=== <gamename>.action.php ===		=== <gamename>.action.php ===
			'''IMPORTANT NOTE:''' This file is deprecated, you shouldn't need to use it if you use autowired actions.

	File used to describe methods that can be called from the client interface through javascript, get parameters and call the appropriate game functions.		File used to describe methods that can be called from the client interface through javascript, get parameters and call the appropriate game functions.
Line 74:		Line 75:

	=== <gamename>.view.php, <gamename>_<gamename>.tpl ===		=== <gamename>.view.php, <gamename>_<gamename>.tpl ===
			'''IMPORTANT NOTE:''' These files are deprecated, you shouldn't need to use it if you generate the template from the JS file.

	Files are used to set up the page layout ('view') for the game.		Files are used to set up the page layout ('view') for the game.
Line 82:		Line 84:

	=== material.inc.php ===		=== material.inc.php ===
			'''IMPORTANT NOTE:''' This file is deprecated, see the dedicated page about it for more information.

	File used to describe all the game material (cards with their description, dices, tokens...). You can also use it to define game constants.		File used to describe all the game material (cards with their description, dices, tokens...). You can also use it to define game constants.