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
 
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<!-- Do not use heading tags, or else these sidebar headings appear in the page TOCs -->


<div style="float: right; width: 300px; border: solid #000 1px; padding: 1em; margin-left: 1em; background: #fff;">
<div class="studio-framework-navigation" style="float: right; width: 300px; border: solid #000 1px; padding: 1em; margin-left: 1em; background: #fff;">
__NOTOC__
<h3><center>'''Game File Reference'''</center></h3>


<h3><center>'''[[Studio file reference|Overview]]'''</center></h3>
<div style="font-weight:bold;font-size:1.2em;margin-top:0.3em;line-height:1.6;padding-top:0.5em;"><center>'''Game File Reference'''</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
* [[Game database model: dbmodel.sql|<b>dbmodel.sql</b>]] - database model
* [[Game meta-information: gameinfos.inc.php|<b>gameinfos.inc.php</b>]] - meta-information
* [[Game meta-information: gameinfos.inc.php|<b>gameinfos.inc.php</b>]] - meta-information
* [[Game options and preferences: gameoptions.inc.php|<b>gameoptions.inc.php</b>]] - game options & user preferences
* [[Options and preferences: gameoptions.json, gamepreferences.json|<b>gameoptions.json</b>]] - game options & user preferences
* [[Game art: img directory|<b>img/</b>]] - game art
* [[Game art: img directory|<b>img/</b>]] - game art
* [[Game_metadata_manager|<b>Game Metadata Manager</b>]] - tags and metadata media
* [[Game material description: material.inc.php|<b>material.inc.php</b>]] - static data
* [[Game material description: material.inc.php|<b>material.inc.php</b>]] - static data
* <b>misc/</b> - studio-only storage
* <b>misc/</b> - studio-only storage
* <b>modules/</b> - additional game code
* <b>modules/</b> - additional game code
* [[State classes: State directory|<b>States/</b>]] - State classes
* [[Your game state machine: states.inc.php|<b>states.inc.php</b>]] - state machine
* [[Your game state machine: states.inc.php|<b>states.inc.php</b>]] - state machine
* [[Game statistics: stats.inc.php|<b>stats.inc.php</b>]] - statistics
* [[Game statistics: stats.json|<b>stats.json</b>]] - statistics
* [[Players actions: yourgamename.action.php|X.<b>action.php</b>]] - player actions
* [[Players actions: yourgamename.action.php|X.<b>action.php</b>]] - player actions
* [[Game interface stylesheet: yourgamename.css|X<b>.css</b>]] - interface stylesheet
* [[Game interface stylesheet: yourgamename.css|X<b>.css</b>]] - interface stylesheet
* [[Main game logic: yourgamename.game.php|X.<b>game.php</b>]] - main logic
* [[Main game logic: Game.php|<b>Game.php</b>]] - main logic
* [[Game interface logic: yourgamename.js|X.<b>js</b>]] - interface logic
* [[Game interface logic: yourgamename.js|X.<b>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.<b>view.php</b>]] - dynamic game layout
Line 23: Line 26:
<br>
<br>
-----
-----
<h3><center>'''Useful Components'''</center></h3>
<div style="font-weight:bold;font-size:1.2em;margin-top:0.3em;line-height:1.6;padding-top:0.5em;"><center>'''Useful Components'''</center></div>


'''Official'''
'''Official'''


* [[Deck]]: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).
* [[Deck]]: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).
* [[PlayerCounter_and_TableCounter|PlayerCounter and TableCounter]]: PHP components to manage counters.
* [[Draggable]]: a JS component to manage drag'n'drop actions.
* [[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).
* [[Counter]]: a JS component to manage a counter that can increase/decrease (ex: player's score).
Line 34: Line 38:
* [[Stock]]: a JS component to manage and display a set of game elements displayed at a position.
* [[Stock]]: a JS component to manage and display a set of game elements displayed at a position.
* [[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).
* [[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).
 
* [[BgaAnimations|bga-animations]] : a JS component for animations.
Undocumented component (if somebody knows please help with docs)
* [[BgaCards|bga-cards]] : a JS component for cards.
* [[Wrapper]]: a JS component to wrap a &lt;div&gt; element around its child, even if these elements are absolute positioned.
* [[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.


'''Unofficial'''
'''Unofficial'''
Line 42: Line 48:
* [[BGA Code Sharing]] - Shared resources, projects on git hub, common code, other links
* [[BGA Code Sharing]] - Shared resources, projects on git hub, common code, other links
* [[BGA Studio Cookbook]] - Tips and instructions on using API's, libraries and frameworks
* [[BGA Studio Cookbook]] - Tips and instructions on using API's, libraries and frameworks
* [[Some usual board game elements image ressources]]
* [[Common board game elements image resources]]


<br>
<br>
-----
-----
<h3><center>'''Game Development Process'''</center></h3>
<div style="font-weight:bold;font-size:1.2em;margin-top:0.3em;line-height:1.6;padding-top:0.5em;"><center>'''Game Development Process'''</center></div>


* [[First steps with BGA Studio]]
* [[First steps with BGA Studio]]
* [[Create a game in BGA Studio: Complete Walkthrough]]
* [[Create a game in BGA Studio: Complete Walkthrough]]
* [[Tutorial reversi]]  
* [[Tutorial reversi]]  
* [[Tutorial gomoku]]
* [[Tutorial hearts]]
* [[Tutorial hearts]]
* [[BGA Studio Guidelines]]
* [[BGA Studio Guidelines]]
Line 61: Line 66:
<br>
<br>
-----
-----
<h3><center>'''Guides for Common Topics'''</center></h3>
<div style="font-weight:bold;font-size:1.2em;margin-top:0.3em;line-height:1.6;padding-top:0.5em;"><center>'''Guides for Common Topics'''</center></div>


* [[Translations]] - make your game translatable
* [[Translations]] - make your game translatable
Line 67: Line 72:
* [[Your game mobile version|Mobile Users]]
* [[Your game mobile version|Mobile Users]]
* [[3D]]
* [[3D]]
* [[Compatibility]]


<br>
<br>
-----
-----
<h3><center>'''Miscellaneous Resources'''</center></h3>
<div style="font-weight:bold;font-size:1.2em;margin-top:0.3em;line-height:1.6;padding-top:0.5em;"><center>'''Miscellaneous Resources'''</center></div>


* [[Studio FAQ]]
* [[Studio FAQ]]

Latest revision as of 11:10, 1 October 2025


Game File Reference


Useful Components

Official

  • Deck: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).
  • PlayerCounter and TableCounter: PHP components to manage counters.
  • 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).
  • Stock: a JS component to manage and display a set of game elements displayed at a position.
  • 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).
  • bga-animations : a JS component for animations.
  • bga-cards : a JS component for cards.
  • bga-dice : a JS component for dice.
  • bga-autofit : a JS component to make text fit on a fixed size div.
  • bga-score-sheet : a JS component to help you display an animated score sheet at the end of the game.

Unofficial


Game Development Process


Guides for Common Topics


Miscellaneous Resources
Retrieved from "http:///index.php?title=Template:Studio_Framework_Navigation&oldid=26677"