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
(17 intermediate revisions by 2 users not shown)
Line 5: Line 5:
== What is Board Game Arena Studio? ==
== What is Board Game Arena Studio? ==


'''Board Game Arena Studio''' is a platform to build online board game adaptation using the Board Game Arena platform.
'''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 development skills :)
It is open to any gamer with software development skills :)


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


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


== Discover BGA Studio in 5 presentations ==
== Discover BGA Studio in 5 presentations ==
Line 34: Line 33:
Then, you should checkout the [[First steps with BGA Studio]] to make sure that runs fine.
Then, you should checkout the [[First steps with BGA Studio]] to make sure that runs fine.


After that, we advise you to take a peek at one of these game creation tutorials:
After that, we strongly advise you to take one of these game creation tutorials:
* [[Tutorial reversi]] - an abstract strategy game played on an 8×8 uncheckered board for 2 players
* [[Tutorial reversi]] - an abstract strategy game played on an 8×8 uncheckered board for 2 players
* [[Tutorial gomoku]] - an abstract strategy game tic-tac-toe style for 2 players
* [[Tutorial gomoku]] - an abstract strategy game tic-tac-toe style for 2 players
Line 51: Line 50:
[[Studio file reference|File structure of a BGA game]]
[[Studio file reference|File structure of a BGA game]]


==== Game logic ====
==== Game logic (Server side) ====


* [[Main game logic: yourgamename.game.php]]
* [[Main game logic: yourgamename.game.php]]
Line 60: Line 59:
* [[Game statistics: stats.inc.php]]
* [[Game statistics: stats.inc.php]]


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


* [[Game interface logic: yourgamename.js]]
* [[Game interface logic: yourgamename.js]]
Line 74: Line 73:
* [[Game meta-information: gameinfos.inc.php]]
* [[Game meta-information: gameinfos.inc.php]]
* [[Game replay]]
* [[Game replay]]
* [[3D]]


=== BGA Studio game components reference ===
=== BGA Studio game components reference ===
Line 92: Line 92:
This part of the documentation is a user guide for the BGA Studio online development environment.
This part of the documentation is a user guide for the BGA Studio online development environment.


* [[Tools and tips of BGA Studio]]
* [[BGA game Lifecycle]]
 
* [[First steps with BGA Studio]]
* [[Practical debugging]]
* [[Tutorial reversi]]
 
* [[Tutorial gomoku]]
* [[Studio logs]]
* [[Tutorial hearts]]
 
* [[Create a game in BGA Studio: Complete Walkthrough]]
* [[Tools and tips of BGA Studio]] - Tips and instructions on setting up development environment
* [[Practical debugging]] - Tips focused on debugging
* [[Studio logs]] - Instructions for log access
* [[BGA Studio Cookbook]] - Tips and instructions on using API's, libraries and frameworks
* [[BGA Studio Guidelines]]
* [[Troubleshooting]] - Most common "I am really stuck" situations
* [[Studio FAQ]]
* [[Studio FAQ]]
 
* [[Pre-release checklist]] - Go throught this list if you think you done development
* [[Troubleshooting]]
 
== BGA Developer team organization ==
 
* [[Steps to create a BGA game]]
* [[Pre-release checklist]]
* [[Post-release phase]]
* [[Post-release phase]]
* [[BGA Code Sharing]]
* [[BGA Code Sharing]] - Shared resources, projects on git hub, common code, other links


== Other resources ==
== Other resources ==
Line 113: Line 113:
[http://forum.boardgamearena.com/viewforum.php?f=12 Development forum]
[http://forum.boardgamearena.com/viewforum.php?f=12 Development forum]


[http://forum.boardgamearena.com/viewforum.php?f=4 Bugs forum]
[https://en.boardgamearena.com/#!bugs Bug tracking system]

Revision as of 03:55, 17 January 2018

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

Discover BGA Studio in 5 presentations

Why, how, what... to start discovering BGA Studio, we prepared 5 "powerpoint" presentations for you:

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! ;)

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).
  • 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.
  • 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.

Other resources

Development forum

Bug tracking system