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

Studio: Разлика между версии

От Board Game Arena
Направо към навигацията Направо към търсенето
 
(Не са показани 36 междинни версии от 3 потребители)
Ред 1: Ред 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 latest information available.


== What is this? ==
== 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 adaptation using the Board Game Arena platform.
Ред 8: Ред 9:
It is open to any gamer with development skills :)
It is open to any gamer with development skills :)


See announcement here:
BGA Studio website:
http://forum.boardgamearena.com/viewtopic.php?f=10&t=1973
http://en.studio.boardgamearena.com


== How can I develop a board game on BGA Studio? ==
(original announcement on BGA forum: http://forum.boardgamearena.com/viewtopic.php?f=10&t=1973)


Check these presentations first:
== 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]
* [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]
Ред 21: Ред 24:
* [http://www.slideshare.net/boardgamearena/bga-studio-guidelines BGA developers guidelines]
* [http://www.slideshare.net/boardgamearena/bga-studio-guidelines BGA developers guidelines]


== How do I register? ==
== How to join the BGA developer team? ==


Registering is done by e-mail at '''studio(at)boardgamearena.com'''.
Please see this page: [[How to join BGA developer team?]]


Please provide the following information:
== Great, I'm in! ... How should I start? ==
* your developer user name to be used on “BGA Studio” (for technical reasons, no space, number or special character);
* your real name;
* your e-mail address;
* your postal address.


We also drafted a quick [http://en.doc.boardgamearena.com/images/0/02/BGA_TC_Dev_en.pdf 'terms & conditions' document]. It's very light, so as to get to the fun part faster.
If you didn't already, check the presentations at the top of this page to get the basics.


To be valid, the registration e-mail must contain this document as an attachment, with the following sentence in the mail body: 'I agree with the terms & conditions for developers on BGA Studio joined as an attachment'.
Then, you should checkout the [[First steps with BGA Studio]] to make sure that runs fine.


And of course, we also encourage you to tell us about which games you would love to develop on BGA!
After that, we advise you to take a peek at one or both of these two game creation tutorials:
* [[Tutorial reversi]]
* [[Tutorial gomoku]]


== Ok, I registered, what do I get? ==
Then start editing files and see what happens! ;)


First, from time to time you will get by e-mail the names of some of the games we have an agreement to develop, so that you can tell us 'Hey, this game is great! I want to develop it!' (please keep these names confidential, or it would ruin our tradition to make players guess the name of the next game on the 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'''].


<pre>NB: during the BETA pĥase, to smooth things up and make sure that everything is working correctly,
== BGA Studio documentation ==
we will work only with 3 fearless developers on 3 simple games.</pre>


Second, once we have discussed together and are fixed on a game you'll take charge of, we'll create your studio account and you will get:
=== BGA Studio Framework reference ===
* one login / password to access files through SFTP
* ten logins with numeric suffixes from 0 to 9 and a common simple password to test games on the studio website while developing.


Once logged in to your SFTP root folder, you will find:
This part of the documentation focuses on the development framework itself: functions and methods available to build your game.
* a 'resources.html' file with the URLs to use and some extra connection information
* three folders containing the three simple games provided as examples
* a folder for the game you will be developing initialized after our 'EmptyGame' template, providing the game structure (and comments! and examples!)


Then... that's all, you can start!
[[Studio file reference|File structure of a BGA game]]


== Great, I'm in! ... How should I start? ==
==== 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 ====
 
* [[Translations]] (how to make your game translatable)
* [[Game options and preferences: gameoptions.inc.php]]
* [[Game meta-information: gameinfos.inc.php]]
* [[Game replay]]
 
=== 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  &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).


If you didn't already, check the presentations at the top of this page to get the basics.
=== BGA Studio user guide ===


After that, we would advise you to take a peek at one or both of these two game creation tutorials:
This part of the documentation is a user guide for the BGA Studio online development environment.
* [[Tutorial reversi]]
* [[Tutorial gomoku]]


Then start editing files and see what happens! ;)
* [[Tools and tips of BGA Studio]]


If you have any questions, please ask them on the [http://forum.boardgamearena.com/viewforum.php?f=12 development forum].
* [[Practical debugging]]


== Other resources ==
* [[Studio logs]]


[[Studio FAQ]]
* [[Studio FAQ]]


[[Studio file reference]]
== BGA Developer team organization ==


[[Studio function reference]]
* [[Steps to create a BGA game]]
* [[Post-release phase]]


[[Studio back-office]]
== Other resources ==


[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]
[http://forum.boardgamearena.com/viewforum.php?f=4 Bugs forum]

Текуща версия към 18:00, 30 септември 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 :)

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

Взето от „http:///index.php?title=Studio&oldid=956“.