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

Studio: Rozdiel medzi revíziami

Zo stránky Board Game Arena
Skočit na navigaci Skočit na vyhledávání
Bez shrnutí editace
 
(22 medziľahlých úprav od 3 ďalších používateľov nie je zobrazených)
Riadok 1: Riadok 1:
[[File:Bga_studio_small.jpg]]
[[File:Bga_studio_small.jpg]]


Note: Please DO NOT translate Studio Documentation, so that there can be one place where you can find the last information available.
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? ==
== What is Board Game Arena Studio? ==
Riadok 14: Riadok 14:
== Discover BGA Studio in 5 presentations ==
== Discover BGA Studio in 5 presentations ==


Why, how, what... to start discovering BGA Studio, we prepare you 5 "powerpoint" 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]
* [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]
Riadok 22: Riadok 22:
* [http://www.slideshare.net/boardgamearena/bga-studio-guidelines BGA developers guidelines]
* [http://www.slideshare.net/boardgamearena/bga-studio-guidelines BGA developers guidelines]


== How to join BGA developer team? ==
== How to join the BGA developer team? ==


Please see: [[How to join BGA developer team?]]
Please see this page: [[How to join BGA developer team?]]


== Great, I'm in! ... How should I start? ==
== Great, I'm in! ... How should I start? ==
Riadok 30: Riadok 30:
If you didn't already, check the presentations at the top of this page to get the basics.
If you didn't already, check the presentations at the top of this page to get the basics.


After that, we would advise you to take a peek at one or both of these two game creation tutorials:
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 or both of these two game creation tutorials:
* [[Tutorial reversi]]
* [[Tutorial reversi]]
* [[Tutorial gomoku]]
* [[Tutorial gomoku]]
Riadok 36: Riadok 38:
Then start editing files and see what happens! ;)
Then start editing files and see what happens! ;)


If you have any questions, please ask them on the [http://forum.boardgamearena.com/viewforum.php?f=12 development forum].
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'''].


== BGA Studio documentation ==
== BGA Studio documentation ==
[[Studio FAQ]]


=== BGA Studio Framework reference ===
=== BGA Studio Framework reference ===


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


[[Studio file reference|File structure of a BGA game]]
[[Studio file reference|File structure of a BGA game]]
Riadok 50: Riadok 50:
==== Game logic ====
==== Game logic ====


[[Main game logic (<gamename>.game.php)]]
* [[Main game logic: yourgamename.game.php]]
[[Your game state machine (states.inc.php)]]
* [[Your game state machine: states.inc.php]]
[[Game database model (dbmodel.sql)]]
* [[Game database model: dbmodel.sql]]
[[Players actions (<gamename>.action.php)]]
* [[Players actions: yourgamename.action.php]]
[[Game material description (material.inc.php)]]
* [[Game material description: material.inc.php]]
[[Game statistics (stats.inc.php)]]
* [[Game statistics: stats.inc.php]]


==== Game interface ====
==== Game interface ====


[[Game interface logic (<gamename>.js)]]
* [[Game interface logic: yourgamename.js]]
[[Game art (img directory)]]
* [[Game art: img directory]]
[[Game interface stylesheet (<gamename>.css)]]
* [[Game interface stylesheet: yourgamename.css]]
[[Game layout: view and template (<gamename>.view.php and <gamename>_<gamename>.tpl)]]
* [[Game layout: view and template: yourgamename.view.php and yourgamename_yourgamename.tpl]]
 
==== Other components ====


==== Other components ===
* [[Translations]] (how to make your game translatable)
* [[Game options and preferences: gameoptions.inc.php]]
* [[Game replay]]


[[Game options and preferences (gameoptions.inc.php)]]
=== BGA Studio game components reference ===


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


[[Studio function reference]]
* [[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  &lt;div&gt; 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 ===
=== BGA Studio user guide ===
Riadok 75: Riadok 87:
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.


[[Studio back-office]]
* [[Tools and tips of BGA Studio]]
 
* [[Practical debugging]]
 
* [[Studio back-office]]
 
* [[Studio FAQ]]
 
== BGA Developer team organization ==
 
* [[Steps to create a BGA game]]
* [[Post-release phase]]


== Other resources ==
== Other resources ==

Aktuálna revízia z 14:09, 29. apríl 2013

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 adaptation using the Board Game Arena platform.

It is open to any gamer with development skills :)

See announcement here: 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 advise you to take a peek at one or both of these two 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

Game interface

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.

BGA Developer team organization

Other resources

Development forum

Bugs forum