This is a documentation for Board Game Arena: play board games online !

Studio: Difference between revisions

From Board Game Arena
Jump to navigation Jump to search
← Older edit
VisualWikitext
Victoria La (talk | contribs)
1,060 edits
No edit summary
 
(13 intermediate revisions by 2 users not shown)
Line 9: Line 9:
== What is Board Game Arena Studio? ==
== What is Board Game Arena Studio? ==


'''Board Game Arena Studio''' is a platform to build online board game adaptations using the Board Game Arena platform.
[https://doc.studio.boardgamearena.com/get-started/ <span class="mw-ui-button mw-ui-progressive mw-ui-big">Get Started!</span>]


It is open to any gamer with software development skills :)
== BGA Studio documentation ==
 
BGA Studio website: https://studio.boardgamearena.com
 
Original announcement on BGA forum: https://forum.boardgamearena.com/viewtopic.php?f=10&t=1973
 
== Discover BGA Studio in 5 presentations ==
 
Why, how, what... to start discovering BGA Studio, we prepared 5 "powerpoint" presentations for you:
 
* [http://www.slideshare.net/boardgamearena/5-reasons-why-you-should-use-bga-studio-for-your-online-board-game 5 reasons why you should use BGA Studio for your online board game] (or [http://en.doc.boardgamearena.com/images/5/58/1-why-developing.pdf ‎Download as PDF])
* [http://www.slideshare.net/boardgamearena/the-8-steps-to-create-a-board-game-on-board-game-arena The 8 steps to create a board game on Board Game Arena] (or [http://en.doc.boardgamearena.com/images/1/1e/2-8-steps-to-realize.pdf Download as PDF])
* [http://www.slideshare.net/boardgamearena/the-bga-framework-at-a-glance The BGA Framework at a glance] (or [http://en.doc.boardgamearena.com/images/7/79/3-thebgaframework.pdf Download as PDF])
* [http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine Focus on BGA game state machine] (or [http://en.doc.boardgamearena.com/images/9/98/4-gamestates.pdf Download as PDF])
* [http://www.slideshare.net/boardgamearena/bga-studio-guidelines BGA developers guidelines] (or [http://en.doc.boardgamearena.com/images/7/76/5-guidelines.pdf ‎Download as PDF])
 
== How to join the BGA developer team? ==
 
Please see this page: [[How to join BGA developer team?]]
 
== Great, I'm in! ... How should I start? ==
 
If you didn't already, check the presentations at the top of this page to get the basics.
 
Then, you should checkout the [[First steps with BGA Studio]] to make sure that runs fine.
 
After that, we strongly advise you to take one of these game creation tutorials:
* [[Tutorial reversi]] ('''recommended''', closest to the actual BGA implementation and maintained by the BGA team) - an abstract strategy game played on an 8×8 uncheckered board for 2 players
* [[Tutorial hearts]] - a card game for 4 players
 
Then start editing files and see what happens! ;)
 
Once you're done with tutorials, you can start a real game (or join existing project)
* [[Create a game in BGA Studio: Complete Walkthrough]]
 
If you have any questions, please check out the [[Studio FAQ]] or [[Contact BGA Studio]].


[https://doc.studio.boardgamearena.com/framework-documentation/ <span class="mw-ui-button mw-ui-progressive mw-ui-big">Framework documentation</span>]


To search wiki pages on studio enter this text in search bar:  
To search wiki pages on studio enter this text in search bar:  
   "Category:Studio" white rabbit  
   "Category:Studio" white rabbit  
That is if you want to search for white rabbit
That is if you want to search for white rabbit
== BGA Studio documentation ==


=== BGA Studio Framework reference ===
=== BGA Studio Framework reference ===
Line 63: Line 27:
==== Game logic (Server side) ====
==== Game logic (Server side) ====


* [[Main game logic: yourgamename.game.php|Main game logic: Game.php]]
[https://doc.studio.boardgamearena.com/framework-documentation/back-end/ <span class="mw-ui-button mw-ui-progressive mw-ui-big">Framework documentation > Back-end</span>]
* [[State classes: State directory|Your game state classes: States directory]]
* [[Game database model: dbmodel.sql]]
* [[Game material description: material.inc.php]]
* [[Game statistics: stats.inc.php|Game statistics: stats.json]]


==== Game interface (Client side) ====
==== Game interface (Client side) ====


* [[Game interface logic: Game.js]]
[https://doc.studio.boardgamearena.com/framework-documentation/front-end/ <span class="mw-ui-button mw-ui-progressive mw-ui-big">Framework documentation > Front-end</span>]
* [[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]]
* [[Your game mobile version]]


Line 80: Line 38:


* [[Translations]] (how to make your game translatable)
* [[Translations]] (how to make your game translatable)
* [[Options_and_preferences:_gameoptions.json,_gamepreferences.json|Game Options and Preferences]]
* [[Game meta-information: gameinfos.inc.php]]
* [[Game replay]]
* [[Game replay]]


Line 88: Line 44:
Game components are useful tools you can use in your game adaptations.
Game components are useful tools you can use in your game adaptations.


JS:
[https://doc.studio.boardgamearena.com/framework-documentation/back-end/libs/ <span class="mw-ui-button mw-ui-progressive mw-ui-big">Framework documentation > Back-end > libs</span>]


* [[Counter]]: a JS component to manage a counter that can increase/decrease (ex: player's score).
[https://doc.studio.boardgamearena.com/framework-documentation/front-end/libs/ <span class="mw-ui-button mw-ui-progressive mw-ui-big">Framework documentation > Front-end > libs</span>]
* [[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).
* [[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)
* [[BgaAnimations|bga-animations]]: a JS component for animations.
* [[BgaCards|bga-cards]]: a JS component for cards.
* [[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.
 
PHP:
* [[Deck]]: 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 ===
=== BGA Studio user guide ===
Line 115: Line 56:
* [[BGA game Lifecycle]]
* [[BGA game Lifecycle]]
* [[BGA Game licenses]]
* [[BGA Game licenses]]
* [[Create a game in BGA Studio: Complete Walkthrough]]
* [https://doc.studio.boardgamearena.com/get-started/start-real-project/ Create a game in BGA Studio: Complete Walkthrough]
* [[Pre-release checklist]] - Go throught this list if you think you done development
* [[Pre-release checklist]] - Go throught this list if you think you done development
* [[Post-release phase]]
* [[Post-release phase]]
Line 121: Line 62:


Tools and Advice
Tools and Advice
* [[BGA Studio Guidelines]]
* [https://doc.studio.boardgamearena.com/framework-documentation/guidelines/ BGA Studio Guidelines]
* [[Tutorials checklist]]
* [[Tutorials checklist]]
* [[I wish I knew this when I started]] - one liners on most common missed features, mistakes, etc with further doc references
* [[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
* [[Tools and tips of BGA Studio]] - Tips and instructions on setting up development environment
** [[Setting up BGA Development environment using VSCode]]
** [https://doc.studio.boardgamearena.com/get-started/vscode-setup/ Setting up BGA Development environment using VSCode]
** [[Practical debugging]] - Tips focused on debugging
** [[Practical debugging]] - Tips focused on debugging
** [[Testing by developer]]
** [[Testing by developer]]
Line 135: Line 76:
** [[Using Typescript and Scss]] - How to auto-build Typescript and SCSS files to make your code cleaner
** [[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
** [[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
* [[BGA Studio Migration Guide]] - Migration tips from older version of studio framework
* [[Studio FAQ]]
* [[Studio FAQ]]
Line 141: Line 83:
* [[Common board game elements image resources]] - Dice, meeples, cubes, etc
* [[Common board game elements image resources]] - Dice, meeples, cubes, etc
* [[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
== Software Versions ==
Versions currently used by BGA framework:
* Dojo Toolkit 1.15
* PHP: 8.4
* SQL: MySQL 5.7
* JS/CSS/HTML: limited by what minimization tools support: [[Game_interface_logic:_yourgamename.js#Javascript_minimization_.28after_July_2020.29|JS minimization]]
* Font Awesome: 4.7 https://fontawesome.com/v4.7/icons/ (available as <code><nowiki><i class="fa fa-clock" /></nowiki></code>)
* Font Awesome: 6.4.0 https://fontawesome.com/v6/search?o=r&m=free (available as <code><nowiki><i class="fa6 fa6-clock" /></nowiki></code>)
=== 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 ==
== Other resources ==
Line 171: Line 96:
BGA Mainsite releases https://en.boardgamearena.com/forum/viewtopic.php?t=23289&start=100
BGA Mainsite releases https://en.boardgamearena.com/forum/viewtopic.php?t=23289&start=100


[[Contact BGA Studio]]
[https://doc.studio.boardgamearena.com/get-started/before-starting-real-project/#communication-with-the-bga-team Contact BGA Studio]
 




[[Category:Studio]]
[[Category:Studio]]

Latest revision as of 13:34, 4 November 2026


Official documentation

Useful Components

Official

Unofficial


Game Development Process


Guides for Common Topics


Miscellaneous Resources

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?

Get Started!

BGA Studio documentation

Framework documentation

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 Framework reference

This part of the documentation focuses on the development framework itself: functions and methods available to build your game.

File structure of a BGA game

Game logic (Server side)

Framework documentation > Back-end

Game interface (Client side)

Framework documentation > Front-end

Other components

BGA Studio game components reference

Game components are useful tools you can use in your game adaptations.

Framework documentation > Back-end > libs

Framework documentation > Front-end > libs

BGA Studio user guide

This part of the documentation is a user guide for the BGA Studio online development environment.

Lifecycle


Tools and Advice

Sharing

Other resources

Development forum

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

Contact BGA Studio

Retrieved from "https://en.doc.boardgamearena.com/index.php?title=Studio&oldid=32369"