This is a documentation for Board Game Arena: play board games online !

Template:Studio Framework Navigation: Difference between revisions

From Board Game Arena
Jump to navigation Jump to search
No edit summary
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 7: Line 7:
<div style="font-weight:bold;font-size:1.2em;margin-top:0.3em;line-height:1.6;padding-top:0.5em;"><center>'''[[Studio file reference|Overview]]'''</center></div>
<div style="font-weight:bold;font-size:1.2em;margin-top:0.3em;line-height:1.6;padding-top:0.5em;"><center>'''[[Studio file reference|Overview]]'''</center></div>


* [[Game database model: dbmodel.sql|<b>dbmodel.sql</b>]] - database model
* [[Main game logic: Game.php|<b>Game.php</b>]] - main logic
* [https://doc.studio.boardgamearena.com/framework-documentation/back-end/game-state-classes/ <b>States/</b>] - State classes
* [https://doc.studio.boardgamearena.com/framework-documentation/back-end/game-database-model/ <b>Game database model</b>]
 
 
* [[Game interface logic: Game.js|<b>Game.js</b>]] - interface logic
* [https://doc.studio.boardgamearena.com/framework-documentation/front-end/game-interface-stylesheet/ <b>Stylesheet (CSS)</b>] - interface stylesheet
* [https://doc.studio.boardgamearena.com/framework-documentation/front-end/game-art/ <b>img</b>] - game art
* [https://doc.studio.boardgamearena.com/framework-documentation/front-end/game-sounds/ <b>sounds</b>] - game sounds
* [https://doc.studio.boardgamearena.com/framework-documentation/front-end/game-fonts/ <b>fonts</b>] - game fonts
* [https://doc.studio.boardgamearena.com/framework-documentation/front-end/game-fonts/ <b>fonts</b>] - game fonts
* [[Game meta-information: gameinfos.jsonc|<b>gameinfos.jsonc</b>]] - meta-information
 
* [[Options and preferences: gameoptions.json, gamepreferences.json|<b>gameoptions.jsonc</b>]] - game options & user preferences
 
* [https://doc.studio.boardgamearena.com/framework-documentation/front-end/game-art/ <b>img</b>] - game art
* [https://doc.studio.boardgamearena.com/framework-documentation/back-end/table-options/ <b>Table options</b> (gameoptions)]
* [[Game_metadata_manager|<b>Game Metadata Manager</b>]] - tags and metadata media
* [https://doc.studio.boardgamearena.com/framework-documentation/back-end/user-preferences/ <b>User preferences</b> (gamepreferences)]
* [[Game material description: material.inc.php|<b>material.inc.php</b>]] - static data
* [https://doc.studio.boardgamearena.com/framework-documentation/back-end/game-statistics/ <b>Game statistics</b> (stats)]
* [https://doc.studio.boardgamearena.com/framework-documentation/back-end/game-meta-information/ <b>Game meta-information</b> (gameinfos)]
* [https://doc.studio.boardgamearena.com/framework-documentation/game-metadata/ <b>Game Metadata Manager</b>] - tags and metadata media
* <b>modules/</b> - additional game code
* <b>misc/</b> - studio-only storage
* <b>misc/</b> - studio-only storage
* <b>modules/</b> - additional game code
* [https://doc.studio.boardgamearena.com/framework-documentation/front-end/game-sounds/ <b>sounds</b>] - game sounds
* [[State classes: State directory|<b>States/</b>]] - State classes
* [[Your game state machine: states.inc.php|<b>states.inc.php</b>]] - state machine
* [[Game statistics: stats.json|<b>stats.jsonc</b>]] - statistics
* [[Players actions: yourgamename.action.php|X.<b>action.php</b>]] - player actions
* [[Game interface stylesheet: yourgamename.css|X<b>.css</b>]] - interface stylesheet
* [[Main game logic: Game.php|<b>Game.php</b>]] - main logic
* [[Game interface logic: Game.js|<b>Game.js</b>]] - interface logic
* [[Game layout: view and template: yourgamename.view.php and yourgamename_yourgamename.tpl|X.<b>view.php</b>]] - dynamic game layout
* [[Game layout: view and template: yourgamename.view.php and yourgamename_yourgamename.tpl|X_X.<b>tpl</b>]] - static game layout
<br>
<br>
-----
-----
Line 32: Line 32:
'''Official'''
'''Official'''


* [[ItemManager]]: a PHP component to manage cards or other game items.
* [https://doc.studio.boardgamearena.com/framework-documentation/back-end/libs/ <b>Back-end libs</b>]
* [[PlayerCounter_and_TableCounter|PlayerCounter and TableCounter]]: PHP components to manage counters.
* [https://doc.studio.boardgamearena.com/framework-documentation/front-end/libs/ <b>Front-end libs</b>]
* [[Draggable]]: a JS component to manage drag'n'drop actions.
* [[Counter]]: a JS component to manage a counter that can increase/decrease (ex: player's score).
* [[ExpandableSection]]: a JS component to manage a rectangular block of HTML than can be displayed/hidden.
* [[Scrollmap]]: a JS component to manage a scrollable game area (useful when the game area can be infinite. Examples:  Saboteur or Takenoko games).
* [[Zone]]: a JS component to manage a zone of the board where several game elements can come and leave, but should be well displayed together (See for example: token's places at Can't Stop).
* [[BgaZoom|bga-zoom]] : a JS component for zoom controls.
* [[BgaAnimations|bga-animations]] : a JS component for animations.
* [[BgaCards|bga-cards]] : a JS component for cards.
* [[BgaDice|bga-dice]] : a JS component for dice.
* [[BgaAutofit|bga-autofit]] : a JS component to make text fit on a fixed size div.
* [[BgaScoreSheet|bga-score-sheet]] : a JS component to help you display an animated score sheet at the end of the game.
* [[BgaJumpTo|bga-jump-to]] : a JS component to add board shortcuts
 
'''Deprecated'''
* [[Deck]]: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).
* [[Stock]]: a JS component to manage and display a set of game elements displayed at a position.


'''Unofficial'''
'''Unofficial'''

Latest revision as of 17:18, 4 November 2026


Game File Reference





Useful Components

Official

Unofficial



Game Development Process



Guides for Common Topics



Miscellaneous Resources