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
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
<div style="float: right; width: 300px; border: solid #000 1px; padding: 1em; margin-left: 1em; background: #fff;"> | <div 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>'''Game File Reference'''</center></h3> | ||
| Line 24: | Line 22: | ||
<br> | <br> | ||
----- | ----- | ||
<h3><center>''' | <h3><center>'''Useful Components'''</center></h3> | ||
'''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, ...). | ||
| Line 37: | Line 37: | ||
* [[Wrapper]]: a JS component to wrap a <div> element around its child, even if these elements are absolute positioned. | * [[Wrapper]]: a JS component to wrap a <div> element around its child, even if these elements are absolute positioned. | ||
'''Unofficial''' | |||
* [[ | * [[BGA Code Sharing]] - Shared resources, projects on git hub, common code, other links | ||
* [[Some usual board game elements image ressources]] | * [[Some usual board game elements image ressources]] | ||
<br> | <br> | ||
----- | ----- | ||
<h3><center>''' | <h3><center>'''Game Development Process'''</center></h3> | ||
* [[First steps with BGA Studio]] | * [[First steps with BGA Studio]] | ||
* [[Create a game in BGA Studio: Complete Walkthrough]] | |||
* [[Tutorial reversi]] | * [[Tutorial reversi]] | ||
* [[Tutorial gomoku]] | * [[Tutorial gomoku]] | ||
* [[Tutorial hearts]] | * [[Tutorial hearts]] | ||
* [[ | * [[BGA game Lifecycle]] | ||
* [[Pre-release checklist]] | |||
* [[Post-release phase]] | |||
<br> | |||
----- | |||
<h3><center>'''Guides for Common Topics'''</center></h3> | |||
* [[BGA Studio Guidelines]] | |||
* [[Translations]] - make your game translatable | |||
* [[Game replay|Game Replay]] | |||
* [[Your game mobile version|Mobile Users]] | |||
* [[3D]] | |||
<br> | |||
----- | |||
<h3><center>'''Miscellaneous Resources'''</center></h3> | |||
* [[Studio FAQ]] | |||
* [[BGA Studio Cookbook]] - Tips and instructions on using API's, libraries and frameworks | |||
* [[Tools and tips of BGA Studio]] - Tips and instructions on setting up development environment | * [[Tools and tips of BGA Studio]] - Tips and instructions on setting up development environment | ||
* [[Studio logs]] - Instructions for log access | |||
* [[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 | ||
</div> | </div> | ||
Revision as of 16:44, 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
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
- BGA Code Sharing - Shared resources, projects on git hub, common code, other links
- Some usual board game elements image ressources
Game Development Process
- First steps with BGA Studio
- Create a game in BGA Studio: Complete Walkthrough
- Tutorial reversi
- Tutorial gomoku
- Tutorial hearts
- BGA game Lifecycle
- Pre-release checklist
- Post-release phase
Guides for Common Topics
- BGA Studio Guidelines
- Translations - make your game translatable
- Game Replay
- Mobile Users
- 3D
Miscellaneous Resources
- Studio FAQ
- BGA Studio Cookbook - Tips and instructions on using API's, libraries and frameworks
- Tools and tips of BGA Studio - Tips and instructions on setting up development environment
- Studio logs - Instructions for log access
- Practical debugging - Tips focused on debugging
- Troubleshooting - Most common "I am really stuck" situations