This is a documentation for Board Game Arena: play board games online !
Studio: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 9: | Line 9: | ||
== What is Board Game Arena Studio? == | == What is Board Game Arena Studio? == | ||
[https://doc.studio.boardgamearena.com/get-started/ <span class="mw-ui-button mw-ui-progressive mw-ui-big">Get Started!</span>] | |||
== How to join the BGA developer team? == | == How to join the BGA developer team? == | ||
Please see this page: [[How to join BGA developer team?]] | Please see this page: [[How to join BGA developer team?]] | ||
Revision as of 16:44, 3 November 2026
Note: Please DO NOT translate Studio Documentation, so that there can be one place where you can find the latest information available.
What is Board Game Arena Studio?
How to join the BGA developer team?
Please see this page: How to join BGA developer team?
To search wiki pages on studio enter this text in search bar:
"Category:Studio" white rabbit
That is if you want to search for white rabbit
BGA Studio documentation
BGA Studio Framework reference
This part of the documentation focuses on the development framework itself: functions and methods available to build your game.
Game logic (Server side)
- Main game logic: Game.php
- Your game state classes: States directory
- Game database model: dbmodel.sql
- Game material description: material.inc.php
- Game statistics: stats.json
Game interface (Client side)
- Game interface logic: Game.js
- Game art: img directory
- Game interface stylesheet: yourgamename.css
- Game layout: view and template: yourgamename.view.php and yourgamename_yourgamename.tpl
- Your game mobile version
Other components
- Translations (how to make your game translatable)
- Game Options and Preferences
- Game meta-information: gameinfos.jsonc
- Game replay
BGA Studio game components reference
Game components are useful tools you can use in your game adaptations.
JS:
- Counter: a JS component to manage a counter that can increase/decrease (ex: player's score).
- Scrollmap: a JS component to manage a scrollable game area (useful when the game area can be infinite. Examples: Saboteur or Takenoko games).
- Stock (deprecated): 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).
- Draggable: a JS component to manage drag'n'drop actions.
- ExpandableSection: a JS component to manage a rectangular block of HTML than can be displayed/hidden.
- Anti-Stock: Code snippets in vanilla JS/HTML5 to do what stock does (that is if you cannot beat Stock into submission)
- bga-zoom : a JS component for zoom controls.
- 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.
- bga-jump-to : a JS component to add board shortcuts.
PHP:
- ItemManager: a PHP component to manage cards or other game items.
- Deck (deprecated): a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...)
- PlayerCounter and TableCounter: php component to manager counters
BGA Studio user guide
This part of the documentation is a user guide for the BGA Studio online development environment.
Lifecycle
- BGA game Lifecycle
- BGA Game licenses
- Create a game in BGA Studio: Complete Walkthrough
- Pre-release checklist - Go throught this list if you think you done development
- Post-release phase
Tools and Advice
- BGA Studio Guidelines
- Tutorials checklist
- I wish I knew this when I started - one liners on most common missed features, mistakes, etc with further doc references
- Tools and tips of BGA Studio - Tips and instructions on setting up development environment
- Setting up BGA Development environment using VSCode
- Practical debugging - Tips focused on debugging
- Testing by developer
- Studio logs - Instructions for log access
- Troubleshooting - Most common "I am really stuck" situations
- Production issues reporting tool
- BGA Studio Cookbook - Tips and instructions on using API's, libraries and frameworks
- Using Vue - work-in-progress guide on using the modern framework Vue.js to create a game
- Using Typescript and Scss - How to auto-build Typescript and SCSS files to make your code cleaner
- Bots and Artificial Intelligence - How to add AI/Bots to the game
- Using AI for BGA game development - Shared resources about setting up AI agents
- BGA Studio Migration Guide - Migration tips from older version of studio framework
- Studio FAQ
Sharing
- Common board game elements image resources - Dice, meeples, cubes, etc
- BGA Code Sharing - Shared resources, projects on git hub, common code, other links
Software Versions
Versions currently used by BGA framework:
- Dojo Toolkit 1.15 - deprecated, avoid at all cost
- PHP: 8.4
- SQL: MySQL 5.7 (prod) - on studio 8.0
- JS/CSS/HTML: limited by what minimization tools support: JS minimization
- Font Awesome: 4.7 https://fontawesome.com/v4.7/icons/ (available as
<i class="fa fa-clock" />) - Font Awesome: 6.4.0 https://fontawesome.com/v6/search?o=r&m=free (available as
<i class="fa6 fa6-clock" />)
PHP Extensions Used
The following PHP extensions are - as of Apr 1, 2026 - in use in BGA Studio:
Core date libxml openssl pcre sqlite3 zlib ctype curl dom fileinfo filter hash iconv json mbstring SPL session PDO pdo_sqlite standard posix random readline Reflection Phar SimpleXML tokenizer xml xmlreader xmlwriter mysqlnd cgi-fcgi apcu gd gettext gmp mysqli pcntl redis sodium zip memcached Zend OPcache
Other resources
Bug tracking system FOR STUDIO issues and APIs
DISCORD chat server/room invite link https://discord.gg/YxEUacY if it does not work check this topic https://forum.boardgamearena.com/viewtopic.php?f=12&t=17403&hilit=discord
Developer BLOGS https://bga-devs.github.io/blog/
BGA Mainsite releases https://en.boardgamearena.com/forum/viewtopic.php?t=23289&start=100