Board Game Arena - Naudotojo indėlis [lt]

Contact us

2025-06-30T15:55:27Z

Sourisdudesert:

'''Board Game Arena''' is located in France.

== Contact e-mail ==

contact(at)boardgamearena.com

We receive '''a lot''' of e-mails. Please do not send us an e-mail in any of these two cases:

* If you want to report a bug, please do it in the corresponding forum
* If you want to report a player for violation of BGA policy, use the "report this player" button on his/her profile.

Studio logs

2013-06-20T20:10:01Z

Sourisdudesert: /* BGA unexpected exceptions logs */

BGA Studio logs are available directly from your game development interface.

Logs allows you to check out what happened recently on server and to debug your game.

== BGA request&SQL logs ==

This log is useful:
* When you want to check what SQL requests has been built during a request.
* When you want to debug your PHP code using "self::trace"
* When you want to know why a request takes too many time.

On this log, you can see:

=== Your requests ===

Example:

20/06 21:50:56 [info] [T403] [4/mytest0] /cinco/cinco/exchange4Cards.html?id=4&lock=97d1c7a1-903a-4d1f-8206-de39ce8204fc&table=403&testuser=4&dojo.preventCache=1371757856044

Note that the best way to check your Ajax request is to read the [[http://en.doc.boardgamearena.com/Tools_and_tips_of_BGA_Studio#Input.2FOutput_debugging_section Input/Output section]].

=== Request responses ===

Example:

20/06 21:50:56 [notice] [T403] [4/mytest0] OK-0 169 d141 c8 e0 I9 A158 V0 T0 /cinco/cinco/exchange4Cards.html?id=4&lock=97d1c7a1-903a-4d1f-8206-de39ce8204fc&table=403&testuser=4&dojo.preventCache=1371757856044

You can recognize a response because it contains [notice]. Usually, there is one response for each request.

Let's details the beginning of the log:
* 20/06 21:50:56: the date
* [notice]
* [T403]: this is a log from table 403
* [4/mytest0]: this is use "mytest0", with id 4
* OK-0: it means that the request ended up successfully, with no exception (expected or unexpected).
* 169: this is the time taken to process the request (169ms).
* d141: this is the total Database time used to process the request (141ms).

=== SQL requests ===

Example:
20/06 21:50:56 [info] [T403] [4/mytest0] 0.26 SELECT player_tokenColor FROM player WHERE player_id ='4'

All requests to Database are traced in this log. You can see here the time take by the request (0,26ms).

=== Custom trace ===

You can use special PHP methods in your PHP code to left some trace in this log:
* self::trace( "your message here" ); // Display "your message here" in the log
* self::dump( "My variable", $variable_to_dump ); // Display the content of $variable_to_dump in the log

== BGA unexpected exceptions logs ==

In this log you can check the last Unexpected exceptions from your game.

Exceptions management on PHP side [[http://en.doc.boardgamearena.com/Main_game_logic:_yourgamename.game.php#Managing_errors_and_exceptions is described here]].

The log displayed the complete stacktrace of the exception, so you can debug it.

Studio logs

2013-06-20T20:07:24Z

Sourisdudesert:

Studio logs

2013-06-20T20:06:31Z

Sourisdudesert: /* SQL requests */

2013-05-02T12:01:04Z

Sourisdudesert: /* BGA packages: when my updates will be visible by players? */

Your game is now on BGA: congrats!

But what happened when there are some bugs to fix or when you want to optimize something?

Don't be afraid: you're still allowed to modify your game. You just have to pay attention to the points below.

== Bugs reporting ==

Bugs are reported in the [http://forum.boardgamearena.com/viewforum.php?f=4 BGA bugs forum].

During days after your game has been published and from time to time, please have a look at it to check if everything is fine.

== How to submit changes? ==

To submit your changes, you just have to commit your work from BGA Studio backoffice, as you did during the development phase.

Warning: as soon as you commited your changes, we assume that your code is ready to deploy '''anytime''' on BGA. Consequently, please do not commit a development in progress.

== BGA packages: when my updates will be visible by players? ==

BGA website is updated with "packages". When needed, we build a new package with all games and release a new version of BGA with this package.

It means that your updates won't be visible by players until a new package is build and released on the website.

Usually, there is less than 2 weeks between 2 packages, so it's quick. BUT, if you detect some major bug in your game, please warn us immediately so we can decide what to do. Usually, we do the following:
* We can do a "hotfix": you send us a very little change and we fix the website immediately. This is only possible if you change only the PHP side. The good news is that most blocking bugs are on PHP side - the client side bugs are most of the time solved by a page refresh. Of course, we don't hotfix minor bugs.
* We can build another package. Of course, it's better to fix several bugs in each package, in order we don't have to build another package right after the first one :)
* If the situation is critical, we can suspend the game from BGA waiting for the update.

Of course, we particularly care of your game during the days after your game is available on BGA. During this period of time, there's no problem to build package and to hotfix just for your game, and this is done in close collaboration with you. You just have to inform us when you're ready to publish a new version.

Note: don't forget that in any case, you need to commit your changes to made them available for the next package. Modifications that are not commited are not included in the packages.

== What can be modified after release? ==

Everything can be modified. BUT, some items requires a special attention, and you must inform us in some cases:

===Changes that breaks the games in progress===

Some changes will break the games in progress at the moment the release/the hotfix will be performed. Each time you make a change, you should ask you the question "it is safe to make this change in a game in progress", and if the answer is "no" you have to inform us.

Example of changes that break the games in progress:
* Changes in the database schema of the game (dbmodel.sql).
* New global variable or game option accessed during the game (if it's only used during setup, it should be safe).
* New statistic (it won't be initialized properly, so it's going to crash the game).
* Change ID of existing game states (adding new game states is fine).

Of course, as a rule of thumb, you should avoid to introduce changes that break a game in progress. Sometimes however, you do not have any other choice. In this case:
* Try to group all your updates in one BGA package, thus we won't have to block your game several times.
* Tell us explicitly that you introduce some update that can break games in progress, '''as soon as you commit your update'''.
* Thus, during the package delivery, we will block the game and let game in progress end before publishing the new version.

===Major changes===

If you do some major changes to your game like:
* Introducing a new expansion.
* Major code rewriting/refactoring.

... please tell us. In this case, we can:
* Make your game back from "gold" to "public beta", to incite player to report bugs.
* Discuss with you about the release date of the next BGA package.
* Pay attention to your game when publishing the package.
* And eventually, publish a news about it :)

Post-release phase

2013-04-29T14:14:49Z

Sourisdudesert: /* Major changes */

2013-04-29T13:09:31Z

Sourisdudesert:

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

* [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-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 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:
* [[Tutorial reversi]]
* [[Tutorial gomoku]]

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

[[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]]
* [[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 <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.

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

[http://forum.boardgamearena.com/viewforum.php?f=12 Development forum]

[http://forum.boardgamearena.com/viewforum.php?f=4 Bugs forum]