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

„Studio” változatai közötti eltérés

Innen: Board Game Arena
Ugrás a navigációhoz Ugrás a kereséshez
 
(17 közbenső módosítás, amit 2 másik szerkesztő végzett, nincs mutatva)
1. sor: 1. sor:
 
[[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.
  
== 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.
11. sor: 12. sor:
 
http://forum.boardgamearena.com/viewtopic.php?f=10&t=1973
 
http://forum.boardgamearena.com/viewtopic.php?f=10&t=1973
  
== How can I develop a board game on BGA Studio? ==
+
== Discover BGA Studio in 5 presentations ==
  
Check these presentations first:
+
Why, how, what... to start discovering BGA Studio, we prepare you 5 "powerpoint" presentations:
  
 
* [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. sor: 22. sor:
 
* [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 BGA developer team? ==
  
Registering is done by e-mail at '''studio(at)boardgamearena.com'''.
+
Please see: [[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'.
+
After that, we would advise you to take a peek at one or both of these two game creation tutorials:
 +
* [[Tutorial reversi]]
 +
* [[Tutorial gomoku]]
  
And of course, we also encourage you to tell us about which games you would love to develop on BGA!
+
Then start editing files and see what happens! ;)
  
== Ok, I registered, what do I get? ==
+
If you have any questions, please ask them on the [http://forum.boardgamearena.com/viewforum.php?f=12 development forum].
  
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)
+
== BGA Studio documentation ==
  
<pre>NB: during the BETA pĥase, to smooth things up and make sure that everything is working correctly,
+
[[Studio FAQ]]
we will work only with 3 fearless developers on 3 simple games.</pre>
+
 
 +
=== BGA Studio Framework reference ===
 +
 
 +
This part of the documentation focus on the development framework itself: functions and methods available to build your game.
  
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:
+
[[Studio file reference|File structure of a BGA game]]
* 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:
+
==== Game logic ====
* 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!
+
* [[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]]
  
== Great, I'm in! ... How should I start? ==
+
==== Game interface ====
  
If you didn't already, check the presentations at the top of this page to get the basics.
+
* [[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]]
  
After that, we would advise you to take a peek at this tutorial for creating the Reversi example game:
+
==== Other components ====
* [[Tutorial reversi]]
 
  
Then start editing files and see what happens! ;)
+
* [[Translations]] (how to make your game translatable)
 +
* [[Game options and preferences: gameoptions.inc.php]]
  
If you have any questions, please ask them on the [http://forum.boardgamearena.com/viewforum.php?f=12 development forum].
+
=== BGA Studio game components reference ===
  
== Other resources ==
+
Game components are useful tools you can use in your game adaptations.
  
[[Studio FAQ]]
+
* [[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/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).
  
[[Studio file reference]]
+
=== BGA Studio user guide ===
  
[[Studio function reference]]
+
This part of the documentation is a user guide for the BGA Studio online development environment.
  
 
[[Studio back-office]]
 
[[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]

A lap jelenlegi, 2013. január 11., 17:47-kori változata

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.

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 prepare you 5 "powerpoint" presentations:

How to join BGA developer team?

Please see: 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.

After that, we would 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 ask them on the development forum.

BGA Studio documentation

Studio FAQ

BGA Studio Framework reference

This part of the documentation focus 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/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
    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.

Studio back-office

Other resources

Development forum

Bugs forum