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 3 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
Line 10: Line 11:
* [[Game options and preferences: gameoptions.inc.php|<b>gameoptions.inc.php</b>]] - game options & user preferences
* [[Game options and preferences: gameoptions.inc.php|<b>gameoptions.inc.php</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
Line 23: Line 25:
<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'''
Line 46: Line 48:
<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]]
Line 53: Line 55:
* [[Tutorial gomoku]]  
* [[Tutorial gomoku]]  
* [[Tutorial hearts]]
* [[Tutorial hearts]]
* [[BGA Studio Guidelines]]
* [[BGA game Lifecycle]]
* [[BGA game Lifecycle]]
* [[Pre-release checklist]]
* [[Pre-release checklist]]
Line 60: Line 63:
<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>


* [[BGA Studio Guidelines]]
* [[Translations]] - make your game translatable
* [[Translations]] - make your game translatable
* [[Game replay|Game Replay]]
* [[Game replay|Game Replay]]
Line 70: Line 72:
<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]]
Line 77: Line 79:
* [[Practical debugging]] - Tips focused on debugging
* [[Practical debugging]] - Tips focused on debugging
* [[Troubleshooting]] - Most common "I am really stuck" situations
* [[Troubleshooting]] - Most common "I am really stuck" situations
* [https://studio.boardgamearena.com/bugs Studio Bugs] - Reports against Studio itself (not BGA!)
</div>
</div>

Revision as of 11:45, 4 May 2022


Game File Reference



Useful Components

Official

  • Deck: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).
  • 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).

Undocumented component (if somebody knows please help with docs)

  • Wrapper: a JS component to wrap a <div> element around its child, even if these elements are absolute positioned.

Unofficial



Game Development Process



Guides for Common Topics



Miscellaneous Resources