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
 
(19 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.
  
It is opened to any gamer with development skills :)
+
It is open to any gamer with development skills :)
  
 
See announcement here:
 
See announcement here:
 
http://forum.boardgamearena.com/viewtopic.php?f=10&t=1973
 
http://forum.boardgamearena.com/viewtopic.php?f=10&t=1973
  
== How to 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]
 
* [http://www.slideshare.net/boardgamearena/the-8-steps-to-create-a-board-game-on-board-game-arena The 8 steps to create a board game on Board Game Arena]
 
* [http://www.slideshare.net/boardgamearena/the-8-steps-to-create-a-board-game-on-board-game-arena The 8 steps to create a board game on Board Game Arena]
 +
* [http://www.slideshare.net/boardgamearena/the-bga-framework-at-a-glance The BGA Framework at a glance]
 +
* [http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine Focus on BGA game state machine]
 +
* [http://www.slideshare.net/boardgamearena/bga-studio-guidelines BGA developers guidelines]
 +
 +
== 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:
 +
* [[Tutorial reversi]]
 +
* [[Tutorial gomoku]]
 +
 +
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].
  
 
== BGA Studio documentation ==
 
== BGA Studio documentation ==
  
(available soon...)
+
[[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.
 +
 
 +
[[Studio file reference|File structure of a BGA game]]
 +
 
 +
==== 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]]
 +
 
 +
=== 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 <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.
 +
 
 +
[[Studio back-office]]
 +
 
 +
== Other resources ==
 +
 
 +
[http://forum.boardgamearena.com/viewforum.php?f=12 Development 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