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
No edit summary
 
(130 intermediate revisions by 18 users not shown)
Line 1: Line 1:
[[File:Bga_studio_small.jpg]]
{{InfoBox|title=User contributions|body=The Studio wiki is kept for dev contributions. Official documentation is here:
[https://doc.studio.boardgamearena.com/get-started/ <span class="mw-ui-button mw-ui-progressive mw-ui-big">Get Started!</span>] [https://doc.studio.boardgamearena.com/framework-documentation/ <span class="mw-ui-button mw-ui-progressive mw-ui-big">Framework documentation</span>]
}}


Note: Please DO NOT translate Studio Documentation, so that there can be one place where you can find the last information available.
{{Studio_Framework_Navigation}}


== What is Board Game Arena Studio? ==
[[File:Bga_studio_small.jpg|frameless|300px]]


'''Board Game Arena Studio''' is a platform to build online board game adaptation using the Board Game Arena platform.
*Note: Please DO NOT translate Studio Documentation, so that there can be one place where you can find the latest information available.*


It is open to any gamer with development skills :)
__TOC__


See announcement here:
To search wiki pages on studio enter this text in search bar:  
http://forum.boardgamearena.com/viewtopic.php?f=10&t=1973
  "Category:Studio" white rabbit
That is if you want to search for white rabbit


== Discover BGA Studio in 5 presentations ==
==== Game interface (Client side) ====


Why, how, what... to start discovering BGA Studio, we prepared 5 "powerpoint" presentations for you:
* [[Your game mobile version]]


* [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]
==== Other components ====
* [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]
* [http://www.slideshare.net/boardgamearena/the-bga-framework-at-a-glance The BGA Framework at a glance]
* [http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine Focus on BGA game state machine]
* [http://www.slideshare.net/boardgamearena/bga-studio-guidelines BGA developers guidelines]


== How to join the BGA developer team? ==
* [[Translations]] (how to make your game translatable)
* [[Game replay]]


Please see this page: [[How to join BGA developer team?]]
=== BGA Studio user guide ===


== Great, I'm in! ... How should I start? ==
This part of the documentation is a user guide for the BGA Studio online development environment.


If you didn't already, check the presentations at the top of this page to get the basics.
Lifecycle


Then, you should checkout the [[First steps with BGA Studio]] to make sure that runs fine.
* [[BGA game Lifecycle]]
* [[BGA Game licenses]]
* [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
* [[Post-release phase]]


After that, we advise you to take a peek at one or both of these two game creation tutorials:
* [[Tutorial reversi]]
* [[Tutorial gomoku]]


Then start editing files and see what happens! ;)
Tools and Advice
* [https://doc.studio.boardgamearena.com/framework-documentation/guidelines/ 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
** [https://doc.studio.boardgamearena.com/get-started/vscode-setup/ 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|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]]


If you have any questions, please check out the '''[[Studio FAQ]]''' first, then if you didn't find the answer you were looking for, please post your question on the [http://forum.boardgamearena.com/viewforum.php?f=12 '''development forum'''].
Sharing
* [[Common board game elements image resources]] - Dice, meeples, cubes, etc
* [[BGA Code Sharing]] - Shared resources, projects on git hub, common code, other links


== BGA Studio documentation ==
== Other resources ==


=== BGA Studio Framework reference ===
[http://forum.boardgamearena.com/viewforum.php?f=12 Development forum]
 
This part of the documentation focus on the development framework itself: functions and methods available to build your game.
 
[[Studio file reference|File structure of a BGA game]]
 
==== Game logic ====
 
* [[Main game logic: yourgamename.game.php]]
* [[Your game state machine: states.inc.php]]
* [[Game database model: dbmodel.sql]]
* [[Players actions: yourgamename.action.php]]
* [[Game material description: material.inc.php]]
* [[Game statistics: stats.inc.php]]
 
==== Game interface ====
 
* [[Game interface logic: yourgamename.js]]
* [[Game art: img directory]]
* [[Game interface stylesheet: yourgamename.css]]
* [[Game layout: view and template: yourgamename.view.php and yourgamename_yourgamename.tpl]]


==== Other components ====
[https://studio.boardgamearena.com/bugs Bug tracking system FOR STUDIO issues and APIs]


* [[Translations]] (how to make your game translatable)
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
* [[Game options and preferences: gameoptions.inc.php]]
* [[Game replay]]


=== BGA Studio game components reference ===
Developer BLOGS https://bga-devs.github.io/blog/


Game components are useful tools you can use in your game adaptations.
BGA Mainsite releases https://en.boardgamearena.com/forum/viewtopic.php?t=23289&start=100


* [[Deck]]: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).
[https://doc.studio.boardgamearena.com/get-started/before-starting-real-project/#communication-with-the-bga-team Contact BGA Studio]
* [[Counter]]: a JS component to manage a counter that can increase/decrease (ex: player's score).
* [[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/hide.
* [[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.
* [[Wrapper]]: a JS component to wrap a <div> element around his child, even if these elements are absolute positioned.
* [[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).


=== BGA Studio user guide ===
This part of the documentation is a user guide for the BGA Studio online development environment.
[[Tools and tips of BGA Studio]]
[[Practical debugging]]
[[Studio back-office]]
== Other resources ==
[http://forum.boardgamearena.com/viewforum.php?f=12 Development forum]


[http://forum.boardgamearena.com/viewforum.php?f=4 Bugs forum]
[[Category:Studio]]

Latest revision as of 14:18, 10 November 2026

User contributions
The Studio wiki is kept for dev contributions. Official documentation is here: Get Started! Framework documentation


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.*

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

Game interface (Client side)

Other components

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