loading

If you see this message, it means that your browser failed to load this file.

You should try the following : check your connection, disable ad-blocker, clear your browser cache, try in private mode, try from another browser/computer/connection.

Home »
BGA Studio
(for web developers)

• You are a web developer fluent in server side (PHP, SQL) and client side (HTML, Javascript) languages

So this presentation looks easy and fun to you.

• You want full access to the BGA development stack to develop complex games (but we still advise you to start with something simple for your first game!)

Check the documentation and tutorials to get started!

What is BGA Studio?


Getting started

4 slideshare presentations to get ready to use BGA Studio in 30 minutes:

Reference Documentation

This page comes from BGA wiki, and has been written by BGA players community. Feel free to edit it!

Game File Reference

Overview



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



Game Development Process



Guides for Common Topics



Miscellaneous Resources

Bga studio small.jpg

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?

Board Game Arena Studio is a platform to build online board game adaptations using the Board Game Arena platform.

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

BGA Studio website: http://en.studio.boardgamearena.com

Original announcement on BGA forum: http://forum.boardgamearena.com/viewtopic.php?f=10&t=1973

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:

Then start editing files and see what happens! ;)

Once you're done with tutorials, you can start a real game (or join existing project)

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 development forum.

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.

File structure of a BGA game

Game logic (Server side)

Game interface (Client side)

Other components


BGA Studio game components reference

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

  • Deck: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).
  • 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: 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)

  • 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.
  • Wrapper: a JS component to wrap a <div> element around its child, even if these elements are absolute positioned.

Reference for classes in game class hierarchy

  • Table: a PHP class that you inherit from for the game php

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

Login


Please remember me




Join the BGA Studio developers team

To start developing on BGA Studio and get access to development environment, you need to create an account below.

Personal infos provided in this form is NOT shown to anyone but BGA Studio admin, and is NOT used for any other purpose that BGA Studio organization.




(Must be valid. We may remove accounts from developers we can't contact.)




(3 to 20 characters. No space, no number, no special characters)




(The exact username you are using on BGA)




Important: we need your REAL name to attribute your work on the Studio & to send you stuff by Post when needed.




Important: we need your REAL name to attribute your work on the Studio & to send you stuff by Post when needed.





Please enter the security code you see
???


I agree to the Terms & Conditions for developers on BGA Studio.


Register


More controls and cross checks on game options

Hi,
I'm developing a self-published game with werewolf style, so a game in which every player a specific character, randomly assigned, with a specific role.

Suppose I have 4 character types and everyone can be assigned to 0-N players, depending on game selected options.
I have created 4 options (characterA_number, characterB_number, characterC_number and characterD_number) that determine how many characters of any type should be present in game.

In the options I am able to define for example that I can insert at most 2 characterA, or 3 characterB in a 4 players game.
But how can I combine them?
I am not able to check that, in a 4 players game, have not been inserted 2 characterA and 3 characterB, for a total of 5 characters in a 4 players game!

With the actual options rules I could use startcondition to check for other options selected value, but once at the time, not a combination of options. And also following this way, growing the number of characters (currently I have developed 7), I would get an exponential number of options conditions! Not very maintainable..
09/28/2021 3 comments

"safe" player IDs [SOLVED]

I'm storing player IDs as global variables, but sometimes I want to use the same global to say something like "no player has yet..." or "there is no longer a player such that..."

So, let's suppose I record that as "7". That's going to be all well and good until the 7th person to get an account with BGA tries to play and everything crashes.

Or does it work like that? Is there a player_id 7 out there somewhere? What player_id can I be 100% confident doesn't exist?

(Yes, I know, there are workarounds that don't assume any player numbers don't exist, but if there are any that don't yet and will never exist, that will be very useful.)
09/28/2021 2 comments

Where can I find a list of BGA Frameworks static methods

Hi all :)

I noticed there are a lot of really helpful methods that get pulled in when you are running your game in the BGA environment.
Examples:
  • clienttranslate
  • notifyAllPlayers
  • DbQuery
  • getCollectionFromDb
  • giveExtraTime
  • getActivePlayerName
  • activeNextPlayer
I'm sure there are many more that I'm unaware of :oops:
Is there a wiki page listing them? Or better yet, an interface we can implement on the dev side to get some intellisence with docs and argument/param explanations?
09/27/2021 4 comments


Application loading... ...
THANK YOU : You are one of our most loyal players!
Get the best from Board Game Arena for only €2 / month.
1
2
3
4
5
6
7
8
9
10
11
12