This is a documentation for Board Game Arena: play board games online !
Template:Studio Framework Navigation: Difference between revisions
Jump to navigation
Jump to search
Studio Framework Navigation
No edit summary |
No edit summary |
||
| Line 4: | Line 4: | ||
<center>'''Studio Framework Navigation'''</center> | <center>'''Studio Framework Navigation'''</center> | ||
<h3><center>'''Game File Reference'''</center></h3> | |||
<h3><center>'''[[Studio file reference|Overview]]'''</center></h3> | <h3><center>'''[[Studio file reference|Overview]]'''</center></h3> | ||
| Line 24: | Line 24: | ||
<br> | <br> | ||
----- | ----- | ||
<h3><center>'''Studio Components'''</center></h3> | |||
* [[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, ...). | ||
| Line 39: | Line 39: | ||
<br> | <br> | ||
----- | ----- | ||
<h3><center>'''Other Topics'''</center></h3> | |||
* [[Translations]] (how to make your game translatable) | * [[Translations]] (how to make your game translatable) | ||
| Line 49: | Line 49: | ||
<br> | <br> | ||
----- | ----- | ||
<h3><center>'''Studio User Guide'''</center></h3> | |||
* [[BGA game Lifecycle]] | * [[BGA game Lifecycle]] | ||
Revision as of 16:10, 16 March 2021
Game File Reference
Overview
- dbmodel.sql - database model
- gameinfos.inc.php - meta-information
- gameoptions.inc.php - game options & user preferences
- img/ - game art
- material.inc.php - static data
- states.inc.php - state machine
- stats.inc.php - statistics
- X.action.php - player actions
- X.css - interface stylesheet
- X.game.php - main logic
- X.js - interface logic
- X.view.php - dynamic game layout
- X_X.tpl - static game layout
Studio Components
- 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.
Other Topics
- Translations (how to make your game translatable)
- Game replay
- Your game mobile version
- 3D
- Some usual board game elements image ressources
Studio User Guide
- BGA game Lifecycle
- First steps with BGA Studio
- Tutorial reversi
- Tutorial gomoku
- Tutorial hearts
- Create a game in BGA Studio: Complete Walkthrough
- Tools and tips of BGA Studio - Tips and instructions on setting up development environment
- Practical debugging - Tips focused on debugging
- Studio logs - Instructions for log access
- BGA Studio Cookbook - Tips and instructions on using API's, libraries and frameworks
- BGA Studio Guidelines
- Troubleshooting - Most common "I am really stuck" situations
- Studio FAQ
- Pre-release checklist - Go throught this list if you think you done development
- Post-release phase
- BGA Code Sharing - Shared resources, projects on git hub, common code, other links