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

Studio: Розніца паміж версіямі

З пляцоўкі Board Game Arena
Перайсці да навігацыі Перайсці да пошуку
Няма тлумачэння праўкі
 
(Не паказана 75 прамежкавых версій 7 удзельнікаў)
Радок 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 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 :)


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


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


* [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]
Why, how, what... to start discovering BGA Studio, we prepared 5 "powerpoint" presentations for you:
* [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 do I register? ==
* [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] (or [http://en.doc.boardgamearena.com/images/5/58/1-why-developing.pdf ‎Download as PDF])
* [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] (or [http://en.doc.boardgamearena.com/images/1/1e/2-8-steps-to-realize.pdf Download as PDF])
* [http://www.slideshare.net/boardgamearena/the-bga-framework-at-a-glance The BGA Framework at a glance] (or [http://en.doc.boardgamearena.com/images/7/79/3-thebgaframework.pdf Download as PDF])
* [http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine Focus on BGA game state machine] (or [http://en.doc.boardgamearena.com/images/9/98/4-gamestates.pdf Download as PDF])
* [http://www.slideshare.net/boardgamearena/bga-studio-guidelines BGA developers guidelines] (or [http://en.doc.boardgamearena.com/images/7/76/5-guidelines.pdf ‎Download as PDF])


Registering is done by e-mail at '''studio(at)boardgamearena.com'''.
== How to join the BGA developer team? ==


Please provide the following information:
Please see this page: [[How to join BGA developer team?]]
* 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.
== Great, I'm in! ... How should I start? ==


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'.
If you didn't already, check the presentations at the top of this page to get the basics.


And of course, we also encourage you to tell us about which games you would love to develop on BGA!
Then, you should checkout the [[First steps with BGA Studio]] to make sure that runs fine.


== Ok, I registered, what do I get? ==
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 gomoku]] - an abstract strategy game tic-tac-toe style for 2 players
* [[Tutorial hearts]] - a card game for 4 players


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)
Then start editing files and see what happens! ;)


<pre>NB: during the BETA pĥase, to smooth things up and make sure that everything is working correctly,  
Once you're done with tutorials, you can start a real game (or join existing project)
we will work only with 3 fearless developers on 3 simple games.</pre>
* [[Create a game in BGA Studio: Complete Walkthrough]]


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:
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'''].
* 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:
== BGA Studio documentation ==
* 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!
=== BGA Studio Framework reference ===


== Great, I'm in! ... How should I start? ==
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]]
 
==== Game logic (Server side) ====
 
* [[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 (Client side) ====
 
* [[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]]
* [[Your game mobile version]]
 
==== Other components ====
 
* [[Translations]] (how to make your game translatable)
* [[Game options and preferences: gameoptions.inc.php]]
* [[Game meta-information: gameinfos.inc.php]]
* [[Game replay]]
* [[3D]]
 
 
=== BGA Studio game components reference ===


If you didn't already, check the presentations at the top of this page to get the basics.
Game components are useful tools you can use in your game adaptations.


After that, we would advise you to take a peek at this tutorial for creating the Reversi example game:
* [[Deck]]: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).
* [[Tutorial reversi]]
* [[Counter]]: a JS component to manage a counter that can increase/decrease (ex: player's score).
* [[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.
* [[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).


Then start editing files and see what happens! ;)
Undocumented component (if somebody knows please help with docs)
* [[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.
* [[Wrapper]]: a JS component to wrap a  &lt;div&gt; element around its child, even if these elements are absolute positioned.


If you have any questions, please ask them on the [http://forum.boardgamearena.com/viewforum.php?f=12 development forum].
Reference for classes in game class hierarchy


== Other resources ==
* [[Table]]: a PHP class that you inherit from for the game php


[[Studio FAQ]]
=== BGA Studio user guide ===


[[Studio file reference]]
This part of the documentation is a user guide for the BGA Studio online development environment.


[[Studio function reference]]
* [[BGA game Lifecycle]]
* [[First steps with BGA Studio]]
* [[Tutorial reversi]]
* [[Tutorial gomoku]]
* [[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
* [[Some usual board game elements image ressources]]
* [[BGA Studio Guidelines]]
* [[Troubleshooting]] - Most common "I am really stuck" situations
* [[Studio FAQ]]
* [[Pre-release checklist]] - Go throught this list if you think you done development
* [[Post-release phase]]
* [[BGA Code Sharing]] - Shared resources, projects on git hub, common code, other links


[[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]
[https://en.boardgamearena.com/#!bugs Bug tracking system]

Актуальная версія на 04:12, 3 кастрычніка 2020

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

Once you're done with tutorials, you can start a real game (or join existing project)

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

Undocumented component (if somebody knows please help with docs)

  • 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.
  • Wrapper: a JS component to wrap a <div> element around its child, even if these elements are absolute positioned.

Reference for classes in game class hierarchy

  • Table: a PHP class that you inherit from for the game php

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

Узята з "http:///index.php?title=Studio&oldid=5800"