https://sr.doc.boardgamearena.com/api.php?action=feedcontributions&feedformat=atom&user=SourisdudesertBoard Game Arena - Кориснички доприноси [sr]2026-10-30T19:19:36ZКориснички доприносиMediaWiki 1.43.11https://sr.doc.boardgamearena.com/index.php?title=Contact_us&diff=3261Contact us2025-06-30T15:59:13Z<p>Sourisdudesert: </p>
<hr />
<div>'''Board Game Arena''' is located in France.<br />
<br />
== Contact e-mail ==<br />
<br />
contact(at)boardgamearena.com<br />
<br />
We receive '''a lot''' of e-mails. Please do not send us an e-mail in any of these two cases:<br />
<br />
* If you want to report a bug, please do it in the [http://boardgamearena.com/#!bugs bug reporting system]<br />
* If you want to report a player for violation of BGA policy, use the "report this player" button on his/her profile.</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Main_game_logic:_yourgamename.game.php&diff=3224Main game logic: yourgamename.game.php2018-10-10T09:22:21Z<p>Sourisdudesert: /* About random and randomness */</p>
<hr />
<div><br />
This is the main file for your game logic. Here you initialize the game, persist data, implement the rules and notify the client interface of changes.<br />
<br />
== File Structure ==<br />
<br />
The details of how the file is structured are described directly with comments in the code skeleton provided to you.<br />
<br />
Here is the basic structure:<br />
<br />
* EmptyGame (constructor): where you define global variables.<br />
* setupNewGame: initial setup of the game.<br />
* getAllDatas: where you retrieve all game data during a complete reload of the game.<br />
* getGameProgression: where you compute the game progression indicator.<br />
* Utility functions: your utility functions.<br />
* Player actions: the entry points for players actions. <br />
* Game state arguments: methods to return additional data on specific game states ([http://en.doc.boardgamearena.com/Your_game_state_machine:_states.inc.php#args more info here]).<br />
* Game state actions: the logic to run when entering a new game state ([http://en.doc.boardgamearena.com/Your_game_state_machine:_states.inc.php#action more info here]).<br />
* zombieTurn: what to do it's the turn of a zombie player.<br />
<br />
== Accessing player information ==<br />
<br />
; getPlayersNumber()<br />
: Returns the number of players playing at the table<br />
: Note: doesn't work in setupNewGame so use count($players) instead<br />
<br />
; getActivePlayerId()<br />
: Get the "active_player", whatever what is the current state type.<br />
: Note: it does NOT mean that this player is active right now, because state type could be "game" or "multiplayer"<br />
: Note: avoid using this method in a "multiplayer" state because it does not mean anything.<br />
<br />
; getActivePlayerName()<br />
: Get the "active_player" name<br />
: Note: avoid using this method in a "multiplayer" state because it does not mean anything.<br />
<br />
; loadPlayersBasicInfos()<br />
: Get an associative array with generic data about players (ie: not game specific data).<br />
: The key of the associative array is the player id. The returned table is cached, so ok to call multiple times without performance concerns.<br />
: The content of each value is:<br />
: * player_name - the name of the player<br />
: * player_color (ex: ff0000) - the color code of the player<br />
: * player_no - the position of the player at the start of the game in natural table order, i.e. 1,2,3<br />
<br />
; getCurrentPlayerId()<br />
: Get the "current_player". The current player is the one from which the action originated (the one who send the request).<br />
: '''Be careful''': It is not always the active player.<br />
: In general, you shouldn't use this method, unless you are in "multiplayer" state.<br />
<br />
; getCurrentPlayerName()<br />
: Get the "current_player" name<br />
: Be careful using this method (see above).<br />
<br />
; getCurrentPlayerColor()<br />
: Get the "current_player" color<br />
: Be careful using this method (see above).<br />
<br />
; isCurrentPlayerZombie()<br />
: Check the "current_player" zombie status. If true, player is zombie, i.e. left or was kicked out of the game.<br />
<br />
== Accessing the database ==<br />
<br />
The main game logic should be the only point from which you should access the game database. You access your database using SQL queries with the methods below.<br />
<br />
'''IMPORTANT'''<br />
<br />
BGA uses [http://dev.mysql.com/doc/refman/5.0/en/sql-syntax-transactions.html database transactions]. This means that your database changes WON'T BE APPLIED to the database until your request ends normally. Using transactions is in fact very useful for you; at any time, if your game logic detects that something is wrong (example: a disallowed move), you just have to throw an exception and all changes to the game situation will be removed.<br />
<br />
; DbQuery( $sql )<br />
: This is the generic method to access the database.<br />
: It can execute any type of SELECT/UPDATE/DELETE/REPLACE query on the database.<br />
: You should use it for UPDATE/DELETE/REPLACE queries. For SELECT queries, the specialized methods below are much better.<br />
<br />
; getUniqueValueFromDB( $sql )<br />
: Returns a unique value from DB or null if no value is found.<br />
: $sql must be a SELECT query.<br />
: Raise an exception if more than 1 row is returned.<br />
<br />
; getCollectionFromDB( $sql, $bSingleValue=false )<br />
: Returns an associative array of rows for a sql SELECT query.<br />
: The key of the resulting associative array is the first field specified in the SELECT query.<br />
: The value of the resulting associative array if an associative array with all the field specified in the SELECT query and associated values.<br />
: First column must be a primary or alternate key.<br />
: The resulting collection can be empty.<br />
: If you specified $bSingleValue=true and if your SQL query request 2 fields A and B, the method returns an associative array "A=>B"<br />
<br />
Example 1:<br />
<pre><br />
self::getCollectionFromDB( "SELECT player_id id, player_name name, player_score score FROM player" );<br />
<br />
Result:<br />
array(<br />
1234 => array( 'id'=>1234, 'name'=>'myuser0', 'score'=>1 ),<br />
1235 => array( 'id'=>1235, 'name'=>'myuser1', 'score'=>0 )<br />
)<br />
</pre><br />
Example 2:<br />
<pre><br />
self::getCollectionFromDB( "SELECT player_id id, player_name name FROM player", true );<br />
<br />
Result:<br />
array(<br />
1234 => 'myuser0',<br />
1235 => 'myuser1'<br />
)<br />
<br />
</pre><br />
<br />
; getNonEmptyCollectionFromDB( $sql )<br />
: Idem than previous one, but raise an exception if the collection is empty<br />
<br />
; getObjectFromDB( $sql )<br />
: Returns one row for the sql SELECT query as an associative array or null if there is no result<br />
: Raise an exception if the query return more than one row<br />
<br />
Example:<br />
<pre><br />
self::getObjectFromDB( "SELECT player_id id, player_name name, player_score score FROM player WHERE player_id='$player_id'" );<br />
<br />
Result:<br />
array(<br />
'id'=>1234, 'name'=>'myuser0', 'score'=>1 <br />
)<br />
</pre><br />
<br />
; getNonEmptyObjectFromDB( $sql )<br />
: Idem than previous one, but raise an exception if no row is found<br />
<br />
; getObjectListFromDB( $sql, $bUniqueValue=false )<br />
: Return an array of rows for a sql SELECT query.<br />
: the result if the same than "getCollectionFromDB" except that the result is a simple array (and not an associative array).<br />
: The result can be empty.<br />
: If you specified $bUniqueValue=true and if your SQL query request 1 field, the method returns directly an array of values.<br />
<br />
Example 1:<br />
<pre><br />
self::getObjectListFromDB( "SELECT player_id id, player_name name, player_score score FROM player" );<br />
<br />
Result:<br />
array(<br />
array( 'id'=>1234, 'name'=>'myuser0', 'score'=>1 ),<br />
array( 'id'=>1235, 'name'=>'myuser1', 'score'=>0 )<br />
)<br />
</pre><br />
Example 2:<br />
<pre><br />
self::getObjectListFromDB( "SELECT player_name name FROM player", true );<br />
<br />
Result:<br />
array(<br />
'myuser0',<br />
'myuser1'<br />
)<br />
<br />
</pre><br />
<br />
; getDoubleKeyCollectionFromDB( $sql, $bSingleValue=false )<br />
: Return an associative array of associative array, from a SQL SELECT query.<br />
: First array level correspond to first column specified in SQL query.<br />
: Second array level correspond to second column specified in SQL query.<br />
: If bSingleValue = true, keep only third column on result<br />
<br />
<br />
; DbGetLastId()<br />
: Return the PRIMARY key of the last inserted row (see PHP mysql_insert_id function).<br />
<br />
; DbAffectedRow()<br />
: Return the number of row affected by the last operation<br />
<br />
; escapeStringForDB( $string )<br />
: You must use this function on every string type data in your database that contains unsafe data.<br />
: (unsafe = can be modified by a player).<br />
: This method makes sure that no SQL injection will be done through the string used.<br />
: Note: if you using standard types in ajax actions, like AT_alphanum it is sanitized before arrival,<br />
: this is only needed if you manage to get unchecked string, like in the games where user has to enter text as a response.<br />
<br />
<pre><br />
<br />
<br />
</pre><br />
<br />
Note: see Editing [[Game database model: dbmodel.sql]] to know how to define your database model.<br />
<br />
== Use globals ==<br />
<br />
Sometimes, you have to keep a single integer value that is global to your game, and you don't want to create a DB table specifically for it.<br />
<br />
Using a BGA framework "global", you can do such a thing. Your value will be stored in the "global" table in database, and you can access it with simple methods.<br />
<br />
'''initGameStateLabels'''<br />
<br />
This method is located at the beginning of your game logic. This is the place you defines the globals used in your game logic, by assigning them IDs.<br />
<br />
You can define up to 79 globals, with IDs from 10 to 89. You must NOT use globals outside this range as globals are used by other components of the framework.<br />
<br />
<pre><br />
self::initGameStateLabels( array( <br />
"my_first_global_variable" => 10,<br />
"my_second_global_variable" => 11<br />
) );<br />
</pre><br />
<br />
'''setGameStateInitialValue( $value_label, $value_value )'''<br />
<br />
Init your global value. Must be called before any use of your global, so you should call this method from your "setupNewGame" method.<br />
<br />
'''getGameStateValue( $value_label )'''<br />
<br />
Retrieve the current value of a global.<br />
<br />
'''setGameStateValue( $value_label, $value_value )'''<br />
<br />
Set the current value of a global.<br />
<br />
'''incGameStateValue( $value_label, $increment )'''<br />
<br />
Increment the current value of a global. If increment is negative, decrement the value of the global.<br />
<br />
Return the final value of the global.<br />
<br />
== Game states and active players ==<br />
<br />
<br />
=== Activate player handling ===<br />
<br />
; $this->activeNextPlayer()<br />
: Make the next player active in the natural player order.<br />
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.<br />
<br />
; $this->activePrevPlayer()<br />
: Make the previous player active (in the natural player order).<br />
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.<br />
<br />
; $this->gamestate->changeActivePlayer( $player_id )<br />
: You can call this method to make any player active.<br />
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.<br />
<br />
; $this->getActivePlayerId()<br />
: Return the "active_player" id<br />
: Note: it does NOT mean that this player is active right now, because state type could be "game" or "multiplayer"<br />
<br />
=== Multiactivate player handling ===<br />
<br />
; $this->gamestate->setAllPlayersMultiactive()<br />
: All playing players are made active. Update notification is sent to all players (triggers onUpdateActionButtons).<br />
: Usually, you use this method at the beginning (ex: "st" action method) of a multiplayer game state when all players have to do some action.<br />
<br />
; $this->gamestate->setAllPlayersNonMultiactive( $next_state )<br />
: All playing players are made inactive. Transition to next state<br />
<br />
; $this->gamestate->setPlayersMultiactive( $players, $next_state, $bExclusive = false )<br />
: Make a specific list of players active during a multiactive gamestate. Update notification is sent to all players who's state changed.<br />
: "players" is the array of player id that should be made active.<br />
: If "exclusive" parameter is not set or false it doesn't deactivate other previously active players. If its set to true, the players who will be multiactive at the end are only these in "$layers" array<br />
<br />
: In case "players" is empty, the method trigger the "next_state" transition to go to the next game state.<br />
: returns true if state transition happened, false otherwise<br />
<br />
; $this->gamestate->setPlayerNonMultiactive( $player_id, $next_state )<br />
: During a multiactive game state, make the specified player inactive.<br />
: Usually, you call this method during a multiactive game state after a player did his action.<br />
: If this player was the last active player, the method trigger the "next_state" transition to go to the next game state.<br />
: returns true if state transition happened, false otherwise<br />
<br />
; $this->gamestate->updateMultiactiveOrNextState( $next_state_if_none )<br />
: Sends update notification about multiplayer changes. All multiactive set* functions above do that, however if you want to change state manually using db queries for complex calculations, you have to call this yourself after. Do not call this if you calling one of the other setters above.<br />
Example: you have player teams and you want to activate all players in one team<br />
<pre><br />
$sql = "UPDATE player SET player_is_multiactive='0'";<br />
self::DbQuery( $sql );<br />
$sql = "UPDATE player SET player_is_multiactive='1' WHERE player_id='$player_id' AND player_team='$team_no'";<br />
self::DbQuery( $sql );<br />
<br />
$this->gamestate->updateMultiactiveOrNextState( 'error' );<br />
</pre><br />
<br />
; $this->gamestate->getActivePlayerList()<br />
: With this method you can retrieve the list of the active player at any time.<br />
: During a "game" type gamestate, it will return a void array.<br />
: During a "activeplayer" type gamestate, it will return an array with one value (the active player id).<br />
: During a "multipleactiveplayer" type gamestate, it will return an array of the active players id.<br />
: Note: you should only use this method is the latter case.<br />
<br />
=== States functions ===<br />
; $this->gamestate->nextState( $transition )<br />
: Change current state to a new state. Important: parameter $transition is the name of the transition, and NOT the name of the target game state, see [[Your game state machine: states.inc.php]] for more information about states.<br />
<br />
; $this->checkAction( $actionName, $bThrowException=true )<br />
: Check if action is valid regarding current game state (exception if fails).<br />
: The action is valid if it is listed as a "possibleactions" in the current game state (see game state description).<br />
: This method MUST be called in the first place in ALL your PHP methods that handle players action, in order to make sure a player can't do an action when the rules disallow it at this moment of the game.<br />
: if "bThrowException" is set to "false", the function return false in case of failure instead of throwing and exception. This is useful when several actions are possible in order to test each of them without throwing exceptions.<br />
<br />
; $this->gamestate->checkPossibleAction( $action )<br />
: (rarely used)<br />
: This works exactly like "checkAction", except that it do NOT check if current player is active.<br />
: This is used specifically in certain game states when you want to authorize some additional actions for players that are not active at the moment.<br />
: Example: in Libertalia game, you want to authorize players to change their mind about card played. They are of course not active at the time they change their mind, so you cannot use "checkAction" and use "checkPossibleAction" instead.<br />
<br />
; $this->gamestate->state()<br />
: Get an associative array of current game state attributes, see [[Your game state machine: states.inc.php]] for state attributes.<br />
$state=$this->gamestate->state(); if( $state['name'] == 'myGameState' ) {...}<br />
<br />
== Players turn order ==<br />
<br />
'''getNextPlayerTable()'''<br />
<br />
Return an associative array which associate each player with the next player around the table.<br />
<br />
In addition, key 0 is associated to the first player to play.<br />
<br />
Example: if three player with ID 1, 2 and 3 are around the table, in this order, the method returns:<br />
<pre><br />
array( <br />
1 => 2, <br />
2 => 3, <br />
3 => 1, <br />
0 => 1 <br />
);<br />
</pre><br />
<br />
'''getPrevPlayerTable()'''<br />
<br />
Same as above, but the associative array associate the previous player around the table.<br />
<br />
'''getPlayerAfter( $player_id )'''<br />
<br />
Get player playing after given player in natural playing order.<br />
<br />
'''getPlayerBefore( $player_id )'''<br />
<br />
Get player playing before given player in natural playing order.<br />
<br />
Note: There is no API to modify this order, if you have custom player order you have to maintain it in your database<br />
and have custom function to access it.<br />
<br />
== Notify players ==<br />
<br />
To understand notifications, please read [http://www.slideshare.net/boardgamearena/the-bga-framework-at-a-glance The BGA Framework at a glance] first.<br />
<br />
'''IMPORTANT'''<br />
<br />
Notifications are sent at the very end of the request, when it ends normally. It means that if you throw an exception for any reason (ex: move not allowed), no notifications will be sent to players.<br />
Notifications sent between the game start (setupNewGame) and the end of the "action" method of the first active state will never reach their destination.<br />
<br />
'''notifyAllPlayers( $notification_type, $notification_log, $notification_args )'''<br />
<br />
Send a notification to all players of the game.<br />
<br />
* notification_type:<br />
A string that defines the type of your notification.<br />
<br />
Your game interface Javascript logic will use this to know what is the type of the received notification (and to trigger the corresponding method).<br />
<br />
* notification_log:<br />
A string that defines what is to be displayed in the game log.<br />
<br />
You can use an empty string here (""). In this case, nothing is displayed in the game log.<br />
<br />
If you define a real string here, you should use "clienttranslate" method to make sure it can be translate.<br />
<br />
You can use arguments in your notification_log strings, that refers to values defines in the "notification_args" argument (see below). <br />
Note: Make sure you only use single quotes ('), otherwise PHP will try to interpolate the variable and will ignore the values in the args array.<br />
<br />
<br />
<br />
* notification_args:<br />
The arguments of your notifications, as an associative array.<br />
<br />
This array will be transmitted to the game interface logic, in order the game interface can be updated.<br />
<br />
Complete notifyAllPlayers example (from "Reversi"):<br />
<br />
<pre><br />
self::notifyAllPlayers( "playDisc", clienttranslate( '${player_name} plays a disc and turns over ${returned_nbr} disc(s)' ),<br />
array(<br />
'player_id' => $player_id,<br />
'player_name' => self::getActivePlayerName(),<br />
'returned_nbr' => count( $turnedOverDiscs ),<br />
'x' => $x,<br />
'y' => $y<br />
) );<br />
</pre><br />
<br />
You can see in the example above the use of the "clienttranslate" method, and the use of 2 arguments "player_name" and "returned_nbr" in the notification log.<br />
<br />
Important: NO private data must be sent with this method, as a cheater could see it even it is not used explicitly by the game interface logic. If you want to send private information to a player, please use notifyPlayer below.<br />
<br />
Note: you CAN use some HTML inside your notification log, however it not recommended for many reasons:<br />
* Its bad architecture, ui elements leak into server now you have to manage ui in many places<br />
* If you decided to change something in ui in future version, old games reply and tutorials may not work, since they use stored notifications<br />
* When you read log preview for old games its unreadable (this is log before you enter the game reply, useful for troubleshooting or game analysis)<br />
* Its more data to transfer and store in db<br />
* Its nightmare for translators, at least don't put HTML tags inside the "clienttranslate" method. You can use a notification argument instead, and provide your HTML through this argument.<br />
<br />
If you still want to have pretty pictures in the log check this [[BGA_Studio_Cookbook#Inject_images_and_styled_html_in_the_log]].<br />
<br />
If your notification contains some phrases that build programmatically you may need to use recursive notifications. In this case the argument can be not only the string but<br />
an array itself, which contains 'log' and 'args', i.e.<br />
<br />
$this->notifyAllPlayers('playerLog',clienttranslate('Game moves ${token_name_rec}'),<br />
['token_name_rec'=>['log'=>'${token_name} #${token_number}',<br />
'args'=> ['token_name'=>clienttranslate('Boo'), 'token_number'=>$number, 'i18n'=>['token_name'] ]<br />
]<br />
]);<br />
<br />
<br />
<br />
'''notifyPlayer( $player_id, $notification_type, $notification_log, $notification_args )'''<br />
<br />
Same as above, except that the notification is sent to one player only.<br />
<br />
This method must be used each time some private information must be transmitted to a player.<br />
<br />
Important: the variable for player name must be ${player_name} in order to be highlighted with the player color in the game log<br />
<br />
== About random and randomness ==<br />
<br />
A large number of board games rely on random, most often based on dice, cards shuffling, picking some item in a bag, and so on. This is very important to ensure a high level of randomness for each of these situations.<br />
<br />
Here's are a list of techniques you should use in these situations, from the best to the worst.<br />
<br />
=== Dices and bga_rand ===<br />
<br />
'''bga_rand( min, max )''' <br />
This is a BGA framework function that provides you a random number between "min" and "max" (included), using the best available random method available on the system.<br />
<br />
This is the preferred function you should use, because we are updating it when a better method is introduced.<br />
<br />
At now, bga_rand is based on the PHP function "random_int", which ensure a cryptographic level of randomness.<br />
<br />
In particular, it is '''mandatory''' to use it for all '''dice throw''' (ie: games using other methods for dice throwing will be rejected by BGA during review).<br />
<br />
Note: rand() and mt_rand() are deprecated on BGA and should not be used anymore, as their randomness is not as good as "bga_rand".<br />
<br />
=== shuffle and cards shuffling ===<br />
<br />
To shuffle items, like a pile of cards, the best way is to use the BGA PHP [[Deck]] component and to use "shuffle" method. This ensure you that the best available shuffling method is used, and that if in the future we improve it your game will be up to date.<br />
<br />
At now, the Deck component shuffle method is based on PHP "shuffle" method, which has a quite good randomness (even it is not as good as bga_rand). In consequence, we accept other shuffling methods during reviews, as long as their are based on PHP "shuffle" function (or similar, like "array_rand").<br />
<br />
=== Other methods ===<br />
<br />
Mysql "RAND()" function has not enough randomness to be a valid method to get a random element on BGA. This function has been used in some existing games and has given acceptable results, but now it should be avoided and you should use other methods instead.<br />
<br />
== Game statistics ==<br />
<br />
There are 2 types of statistics:<br />
* a "player" statistic is a statistic associated to a player<br />
* a "table" statistics is a statistic not associated to a player (global statistic for this game).<br />
<br />
See [[Game statistics: stats.inc.php]] to see how you defines statistics for your game.<br />
<br />
<br />
'''initStat( $table_or_player, $name, $value, $player_id = null )'''<br />
<br />
Create a statistic entry with a default value.<br />
This method must be called for each statistics of your game, in your setupNewGame method.<br />
<br />
'$table_or_player' must be set to "table" if this is a table statistics, or "player" if this is a player statistics.<br />
<br />
'$name' is the name of your statistics, as it has been defined in your stats.inc.php file.<br />
<br />
'$value' is the initial value of the statistics. If this is a player statistics and if the player is not specified by "$player_id" argument, the value is set for ALL players.<br />
<br />
<br />
'''setStat( $value, $name, $player_id = null )'''<br />
<br />
Set a statistic $name to $value.<br />
<br />
If "$player_id" is not specified, setStat consider it is a TABLE statistic.<br />
<br />
If "$player_id" is specified, setStat consider it is a PLAYER statistic.<br />
<br />
<br />
'''incStat( $delta, $name, $player_id = null )'''<br />
<br />
Increment (or decrement) specified statistic value by $delta value. Same behavior as setStat function.<br />
<br />
<br />
'''getStat( $name, $player_id = null )'''<br />
<br />
Return the value of statistic specified by $name. Useful when creating derivative statistics such as average.<br />
<br />
== Translations ==<br />
<br />
See [[Translations]]<br />
<br />
== Manage player scores and Tie breaker ==<br />
<br />
=== Normal scoring ===<br />
<br />
At the end of the game, players automatically get a rank depending on their score: the player with the biggest score is #1, the player with the second biggest score is #2, and so on...<br />
<br />
During the game, you update player's score directly by updating "player_score" field of "player" table in database.<br />
<br />
Examples:<br />
<pre><br />
<br />
// +2 points to active player<br />
self::DbQuery( "UPDATE player SET player_score=player_score+2 WHERE player_id='".self::getActivePlayerId()."'" );<br />
<br />
// Set score of active player to 5<br />
self::DbQuery( "UPDATE player SET player_score=5 WHERE player_id='".self::getActivePlayerId()."'" );<br />
<br />
</pre><br />
<br />
Note: don't forget to notify the client side in order the score control can be updated accordingly.<br />
<br />
=== Tie breaker ===<br />
<br />
Tie breaker is used when two players get the same score at the end of a game.<br />
<br />
Tie breaker is using "player_score_aux" field of "player" table. It is updated exactly like the "player_score" field.<br />
<br />
Tie breaker score is displayed only for players who are tied at the end of the game. Most of the time, it is not supposed to be displayed explicitly during the game.<br />
<br />
When you are using "player_score_aux" functionality, you must describe the formula to use in your gameinfos.inc.php file like this:<br />
<br />
<pre><br />
'tie_breaker_description' => totranslate("Describe here your tie breaker formula"),<br />
</pre><br />
<br />
This description will be used as a tooltip to explain to players how this auxiliary score has been calculated.<br />
<br />
=== Co-operative game ===<br />
<br />
To make everyone lose in full-coop game:<br />
<br />
Add the following in gameinfos.inc.php :<br />
'is_coop' => 1, // full cooperative<br />
<br />
And score zero to everyone.<br />
<br />
=== Semi-coop ===<br />
<br />
If the game is not full-coop, then everyone lose = everyone is tie. I.e. set score to 0 to everybody.<br />
<br />
=== One winner only ===<br />
If you need to one person to win and everybody else to lose, set the scores so that the winner has the best score, and the other players have the same (lower) score. Then add the following lines to gameinfos.php:<br />
<br />
<pre><br />
// If in the game, all losers are equal (no score to rank them or explicit in the rules that losers are not ranked between them), set this to true <br />
// The game end result will display "Winner" for the 1st player and "Loser" for all other players<br />
'losers_not_ranked' => true,<br />
</pre><br />
<br />
Quantum and Coup are implemented like this, as you can see here:<br />
* https://boardgamearena.com/#!gamepanel?game=quantum&section=lastresults<br />
* https://boardgamearena.com/#!gamepanel?game=coupcitystate&section=lastresults<br />
<br />
=== Solo ===<br />
<br />
If game supports solo variant, a negative score means defeat, a positive score means victory.<br />
<br />
=== Player elimination ===<br />
<br />
In some games, this is useful to eliminate a player from the game in order he/she can start another game without waiting for the current game end.<br />
<br />
This case should be rare. Please don't use player elimination feature if some player just has to wait the last 10% of the game for game end. This feature should be used only in games where players are eliminated all along the game (typical examples: "Perudo" or "The Werewolves of Miller's Hollow").<br />
<br />
Usage:<br />
<br />
* Player to eliminate should NOT be active anymore (preferably use the feature in a "game" type game state).<br />
* In your PHP code:<br />
self::eliminatePlayer( <player_to_eliminate_id> );<br />
* the player is informed in a dialog box that he no longer have to played and can start another game if he/she wants too (whith buttons "stay at this table" "quit table and back to main site"). In any case, the player is free to tart&join another table from now.<br />
* When your game is over, all players who have been eliminated before receive a "notification" (the small "!" icon on the top right of the BGA interface) that indicate them that "the game has ended" and invite them to review the game results.<br />
<br />
=== Scoring Helper functions ===<br />
<br />
// get score<br />
function dbGetScore($player_id) {<br />
return $this->getUniqueValueFromDB("SELECT player_score FROM player WHERE player_id='$player_id'");<br />
}<br />
<br />
// set score<br />
function dbSetScore($player_id, $count) {<br />
$this->DbQuery("UPDATE player SET player_score='$count' WHERE player_id='$player_id'");<br />
}<br />
<br />
// set aux score (tie breaker)<br />
function dbSetAuxScore($player_id, $score) {<br />
$this->DbQuery("UPDATE player SET player_score_aux=$score WHERE player_id='$player_id'");<br />
}<br />
<br />
// increment score (can be negative too)<br />
function dbIncScore($player_id, $inc) {<br />
$count = $this->dbGetScore($player_id);<br />
if ($inc != 0) {<br />
$count += $inc;<br />
$this->dbSetScore($player_id, $count);<br />
}<br />
return $count;<br />
}<br />
<br />
== Reflexion time ==<br />
<br />
; function giveExtraTime( $player_id, $specific_time=null )<br />
: Give standard extra time to this player.<br />
: Standard extra time depends on the speed of the game (small with "slow" game option, bigger with other options).<br />
: You can also specify an exact time to add, in seconds, with the "specified_time" argument (rarely used).<br />
<br />
== Managing errors and exceptions ==<br />
<br />
Note: when you throw an exception, all database changes and all notifications are cancelled immediately. This way, the game situation that existed before the request is completely restored.<br />
<br />
; throw new BgaUserException ( $error_message)<br />
: Base class to notify a user error<br />
: You must throw this exception when a player wants to do something that he is not allowed to do.<br />
: The error message will be shown to the player as a "red message", so it must be translated.<br />
: Throwing such an exception is NOT considered a bug, so it is not traced in BGA error logs.<br />
<br />
Example from Gomoku:<br />
<pre><br />
throw new BgaUserException( self::_("There is already a stone on this intersection, you can't play there") );<br />
</pre><br />
<br />
<br />
; throw new BgaVisibleSystemException ( $error_message)<br />
: You must throw this exception when you detect something that is not supposed to happened in your code.<br />
: The error message is shown to the user as an "Unexpected error", in order that he can report it in the forum.<br />
: The error message is logged in BGA error logs. If it happens regularly, we will report it to you.<br />
<br />
; throw new BgaSystemException ( $error_message)<br />
: Base class to notify a system exception. The message will be hidden from the user, but show in the logs. Use this if the message contains technical information.<br />
: You shouldn't use this type of exception except if you think the information shown could be critical. Indeed: a generic error message will be shown to the user, so it's going to be difficult for you to see what happened.<br />
<br />
== Zombie mode ==<br />
<br />
When a player leaves a game for any reason (expelled, quit), he becomes a "zombie player". In this case, the results of the game won't count for statistics, but this is cool if the other players can finish the game anyway. That's why zombie mode exists: allow the other player to finish the game, even if the situation is not ideal.<br />
<br />
While developing your zombie mode, keep in mind that:<br />
* Do not refer to the rules, because this situation is not planned by the rules.<br />
* Try to figure that you are playing with your friends and one of them has to leave: how can we finish the game without killing the spirit of the game?<br />
* The idea is NOT to develop an artificial intelligence for the game.<br />
<br />
Most of the time, the best thing to do when it is zombie player turn is to jump immediately to a state where he is not active anymore. For example, if he is in a game state where he has a choice between playing A and playing B, the best thing to do is NOT to choose A or B, but to pass. So, even if there's no "pass" action in the rules, add a "zombiepass" transitition in your game state and use it.<br />
<br />
Each time a zombie player must play, your "zombieTurn" method is called.<br />
<br />
Parameters:<br />
* $state: the name of the current game state.<br />
* $active_player: the id of the active player.<br />
<br />
Most of the time, your zombieTurn method looks like this:<br />
<br />
<pre><br />
function zombieTurn( $state, $active_player )<br />
{<br />
$statename = $state['name'];<br />
<br />
if( $statename == 'myFirstGameState'<br />
|| $statename == 'my2ndGameState'<br />
|| $statename == 'my3rdGameState'<br />
....<br />
)<br />
{<br />
$this->gamestate->nextState( "zombiePass" );<br />
}<br />
else<br />
throw new BgaVisibleSystemException( "Zombie mode not supported at this game state: ".$statename );<br />
}<br />
</pre><br />
<br />
Note that in the example above, all corresponding game state should implement "zombiePass" as a transition.<br />
<br />
<br />
<br />
== Player color preferences ==<br />
<br />
<br />
BGA players (Club members) may now choose their preferred color for playing. For example, if they are used to play green for every board game, they can select "green" in their BGA preferences page.<br />
<br />
Making your game compatible with colors preferences is very easy and requires only 1 line of PHP and 1 configuration change :<br />
<br />
On your gameinfos.inc.php file, add the following lines :<br />
<br />
// Favorite colors support : if set to "true", support attribution of favorite colors based on player's preferences (see reattributeColorsBasedOnPreferences PHP method)<br />
'favorite_colors_support' => true,<br />
<br />
Then, on your main <your_game>.game.php file, find the "reloadPlayersBasicInfos" call in your "setupNewGame" method and replace :<br />
<br />
$sql .= implode( $values, ',' );<br />
self::DbQuery( $sql );<br />
self::reloadPlayersBasicInfos();<br />
<br />
By :<br />
<br />
$sql .= implode( $values, ',' );<br />
self::DbQuery( $sql );<br />
self::reattributeColorsBasedOnPreferences( $players, array( /* LIST HERE THE AVAILABLE COLORS OF YOUR GAME INSTEAD OF THESE ONES */"ff0000", "008000", "0000ff", "ffa500", "773300" ) );<br />
self::reloadPlayersBasicInfos();<br />
<br />
<br />
The "reattributeColorsBasedOnPreferences" method reattributes all colors, taking into account players color preferences and available colors.<br />
<br />
Note that you must update the colors to indicate the colors available for your game.<br />
<br />
2 important remarks :<br />
* for some games (ex : Chess), the color has an influence on a mechanism of the game, most of the time by giving a special advantage to a player (ex : Starting the game). Color preference mechanism must NOT be used in such a case.<br />
* your logic should NEVER consider that the first player has the color X, that the second player has the color Y, and so on. If this is the case, your game will NOT be compatible with reattributeColorsBasedOnPreferences as this method attribute colors to players based on their preferences and not based as their order at the table.<br />
<br />
Colours currently listed as a choice in preferences:<br />
<br />
* #ff0000 Red<br />
* #008000 Green<br />
* #0000ff Blue<br />
* #ffa500 Yellow<br />
* #000000 Black<br />
* #ffffff White<br />
<br />
== Debugging and Tracing ==<br />
<br />
To debug php code you can use some tracing functions available from the parent class such as debug, trace, error, warn, dump.<br />
<br />
self::debug("Ahh!");<br />
self::dump('my_var',$my_var);<br />
<br />
See [[Practical_debugging]] section for complete information about debugging interfaces and where to find logs.</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Main_game_logic:_yourgamename.game.php&diff=3223Main game logic: yourgamename.game.php2018-10-10T09:19:11Z<p>Sourisdudesert: /* bga_rand */</p>
<hr />
<div><br />
This is the main file for your game logic. Here you initialize the game, persist data, implement the rules and notify the client interface of changes.<br />
<br />
== File Structure ==<br />
<br />
The details of how the file is structured are described directly with comments in the code skeleton provided to you.<br />
<br />
Here is the basic structure:<br />
<br />
* EmptyGame (constructor): where you define global variables.<br />
* setupNewGame: initial setup of the game.<br />
* getAllDatas: where you retrieve all game data during a complete reload of the game.<br />
* getGameProgression: where you compute the game progression indicator.<br />
* Utility functions: your utility functions.<br />
* Player actions: the entry points for players actions. <br />
* Game state arguments: methods to return additional data on specific game states ([http://en.doc.boardgamearena.com/Your_game_state_machine:_states.inc.php#args more info here]).<br />
* Game state actions: the logic to run when entering a new game state ([http://en.doc.boardgamearena.com/Your_game_state_machine:_states.inc.php#action more info here]).<br />
* zombieTurn: what to do it's the turn of a zombie player.<br />
<br />
== Accessing player information ==<br />
<br />
; getPlayersNumber()<br />
: Returns the number of players playing at the table<br />
: Note: doesn't work in setupNewGame so use count($players) instead<br />
<br />
; getActivePlayerId()<br />
: Get the "active_player", whatever what is the current state type.<br />
: Note: it does NOT mean that this player is active right now, because state type could be "game" or "multiplayer"<br />
: Note: avoid using this method in a "multiplayer" state because it does not mean anything.<br />
<br />
; getActivePlayerName()<br />
: Get the "active_player" name<br />
: Note: avoid using this method in a "multiplayer" state because it does not mean anything.<br />
<br />
; loadPlayersBasicInfos()<br />
: Get an associative array with generic data about players (ie: not game specific data).<br />
: The key of the associative array is the player id. The returned table is cached, so ok to call multiple times without performance concerns.<br />
: The content of each value is:<br />
: * player_name - the name of the player<br />
: * player_color (ex: ff0000) - the color code of the player<br />
: * player_no - the position of the player at the start of the game in natural table order, i.e. 1,2,3<br />
<br />
; getCurrentPlayerId()<br />
: Get the "current_player". The current player is the one from which the action originated (the one who send the request).<br />
: '''Be careful''': It is not always the active player.<br />
: In general, you shouldn't use this method, unless you are in "multiplayer" state.<br />
<br />
; getCurrentPlayerName()<br />
: Get the "current_player" name<br />
: Be careful using this method (see above).<br />
<br />
; getCurrentPlayerColor()<br />
: Get the "current_player" color<br />
: Be careful using this method (see above).<br />
<br />
; isCurrentPlayerZombie()<br />
: Check the "current_player" zombie status. If true, player is zombie, i.e. left or was kicked out of the game.<br />
<br />
== Accessing the database ==<br />
<br />
The main game logic should be the only point from which you should access the game database. You access your database using SQL queries with the methods below.<br />
<br />
'''IMPORTANT'''<br />
<br />
BGA uses [http://dev.mysql.com/doc/refman/5.0/en/sql-syntax-transactions.html database transactions]. This means that your database changes WON'T BE APPLIED to the database until your request ends normally. Using transactions is in fact very useful for you; at any time, if your game logic detects that something is wrong (example: a disallowed move), you just have to throw an exception and all changes to the game situation will be removed.<br />
<br />
; DbQuery( $sql )<br />
: This is the generic method to access the database.<br />
: It can execute any type of SELECT/UPDATE/DELETE/REPLACE query on the database.<br />
: You should use it for UPDATE/DELETE/REPLACE queries. For SELECT queries, the specialized methods below are much better.<br />
<br />
; getUniqueValueFromDB( $sql )<br />
: Returns a unique value from DB or null if no value is found.<br />
: $sql must be a SELECT query.<br />
: Raise an exception if more than 1 row is returned.<br />
<br />
; getCollectionFromDB( $sql, $bSingleValue=false )<br />
: Returns an associative array of rows for a sql SELECT query.<br />
: The key of the resulting associative array is the first field specified in the SELECT query.<br />
: The value of the resulting associative array if an associative array with all the field specified in the SELECT query and associated values.<br />
: First column must be a primary or alternate key.<br />
: The resulting collection can be empty.<br />
: If you specified $bSingleValue=true and if your SQL query request 2 fields A and B, the method returns an associative array "A=>B"<br />
<br />
Example 1:<br />
<pre><br />
self::getCollectionFromDB( "SELECT player_id id, player_name name, player_score score FROM player" );<br />
<br />
Result:<br />
array(<br />
1234 => array( 'id'=>1234, 'name'=>'myuser0', 'score'=>1 ),<br />
1235 => array( 'id'=>1235, 'name'=>'myuser1', 'score'=>0 )<br />
)<br />
</pre><br />
Example 2:<br />
<pre><br />
self::getCollectionFromDB( "SELECT player_id id, player_name name FROM player", true );<br />
<br />
Result:<br />
array(<br />
1234 => 'myuser0',<br />
1235 => 'myuser1'<br />
)<br />
<br />
</pre><br />
<br />
; getNonEmptyCollectionFromDB( $sql )<br />
: Idem than previous one, but raise an exception if the collection is empty<br />
<br />
; getObjectFromDB( $sql )<br />
: Returns one row for the sql SELECT query as an associative array or null if there is no result<br />
: Raise an exception if the query return more than one row<br />
<br />
Example:<br />
<pre><br />
self::getObjectFromDB( "SELECT player_id id, player_name name, player_score score FROM player WHERE player_id='$player_id'" );<br />
<br />
Result:<br />
array(<br />
'id'=>1234, 'name'=>'myuser0', 'score'=>1 <br />
)<br />
</pre><br />
<br />
; getNonEmptyObjectFromDB( $sql )<br />
: Idem than previous one, but raise an exception if no row is found<br />
<br />
; getObjectListFromDB( $sql, $bUniqueValue=false )<br />
: Return an array of rows for a sql SELECT query.<br />
: the result if the same than "getCollectionFromDB" except that the result is a simple array (and not an associative array).<br />
: The result can be empty.<br />
: If you specified $bUniqueValue=true and if your SQL query request 1 field, the method returns directly an array of values.<br />
<br />
Example 1:<br />
<pre><br />
self::getObjectListFromDB( "SELECT player_id id, player_name name, player_score score FROM player" );<br />
<br />
Result:<br />
array(<br />
array( 'id'=>1234, 'name'=>'myuser0', 'score'=>1 ),<br />
array( 'id'=>1235, 'name'=>'myuser1', 'score'=>0 )<br />
)<br />
</pre><br />
Example 2:<br />
<pre><br />
self::getObjectListFromDB( "SELECT player_name name FROM player", true );<br />
<br />
Result:<br />
array(<br />
'myuser0',<br />
'myuser1'<br />
)<br />
<br />
</pre><br />
<br />
; getDoubleKeyCollectionFromDB( $sql, $bSingleValue=false )<br />
: Return an associative array of associative array, from a SQL SELECT query.<br />
: First array level correspond to first column specified in SQL query.<br />
: Second array level correspond to second column specified in SQL query.<br />
: If bSingleValue = true, keep only third column on result<br />
<br />
<br />
; DbGetLastId()<br />
: Return the PRIMARY key of the last inserted row (see PHP mysql_insert_id function).<br />
<br />
; DbAffectedRow()<br />
: Return the number of row affected by the last operation<br />
<br />
; escapeStringForDB( $string )<br />
: You must use this function on every string type data in your database that contains unsafe data.<br />
: (unsafe = can be modified by a player).<br />
: This method makes sure that no SQL injection will be done through the string used.<br />
: Note: if you using standard types in ajax actions, like AT_alphanum it is sanitized before arrival,<br />
: this is only needed if you manage to get unchecked string, like in the games where user has to enter text as a response.<br />
<br />
<pre><br />
<br />
<br />
</pre><br />
<br />
Note: see Editing [[Game database model: dbmodel.sql]] to know how to define your database model.<br />
<br />
== Use globals ==<br />
<br />
Sometimes, you have to keep a single integer value that is global to your game, and you don't want to create a DB table specifically for it.<br />
<br />
Using a BGA framework "global", you can do such a thing. Your value will be stored in the "global" table in database, and you can access it with simple methods.<br />
<br />
'''initGameStateLabels'''<br />
<br />
This method is located at the beginning of your game logic. This is the place you defines the globals used in your game logic, by assigning them IDs.<br />
<br />
You can define up to 79 globals, with IDs from 10 to 89. You must NOT use globals outside this range as globals are used by other components of the framework.<br />
<br />
<pre><br />
self::initGameStateLabels( array( <br />
"my_first_global_variable" => 10,<br />
"my_second_global_variable" => 11<br />
) );<br />
</pre><br />
<br />
'''setGameStateInitialValue( $value_label, $value_value )'''<br />
<br />
Init your global value. Must be called before any use of your global, so you should call this method from your "setupNewGame" method.<br />
<br />
'''getGameStateValue( $value_label )'''<br />
<br />
Retrieve the current value of a global.<br />
<br />
'''setGameStateValue( $value_label, $value_value )'''<br />
<br />
Set the current value of a global.<br />
<br />
'''incGameStateValue( $value_label, $increment )'''<br />
<br />
Increment the current value of a global. If increment is negative, decrement the value of the global.<br />
<br />
Return the final value of the global.<br />
<br />
== Game states and active players ==<br />
<br />
<br />
=== Activate player handling ===<br />
<br />
; $this->activeNextPlayer()<br />
: Make the next player active in the natural player order.<br />
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.<br />
<br />
; $this->activePrevPlayer()<br />
: Make the previous player active (in the natural player order).<br />
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.<br />
<br />
; $this->gamestate->changeActivePlayer( $player_id )<br />
: You can call this method to make any player active.<br />
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.<br />
<br />
; $this->getActivePlayerId()<br />
: Return the "active_player" id<br />
: Note: it does NOT mean that this player is active right now, because state type could be "game" or "multiplayer"<br />
<br />
=== Multiactivate player handling ===<br />
<br />
; $this->gamestate->setAllPlayersMultiactive()<br />
: All playing players are made active. Update notification is sent to all players (triggers onUpdateActionButtons).<br />
: Usually, you use this method at the beginning (ex: "st" action method) of a multiplayer game state when all players have to do some action.<br />
<br />
; $this->gamestate->setAllPlayersNonMultiactive( $next_state )<br />
: All playing players are made inactive. Transition to next state<br />
<br />
; $this->gamestate->setPlayersMultiactive( $players, $next_state, $bExclusive = false )<br />
: Make a specific list of players active during a multiactive gamestate. Update notification is sent to all players who's state changed.<br />
: "players" is the array of player id that should be made active.<br />
: If "exclusive" parameter is not set or false it doesn't deactivate other previously active players. If its set to true, the players who will be multiactive at the end are only these in "$layers" array<br />
<br />
: In case "players" is empty, the method trigger the "next_state" transition to go to the next game state.<br />
: returns true if state transition happened, false otherwise<br />
<br />
; $this->gamestate->setPlayerNonMultiactive( $player_id, $next_state )<br />
: During a multiactive game state, make the specified player inactive.<br />
: Usually, you call this method during a multiactive game state after a player did his action.<br />
: If this player was the last active player, the method trigger the "next_state" transition to go to the next game state.<br />
: returns true if state transition happened, false otherwise<br />
<br />
; $this->gamestate->updateMultiactiveOrNextState( $next_state_if_none )<br />
: Sends update notification about multiplayer changes. All multiactive set* functions above do that, however if you want to change state manually using db queries for complex calculations, you have to call this yourself after. Do not call this if you calling one of the other setters above.<br />
Example: you have player teams and you want to activate all players in one team<br />
<pre><br />
$sql = "UPDATE player SET player_is_multiactive='0'";<br />
self::DbQuery( $sql );<br />
$sql = "UPDATE player SET player_is_multiactive='1' WHERE player_id='$player_id' AND player_team='$team_no'";<br />
self::DbQuery( $sql );<br />
<br />
$this->gamestate->updateMultiactiveOrNextState( 'error' );<br />
</pre><br />
<br />
; $this->gamestate->getActivePlayerList()<br />
: With this method you can retrieve the list of the active player at any time.<br />
: During a "game" type gamestate, it will return a void array.<br />
: During a "activeplayer" type gamestate, it will return an array with one value (the active player id).<br />
: During a "multipleactiveplayer" type gamestate, it will return an array of the active players id.<br />
: Note: you should only use this method is the latter case.<br />
<br />
=== States functions ===<br />
; $this->gamestate->nextState( $transition )<br />
: Change current state to a new state. Important: parameter $transition is the name of the transition, and NOT the name of the target game state, see [[Your game state machine: states.inc.php]] for more information about states.<br />
<br />
; $this->checkAction( $actionName, $bThrowException=true )<br />
: Check if action is valid regarding current game state (exception if fails).<br />
: The action is valid if it is listed as a "possibleactions" in the current game state (see game state description).<br />
: This method MUST be called in the first place in ALL your PHP methods that handle players action, in order to make sure a player can't do an action when the rules disallow it at this moment of the game.<br />
: if "bThrowException" is set to "false", the function return false in case of failure instead of throwing and exception. This is useful when several actions are possible in order to test each of them without throwing exceptions.<br />
<br />
; $this->gamestate->checkPossibleAction( $action )<br />
: (rarely used)<br />
: This works exactly like "checkAction", except that it do NOT check if current player is active.<br />
: This is used specifically in certain game states when you want to authorize some additional actions for players that are not active at the moment.<br />
: Example: in Libertalia game, you want to authorize players to change their mind about card played. They are of course not active at the time they change their mind, so you cannot use "checkAction" and use "checkPossibleAction" instead.<br />
<br />
; $this->gamestate->state()<br />
: Get an associative array of current game state attributes, see [[Your game state machine: states.inc.php]] for state attributes.<br />
$state=$this->gamestate->state(); if( $state['name'] == 'myGameState' ) {...}<br />
<br />
== Players turn order ==<br />
<br />
'''getNextPlayerTable()'''<br />
<br />
Return an associative array which associate each player with the next player around the table.<br />
<br />
In addition, key 0 is associated to the first player to play.<br />
<br />
Example: if three player with ID 1, 2 and 3 are around the table, in this order, the method returns:<br />
<pre><br />
array( <br />
1 => 2, <br />
2 => 3, <br />
3 => 1, <br />
0 => 1 <br />
);<br />
</pre><br />
<br />
'''getPrevPlayerTable()'''<br />
<br />
Same as above, but the associative array associate the previous player around the table.<br />
<br />
'''getPlayerAfter( $player_id )'''<br />
<br />
Get player playing after given player in natural playing order.<br />
<br />
'''getPlayerBefore( $player_id )'''<br />
<br />
Get player playing before given player in natural playing order.<br />
<br />
Note: There is no API to modify this order, if you have custom player order you have to maintain it in your database<br />
and have custom function to access it.<br />
<br />
== Notify players ==<br />
<br />
To understand notifications, please read [http://www.slideshare.net/boardgamearena/the-bga-framework-at-a-glance The BGA Framework at a glance] first.<br />
<br />
'''IMPORTANT'''<br />
<br />
Notifications are sent at the very end of the request, when it ends normally. It means that if you throw an exception for any reason (ex: move not allowed), no notifications will be sent to players.<br />
Notifications sent between the game start (setupNewGame) and the end of the "action" method of the first active state will never reach their destination.<br />
<br />
'''notifyAllPlayers( $notification_type, $notification_log, $notification_args )'''<br />
<br />
Send a notification to all players of the game.<br />
<br />
* notification_type:<br />
A string that defines the type of your notification.<br />
<br />
Your game interface Javascript logic will use this to know what is the type of the received notification (and to trigger the corresponding method).<br />
<br />
* notification_log:<br />
A string that defines what is to be displayed in the game log.<br />
<br />
You can use an empty string here (""). In this case, nothing is displayed in the game log.<br />
<br />
If you define a real string here, you should use "clienttranslate" method to make sure it can be translate.<br />
<br />
You can use arguments in your notification_log strings, that refers to values defines in the "notification_args" argument (see below). <br />
Note: Make sure you only use single quotes ('), otherwise PHP will try to interpolate the variable and will ignore the values in the args array.<br />
<br />
<br />
<br />
* notification_args:<br />
The arguments of your notifications, as an associative array.<br />
<br />
This array will be transmitted to the game interface logic, in order the game interface can be updated.<br />
<br />
Complete notifyAllPlayers example (from "Reversi"):<br />
<br />
<pre><br />
self::notifyAllPlayers( "playDisc", clienttranslate( '${player_name} plays a disc and turns over ${returned_nbr} disc(s)' ),<br />
array(<br />
'player_id' => $player_id,<br />
'player_name' => self::getActivePlayerName(),<br />
'returned_nbr' => count( $turnedOverDiscs ),<br />
'x' => $x,<br />
'y' => $y<br />
) );<br />
</pre><br />
<br />
You can see in the example above the use of the "clienttranslate" method, and the use of 2 arguments "player_name" and "returned_nbr" in the notification log.<br />
<br />
Important: NO private data must be sent with this method, as a cheater could see it even it is not used explicitly by the game interface logic. If you want to send private information to a player, please use notifyPlayer below.<br />
<br />
Note: you CAN use some HTML inside your notification log, however it not recommended for many reasons:<br />
* Its bad architecture, ui elements leak into server now you have to manage ui in many places<br />
* If you decided to change something in ui in future version, old games reply and tutorials may not work, since they use stored notifications<br />
* When you read log preview for old games its unreadable (this is log before you enter the game reply, useful for troubleshooting or game analysis)<br />
* Its more data to transfer and store in db<br />
* Its nightmare for translators, at least don't put HTML tags inside the "clienttranslate" method. You can use a notification argument instead, and provide your HTML through this argument.<br />
<br />
If you still want to have pretty pictures in the log check this [[BGA_Studio_Cookbook#Inject_images_and_styled_html_in_the_log]].<br />
<br />
If your notification contains some phrases that build programmatically you may need to use recursive notifications. In this case the argument can be not only the string but<br />
an array itself, which contains 'log' and 'args', i.e.<br />
<br />
$this->notifyAllPlayers('playerLog',clienttranslate('Game moves ${token_name_rec}'),<br />
['token_name_rec'=>['log'=>'${token_name} #${token_number}',<br />
'args'=> ['token_name'=>clienttranslate('Boo'), 'token_number'=>$number, 'i18n'=>['token_name'] ]<br />
]<br />
]);<br />
<br />
<br />
<br />
'''notifyPlayer( $player_id, $notification_type, $notification_log, $notification_args )'''<br />
<br />
Same as above, except that the notification is sent to one player only.<br />
<br />
This method must be used each time some private information must be transmitted to a player.<br />
<br />
Important: the variable for player name must be ${player_name} in order to be highlighted with the player color in the game log<br />
<br />
== About random and randomness ==<br />
<br />
A large number of board games rely on random, most often based on dice, cards shuffling, picking some item in a bag, and so on. This is very important to ensure a high level of randomness for each of these situations.<br />
<br />
Here's are a list of techniques you should use in these situations, from the best to the worst.<br />
<br />
=== Dices and bga_rand ===<br />
<br />
'''bga_rand( min, max )''' <br />
This is a BGA framework function that provides you a random number between "min" and "max" (included), using the best available random method available on the system.<br />
<br />
This is the preferred function you should use, because we are updating it when a better method is introduced.<br />
<br />
At now, bga_rand is based on the PHP function "random_int", which ensure a cryptographic level of randomness.<br />
<br />
In particular, it is '''mandatory''' to use it for all '''dice throw''' (ie: games using other methods for dice throwing will be rejected by BGA during review).<br />
<br />
Note: rand() and mt_rand() are deprecated on BGA and should not be used anymore, as their randomness is not as good as "bga_rand".<br />
<br />
=== shuffle and cards shuffling ===<br />
<br />
To shuffle items, like a pile of cards, the best way is to use the BGA PHP [[Deck]] component and to use "shuffle" method. This ensure you that the best available shuffling method is used, and that if in the future we improve it your game will be up to date.<br />
<br />
At now, the Deck component shuffle method is based on PHP "shuffle" method, which has a quite good randomness (even it is not as good as bga_rand). In consequence, we accept other shuffling methods during reviews, as long as their are based on PHP "shuffle" function (or similar, like "array_rand").<br />
<br />
== Game statistics ==<br />
<br />
There are 2 types of statistics:<br />
* a "player" statistic is a statistic associated to a player<br />
* a "table" statistics is a statistic not associated to a player (global statistic for this game).<br />
<br />
See [[Game statistics: stats.inc.php]] to see how you defines statistics for your game.<br />
<br />
<br />
'''initStat( $table_or_player, $name, $value, $player_id = null )'''<br />
<br />
Create a statistic entry with a default value.<br />
This method must be called for each statistics of your game, in your setupNewGame method.<br />
<br />
'$table_or_player' must be set to "table" if this is a table statistics, or "player" if this is a player statistics.<br />
<br />
'$name' is the name of your statistics, as it has been defined in your stats.inc.php file.<br />
<br />
'$value' is the initial value of the statistics. If this is a player statistics and if the player is not specified by "$player_id" argument, the value is set for ALL players.<br />
<br />
<br />
'''setStat( $value, $name, $player_id = null )'''<br />
<br />
Set a statistic $name to $value.<br />
<br />
If "$player_id" is not specified, setStat consider it is a TABLE statistic.<br />
<br />
If "$player_id" is specified, setStat consider it is a PLAYER statistic.<br />
<br />
<br />
'''incStat( $delta, $name, $player_id = null )'''<br />
<br />
Increment (or decrement) specified statistic value by $delta value. Same behavior as setStat function.<br />
<br />
<br />
'''getStat( $name, $player_id = null )'''<br />
<br />
Return the value of statistic specified by $name. Useful when creating derivative statistics such as average.<br />
<br />
== Translations ==<br />
<br />
See [[Translations]]<br />
<br />
== Manage player scores and Tie breaker ==<br />
<br />
=== Normal scoring ===<br />
<br />
At the end of the game, players automatically get a rank depending on their score: the player with the biggest score is #1, the player with the second biggest score is #2, and so on...<br />
<br />
During the game, you update player's score directly by updating "player_score" field of "player" table in database.<br />
<br />
Examples:<br />
<pre><br />
<br />
// +2 points to active player<br />
self::DbQuery( "UPDATE player SET player_score=player_score+2 WHERE player_id='".self::getActivePlayerId()."'" );<br />
<br />
// Set score of active player to 5<br />
self::DbQuery( "UPDATE player SET player_score=5 WHERE player_id='".self::getActivePlayerId()."'" );<br />
<br />
</pre><br />
<br />
Note: don't forget to notify the client side in order the score control can be updated accordingly.<br />
<br />
=== Tie breaker ===<br />
<br />
Tie breaker is used when two players get the same score at the end of a game.<br />
<br />
Tie breaker is using "player_score_aux" field of "player" table. It is updated exactly like the "player_score" field.<br />
<br />
Tie breaker score is displayed only for players who are tied at the end of the game. Most of the time, it is not supposed to be displayed explicitly during the game.<br />
<br />
When you are using "player_score_aux" functionality, you must describe the formula to use in your gameinfos.inc.php file like this:<br />
<br />
<pre><br />
'tie_breaker_description' => totranslate("Describe here your tie breaker formula"),<br />
</pre><br />
<br />
This description will be used as a tooltip to explain to players how this auxiliary score has been calculated.<br />
<br />
=== Co-operative game ===<br />
<br />
To make everyone lose in full-coop game:<br />
<br />
Add the following in gameinfos.inc.php :<br />
'is_coop' => 1, // full cooperative<br />
<br />
And score zero to everyone.<br />
<br />
=== Semi-coop ===<br />
<br />
If the game is not full-coop, then everyone lose = everyone is tie. I.e. set score to 0 to everybody.<br />
<br />
=== One winner only ===<br />
If you need to one person to win and everybody else to lose, set the scores so that the winner has the best score, and the other players have the same (lower) score. Then add the following lines to gameinfos.php:<br />
<br />
<pre><br />
// If in the game, all losers are equal (no score to rank them or explicit in the rules that losers are not ranked between them), set this to true <br />
// The game end result will display "Winner" for the 1st player and "Loser" for all other players<br />
'losers_not_ranked' => true,<br />
</pre><br />
<br />
Quantum and Coup are implemented like this, as you can see here:<br />
* https://boardgamearena.com/#!gamepanel?game=quantum&section=lastresults<br />
* https://boardgamearena.com/#!gamepanel?game=coupcitystate&section=lastresults<br />
<br />
=== Solo ===<br />
<br />
If game supports solo variant, a negative score means defeat, a positive score means victory.<br />
<br />
=== Player elimination ===<br />
<br />
In some games, this is useful to eliminate a player from the game in order he/she can start another game without waiting for the current game end.<br />
<br />
This case should be rare. Please don't use player elimination feature if some player just has to wait the last 10% of the game for game end. This feature should be used only in games where players are eliminated all along the game (typical examples: "Perudo" or "The Werewolves of Miller's Hollow").<br />
<br />
Usage:<br />
<br />
* Player to eliminate should NOT be active anymore (preferably use the feature in a "game" type game state).<br />
* In your PHP code:<br />
self::eliminatePlayer( <player_to_eliminate_id> );<br />
* the player is informed in a dialog box that he no longer have to played and can start another game if he/she wants too (whith buttons "stay at this table" "quit table and back to main site"). In any case, the player is free to tart&join another table from now.<br />
* When your game is over, all players who have been eliminated before receive a "notification" (the small "!" icon on the top right of the BGA interface) that indicate them that "the game has ended" and invite them to review the game results.<br />
<br />
=== Scoring Helper functions ===<br />
<br />
// get score<br />
function dbGetScore($player_id) {<br />
return $this->getUniqueValueFromDB("SELECT player_score FROM player WHERE player_id='$player_id'");<br />
}<br />
<br />
// set score<br />
function dbSetScore($player_id, $count) {<br />
$this->DbQuery("UPDATE player SET player_score='$count' WHERE player_id='$player_id'");<br />
}<br />
<br />
// set aux score (tie breaker)<br />
function dbSetAuxScore($player_id, $score) {<br />
$this->DbQuery("UPDATE player SET player_score_aux=$score WHERE player_id='$player_id'");<br />
}<br />
<br />
// increment score (can be negative too)<br />
function dbIncScore($player_id, $inc) {<br />
$count = $this->dbGetScore($player_id);<br />
if ($inc != 0) {<br />
$count += $inc;<br />
$this->dbSetScore($player_id, $count);<br />
}<br />
return $count;<br />
}<br />
<br />
== Reflexion time ==<br />
<br />
; function giveExtraTime( $player_id, $specific_time=null )<br />
: Give standard extra time to this player.<br />
: Standard extra time depends on the speed of the game (small with "slow" game option, bigger with other options).<br />
: You can also specify an exact time to add, in seconds, with the "specified_time" argument (rarely used).<br />
<br />
== Managing errors and exceptions ==<br />
<br />
Note: when you throw an exception, all database changes and all notifications are cancelled immediately. This way, the game situation that existed before the request is completely restored.<br />
<br />
; throw new BgaUserException ( $error_message)<br />
: Base class to notify a user error<br />
: You must throw this exception when a player wants to do something that he is not allowed to do.<br />
: The error message will be shown to the player as a "red message", so it must be translated.<br />
: Throwing such an exception is NOT considered a bug, so it is not traced in BGA error logs.<br />
<br />
Example from Gomoku:<br />
<pre><br />
throw new BgaUserException( self::_("There is already a stone on this intersection, you can't play there") );<br />
</pre><br />
<br />
<br />
; throw new BgaVisibleSystemException ( $error_message)<br />
: You must throw this exception when you detect something that is not supposed to happened in your code.<br />
: The error message is shown to the user as an "Unexpected error", in order that he can report it in the forum.<br />
: The error message is logged in BGA error logs. If it happens regularly, we will report it to you.<br />
<br />
; throw new BgaSystemException ( $error_message)<br />
: Base class to notify a system exception. The message will be hidden from the user, but show in the logs. Use this if the message contains technical information.<br />
: You shouldn't use this type of exception except if you think the information shown could be critical. Indeed: a generic error message will be shown to the user, so it's going to be difficult for you to see what happened.<br />
<br />
== Zombie mode ==<br />
<br />
When a player leaves a game for any reason (expelled, quit), he becomes a "zombie player". In this case, the results of the game won't count for statistics, but this is cool if the other players can finish the game anyway. That's why zombie mode exists: allow the other player to finish the game, even if the situation is not ideal.<br />
<br />
While developing your zombie mode, keep in mind that:<br />
* Do not refer to the rules, because this situation is not planned by the rules.<br />
* Try to figure that you are playing with your friends and one of them has to leave: how can we finish the game without killing the spirit of the game?<br />
* The idea is NOT to develop an artificial intelligence for the game.<br />
<br />
Most of the time, the best thing to do when it is zombie player turn is to jump immediately to a state where he is not active anymore. For example, if he is in a game state where he has a choice between playing A and playing B, the best thing to do is NOT to choose A or B, but to pass. So, even if there's no "pass" action in the rules, add a "zombiepass" transitition in your game state and use it.<br />
<br />
Each time a zombie player must play, your "zombieTurn" method is called.<br />
<br />
Parameters:<br />
* $state: the name of the current game state.<br />
* $active_player: the id of the active player.<br />
<br />
Most of the time, your zombieTurn method looks like this:<br />
<br />
<pre><br />
function zombieTurn( $state, $active_player )<br />
{<br />
$statename = $state['name'];<br />
<br />
if( $statename == 'myFirstGameState'<br />
|| $statename == 'my2ndGameState'<br />
|| $statename == 'my3rdGameState'<br />
....<br />
)<br />
{<br />
$this->gamestate->nextState( "zombiePass" );<br />
}<br />
else<br />
throw new BgaVisibleSystemException( "Zombie mode not supported at this game state: ".$statename );<br />
}<br />
</pre><br />
<br />
Note that in the example above, all corresponding game state should implement "zombiePass" as a transition.<br />
<br />
<br />
<br />
== Player color preferences ==<br />
<br />
<br />
BGA players (Club members) may now choose their preferred color for playing. For example, if they are used to play green for every board game, they can select "green" in their BGA preferences page.<br />
<br />
Making your game compatible with colors preferences is very easy and requires only 1 line of PHP and 1 configuration change :<br />
<br />
On your gameinfos.inc.php file, add the following lines :<br />
<br />
// Favorite colors support : if set to "true", support attribution of favorite colors based on player's preferences (see reattributeColorsBasedOnPreferences PHP method)<br />
'favorite_colors_support' => true,<br />
<br />
Then, on your main <your_game>.game.php file, find the "reloadPlayersBasicInfos" call in your "setupNewGame" method and replace :<br />
<br />
$sql .= implode( $values, ',' );<br />
self::DbQuery( $sql );<br />
self::reloadPlayersBasicInfos();<br />
<br />
By :<br />
<br />
$sql .= implode( $values, ',' );<br />
self::DbQuery( $sql );<br />
self::reattributeColorsBasedOnPreferences( $players, array( /* LIST HERE THE AVAILABLE COLORS OF YOUR GAME INSTEAD OF THESE ONES */"ff0000", "008000", "0000ff", "ffa500", "773300" ) );<br />
self::reloadPlayersBasicInfos();<br />
<br />
<br />
The "reattributeColorsBasedOnPreferences" method reattributes all colors, taking into account players color preferences and available colors.<br />
<br />
Note that you must update the colors to indicate the colors available for your game.<br />
<br />
2 important remarks :<br />
* for some games (ex : Chess), the color has an influence on a mechanism of the game, most of the time by giving a special advantage to a player (ex : Starting the game). Color preference mechanism must NOT be used in such a case.<br />
* your logic should NEVER consider that the first player has the color X, that the second player has the color Y, and so on. If this is the case, your game will NOT be compatible with reattributeColorsBasedOnPreferences as this method attribute colors to players based on their preferences and not based as their order at the table.<br />
<br />
Colours currently listed as a choice in preferences:<br />
<br />
* #ff0000 Red<br />
* #008000 Green<br />
* #0000ff Blue<br />
* #ffa500 Yellow<br />
* #000000 Black<br />
* #ffffff White<br />
<br />
== Debugging and Tracing ==<br />
<br />
To debug php code you can use some tracing functions available from the parent class such as debug, trace, error, warn, dump.<br />
<br />
self::debug("Ahh!");<br />
self::dump('my_var',$my_var);<br />
<br />
See [[Practical_debugging]] section for complete information about debugging interfaces and where to find logs.</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Main_game_logic:_yourgamename.game.php&diff=3222Main game logic: yourgamename.game.php2018-10-10T09:18:57Z<p>Sourisdudesert: /* About random and randomness */</p>
<hr />
<div><br />
This is the main file for your game logic. Here you initialize the game, persist data, implement the rules and notify the client interface of changes.<br />
<br />
== File Structure ==<br />
<br />
The details of how the file is structured are described directly with comments in the code skeleton provided to you.<br />
<br />
Here is the basic structure:<br />
<br />
* EmptyGame (constructor): where you define global variables.<br />
* setupNewGame: initial setup of the game.<br />
* getAllDatas: where you retrieve all game data during a complete reload of the game.<br />
* getGameProgression: where you compute the game progression indicator.<br />
* Utility functions: your utility functions.<br />
* Player actions: the entry points for players actions. <br />
* Game state arguments: methods to return additional data on specific game states ([http://en.doc.boardgamearena.com/Your_game_state_machine:_states.inc.php#args more info here]).<br />
* Game state actions: the logic to run when entering a new game state ([http://en.doc.boardgamearena.com/Your_game_state_machine:_states.inc.php#action more info here]).<br />
* zombieTurn: what to do it's the turn of a zombie player.<br />
<br />
== Accessing player information ==<br />
<br />
; getPlayersNumber()<br />
: Returns the number of players playing at the table<br />
: Note: doesn't work in setupNewGame so use count($players) instead<br />
<br />
; getActivePlayerId()<br />
: Get the "active_player", whatever what is the current state type.<br />
: Note: it does NOT mean that this player is active right now, because state type could be "game" or "multiplayer"<br />
: Note: avoid using this method in a "multiplayer" state because it does not mean anything.<br />
<br />
; getActivePlayerName()<br />
: Get the "active_player" name<br />
: Note: avoid using this method in a "multiplayer" state because it does not mean anything.<br />
<br />
; loadPlayersBasicInfos()<br />
: Get an associative array with generic data about players (ie: not game specific data).<br />
: The key of the associative array is the player id. The returned table is cached, so ok to call multiple times without performance concerns.<br />
: The content of each value is:<br />
: * player_name - the name of the player<br />
: * player_color (ex: ff0000) - the color code of the player<br />
: * player_no - the position of the player at the start of the game in natural table order, i.e. 1,2,3<br />
<br />
; getCurrentPlayerId()<br />
: Get the "current_player". The current player is the one from which the action originated (the one who send the request).<br />
: '''Be careful''': It is not always the active player.<br />
: In general, you shouldn't use this method, unless you are in "multiplayer" state.<br />
<br />
; getCurrentPlayerName()<br />
: Get the "current_player" name<br />
: Be careful using this method (see above).<br />
<br />
; getCurrentPlayerColor()<br />
: Get the "current_player" color<br />
: Be careful using this method (see above).<br />
<br />
; isCurrentPlayerZombie()<br />
: Check the "current_player" zombie status. If true, player is zombie, i.e. left or was kicked out of the game.<br />
<br />
== Accessing the database ==<br />
<br />
The main game logic should be the only point from which you should access the game database. You access your database using SQL queries with the methods below.<br />
<br />
'''IMPORTANT'''<br />
<br />
BGA uses [http://dev.mysql.com/doc/refman/5.0/en/sql-syntax-transactions.html database transactions]. This means that your database changes WON'T BE APPLIED to the database until your request ends normally. Using transactions is in fact very useful for you; at any time, if your game logic detects that something is wrong (example: a disallowed move), you just have to throw an exception and all changes to the game situation will be removed.<br />
<br />
; DbQuery( $sql )<br />
: This is the generic method to access the database.<br />
: It can execute any type of SELECT/UPDATE/DELETE/REPLACE query on the database.<br />
: You should use it for UPDATE/DELETE/REPLACE queries. For SELECT queries, the specialized methods below are much better.<br />
<br />
; getUniqueValueFromDB( $sql )<br />
: Returns a unique value from DB or null if no value is found.<br />
: $sql must be a SELECT query.<br />
: Raise an exception if more than 1 row is returned.<br />
<br />
; getCollectionFromDB( $sql, $bSingleValue=false )<br />
: Returns an associative array of rows for a sql SELECT query.<br />
: The key of the resulting associative array is the first field specified in the SELECT query.<br />
: The value of the resulting associative array if an associative array with all the field specified in the SELECT query and associated values.<br />
: First column must be a primary or alternate key.<br />
: The resulting collection can be empty.<br />
: If you specified $bSingleValue=true and if your SQL query request 2 fields A and B, the method returns an associative array "A=>B"<br />
<br />
Example 1:<br />
<pre><br />
self::getCollectionFromDB( "SELECT player_id id, player_name name, player_score score FROM player" );<br />
<br />
Result:<br />
array(<br />
1234 => array( 'id'=>1234, 'name'=>'myuser0', 'score'=>1 ),<br />
1235 => array( 'id'=>1235, 'name'=>'myuser1', 'score'=>0 )<br />
)<br />
</pre><br />
Example 2:<br />
<pre><br />
self::getCollectionFromDB( "SELECT player_id id, player_name name FROM player", true );<br />
<br />
Result:<br />
array(<br />
1234 => 'myuser0',<br />
1235 => 'myuser1'<br />
)<br />
<br />
</pre><br />
<br />
; getNonEmptyCollectionFromDB( $sql )<br />
: Idem than previous one, but raise an exception if the collection is empty<br />
<br />
; getObjectFromDB( $sql )<br />
: Returns one row for the sql SELECT query as an associative array or null if there is no result<br />
: Raise an exception if the query return more than one row<br />
<br />
Example:<br />
<pre><br />
self::getObjectFromDB( "SELECT player_id id, player_name name, player_score score FROM player WHERE player_id='$player_id'" );<br />
<br />
Result:<br />
array(<br />
'id'=>1234, 'name'=>'myuser0', 'score'=>1 <br />
)<br />
</pre><br />
<br />
; getNonEmptyObjectFromDB( $sql )<br />
: Idem than previous one, but raise an exception if no row is found<br />
<br />
; getObjectListFromDB( $sql, $bUniqueValue=false )<br />
: Return an array of rows for a sql SELECT query.<br />
: the result if the same than "getCollectionFromDB" except that the result is a simple array (and not an associative array).<br />
: The result can be empty.<br />
: If you specified $bUniqueValue=true and if your SQL query request 1 field, the method returns directly an array of values.<br />
<br />
Example 1:<br />
<pre><br />
self::getObjectListFromDB( "SELECT player_id id, player_name name, player_score score FROM player" );<br />
<br />
Result:<br />
array(<br />
array( 'id'=>1234, 'name'=>'myuser0', 'score'=>1 ),<br />
array( 'id'=>1235, 'name'=>'myuser1', 'score'=>0 )<br />
)<br />
</pre><br />
Example 2:<br />
<pre><br />
self::getObjectListFromDB( "SELECT player_name name FROM player", true );<br />
<br />
Result:<br />
array(<br />
'myuser0',<br />
'myuser1'<br />
)<br />
<br />
</pre><br />
<br />
; getDoubleKeyCollectionFromDB( $sql, $bSingleValue=false )<br />
: Return an associative array of associative array, from a SQL SELECT query.<br />
: First array level correspond to first column specified in SQL query.<br />
: Second array level correspond to second column specified in SQL query.<br />
: If bSingleValue = true, keep only third column on result<br />
<br />
<br />
; DbGetLastId()<br />
: Return the PRIMARY key of the last inserted row (see PHP mysql_insert_id function).<br />
<br />
; DbAffectedRow()<br />
: Return the number of row affected by the last operation<br />
<br />
; escapeStringForDB( $string )<br />
: You must use this function on every string type data in your database that contains unsafe data.<br />
: (unsafe = can be modified by a player).<br />
: This method makes sure that no SQL injection will be done through the string used.<br />
: Note: if you using standard types in ajax actions, like AT_alphanum it is sanitized before arrival,<br />
: this is only needed if you manage to get unchecked string, like in the games where user has to enter text as a response.<br />
<br />
<pre><br />
<br />
<br />
</pre><br />
<br />
Note: see Editing [[Game database model: dbmodel.sql]] to know how to define your database model.<br />
<br />
== Use globals ==<br />
<br />
Sometimes, you have to keep a single integer value that is global to your game, and you don't want to create a DB table specifically for it.<br />
<br />
Using a BGA framework "global", you can do such a thing. Your value will be stored in the "global" table in database, and you can access it with simple methods.<br />
<br />
'''initGameStateLabels'''<br />
<br />
This method is located at the beginning of your game logic. This is the place you defines the globals used in your game logic, by assigning them IDs.<br />
<br />
You can define up to 79 globals, with IDs from 10 to 89. You must NOT use globals outside this range as globals are used by other components of the framework.<br />
<br />
<pre><br />
self::initGameStateLabels( array( <br />
"my_first_global_variable" => 10,<br />
"my_second_global_variable" => 11<br />
) );<br />
</pre><br />
<br />
'''setGameStateInitialValue( $value_label, $value_value )'''<br />
<br />
Init your global value. Must be called before any use of your global, so you should call this method from your "setupNewGame" method.<br />
<br />
'''getGameStateValue( $value_label )'''<br />
<br />
Retrieve the current value of a global.<br />
<br />
'''setGameStateValue( $value_label, $value_value )'''<br />
<br />
Set the current value of a global.<br />
<br />
'''incGameStateValue( $value_label, $increment )'''<br />
<br />
Increment the current value of a global. If increment is negative, decrement the value of the global.<br />
<br />
Return the final value of the global.<br />
<br />
== Game states and active players ==<br />
<br />
<br />
=== Activate player handling ===<br />
<br />
; $this->activeNextPlayer()<br />
: Make the next player active in the natural player order.<br />
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.<br />
<br />
; $this->activePrevPlayer()<br />
: Make the previous player active (in the natural player order).<br />
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.<br />
<br />
; $this->gamestate->changeActivePlayer( $player_id )<br />
: You can call this method to make any player active.<br />
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.<br />
<br />
; $this->getActivePlayerId()<br />
: Return the "active_player" id<br />
: Note: it does NOT mean that this player is active right now, because state type could be "game" or "multiplayer"<br />
<br />
=== Multiactivate player handling ===<br />
<br />
; $this->gamestate->setAllPlayersMultiactive()<br />
: All playing players are made active. Update notification is sent to all players (triggers onUpdateActionButtons).<br />
: Usually, you use this method at the beginning (ex: "st" action method) of a multiplayer game state when all players have to do some action.<br />
<br />
; $this->gamestate->setAllPlayersNonMultiactive( $next_state )<br />
: All playing players are made inactive. Transition to next state<br />
<br />
; $this->gamestate->setPlayersMultiactive( $players, $next_state, $bExclusive = false )<br />
: Make a specific list of players active during a multiactive gamestate. Update notification is sent to all players who's state changed.<br />
: "players" is the array of player id that should be made active.<br />
: If "exclusive" parameter is not set or false it doesn't deactivate other previously active players. If its set to true, the players who will be multiactive at the end are only these in "$layers" array<br />
<br />
: In case "players" is empty, the method trigger the "next_state" transition to go to the next game state.<br />
: returns true if state transition happened, false otherwise<br />
<br />
; $this->gamestate->setPlayerNonMultiactive( $player_id, $next_state )<br />
: During a multiactive game state, make the specified player inactive.<br />
: Usually, you call this method during a multiactive game state after a player did his action.<br />
: If this player was the last active player, the method trigger the "next_state" transition to go to the next game state.<br />
: returns true if state transition happened, false otherwise<br />
<br />
; $this->gamestate->updateMultiactiveOrNextState( $next_state_if_none )<br />
: Sends update notification about multiplayer changes. All multiactive set* functions above do that, however if you want to change state manually using db queries for complex calculations, you have to call this yourself after. Do not call this if you calling one of the other setters above.<br />
Example: you have player teams and you want to activate all players in one team<br />
<pre><br />
$sql = "UPDATE player SET player_is_multiactive='0'";<br />
self::DbQuery( $sql );<br />
$sql = "UPDATE player SET player_is_multiactive='1' WHERE player_id='$player_id' AND player_team='$team_no'";<br />
self::DbQuery( $sql );<br />
<br />
$this->gamestate->updateMultiactiveOrNextState( 'error' );<br />
</pre><br />
<br />
; $this->gamestate->getActivePlayerList()<br />
: With this method you can retrieve the list of the active player at any time.<br />
: During a "game" type gamestate, it will return a void array.<br />
: During a "activeplayer" type gamestate, it will return an array with one value (the active player id).<br />
: During a "multipleactiveplayer" type gamestate, it will return an array of the active players id.<br />
: Note: you should only use this method is the latter case.<br />
<br />
=== States functions ===<br />
; $this->gamestate->nextState( $transition )<br />
: Change current state to a new state. Important: parameter $transition is the name of the transition, and NOT the name of the target game state, see [[Your game state machine: states.inc.php]] for more information about states.<br />
<br />
; $this->checkAction( $actionName, $bThrowException=true )<br />
: Check if action is valid regarding current game state (exception if fails).<br />
: The action is valid if it is listed as a "possibleactions" in the current game state (see game state description).<br />
: This method MUST be called in the first place in ALL your PHP methods that handle players action, in order to make sure a player can't do an action when the rules disallow it at this moment of the game.<br />
: if "bThrowException" is set to "false", the function return false in case of failure instead of throwing and exception. This is useful when several actions are possible in order to test each of them without throwing exceptions.<br />
<br />
; $this->gamestate->checkPossibleAction( $action )<br />
: (rarely used)<br />
: This works exactly like "checkAction", except that it do NOT check if current player is active.<br />
: This is used specifically in certain game states when you want to authorize some additional actions for players that are not active at the moment.<br />
: Example: in Libertalia game, you want to authorize players to change their mind about card played. They are of course not active at the time they change their mind, so you cannot use "checkAction" and use "checkPossibleAction" instead.<br />
<br />
; $this->gamestate->state()<br />
: Get an associative array of current game state attributes, see [[Your game state machine: states.inc.php]] for state attributes.<br />
$state=$this->gamestate->state(); if( $state['name'] == 'myGameState' ) {...}<br />
<br />
== Players turn order ==<br />
<br />
'''getNextPlayerTable()'''<br />
<br />
Return an associative array which associate each player with the next player around the table.<br />
<br />
In addition, key 0 is associated to the first player to play.<br />
<br />
Example: if three player with ID 1, 2 and 3 are around the table, in this order, the method returns:<br />
<pre><br />
array( <br />
1 => 2, <br />
2 => 3, <br />
3 => 1, <br />
0 => 1 <br />
);<br />
</pre><br />
<br />
'''getPrevPlayerTable()'''<br />
<br />
Same as above, but the associative array associate the previous player around the table.<br />
<br />
'''getPlayerAfter( $player_id )'''<br />
<br />
Get player playing after given player in natural playing order.<br />
<br />
'''getPlayerBefore( $player_id )'''<br />
<br />
Get player playing before given player in natural playing order.<br />
<br />
Note: There is no API to modify this order, if you have custom player order you have to maintain it in your database<br />
and have custom function to access it.<br />
<br />
== Notify players ==<br />
<br />
To understand notifications, please read [http://www.slideshare.net/boardgamearena/the-bga-framework-at-a-glance The BGA Framework at a glance] first.<br />
<br />
'''IMPORTANT'''<br />
<br />
Notifications are sent at the very end of the request, when it ends normally. It means that if you throw an exception for any reason (ex: move not allowed), no notifications will be sent to players.<br />
Notifications sent between the game start (setupNewGame) and the end of the "action" method of the first active state will never reach their destination.<br />
<br />
'''notifyAllPlayers( $notification_type, $notification_log, $notification_args )'''<br />
<br />
Send a notification to all players of the game.<br />
<br />
* notification_type:<br />
A string that defines the type of your notification.<br />
<br />
Your game interface Javascript logic will use this to know what is the type of the received notification (and to trigger the corresponding method).<br />
<br />
* notification_log:<br />
A string that defines what is to be displayed in the game log.<br />
<br />
You can use an empty string here (""). In this case, nothing is displayed in the game log.<br />
<br />
If you define a real string here, you should use "clienttranslate" method to make sure it can be translate.<br />
<br />
You can use arguments in your notification_log strings, that refers to values defines in the "notification_args" argument (see below). <br />
Note: Make sure you only use single quotes ('), otherwise PHP will try to interpolate the variable and will ignore the values in the args array.<br />
<br />
<br />
<br />
* notification_args:<br />
The arguments of your notifications, as an associative array.<br />
<br />
This array will be transmitted to the game interface logic, in order the game interface can be updated.<br />
<br />
Complete notifyAllPlayers example (from "Reversi"):<br />
<br />
<pre><br />
self::notifyAllPlayers( "playDisc", clienttranslate( '${player_name} plays a disc and turns over ${returned_nbr} disc(s)' ),<br />
array(<br />
'player_id' => $player_id,<br />
'player_name' => self::getActivePlayerName(),<br />
'returned_nbr' => count( $turnedOverDiscs ),<br />
'x' => $x,<br />
'y' => $y<br />
) );<br />
</pre><br />
<br />
You can see in the example above the use of the "clienttranslate" method, and the use of 2 arguments "player_name" and "returned_nbr" in the notification log.<br />
<br />
Important: NO private data must be sent with this method, as a cheater could see it even it is not used explicitly by the game interface logic. If you want to send private information to a player, please use notifyPlayer below.<br />
<br />
Note: you CAN use some HTML inside your notification log, however it not recommended for many reasons:<br />
* Its bad architecture, ui elements leak into server now you have to manage ui in many places<br />
* If you decided to change something in ui in future version, old games reply and tutorials may not work, since they use stored notifications<br />
* When you read log preview for old games its unreadable (this is log before you enter the game reply, useful for troubleshooting or game analysis)<br />
* Its more data to transfer and store in db<br />
* Its nightmare for translators, at least don't put HTML tags inside the "clienttranslate" method. You can use a notification argument instead, and provide your HTML through this argument.<br />
<br />
If you still want to have pretty pictures in the log check this [[BGA_Studio_Cookbook#Inject_images_and_styled_html_in_the_log]].<br />
<br />
If your notification contains some phrases that build programmatically you may need to use recursive notifications. In this case the argument can be not only the string but<br />
an array itself, which contains 'log' and 'args', i.e.<br />
<br />
$this->notifyAllPlayers('playerLog',clienttranslate('Game moves ${token_name_rec}'),<br />
['token_name_rec'=>['log'=>'${token_name} #${token_number}',<br />
'args'=> ['token_name'=>clienttranslate('Boo'), 'token_number'=>$number, 'i18n'=>['token_name'] ]<br />
]<br />
]);<br />
<br />
<br />
<br />
'''notifyPlayer( $player_id, $notification_type, $notification_log, $notification_args )'''<br />
<br />
Same as above, except that the notification is sent to one player only.<br />
<br />
This method must be used each time some private information must be transmitted to a player.<br />
<br />
Important: the variable for player name must be ${player_name} in order to be highlighted with the player color in the game log<br />
<br />
== About random and randomness ==<br />
<br />
A large number of board games rely on random, most often based on dice, cards shuffling, picking some item in a bag, and so on. This is very important to ensure a high level of randomness for each of these situations.<br />
<br />
Here's are a list of techniques you should use in these situations, from the best to the worst.<br />
<br />
=== bga_rand ===<br />
<br />
'''bga_rand( min, max )''' <br />
This is a BGA framework function that provides you a random number between "min" and "max" (included), using the best available random method available on the system.<br />
<br />
This is the preferred function you should use, because we are updating it when a better method is introduced.<br />
<br />
At now, bga_rand is based on the PHP function "random_int", which ensure a cryptographic level of randomness.<br />
<br />
In particular, it is '''mandatory''' to use it for all '''dice throw''' (ie: games using other methods for dice throwing will be rejected by BGA during review).<br />
<br />
Note: rand() and mt_rand() are deprecated on BGA and should not be used anymore, as their randomness is not as good as "bga_rand".<br />
<br />
=== shuffle and cards shuffling ===<br />
<br />
To shuffle items, like a pile of cards, the best way is to use the BGA PHP [[Deck]] component and to use "shuffle" method. This ensure you that the best available shuffling method is used, and that if in the future we improve it your game will be up to date.<br />
<br />
At now, the Deck component shuffle method is based on PHP "shuffle" method, which has a quite good randomness (even it is not as good as bga_rand). In consequence, we accept other shuffling methods during reviews, as long as their are based on PHP "shuffle" function (or similar, like "array_rand").<br />
<br />
== Game statistics ==<br />
<br />
There are 2 types of statistics:<br />
* a "player" statistic is a statistic associated to a player<br />
* a "table" statistics is a statistic not associated to a player (global statistic for this game).<br />
<br />
See [[Game statistics: stats.inc.php]] to see how you defines statistics for your game.<br />
<br />
<br />
'''initStat( $table_or_player, $name, $value, $player_id = null )'''<br />
<br />
Create a statistic entry with a default value.<br />
This method must be called for each statistics of your game, in your setupNewGame method.<br />
<br />
'$table_or_player' must be set to "table" if this is a table statistics, or "player" if this is a player statistics.<br />
<br />
'$name' is the name of your statistics, as it has been defined in your stats.inc.php file.<br />
<br />
'$value' is the initial value of the statistics. If this is a player statistics and if the player is not specified by "$player_id" argument, the value is set for ALL players.<br />
<br />
<br />
'''setStat( $value, $name, $player_id = null )'''<br />
<br />
Set a statistic $name to $value.<br />
<br />
If "$player_id" is not specified, setStat consider it is a TABLE statistic.<br />
<br />
If "$player_id" is specified, setStat consider it is a PLAYER statistic.<br />
<br />
<br />
'''incStat( $delta, $name, $player_id = null )'''<br />
<br />
Increment (or decrement) specified statistic value by $delta value. Same behavior as setStat function.<br />
<br />
<br />
'''getStat( $name, $player_id = null )'''<br />
<br />
Return the value of statistic specified by $name. Useful when creating derivative statistics such as average.<br />
<br />
== Translations ==<br />
<br />
See [[Translations]]<br />
<br />
== Manage player scores and Tie breaker ==<br />
<br />
=== Normal scoring ===<br />
<br />
At the end of the game, players automatically get a rank depending on their score: the player with the biggest score is #1, the player with the second biggest score is #2, and so on...<br />
<br />
During the game, you update player's score directly by updating "player_score" field of "player" table in database.<br />
<br />
Examples:<br />
<pre><br />
<br />
// +2 points to active player<br />
self::DbQuery( "UPDATE player SET player_score=player_score+2 WHERE player_id='".self::getActivePlayerId()."'" );<br />
<br />
// Set score of active player to 5<br />
self::DbQuery( "UPDATE player SET player_score=5 WHERE player_id='".self::getActivePlayerId()."'" );<br />
<br />
</pre><br />
<br />
Note: don't forget to notify the client side in order the score control can be updated accordingly.<br />
<br />
=== Tie breaker ===<br />
<br />
Tie breaker is used when two players get the same score at the end of a game.<br />
<br />
Tie breaker is using "player_score_aux" field of "player" table. It is updated exactly like the "player_score" field.<br />
<br />
Tie breaker score is displayed only for players who are tied at the end of the game. Most of the time, it is not supposed to be displayed explicitly during the game.<br />
<br />
When you are using "player_score_aux" functionality, you must describe the formula to use in your gameinfos.inc.php file like this:<br />
<br />
<pre><br />
'tie_breaker_description' => totranslate("Describe here your tie breaker formula"),<br />
</pre><br />
<br />
This description will be used as a tooltip to explain to players how this auxiliary score has been calculated.<br />
<br />
=== Co-operative game ===<br />
<br />
To make everyone lose in full-coop game:<br />
<br />
Add the following in gameinfos.inc.php :<br />
'is_coop' => 1, // full cooperative<br />
<br />
And score zero to everyone.<br />
<br />
=== Semi-coop ===<br />
<br />
If the game is not full-coop, then everyone lose = everyone is tie. I.e. set score to 0 to everybody.<br />
<br />
=== One winner only ===<br />
If you need to one person to win and everybody else to lose, set the scores so that the winner has the best score, and the other players have the same (lower) score. Then add the following lines to gameinfos.php:<br />
<br />
<pre><br />
// If in the game, all losers are equal (no score to rank them or explicit in the rules that losers are not ranked between them), set this to true <br />
// The game end result will display "Winner" for the 1st player and "Loser" for all other players<br />
'losers_not_ranked' => true,<br />
</pre><br />
<br />
Quantum and Coup are implemented like this, as you can see here:<br />
* https://boardgamearena.com/#!gamepanel?game=quantum&section=lastresults<br />
* https://boardgamearena.com/#!gamepanel?game=coupcitystate&section=lastresults<br />
<br />
=== Solo ===<br />
<br />
If game supports solo variant, a negative score means defeat, a positive score means victory.<br />
<br />
=== Player elimination ===<br />
<br />
In some games, this is useful to eliminate a player from the game in order he/she can start another game without waiting for the current game end.<br />
<br />
This case should be rare. Please don't use player elimination feature if some player just has to wait the last 10% of the game for game end. This feature should be used only in games where players are eliminated all along the game (typical examples: "Perudo" or "The Werewolves of Miller's Hollow").<br />
<br />
Usage:<br />
<br />
* Player to eliminate should NOT be active anymore (preferably use the feature in a "game" type game state).<br />
* In your PHP code:<br />
self::eliminatePlayer( <player_to_eliminate_id> );<br />
* the player is informed in a dialog box that he no longer have to played and can start another game if he/she wants too (whith buttons "stay at this table" "quit table and back to main site"). In any case, the player is free to tart&join another table from now.<br />
* When your game is over, all players who have been eliminated before receive a "notification" (the small "!" icon on the top right of the BGA interface) that indicate them that "the game has ended" and invite them to review the game results.<br />
<br />
=== Scoring Helper functions ===<br />
<br />
// get score<br />
function dbGetScore($player_id) {<br />
return $this->getUniqueValueFromDB("SELECT player_score FROM player WHERE player_id='$player_id'");<br />
}<br />
<br />
// set score<br />
function dbSetScore($player_id, $count) {<br />
$this->DbQuery("UPDATE player SET player_score='$count' WHERE player_id='$player_id'");<br />
}<br />
<br />
// set aux score (tie breaker)<br />
function dbSetAuxScore($player_id, $score) {<br />
$this->DbQuery("UPDATE player SET player_score_aux=$score WHERE player_id='$player_id'");<br />
}<br />
<br />
// increment score (can be negative too)<br />
function dbIncScore($player_id, $inc) {<br />
$count = $this->dbGetScore($player_id);<br />
if ($inc != 0) {<br />
$count += $inc;<br />
$this->dbSetScore($player_id, $count);<br />
}<br />
return $count;<br />
}<br />
<br />
== Reflexion time ==<br />
<br />
; function giveExtraTime( $player_id, $specific_time=null )<br />
: Give standard extra time to this player.<br />
: Standard extra time depends on the speed of the game (small with "slow" game option, bigger with other options).<br />
: You can also specify an exact time to add, in seconds, with the "specified_time" argument (rarely used).<br />
<br />
== Managing errors and exceptions ==<br />
<br />
Note: when you throw an exception, all database changes and all notifications are cancelled immediately. This way, the game situation that existed before the request is completely restored.<br />
<br />
; throw new BgaUserException ( $error_message)<br />
: Base class to notify a user error<br />
: You must throw this exception when a player wants to do something that he is not allowed to do.<br />
: The error message will be shown to the player as a "red message", so it must be translated.<br />
: Throwing such an exception is NOT considered a bug, so it is not traced in BGA error logs.<br />
<br />
Example from Gomoku:<br />
<pre><br />
throw new BgaUserException( self::_("There is already a stone on this intersection, you can't play there") );<br />
</pre><br />
<br />
<br />
; throw new BgaVisibleSystemException ( $error_message)<br />
: You must throw this exception when you detect something that is not supposed to happened in your code.<br />
: The error message is shown to the user as an "Unexpected error", in order that he can report it in the forum.<br />
: The error message is logged in BGA error logs. If it happens regularly, we will report it to you.<br />
<br />
; throw new BgaSystemException ( $error_message)<br />
: Base class to notify a system exception. The message will be hidden from the user, but show in the logs. Use this if the message contains technical information.<br />
: You shouldn't use this type of exception except if you think the information shown could be critical. Indeed: a generic error message will be shown to the user, so it's going to be difficult for you to see what happened.<br />
<br />
== Zombie mode ==<br />
<br />
When a player leaves a game for any reason (expelled, quit), he becomes a "zombie player". In this case, the results of the game won't count for statistics, but this is cool if the other players can finish the game anyway. That's why zombie mode exists: allow the other player to finish the game, even if the situation is not ideal.<br />
<br />
While developing your zombie mode, keep in mind that:<br />
* Do not refer to the rules, because this situation is not planned by the rules.<br />
* Try to figure that you are playing with your friends and one of them has to leave: how can we finish the game without killing the spirit of the game?<br />
* The idea is NOT to develop an artificial intelligence for the game.<br />
<br />
Most of the time, the best thing to do when it is zombie player turn is to jump immediately to a state where he is not active anymore. For example, if he is in a game state where he has a choice between playing A and playing B, the best thing to do is NOT to choose A or B, but to pass. So, even if there's no "pass" action in the rules, add a "zombiepass" transitition in your game state and use it.<br />
<br />
Each time a zombie player must play, your "zombieTurn" method is called.<br />
<br />
Parameters:<br />
* $state: the name of the current game state.<br />
* $active_player: the id of the active player.<br />
<br />
Most of the time, your zombieTurn method looks like this:<br />
<br />
<pre><br />
function zombieTurn( $state, $active_player )<br />
{<br />
$statename = $state['name'];<br />
<br />
if( $statename == 'myFirstGameState'<br />
|| $statename == 'my2ndGameState'<br />
|| $statename == 'my3rdGameState'<br />
....<br />
)<br />
{<br />
$this->gamestate->nextState( "zombiePass" );<br />
}<br />
else<br />
throw new BgaVisibleSystemException( "Zombie mode not supported at this game state: ".$statename );<br />
}<br />
</pre><br />
<br />
Note that in the example above, all corresponding game state should implement "zombiePass" as a transition.<br />
<br />
<br />
<br />
== Player color preferences ==<br />
<br />
<br />
BGA players (Club members) may now choose their preferred color for playing. For example, if they are used to play green for every board game, they can select "green" in their BGA preferences page.<br />
<br />
Making your game compatible with colors preferences is very easy and requires only 1 line of PHP and 1 configuration change :<br />
<br />
On your gameinfos.inc.php file, add the following lines :<br />
<br />
// Favorite colors support : if set to "true", support attribution of favorite colors based on player's preferences (see reattributeColorsBasedOnPreferences PHP method)<br />
'favorite_colors_support' => true,<br />
<br />
Then, on your main <your_game>.game.php file, find the "reloadPlayersBasicInfos" call in your "setupNewGame" method and replace :<br />
<br />
$sql .= implode( $values, ',' );<br />
self::DbQuery( $sql );<br />
self::reloadPlayersBasicInfos();<br />
<br />
By :<br />
<br />
$sql .= implode( $values, ',' );<br />
self::DbQuery( $sql );<br />
self::reattributeColorsBasedOnPreferences( $players, array( /* LIST HERE THE AVAILABLE COLORS OF YOUR GAME INSTEAD OF THESE ONES */"ff0000", "008000", "0000ff", "ffa500", "773300" ) );<br />
self::reloadPlayersBasicInfos();<br />
<br />
<br />
The "reattributeColorsBasedOnPreferences" method reattributes all colors, taking into account players color preferences and available colors.<br />
<br />
Note that you must update the colors to indicate the colors available for your game.<br />
<br />
2 important remarks :<br />
* for some games (ex : Chess), the color has an influence on a mechanism of the game, most of the time by giving a special advantage to a player (ex : Starting the game). Color preference mechanism must NOT be used in such a case.<br />
* your logic should NEVER consider that the first player has the color X, that the second player has the color Y, and so on. If this is the case, your game will NOT be compatible with reattributeColorsBasedOnPreferences as this method attribute colors to players based on their preferences and not based as their order at the table.<br />
<br />
Colours currently listed as a choice in preferences:<br />
<br />
* #ff0000 Red<br />
* #008000 Green<br />
* #0000ff Blue<br />
* #ffa500 Yellow<br />
* #000000 Black<br />
* #ffffff White<br />
<br />
== Debugging and Tracing ==<br />
<br />
To debug php code you can use some tracing functions available from the parent class such as debug, trace, error, warn, dump.<br />
<br />
self::debug("Ahh!");<br />
self::dump('my_var',$my_var);<br />
<br />
See [[Practical_debugging]] section for complete information about debugging interfaces and where to find logs.</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Main_game_logic:_yourgamename.game.php&diff=3221Main game logic: yourgamename.game.php2018-10-10T09:05:58Z<p>Sourisdudesert: /* Game statistics */</p>
<hr />
<div><br />
This is the main file for your game logic. Here you initialize the game, persist data, implement the rules and notify the client interface of changes.<br />
<br />
== File Structure ==<br />
<br />
The details of how the file is structured are described directly with comments in the code skeleton provided to you.<br />
<br />
Here is the basic structure:<br />
<br />
* EmptyGame (constructor): where you define global variables.<br />
* setupNewGame: initial setup of the game.<br />
* getAllDatas: where you retrieve all game data during a complete reload of the game.<br />
* getGameProgression: where you compute the game progression indicator.<br />
* Utility functions: your utility functions.<br />
* Player actions: the entry points for players actions. <br />
* Game state arguments: methods to return additional data on specific game states ([http://en.doc.boardgamearena.com/Your_game_state_machine:_states.inc.php#args more info here]).<br />
* Game state actions: the logic to run when entering a new game state ([http://en.doc.boardgamearena.com/Your_game_state_machine:_states.inc.php#action more info here]).<br />
* zombieTurn: what to do it's the turn of a zombie player.<br />
<br />
== Accessing player information ==<br />
<br />
; getPlayersNumber()<br />
: Returns the number of players playing at the table<br />
: Note: doesn't work in setupNewGame so use count($players) instead<br />
<br />
; getActivePlayerId()<br />
: Get the "active_player", whatever what is the current state type.<br />
: Note: it does NOT mean that this player is active right now, because state type could be "game" or "multiplayer"<br />
: Note: avoid using this method in a "multiplayer" state because it does not mean anything.<br />
<br />
; getActivePlayerName()<br />
: Get the "active_player" name<br />
: Note: avoid using this method in a "multiplayer" state because it does not mean anything.<br />
<br />
; loadPlayersBasicInfos()<br />
: Get an associative array with generic data about players (ie: not game specific data).<br />
: The key of the associative array is the player id. The returned table is cached, so ok to call multiple times without performance concerns.<br />
: The content of each value is:<br />
: * player_name - the name of the player<br />
: * player_color (ex: ff0000) - the color code of the player<br />
: * player_no - the position of the player at the start of the game in natural table order, i.e. 1,2,3<br />
<br />
; getCurrentPlayerId()<br />
: Get the "current_player". The current player is the one from which the action originated (the one who send the request).<br />
: '''Be careful''': It is not always the active player.<br />
: In general, you shouldn't use this method, unless you are in "multiplayer" state.<br />
<br />
; getCurrentPlayerName()<br />
: Get the "current_player" name<br />
: Be careful using this method (see above).<br />
<br />
; getCurrentPlayerColor()<br />
: Get the "current_player" color<br />
: Be careful using this method (see above).<br />
<br />
; isCurrentPlayerZombie()<br />
: Check the "current_player" zombie status. If true, player is zombie, i.e. left or was kicked out of the game.<br />
<br />
== Accessing the database ==<br />
<br />
The main game logic should be the only point from which you should access the game database. You access your database using SQL queries with the methods below.<br />
<br />
'''IMPORTANT'''<br />
<br />
BGA uses [http://dev.mysql.com/doc/refman/5.0/en/sql-syntax-transactions.html database transactions]. This means that your database changes WON'T BE APPLIED to the database until your request ends normally. Using transactions is in fact very useful for you; at any time, if your game logic detects that something is wrong (example: a disallowed move), you just have to throw an exception and all changes to the game situation will be removed.<br />
<br />
; DbQuery( $sql )<br />
: This is the generic method to access the database.<br />
: It can execute any type of SELECT/UPDATE/DELETE/REPLACE query on the database.<br />
: You should use it for UPDATE/DELETE/REPLACE queries. For SELECT queries, the specialized methods below are much better.<br />
<br />
; getUniqueValueFromDB( $sql )<br />
: Returns a unique value from DB or null if no value is found.<br />
: $sql must be a SELECT query.<br />
: Raise an exception if more than 1 row is returned.<br />
<br />
; getCollectionFromDB( $sql, $bSingleValue=false )<br />
: Returns an associative array of rows for a sql SELECT query.<br />
: The key of the resulting associative array is the first field specified in the SELECT query.<br />
: The value of the resulting associative array if an associative array with all the field specified in the SELECT query and associated values.<br />
: First column must be a primary or alternate key.<br />
: The resulting collection can be empty.<br />
: If you specified $bSingleValue=true and if your SQL query request 2 fields A and B, the method returns an associative array "A=>B"<br />
<br />
Example 1:<br />
<pre><br />
self::getCollectionFromDB( "SELECT player_id id, player_name name, player_score score FROM player" );<br />
<br />
Result:<br />
array(<br />
1234 => array( 'id'=>1234, 'name'=>'myuser0', 'score'=>1 ),<br />
1235 => array( 'id'=>1235, 'name'=>'myuser1', 'score'=>0 )<br />
)<br />
</pre><br />
Example 2:<br />
<pre><br />
self::getCollectionFromDB( "SELECT player_id id, player_name name FROM player", true );<br />
<br />
Result:<br />
array(<br />
1234 => 'myuser0',<br />
1235 => 'myuser1'<br />
)<br />
<br />
</pre><br />
<br />
; getNonEmptyCollectionFromDB( $sql )<br />
: Idem than previous one, but raise an exception if the collection is empty<br />
<br />
; getObjectFromDB( $sql )<br />
: Returns one row for the sql SELECT query as an associative array or null if there is no result<br />
: Raise an exception if the query return more than one row<br />
<br />
Example:<br />
<pre><br />
self::getObjectFromDB( "SELECT player_id id, player_name name, player_score score FROM player WHERE player_id='$player_id'" );<br />
<br />
Result:<br />
array(<br />
'id'=>1234, 'name'=>'myuser0', 'score'=>1 <br />
)<br />
</pre><br />
<br />
; getNonEmptyObjectFromDB( $sql )<br />
: Idem than previous one, but raise an exception if no row is found<br />
<br />
; getObjectListFromDB( $sql, $bUniqueValue=false )<br />
: Return an array of rows for a sql SELECT query.<br />
: the result if the same than "getCollectionFromDB" except that the result is a simple array (and not an associative array).<br />
: The result can be empty.<br />
: If you specified $bUniqueValue=true and if your SQL query request 1 field, the method returns directly an array of values.<br />
<br />
Example 1:<br />
<pre><br />
self::getObjectListFromDB( "SELECT player_id id, player_name name, player_score score FROM player" );<br />
<br />
Result:<br />
array(<br />
array( 'id'=>1234, 'name'=>'myuser0', 'score'=>1 ),<br />
array( 'id'=>1235, 'name'=>'myuser1', 'score'=>0 )<br />
)<br />
</pre><br />
Example 2:<br />
<pre><br />
self::getObjectListFromDB( "SELECT player_name name FROM player", true );<br />
<br />
Result:<br />
array(<br />
'myuser0',<br />
'myuser1'<br />
)<br />
<br />
</pre><br />
<br />
; getDoubleKeyCollectionFromDB( $sql, $bSingleValue=false )<br />
: Return an associative array of associative array, from a SQL SELECT query.<br />
: First array level correspond to first column specified in SQL query.<br />
: Second array level correspond to second column specified in SQL query.<br />
: If bSingleValue = true, keep only third column on result<br />
<br />
<br />
; DbGetLastId()<br />
: Return the PRIMARY key of the last inserted row (see PHP mysql_insert_id function).<br />
<br />
; DbAffectedRow()<br />
: Return the number of row affected by the last operation<br />
<br />
; escapeStringForDB( $string )<br />
: You must use this function on every string type data in your database that contains unsafe data.<br />
: (unsafe = can be modified by a player).<br />
: This method makes sure that no SQL injection will be done through the string used.<br />
: Note: if you using standard types in ajax actions, like AT_alphanum it is sanitized before arrival,<br />
: this is only needed if you manage to get unchecked string, like in the games where user has to enter text as a response.<br />
<br />
<pre><br />
<br />
<br />
</pre><br />
<br />
Note: see Editing [[Game database model: dbmodel.sql]] to know how to define your database model.<br />
<br />
== Use globals ==<br />
<br />
Sometimes, you have to keep a single integer value that is global to your game, and you don't want to create a DB table specifically for it.<br />
<br />
Using a BGA framework "global", you can do such a thing. Your value will be stored in the "global" table in database, and you can access it with simple methods.<br />
<br />
'''initGameStateLabels'''<br />
<br />
This method is located at the beginning of your game logic. This is the place you defines the globals used in your game logic, by assigning them IDs.<br />
<br />
You can define up to 79 globals, with IDs from 10 to 89. You must NOT use globals outside this range as globals are used by other components of the framework.<br />
<br />
<pre><br />
self::initGameStateLabels( array( <br />
"my_first_global_variable" => 10,<br />
"my_second_global_variable" => 11<br />
) );<br />
</pre><br />
<br />
'''setGameStateInitialValue( $value_label, $value_value )'''<br />
<br />
Init your global value. Must be called before any use of your global, so you should call this method from your "setupNewGame" method.<br />
<br />
'''getGameStateValue( $value_label )'''<br />
<br />
Retrieve the current value of a global.<br />
<br />
'''setGameStateValue( $value_label, $value_value )'''<br />
<br />
Set the current value of a global.<br />
<br />
'''incGameStateValue( $value_label, $increment )'''<br />
<br />
Increment the current value of a global. If increment is negative, decrement the value of the global.<br />
<br />
Return the final value of the global.<br />
<br />
== Game states and active players ==<br />
<br />
<br />
=== Activate player handling ===<br />
<br />
; $this->activeNextPlayer()<br />
: Make the next player active in the natural player order.<br />
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.<br />
<br />
; $this->activePrevPlayer()<br />
: Make the previous player active (in the natural player order).<br />
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.<br />
<br />
; $this->gamestate->changeActivePlayer( $player_id )<br />
: You can call this method to make any player active.<br />
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.<br />
<br />
; $this->getActivePlayerId()<br />
: Return the "active_player" id<br />
: Note: it does NOT mean that this player is active right now, because state type could be "game" or "multiplayer"<br />
<br />
=== Multiactivate player handling ===<br />
<br />
; $this->gamestate->setAllPlayersMultiactive()<br />
: All playing players are made active. Update notification is sent to all players (triggers onUpdateActionButtons).<br />
: Usually, you use this method at the beginning (ex: "st" action method) of a multiplayer game state when all players have to do some action.<br />
<br />
; $this->gamestate->setAllPlayersNonMultiactive( $next_state )<br />
: All playing players are made inactive. Transition to next state<br />
<br />
; $this->gamestate->setPlayersMultiactive( $players, $next_state, $bExclusive = false )<br />
: Make a specific list of players active during a multiactive gamestate. Update notification is sent to all players who's state changed.<br />
: "players" is the array of player id that should be made active.<br />
: If "exclusive" parameter is not set or false it doesn't deactivate other previously active players. If its set to true, the players who will be multiactive at the end are only these in "$layers" array<br />
<br />
: In case "players" is empty, the method trigger the "next_state" transition to go to the next game state.<br />
: returns true if state transition happened, false otherwise<br />
<br />
; $this->gamestate->setPlayerNonMultiactive( $player_id, $next_state )<br />
: During a multiactive game state, make the specified player inactive.<br />
: Usually, you call this method during a multiactive game state after a player did his action.<br />
: If this player was the last active player, the method trigger the "next_state" transition to go to the next game state.<br />
: returns true if state transition happened, false otherwise<br />
<br />
; $this->gamestate->updateMultiactiveOrNextState( $next_state_if_none )<br />
: Sends update notification about multiplayer changes. All multiactive set* functions above do that, however if you want to change state manually using db queries for complex calculations, you have to call this yourself after. Do not call this if you calling one of the other setters above.<br />
Example: you have player teams and you want to activate all players in one team<br />
<pre><br />
$sql = "UPDATE player SET player_is_multiactive='0'";<br />
self::DbQuery( $sql );<br />
$sql = "UPDATE player SET player_is_multiactive='1' WHERE player_id='$player_id' AND player_team='$team_no'";<br />
self::DbQuery( $sql );<br />
<br />
$this->gamestate->updateMultiactiveOrNextState( 'error' );<br />
</pre><br />
<br />
; $this->gamestate->getActivePlayerList()<br />
: With this method you can retrieve the list of the active player at any time.<br />
: During a "game" type gamestate, it will return a void array.<br />
: During a "activeplayer" type gamestate, it will return an array with one value (the active player id).<br />
: During a "multipleactiveplayer" type gamestate, it will return an array of the active players id.<br />
: Note: you should only use this method is the latter case.<br />
<br />
=== States functions ===<br />
; $this->gamestate->nextState( $transition )<br />
: Change current state to a new state. Important: parameter $transition is the name of the transition, and NOT the name of the target game state, see [[Your game state machine: states.inc.php]] for more information about states.<br />
<br />
; $this->checkAction( $actionName, $bThrowException=true )<br />
: Check if action is valid regarding current game state (exception if fails).<br />
: The action is valid if it is listed as a "possibleactions" in the current game state (see game state description).<br />
: This method MUST be called in the first place in ALL your PHP methods that handle players action, in order to make sure a player can't do an action when the rules disallow it at this moment of the game.<br />
: if "bThrowException" is set to "false", the function return false in case of failure instead of throwing and exception. This is useful when several actions are possible in order to test each of them without throwing exceptions.<br />
<br />
; $this->gamestate->checkPossibleAction( $action )<br />
: (rarely used)<br />
: This works exactly like "checkAction", except that it do NOT check if current player is active.<br />
: This is used specifically in certain game states when you want to authorize some additional actions for players that are not active at the moment.<br />
: Example: in Libertalia game, you want to authorize players to change their mind about card played. They are of course not active at the time they change their mind, so you cannot use "checkAction" and use "checkPossibleAction" instead.<br />
<br />
; $this->gamestate->state()<br />
: Get an associative array of current game state attributes, see [[Your game state machine: states.inc.php]] for state attributes.<br />
$state=$this->gamestate->state(); if( $state['name'] == 'myGameState' ) {...}<br />
<br />
== Players turn order ==<br />
<br />
'''getNextPlayerTable()'''<br />
<br />
Return an associative array which associate each player with the next player around the table.<br />
<br />
In addition, key 0 is associated to the first player to play.<br />
<br />
Example: if three player with ID 1, 2 and 3 are around the table, in this order, the method returns:<br />
<pre><br />
array( <br />
1 => 2, <br />
2 => 3, <br />
3 => 1, <br />
0 => 1 <br />
);<br />
</pre><br />
<br />
'''getPrevPlayerTable()'''<br />
<br />
Same as above, but the associative array associate the previous player around the table.<br />
<br />
'''getPlayerAfter( $player_id )'''<br />
<br />
Get player playing after given player in natural playing order.<br />
<br />
'''getPlayerBefore( $player_id )'''<br />
<br />
Get player playing before given player in natural playing order.<br />
<br />
Note: There is no API to modify this order, if you have custom player order you have to maintain it in your database<br />
and have custom function to access it.<br />
<br />
== Notify players ==<br />
<br />
To understand notifications, please read [http://www.slideshare.net/boardgamearena/the-bga-framework-at-a-glance The BGA Framework at a glance] first.<br />
<br />
'''IMPORTANT'''<br />
<br />
Notifications are sent at the very end of the request, when it ends normally. It means that if you throw an exception for any reason (ex: move not allowed), no notifications will be sent to players.<br />
Notifications sent between the game start (setupNewGame) and the end of the "action" method of the first active state will never reach their destination.<br />
<br />
'''notifyAllPlayers( $notification_type, $notification_log, $notification_args )'''<br />
<br />
Send a notification to all players of the game.<br />
<br />
* notification_type:<br />
A string that defines the type of your notification.<br />
<br />
Your game interface Javascript logic will use this to know what is the type of the received notification (and to trigger the corresponding method).<br />
<br />
* notification_log:<br />
A string that defines what is to be displayed in the game log.<br />
<br />
You can use an empty string here (""). In this case, nothing is displayed in the game log.<br />
<br />
If you define a real string here, you should use "clienttranslate" method to make sure it can be translate.<br />
<br />
You can use arguments in your notification_log strings, that refers to values defines in the "notification_args" argument (see below). <br />
Note: Make sure you only use single quotes ('), otherwise PHP will try to interpolate the variable and will ignore the values in the args array.<br />
<br />
<br />
<br />
* notification_args:<br />
The arguments of your notifications, as an associative array.<br />
<br />
This array will be transmitted to the game interface logic, in order the game interface can be updated.<br />
<br />
Complete notifyAllPlayers example (from "Reversi"):<br />
<br />
<pre><br />
self::notifyAllPlayers( "playDisc", clienttranslate( '${player_name} plays a disc and turns over ${returned_nbr} disc(s)' ),<br />
array(<br />
'player_id' => $player_id,<br />
'player_name' => self::getActivePlayerName(),<br />
'returned_nbr' => count( $turnedOverDiscs ),<br />
'x' => $x,<br />
'y' => $y<br />
) );<br />
</pre><br />
<br />
You can see in the example above the use of the "clienttranslate" method, and the use of 2 arguments "player_name" and "returned_nbr" in the notification log.<br />
<br />
Important: NO private data must be sent with this method, as a cheater could see it even it is not used explicitly by the game interface logic. If you want to send private information to a player, please use notifyPlayer below.<br />
<br />
Note: you CAN use some HTML inside your notification log, however it not recommended for many reasons:<br />
* Its bad architecture, ui elements leak into server now you have to manage ui in many places<br />
* If you decided to change something in ui in future version, old games reply and tutorials may not work, since they use stored notifications<br />
* When you read log preview for old games its unreadable (this is log before you enter the game reply, useful for troubleshooting or game analysis)<br />
* Its more data to transfer and store in db<br />
* Its nightmare for translators, at least don't put HTML tags inside the "clienttranslate" method. You can use a notification argument instead, and provide your HTML through this argument.<br />
<br />
If you still want to have pretty pictures in the log check this [[BGA_Studio_Cookbook#Inject_images_and_styled_html_in_the_log]].<br />
<br />
If your notification contains some phrases that build programmatically you may need to use recursive notifications. In this case the argument can be not only the string but<br />
an array itself, which contains 'log' and 'args', i.e.<br />
<br />
$this->notifyAllPlayers('playerLog',clienttranslate('Game moves ${token_name_rec}'),<br />
['token_name_rec'=>['log'=>'${token_name} #${token_number}',<br />
'args'=> ['token_name'=>clienttranslate('Boo'), 'token_number'=>$number, 'i18n'=>['token_name'] ]<br />
]<br />
]);<br />
<br />
<br />
<br />
'''notifyPlayer( $player_id, $notification_type, $notification_log, $notification_args )'''<br />
<br />
Same as above, except that the notification is sent to one player only.<br />
<br />
This method must be used each time some private information must be transmitted to a player.<br />
<br />
Important: the variable for player name must be ${player_name} in order to be highlighted with the player color in the game log<br />
<br />
== About random and randomness ==<br />
<br />
<br />
<br />
<br />
<br />
== Game statistics ==<br />
<br />
There are 2 types of statistics:<br />
* a "player" statistic is a statistic associated to a player<br />
* a "table" statistics is a statistic not associated to a player (global statistic for this game).<br />
<br />
See [[Game statistics: stats.inc.php]] to see how you defines statistics for your game.<br />
<br />
<br />
'''initStat( $table_or_player, $name, $value, $player_id = null )'''<br />
<br />
Create a statistic entry with a default value.<br />
This method must be called for each statistics of your game, in your setupNewGame method.<br />
<br />
'$table_or_player' must be set to "table" if this is a table statistics, or "player" if this is a player statistics.<br />
<br />
'$name' is the name of your statistics, as it has been defined in your stats.inc.php file.<br />
<br />
'$value' is the initial value of the statistics. If this is a player statistics and if the player is not specified by "$player_id" argument, the value is set for ALL players.<br />
<br />
<br />
'''setStat( $value, $name, $player_id = null )'''<br />
<br />
Set a statistic $name to $value.<br />
<br />
If "$player_id" is not specified, setStat consider it is a TABLE statistic.<br />
<br />
If "$player_id" is specified, setStat consider it is a PLAYER statistic.<br />
<br />
<br />
'''incStat( $delta, $name, $player_id = null )'''<br />
<br />
Increment (or decrement) specified statistic value by $delta value. Same behavior as setStat function.<br />
<br />
<br />
'''getStat( $name, $player_id = null )'''<br />
<br />
Return the value of statistic specified by $name. Useful when creating derivative statistics such as average.<br />
<br />
== Translations ==<br />
<br />
See [[Translations]]<br />
<br />
== Manage player scores and Tie breaker ==<br />
<br />
=== Normal scoring ===<br />
<br />
At the end of the game, players automatically get a rank depending on their score: the player with the biggest score is #1, the player with the second biggest score is #2, and so on...<br />
<br />
During the game, you update player's score directly by updating "player_score" field of "player" table in database.<br />
<br />
Examples:<br />
<pre><br />
<br />
// +2 points to active player<br />
self::DbQuery( "UPDATE player SET player_score=player_score+2 WHERE player_id='".self::getActivePlayerId()."'" );<br />
<br />
// Set score of active player to 5<br />
self::DbQuery( "UPDATE player SET player_score=5 WHERE player_id='".self::getActivePlayerId()."'" );<br />
<br />
</pre><br />
<br />
Note: don't forget to notify the client side in order the score control can be updated accordingly.<br />
<br />
=== Tie breaker ===<br />
<br />
Tie breaker is used when two players get the same score at the end of a game.<br />
<br />
Tie breaker is using "player_score_aux" field of "player" table. It is updated exactly like the "player_score" field.<br />
<br />
Tie breaker score is displayed only for players who are tied at the end of the game. Most of the time, it is not supposed to be displayed explicitly during the game.<br />
<br />
When you are using "player_score_aux" functionality, you must describe the formula to use in your gameinfos.inc.php file like this:<br />
<br />
<pre><br />
'tie_breaker_description' => totranslate("Describe here your tie breaker formula"),<br />
</pre><br />
<br />
This description will be used as a tooltip to explain to players how this auxiliary score has been calculated.<br />
<br />
=== Co-operative game ===<br />
<br />
To make everyone lose in full-coop game:<br />
<br />
Add the following in gameinfos.inc.php :<br />
'is_coop' => 1, // full cooperative<br />
<br />
And score zero to everyone.<br />
<br />
=== Semi-coop ===<br />
<br />
If the game is not full-coop, then everyone lose = everyone is tie. I.e. set score to 0 to everybody.<br />
<br />
=== One winner only ===<br />
If you need to one person to win and everybody else to lose, set the scores so that the winner has the best score, and the other players have the same (lower) score. Then add the following lines to gameinfos.php:<br />
<br />
<pre><br />
// If in the game, all losers are equal (no score to rank them or explicit in the rules that losers are not ranked between them), set this to true <br />
// The game end result will display "Winner" for the 1st player and "Loser" for all other players<br />
'losers_not_ranked' => true,<br />
</pre><br />
<br />
Quantum and Coup are implemented like this, as you can see here:<br />
* https://boardgamearena.com/#!gamepanel?game=quantum&section=lastresults<br />
* https://boardgamearena.com/#!gamepanel?game=coupcitystate&section=lastresults<br />
<br />
=== Solo ===<br />
<br />
If game supports solo variant, a negative score means defeat, a positive score means victory.<br />
<br />
=== Player elimination ===<br />
<br />
In some games, this is useful to eliminate a player from the game in order he/she can start another game without waiting for the current game end.<br />
<br />
This case should be rare. Please don't use player elimination feature if some player just has to wait the last 10% of the game for game end. This feature should be used only in games where players are eliminated all along the game (typical examples: "Perudo" or "The Werewolves of Miller's Hollow").<br />
<br />
Usage:<br />
<br />
* Player to eliminate should NOT be active anymore (preferably use the feature in a "game" type game state).<br />
* In your PHP code:<br />
self::eliminatePlayer( <player_to_eliminate_id> );<br />
* the player is informed in a dialog box that he no longer have to played and can start another game if he/she wants too (whith buttons "stay at this table" "quit table and back to main site"). In any case, the player is free to tart&join another table from now.<br />
* When your game is over, all players who have been eliminated before receive a "notification" (the small "!" icon on the top right of the BGA interface) that indicate them that "the game has ended" and invite them to review the game results.<br />
<br />
=== Scoring Helper functions ===<br />
<br />
// get score<br />
function dbGetScore($player_id) {<br />
return $this->getUniqueValueFromDB("SELECT player_score FROM player WHERE player_id='$player_id'");<br />
}<br />
<br />
// set score<br />
function dbSetScore($player_id, $count) {<br />
$this->DbQuery("UPDATE player SET player_score='$count' WHERE player_id='$player_id'");<br />
}<br />
<br />
// set aux score (tie breaker)<br />
function dbSetAuxScore($player_id, $score) {<br />
$this->DbQuery("UPDATE player SET player_score_aux=$score WHERE player_id='$player_id'");<br />
}<br />
<br />
// increment score (can be negative too)<br />
function dbIncScore($player_id, $inc) {<br />
$count = $this->dbGetScore($player_id);<br />
if ($inc != 0) {<br />
$count += $inc;<br />
$this->dbSetScore($player_id, $count);<br />
}<br />
return $count;<br />
}<br />
<br />
== Reflexion time ==<br />
<br />
; function giveExtraTime( $player_id, $specific_time=null )<br />
: Give standard extra time to this player.<br />
: Standard extra time depends on the speed of the game (small with "slow" game option, bigger with other options).<br />
: You can also specify an exact time to add, in seconds, with the "specified_time" argument (rarely used).<br />
<br />
== Managing errors and exceptions ==<br />
<br />
Note: when you throw an exception, all database changes and all notifications are cancelled immediately. This way, the game situation that existed before the request is completely restored.<br />
<br />
; throw new BgaUserException ( $error_message)<br />
: Base class to notify a user error<br />
: You must throw this exception when a player wants to do something that he is not allowed to do.<br />
: The error message will be shown to the player as a "red message", so it must be translated.<br />
: Throwing such an exception is NOT considered a bug, so it is not traced in BGA error logs.<br />
<br />
Example from Gomoku:<br />
<pre><br />
throw new BgaUserException( self::_("There is already a stone on this intersection, you can't play there") );<br />
</pre><br />
<br />
<br />
; throw new BgaVisibleSystemException ( $error_message)<br />
: You must throw this exception when you detect something that is not supposed to happened in your code.<br />
: The error message is shown to the user as an "Unexpected error", in order that he can report it in the forum.<br />
: The error message is logged in BGA error logs. If it happens regularly, we will report it to you.<br />
<br />
; throw new BgaSystemException ( $error_message)<br />
: Base class to notify a system exception. The message will be hidden from the user, but show in the logs. Use this if the message contains technical information.<br />
: You shouldn't use this type of exception except if you think the information shown could be critical. Indeed: a generic error message will be shown to the user, so it's going to be difficult for you to see what happened.<br />
<br />
== Zombie mode ==<br />
<br />
When a player leaves a game for any reason (expelled, quit), he becomes a "zombie player". In this case, the results of the game won't count for statistics, but this is cool if the other players can finish the game anyway. That's why zombie mode exists: allow the other player to finish the game, even if the situation is not ideal.<br />
<br />
While developing your zombie mode, keep in mind that:<br />
* Do not refer to the rules, because this situation is not planned by the rules.<br />
* Try to figure that you are playing with your friends and one of them has to leave: how can we finish the game without killing the spirit of the game?<br />
* The idea is NOT to develop an artificial intelligence for the game.<br />
<br />
Most of the time, the best thing to do when it is zombie player turn is to jump immediately to a state where he is not active anymore. For example, if he is in a game state where he has a choice between playing A and playing B, the best thing to do is NOT to choose A or B, but to pass. So, even if there's no "pass" action in the rules, add a "zombiepass" transitition in your game state and use it.<br />
<br />
Each time a zombie player must play, your "zombieTurn" method is called.<br />
<br />
Parameters:<br />
* $state: the name of the current game state.<br />
* $active_player: the id of the active player.<br />
<br />
Most of the time, your zombieTurn method looks like this:<br />
<br />
<pre><br />
function zombieTurn( $state, $active_player )<br />
{<br />
$statename = $state['name'];<br />
<br />
if( $statename == 'myFirstGameState'<br />
|| $statename == 'my2ndGameState'<br />
|| $statename == 'my3rdGameState'<br />
....<br />
)<br />
{<br />
$this->gamestate->nextState( "zombiePass" );<br />
}<br />
else<br />
throw new BgaVisibleSystemException( "Zombie mode not supported at this game state: ".$statename );<br />
}<br />
</pre><br />
<br />
Note that in the example above, all corresponding game state should implement "zombiePass" as a transition.<br />
<br />
<br />
<br />
== Player color preferences ==<br />
<br />
<br />
BGA players (Club members) may now choose their preferred color for playing. For example, if they are used to play green for every board game, they can select "green" in their BGA preferences page.<br />
<br />
Making your game compatible with colors preferences is very easy and requires only 1 line of PHP and 1 configuration change :<br />
<br />
On your gameinfos.inc.php file, add the following lines :<br />
<br />
// Favorite colors support : if set to "true", support attribution of favorite colors based on player's preferences (see reattributeColorsBasedOnPreferences PHP method)<br />
'favorite_colors_support' => true,<br />
<br />
Then, on your main <your_game>.game.php file, find the "reloadPlayersBasicInfos" call in your "setupNewGame" method and replace :<br />
<br />
$sql .= implode( $values, ',' );<br />
self::DbQuery( $sql );<br />
self::reloadPlayersBasicInfos();<br />
<br />
By :<br />
<br />
$sql .= implode( $values, ',' );<br />
self::DbQuery( $sql );<br />
self::reattributeColorsBasedOnPreferences( $players, array( /* LIST HERE THE AVAILABLE COLORS OF YOUR GAME INSTEAD OF THESE ONES */"ff0000", "008000", "0000ff", "ffa500", "773300" ) );<br />
self::reloadPlayersBasicInfos();<br />
<br />
<br />
The "reattributeColorsBasedOnPreferences" method reattributes all colors, taking into account players color preferences and available colors.<br />
<br />
Note that you must update the colors to indicate the colors available for your game.<br />
<br />
2 important remarks :<br />
* for some games (ex : Chess), the color has an influence on a mechanism of the game, most of the time by giving a special advantage to a player (ex : Starting the game). Color preference mechanism must NOT be used in such a case.<br />
* your logic should NEVER consider that the first player has the color X, that the second player has the color Y, and so on. If this is the case, your game will NOT be compatible with reattributeColorsBasedOnPreferences as this method attribute colors to players based on their preferences and not based as their order at the table.<br />
<br />
Colours currently listed as a choice in preferences:<br />
<br />
* #ff0000 Red<br />
* #008000 Green<br />
* #0000ff Blue<br />
* #ffa500 Yellow<br />
* #000000 Black<br />
* #ffffff White<br />
<br />
== Debugging and Tracing ==<br />
<br />
To debug php code you can use some tracing functions available from the parent class such as debug, trace, error, warn, dump.<br />
<br />
self::debug("Ahh!");<br />
self::dump('my_var',$my_var);<br />
<br />
See [[Practical_debugging]] section for complete information about debugging interfaces and where to find logs.</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Game_options_and_preferences:_gameoptions.inc.php&diff=3204Game options and preferences: gameoptions.inc.php2018-09-25T08:06:24Z<p>Sourisdudesert: </p>
<hr />
<div><br />
In this file, you can define your game options (= game variants) and user preferences.<br />
<br />
Note: If your game has no variants or preferences, you don't have to modify this file.<br />
<br />
'''IMPORTANT:''' after you edited this file in your SFTP folder you have to go to the control panel and press "Reload game options configuration" for your changes to take effect.<br />
<br />
== Game Options ==<br />
<br />
Game options is something selected by table creator and usually correspond to game variant, for example if game includes expansion or certain special rule.<br />
<br />
These variants defined in gameoptions.inc.php as variable <br />
$game_options = array(...); // exactly named that<br />
<br />
Each option is pair number => 'option description array'. <br />
<br />
All options defined in this file should have a corresponding "game state label" with the same ID (see "initGameStateLabels" in yourgame.game.php)<br />
<br />
self::initGameStateLabels ( array (<br />
...<br />
"my_first_game_variant" => 100,<br />
) );<br />
<br />
That is how you access them during runtime:<br />
<br />
$this->gamestate->table_globals[100]<br />
<br />
The following are the parameters of option description array:<br />
* '''name''' - '''mandartory'''. The name of the option visible for table creator. Value must be wrapped in totranslate function.<br />
* '''values''' - '''mandartory'''. The array (map) of values with additional parameters per value.<br />
** '''name''' - '''mandartory'''. String representation of the numeric value visible to table creator. Value must be wrapped in totranslate function.<br />
** '''tmdisplay''' - String representation of the option visible in the table description, usually if variant "names" are On and Off, but the description would be same as option name when On, and nothing when Off.<br />
** '''nobeginner''' - Set to true if not recommended for begginers<br />
** '''beta''' - Option in beta stage on development<br />
** '''premium''' - Option can be only used by premium members<br />
* '''displaycondition''' - checks the conditions before displaying the option for selection. All conditions must be true for the option to display. Supported condition types:<br />
** ''otheroption'' condition ensures another option is set to this given values. Framework options - 201 - ELO OFF.<br />
** ''otheroptionisnot'' conditions ensure another option is NOT set to this given values<br />
* '''startcondition''' - checks the conditions (on options VALUES) before starting the game. All conditions must be true for the game to start, otherwise players will get a red error message when attempting to begin the game. Supported condition types:<br />
** ''minplayers'' condition ensures at least this many players<br />
** ''maxplayers'' conditions ensure at most this many players<br />
** ''otheroption'' conditions ensure another option is set to this given values. That works the same as in '''displaycondition'''.<br />
** ''otheroptionisnot'' conditions ensure another option is NOT set to this given value. That works the same as in '''displaycondition'''.<br />
* '''notdisplayedmessage''' - if option is not suppose to be visible because of displaycondition but this is set, the text will be visible instead of combo drop down<br />
<br />
<pre><br />
$game_options = array(<br />
100 => array(<br />
'name' => totranslate('my game option'),<br />
'values' => array(<br />
// A simple value for this option:<br />
1 => array(<br />
'name' => totranslate('option 1')<br />
),<br />
<br />
// A simple value for this option.<br />
// If this value is chosen, the value of "tmdisplay" is displayed in the game lobby<br />
2 => array(<br />
'name' => totranslate('option 2'),<br />
'tmdisplay' => totranslate('option 2')<br />
),<br />
<br />
// Another value, with other options:<br />
// beta=true => this option is in beta version right now.<br />
// nobeginner=true => this option is not recommended for beginners<br />
3 => array(<br />
'name' => totranslate('option 3'),<br />
'beta' => true,<br />
'nobeginner' => true<br />
),<br />
)<br />
),<br />
<br />
101 => array(<br />
'name' => totranslate('Draft variant'),<br />
'values' => array(<br />
1 => array(<br />
'name' => totranslate('No draft')<br />
),<br />
2 => array(<br />
'name' => totranslate('Draft'),<br />
'tmdisplay' => totranslate('Draft'),<br />
'premium' => true,<br />
'nobeginner' => true<br />
),<br />
),<br />
'displaycondition' => array( <br />
// Note: do not display this option unless these conditions are met<br />
array(<br />
'type' => 'otheroption',<br />
'id' => 100, // Game specific option defined in the same array above<br />
'value' => array(2, 3, 4)<br />
),<br />
// Note: do not display this option unless these conditions are met<br />
array( 'type' => 'otheroption', <br />
'id' => 201, // ELO OFF hardcoded framework option<br />
'value' => 1 // 1 if OFF<br />
)<br />
),<br />
<br />
'startcondition' => array(<br />
1 => array(),<br />
2 => array(<br />
array(<br />
'type' => 'maxplayers',<br />
'value' => 3,<br />
'message' => totranslate('Draft option is available for 3 players maximum.')<br />
)<br />
),<br />
),<br />
'disable' => true<br />
),<br />
<br />
102 => array(<br />
'name' => totranslate('Takeovers'),<br />
'values' => array(<br />
2 => array(<br />
'name' => totranslate('No takeover')<br />
),<br />
1 => array(<br />
'name' => totranslate('Allow takeovers'),<br />
'tmdisplay' => totranslate('Takeovers'),<br />
'premium' => true,<br />
'nobeginner' => true<br />
),<br />
),<br />
'displaycondition' => array( // Note: do not display this option unless these conditions are met<br />
array(<br />
'type' => 'otheroption',<br />
'id' => 100,<br />
'value' => array(3, 4)<br />
)<br />
),<br />
'startcondition' => array(<br />
2 => array(),<br />
1 => array(<br />
array(<br />
'type' => 'maxplayers',<br />
'value' => 2,<br />
'message' => totranslate('Rebel vs Imperium Takeover Scenario is available for 2 players only.')<br />
)<br />
),<br />
),<br />
'disable' => true<br />
)<br />
);<br />
</pre><br />
<br />
Example of option that condition on ELO off<br />
<br />
<pre><br />
$game_options = array(<br />
<br />
100 => array(<br />
'name' => totranslate('Learning Game (No Research)'),<br />
'values' => array(<br />
<br />
1 => array( 'name' => totranslate('Off'), 'tmdisplay' => totranslate('') ),<br />
2 => array( 'name' => totranslate('On'), 'tmdisplay' => totranslate('Learning Game') ),<br />
<br />
),<br />
'displaycondition' => array(<br />
// Note: do not display this option unless these conditions are met<br />
array( 'type' => 'otheroption',<br />
'id' => 201, // ELO OFF hardcoded framework option<br />
'value' => 1, // 1 if OFF<br />
<br />
)<br />
),<br />
'notdisplayedmessage' => totranslate('Learning variant available only with ELO off')<br />
),<br />
<br />
);<br />
</pre><br />
<br />
Example of using condition on your own option<br />
<pre><br />
102 => array(<br />
'name' => totranslate('Scenarios'),<br />
'values' => array(<br />
1 => array( 'name' => totranslate('Off'),<br />
'nobeginner' => false ),<br />
2 => array( 'name' => totranslate('On'), 'tmdisplay' => totranslate('Scenarios'),<br />
'nobeginner' => true ),<br />
<br />
),<br />
'displaycondition' => array(<br />
// Note: do not display this option unless these conditions are met<br />
array( 'type' => 'otheroptionisnot',<br />
'id' => 100, // learning variant<br />
'value' => 2, // 1 if OFF,2 is ON<br />
<br />
)<br />
),<br />
'notdisplayedmessage' => totranslate('Scenarios variant is not available if Learning variant is chosen')<br />
),<br />
</pre><br />
<br />
== User Preferences ==<br />
<br />
User preferences is something cosmetic about the game interface which however can create user wars, so you can satisfy all users<br />
by giving them individual preferences. You should use this only if it significantly improves the interface for a large proportion of users.<br />
<br />
<pre><br />
$game_preferences = array(<br />
100 => array(<br />
'name' => totranslate('Notation style'),<br />
'needReload' => true, // after user changes this preference game interface would auto-reload<br />
'values' => array(<br />
1 => array( 'name' => totranslate( 'Classic' ), 'cssPref' => 'notation_classic' ),<br />
2 => array( 'name' => totranslate( 'Tournament' ), 'cssPref' => 'notation_tournament' )<br />
)<br />
)<br />
);<br />
</pre><br />
<br />
There is two ways to check/apply this. In java Script<br />
<br />
if (this.prefs[100].value == 2) ...<br />
<br />
This checks if preferences 100 has selected value 2.<br />
<br />
Second, if cssPref specified it will be applied to the body tag. So you can use different css styling for the preference.<br />
<br />
As user you have to select them from the Gear menu when game is started. On studio only user0 will have it actually working (bug?).</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Game_options_and_preferences:_gameoptions.inc.php&diff=3203Game options and preferences: gameoptions.inc.php2018-09-25T07:25:46Z<p>Sourisdudesert: </p>
<hr />
<div><br />
In this file, you can define your game options (= game variants) and user preferences.<br />
<br />
Note: If your game has no variants or preferences, you don't have to modify this file.<br />
<br />
'''IMPORTANT:''' after you edited this file in your SFTP folder you have to go to the control panel and press "Reload game options configuration" for your changes to take effect.<br />
<br />
== Game Options ==<br />
<br />
Game options is something selected by table creator and usually correspond to game variant, for example if game includes expansion or certain special rule.<br />
<br />
These variants defined in gameoptions.inc.php as variable <br />
$game_options = array(...); // exactly named that<br />
<br />
Each option is pair number => 'option description array'. <br />
<br />
All options defined in this file should have a corresponding "game state label" with the same ID (see "initGameStateLabels" in yourgame.game.php)<br />
<br />
self::initGameStateLabels ( array (<br />
...<br />
"my_first_game_variant" => 100,<br />
) );<br />
<br />
That is how you access them during runtime:<br />
<br />
$this->gamestate->table_globals[100]<br />
<br />
The following are the parameters of option description array:<br />
* '''name''' - '''mandartory'''. The name of the option visible for table creator. Value must be wrapped in totranslate function.<br />
* '''values''' - '''mandartory'''. The array (map) of values with additional parameters per value.<br />
** '''name''' - '''mandartory'''. String representation of the numeric value visible to table creator. Value must be wrapped in totranslate function.<br />
** '''tmdisplay''' - String representation of the option visible in the table description, usually if variant "names" are On and Off, but the description would be same as option name when On, and nothing when Off.<br />
** '''nobeginner''' - Set to true if not recommended for begginers<br />
** '''beta''' - Option in beta stage on development<br />
** '''premium''' - Option can be only used by premium members<br />
* '''displaycondition''' - checks the conditions before displaying the option for selection. All conditions must be true for the option to display. Supported condition types:<br />
** ''otheroption'' condition ensures another option is set to this given value. Framework options - 201 - ELO OFF.<br />
* '''startcondition''' - checks the conditions (on options VALUES) before starting the game. All conditions must be true for the game to start, otherwise players will get a red error message when attempting to begin the game. Supported condition types:<br />
** ''minplayers'' condition ensures at least this many players<br />
** ''maxplayers'' conditions ensure at most this many players<br />
** ''otheroption'' conditions ensure another option is set to this given value. That works the same as in '''displaycondition'''.<br />
** ''otheroptionisnot'' conditions ensure another option is NOT set to this given value<br />
* '''notdisplayedmessage''' - if option is not suppose to be visible because of displaycondition but this is set, the text will be visible instead of combo drop down<br />
<br />
<pre><br />
$game_options = array(<br />
100 => array(<br />
'name' => totranslate('my game option'),<br />
'values' => array(<br />
// A simple value for this option:<br />
1 => array(<br />
'name' => totranslate('option 1')<br />
),<br />
<br />
// A simple value for this option.<br />
// If this value is chosen, the value of "tmdisplay" is displayed in the game lobby<br />
2 => array(<br />
'name' => totranslate('option 2'),<br />
'tmdisplay' => totranslate('option 2')<br />
),<br />
<br />
// Another value, with other options:<br />
// beta=true => this option is in beta version right now.<br />
// nobeginner=true => this option is not recommended for beginners<br />
3 => array(<br />
'name' => totranslate('option 3'),<br />
'beta' => true,<br />
'nobeginner' => true<br />
),<br />
)<br />
),<br />
<br />
101 => array(<br />
'name' => totranslate('Draft variant'),<br />
'values' => array(<br />
1 => array(<br />
'name' => totranslate('No draft')<br />
),<br />
2 => array(<br />
'name' => totranslate('Draft'),<br />
'tmdisplay' => totranslate('Draft'),<br />
'premium' => true,<br />
'nobeginner' => true<br />
),<br />
),<br />
'displaycondition' => array( <br />
// Note: do not display this option unless these conditions are met<br />
array(<br />
'type' => 'otheroption',<br />
'id' => 100, // Game specific option defined in the same array above<br />
'value' => array(2, 3, 4)<br />
),<br />
// Note: do not display this option unless these conditions are met<br />
array( 'type' => 'otheroption', <br />
'id' => 201, // ELO OFF hardcoded framework option<br />
'value' => 1 // 1 if OFF<br />
)<br />
),<br />
<br />
'startcondition' => array(<br />
1 => array(),<br />
2 => array(<br />
array(<br />
'type' => 'maxplayers',<br />
'value' => 3,<br />
'message' => totranslate('Draft option is available for 3 players maximum.')<br />
)<br />
),<br />
),<br />
'disable' => true<br />
),<br />
<br />
102 => array(<br />
'name' => totranslate('Takeovers'),<br />
'values' => array(<br />
2 => array(<br />
'name' => totranslate('No takeover')<br />
),<br />
1 => array(<br />
'name' => totranslate('Allow takeovers'),<br />
'tmdisplay' => totranslate('Takeovers'),<br />
'premium' => true,<br />
'nobeginner' => true<br />
),<br />
),<br />
'displaycondition' => array( // Note: do not display this option unless these conditions are met<br />
array(<br />
'type' => 'otheroption',<br />
'id' => 100,<br />
'value' => array(3, 4)<br />
)<br />
),<br />
'startcondition' => array(<br />
2 => array(),<br />
1 => array(<br />
array(<br />
'type' => 'maxplayers',<br />
'value' => 2,<br />
'message' => totranslate('Rebel vs Imperium Takeover Scenario is available for 2 players only.')<br />
)<br />
),<br />
),<br />
'disable' => true<br />
)<br />
);<br />
</pre><br />
<br />
Example of option that condition on ELO off<br />
<br />
<pre><br />
$game_options = array(<br />
<br />
100 => array(<br />
'name' => totranslate('Learning Game (No Research)'),<br />
'values' => array(<br />
<br />
1 => array( 'name' => totranslate('Off'), 'tmdisplay' => totranslate('') ),<br />
2 => array( 'name' => totranslate('On'), 'tmdisplay' => totranslate('Learning Game') ),<br />
<br />
),<br />
'displaycondition' => array(<br />
// Note: do not display this option unless these conditions are met<br />
array( 'type' => 'otheroption',<br />
'id' => 201, // ELO OFF hardcoded framework option<br />
'value' => 1, // 1 if OFF<br />
<br />
)<br />
),<br />
'notdisplayedmessage' => totranslate('Learning variant available only with ELO off')<br />
),<br />
<br />
);<br />
</pre><br />
<br />
Example of using condition on your own option<br />
<pre><br />
102 => array(<br />
'name' => totranslate('Scenarios'),<br />
'values' => array(<br />
1 => array( 'name' => totranslate('Off'),<br />
'nobeginner' => false ),<br />
2 => array( 'name' => totranslate('On'), 'tmdisplay' => totranslate('Scenarios'),<br />
'nobeginner' => true ),<br />
<br />
),<br />
'displaycondition' => array(<br />
// Note: do not display this option unless these conditions are met<br />
array( 'type' => 'otheroptionisnot',<br />
'id' => 100, // learning variant<br />
'value' => 2, // 1 if OFF,2 is ON<br />
<br />
)<br />
),<br />
'notdisplayedmessage' => totranslate('Scenarios variant is not available if Learning variant is chosen')<br />
),<br />
</pre><br />
<br />
== User Preferences ==<br />
<br />
User preferences is something cosmetic about the game interface which however can create user wars, so you can satisfy all users<br />
by giving them individual preferences. You should use this only if it significantly improves the interface for a large proportion of users.<br />
<br />
<pre><br />
$game_preferences = array(<br />
100 => array(<br />
'name' => totranslate('Notation style'),<br />
'needReload' => true, // after user changes this preference game interface would auto-reload<br />
'values' => array(<br />
1 => array( 'name' => totranslate( 'Classic' ), 'cssPref' => 'notation_classic' ),<br />
2 => array( 'name' => totranslate( 'Tournament' ), 'cssPref' => 'notation_tournament' )<br />
)<br />
)<br />
);<br />
</pre><br />
<br />
There is two ways to check/apply this. In java Script<br />
<br />
if (this.prefs[100].value == 2) ...<br />
<br />
This checks if preferences 100 has selected value 2.<br />
<br />
Second, if cssPref specified it will be applied to the body tag. So you can use different css styling for the preference.<br />
<br />
As user you have to select them from the Gear menu when game is started. On studio only user0 will have it actually working (bug?).</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Post-release_phase&diff=3075Post-release phase2018-05-22T08:38:04Z<p>Sourisdudesert: /* Updating the database schema */</p>
<hr />
<div><br />
Your game is now on BGA: congrats!<br />
<br />
But what happened when there are some bugs to fix or when you want to optimize something?<br />
<br />
Don't be afraid: you're still allowed to modify your game. You just have to pay attention to the points below.<br />
<br />
== Bugs reporting ==<br />
<br />
Bugs are reported in the [http://forum.boardgamearena.com/viewforum.php?f=4 BGA bugs forum].<br />
<br />
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.<br />
<br />
== How to submit changes? ==<br />
<br />
There is 3 (short) steps to make your changes visible on BGA (from your Control Panel):<br />
<br />
* Commit your changes.<br />
* Build a new version (don't forget to do a successful commit BEFORE your build).<br />
* Deploy your new version in production.<br />
<br />
<br />
== What can be modified after release? ==<br />
<br />
Everything can be modified. BUT, some items requires a special attention, and you must inform us in some cases:<br />
<br />
===Changes that breaks the games in progress===<br />
<br />
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.<br />
<br />
Example of changes that break the games in progress:<br />
* Changes in the database schema of the game (dbmodel.sql).<br />
* New global variable or game option accessed during the game (if it's only used during setup, it should be safe).<br />
* New statistic (it won't be initialized properly, so it's going to crash the game).<br />
* Change ID of existing game states (adding new game states is fine).<br />
<br />
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:<br />
* Try to group all your updates in one version, thus we won't have to block your game several times.<br />
* Tell us explicitly that you introduce some update that can break games in progress so we can block the game during a short time.<br />
<br />
Note: in the near future, we will introduce the possibility for you to block/unblock a game directly from your Control Panel in order to perform all the process by yourself.<br />
<br />
=== Updating Statistics ===<br />
<br />
You should be careful when updating a statistics:<br />
<br />
* If you want to add a new statistics, please refer to the paragraph above ("changes that breaks the games in progress").<br />
* If you want to update a statistic, please update it and do not remove/create another one. Otherwise, the statistic won't keep the same ID and players will lost all the historical statistics data.<br />
* If your game is published on BGA, please don't remove any statistics (historical data will be lost).<br />
<br />
=== Updating the database schema ===<br />
<br />
If you want to update the database schema of the game (dbmodel.sql), you should inform us before releasing the new version (see "[[#Changes that breaks the games in progress|changes that breaks the games in progress]]").<br />
<br />
Any modification in dbmodel.sql should also appear in your nameofyourgame.game.php, in a function<br />
<br />
function upgradeTableDb( $from_version ){<br />
<br />
if( $from_version <= YYMMDDHHMM ){ // where your CURRENT version in production has number YYMMDD-HHMM<br />
<br />
// You DB schema update request.<br />
// Note: all tables names should be prefixed by "DBPREFIX_" to be compatible with the applyDbUpgradeToAllDB method you should use below<br />
$sql = "CREATE TABLE DBPREFIX_xxxxxxx ....";<br />
<br />
// The method below is applying your DB schema update request to all tables, including the BGA framework utility tables like "zz_replayXXXX" or "zz_savepointXXXX".<br />
// You should really use this request, in conjunction with "DBPREFIX_" in your $sql, so ALL tables are updated. All utility tables MUST have the same schema than the main table, otherwise the game may be blocked.<br />
self::applyDbUpgradeToAllDB( $sql );<br />
<br />
}}<br />
<br />
Note: of course you need to change your dbmodel.sql accordingly, so that new games get your updated scheme.<br />
<br />
Note2: this is always risky to modify the DB scheme, so:<br />
_ it may be worthy to contact us before, so we can stop the realtime games during the update (this way, only turn based games are concerned by the DB live upgrade).<br />
_ if you can avoid it... try to avoid it :)<br />
<br />
=== Updating string to be translated ===<br />
<br />
When you update a string that has been marked to be translatable, please keep in mind that all current translations done by the BGA community will be lost.<br />
<br />
Consequently, when you are about to modify a string to be translated (after release), please ask you the following questions:<br />
* Is it just an English misspelling? In this case, it is better to fix the English translation of the string than the original string to be translated.<br />
* Has the meaning of the string changed? If yes, you HAVE to change the original string in order to invalidate all translations that has been done already.<br />
* Is there a similar string already used elsewhere in my game? In this case, you'd better use it again to enjoy immediately all translations already available.<br />
<br />
===Major changes===<br />
<br />
If you do some major changes to your game like:<br />
* Introducing a new expansion.<br />
* Major code rewriting/refactoring.<br />
<br />
... please tell us. In this case, we can:<br />
* Make your game back from "gold" to "public beta", to incite player to report bugs.<br />
* And eventually, publish a news about it :)</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Post-release_phase&diff=3074Post-release phase2018-05-22T08:37:57Z<p>Sourisdudesert: /* Updating the database schema */</p>
<hr />
<div><br />
Your game is now on BGA: congrats!<br />
<br />
But what happened when there are some bugs to fix or when you want to optimize something?<br />
<br />
Don't be afraid: you're still allowed to modify your game. You just have to pay attention to the points below.<br />
<br />
== Bugs reporting ==<br />
<br />
Bugs are reported in the [http://forum.boardgamearena.com/viewforum.php?f=4 BGA bugs forum].<br />
<br />
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.<br />
<br />
== How to submit changes? ==<br />
<br />
There is 3 (short) steps to make your changes visible on BGA (from your Control Panel):<br />
<br />
* Commit your changes.<br />
* Build a new version (don't forget to do a successful commit BEFORE your build).<br />
* Deploy your new version in production.<br />
<br />
<br />
== What can be modified after release? ==<br />
<br />
Everything can be modified. BUT, some items requires a special attention, and you must inform us in some cases:<br />
<br />
===Changes that breaks the games in progress===<br />
<br />
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.<br />
<br />
Example of changes that break the games in progress:<br />
* Changes in the database schema of the game (dbmodel.sql).<br />
* New global variable or game option accessed during the game (if it's only used during setup, it should be safe).<br />
* New statistic (it won't be initialized properly, so it's going to crash the game).<br />
* Change ID of existing game states (adding new game states is fine).<br />
<br />
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:<br />
* Try to group all your updates in one version, thus we won't have to block your game several times.<br />
* Tell us explicitly that you introduce some update that can break games in progress so we can block the game during a short time.<br />
<br />
Note: in the near future, we will introduce the possibility for you to block/unblock a game directly from your Control Panel in order to perform all the process by yourself.<br />
<br />
=== Updating Statistics ===<br />
<br />
You should be careful when updating a statistics:<br />
<br />
* If you want to add a new statistics, please refer to the paragraph above ("changes that breaks the games in progress").<br />
* If you want to update a statistic, please update it and do not remove/create another one. Otherwise, the statistic won't keep the same ID and players will lost all the historical statistics data.<br />
* If your game is published on BGA, please don't remove any statistics (historical data will be lost).<br />
<br />
=== Updating the database schema ===<br />
<br />
If you want to update the database schema of the game (dbmodel.sql), you should inform us before releasing the new version (see "[[#Changes that breaks the games in progress|changes that breaks the games in progress]]").<br />
<br />
Any modification in dbmodel.sql should also appear in your nameofyourgame.game.php, in a function<br />
<br />
function upgradeTableDb( $from_version ){<br />
<br />
if( $from_version <= YYMMDDHHMM ){ // where your CURRENT version in production has number YYMMDD-HHMM<br />
<br />
// You DB schema update request.<br />
// Note: all tables names should be prefixed by "DBPREFIX_" to be compatible with the applyDbUpgradeToAllDB method you should use below<br />
$sql = "CREATE TABLE DBPREFIX_xxxxxxx ....";<br />
<br />
// The method below is applying your DB schema update request to all tables, including the BGA framework utility tables like "zz_replayXXXX" or "zz_savepointXXXX".<br />
// You should really use this request, in conjunction with "DBPREFIX_" in your $sql, so ALL tables are updated. All utility tables MUST have the same schema than the main table, otherwise the game may be blocked.<br />
self::applyDbUpgradeToAllDB( $sql );<br />
<br />
}}<br />
<br />
Note: of course you need to change your dbmodel.sql accordingly, so that new games get your updated scheme.<br />
<br />
Note2: this is always risky to modify the DB scheme, so:<br />
_ it may be worthy to contact us before, so we can stop the realtime games during the update (this way, only turn based games are concerned by the DB live upgrade).<br />
_ if you can avoid it... try to avoid it :)<br />
<br />
=== Updating string to be translated ===<br />
<br />
When you update a string that has been marked to be translatable, please keep in mind that all current translations done by the BGA community will be lost.<br />
<br />
Consequently, when you are about to modify a string to be translated (after release), please ask you the following questions:<br />
* Is it just an English misspelling? In this case, it is better to fix the English translation of the string than the original string to be translated.<br />
* Has the meaning of the string changed? If yes, you HAVE to change the original string in order to invalidate all translations that has been done already.<br />
* Is there a similar string already used elsewhere in my game? In this case, you'd better use it again to enjoy immediately all translations already available.<br />
<br />
===Major changes===<br />
<br />
If you do some major changes to your game like:<br />
* Introducing a new expansion.<br />
* Major code rewriting/refactoring.<br />
<br />
... please tell us. In this case, we can:<br />
* Make your game back from "gold" to "public beta", to incite player to report bugs.<br />
* And eventually, publish a news about it :)</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Post-release_phase&diff=3073Post-release phase2018-05-22T08:37:43Z<p>Sourisdudesert: /* Updating the database schema */</p>
<hr />
<div><br />
Your game is now on BGA: congrats!<br />
<br />
But what happened when there are some bugs to fix or when you want to optimize something?<br />
<br />
Don't be afraid: you're still allowed to modify your game. You just have to pay attention to the points below.<br />
<br />
== Bugs reporting ==<br />
<br />
Bugs are reported in the [http://forum.boardgamearena.com/viewforum.php?f=4 BGA bugs forum].<br />
<br />
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.<br />
<br />
== How to submit changes? ==<br />
<br />
There is 3 (short) steps to make your changes visible on BGA (from your Control Panel):<br />
<br />
* Commit your changes.<br />
* Build a new version (don't forget to do a successful commit BEFORE your build).<br />
* Deploy your new version in production.<br />
<br />
<br />
== What can be modified after release? ==<br />
<br />
Everything can be modified. BUT, some items requires a special attention, and you must inform us in some cases:<br />
<br />
===Changes that breaks the games in progress===<br />
<br />
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.<br />
<br />
Example of changes that break the games in progress:<br />
* Changes in the database schema of the game (dbmodel.sql).<br />
* New global variable or game option accessed during the game (if it's only used during setup, it should be safe).<br />
* New statistic (it won't be initialized properly, so it's going to crash the game).<br />
* Change ID of existing game states (adding new game states is fine).<br />
<br />
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:<br />
* Try to group all your updates in one version, thus we won't have to block your game several times.<br />
* Tell us explicitly that you introduce some update that can break games in progress so we can block the game during a short time.<br />
<br />
Note: in the near future, we will introduce the possibility for you to block/unblock a game directly from your Control Panel in order to perform all the process by yourself.<br />
<br />
=== Updating Statistics ===<br />
<br />
You should be careful when updating a statistics:<br />
<br />
* If you want to add a new statistics, please refer to the paragraph above ("changes that breaks the games in progress").<br />
* If you want to update a statistic, please update it and do not remove/create another one. Otherwise, the statistic won't keep the same ID and players will lost all the historical statistics data.<br />
* If your game is published on BGA, please don't remove any statistics (historical data will be lost).<br />
<br />
=== Updating the database schema ===<br />
<br />
If you want to update the database schema of the game (dbmodel.sql), you should inform us before releasing the new version (see "[[#Changes that breaks the games in progress|changes that breaks the games in progress]]").<br />
<br />
Any modification in dbmodel.sql should also appear in your nameofyourgame.game.php, in a function<br />
<br />
function upgradeTableDb( $from_version ){<br />
<br />
if( $from_version <= YYMMDDHHMM ){ // where your CURRENT version in production has number YYMMDD-HHMM<br />
<br />
// You DB schema update request.<br />
// Note: all tables names should be prefixed by "DBPREFIX_" to be compatible with the applyDbUpgradeToAllDB method you should use below<br />
$sql = "CREATE TABLE DBPREFIX_xxxxxxx ....";<br />
<br />
// The method below is applying your DB schema update request to all tables, including the BGA framework utility tables like "zz_replayXXXX" or "zz_savepointXXXX".<br />
// You should really use this request, in conjunction with "DBPREFIX_" in your $sql, so ALL tables are updated. All utility tables MUST have the same schema than the main table, otherwise the game may be blocked.<br />
self::applyDbUpgradeToAllDB( $sql );<br />
<br />
}}<br />
<br />
Note: of course you need to change your dbmodel.sql accordingly, so that new games get your updated scheme.<br />
<br />
Note2: this is always risky to modify the DB scheme, so:<br />
_ it may be worthy to contact us before, so we can stop the realtime games during the update (this way, only turn based games are concerned by the DB live upgrade).<br />
_ if you can avoid it... try to avoid it :)<br />
<br />
=== Updating string to be translated ===<br />
<br />
When you update a string that has been marked to be translatable, please keep in mind that all current translations done by the BGA community will be lost.<br />
<br />
Consequently, when you are about to modify a string to be translated (after release), please ask you the following questions:<br />
* Is it just an English misspelling? In this case, it is better to fix the English translation of the string than the original string to be translated.<br />
* Has the meaning of the string changed? If yes, you HAVE to change the original string in order to invalidate all translations that has been done already.<br />
* Is there a similar string already used elsewhere in my game? In this case, you'd better use it again to enjoy immediately all translations already available.<br />
<br />
===Major changes===<br />
<br />
If you do some major changes to your game like:<br />
* Introducing a new expansion.<br />
* Major code rewriting/refactoring.<br />
<br />
... please tell us. In this case, we can:<br />
* Make your game back from "gold" to "public beta", to incite player to report bugs.<br />
* And eventually, publish a news about it :)</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Post-release_phase&diff=3072Post-release phase2018-05-22T08:37:34Z<p>Sourisdudesert: /* Updating the database schema */</p>
<hr />
<div><br />
Your game is now on BGA: congrats!<br />
<br />
But what happened when there are some bugs to fix or when you want to optimize something?<br />
<br />
Don't be afraid: you're still allowed to modify your game. You just have to pay attention to the points below.<br />
<br />
== Bugs reporting ==<br />
<br />
Bugs are reported in the [http://forum.boardgamearena.com/viewforum.php?f=4 BGA bugs forum].<br />
<br />
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.<br />
<br />
== How to submit changes? ==<br />
<br />
There is 3 (short) steps to make your changes visible on BGA (from your Control Panel):<br />
<br />
* Commit your changes.<br />
* Build a new version (don't forget to do a successful commit BEFORE your build).<br />
* Deploy your new version in production.<br />
<br />
<br />
== What can be modified after release? ==<br />
<br />
Everything can be modified. BUT, some items requires a special attention, and you must inform us in some cases:<br />
<br />
===Changes that breaks the games in progress===<br />
<br />
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.<br />
<br />
Example of changes that break the games in progress:<br />
* Changes in the database schema of the game (dbmodel.sql).<br />
* New global variable or game option accessed during the game (if it's only used during setup, it should be safe).<br />
* New statistic (it won't be initialized properly, so it's going to crash the game).<br />
* Change ID of existing game states (adding new game states is fine).<br />
<br />
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:<br />
* Try to group all your updates in one version, thus we won't have to block your game several times.<br />
* Tell us explicitly that you introduce some update that can break games in progress so we can block the game during a short time.<br />
<br />
Note: in the near future, we will introduce the possibility for you to block/unblock a game directly from your Control Panel in order to perform all the process by yourself.<br />
<br />
=== Updating Statistics ===<br />
<br />
You should be careful when updating a statistics:<br />
<br />
* If you want to add a new statistics, please refer to the paragraph above ("changes that breaks the games in progress").<br />
* If you want to update a statistic, please update it and do not remove/create another one. Otherwise, the statistic won't keep the same ID and players will lost all the historical statistics data.<br />
* If your game is published on BGA, please don't remove any statistics (historical data will be lost).<br />
<br />
=== Updating the database schema ===<br />
<br />
If you want to update the database schema of the game (dbmodel.sql), you should inform us before releasing the new version (see "[[#Changes that breaks the games in progress|changes that breaks the games in progress]]").<br />
<br />
Any modification in dbmodel.sql should also appear in your nameofyourgame.game.php, in a function<br />
<br />
function upgradeTableDb( $from_version ){<br />
<br />
if( $from_version <= YYMMDDHHMM ){ // where your CURRENT version in production has number YYMMDD-HHMM<br />
<br />
// You DB schema update request.<br />
// Note: all tables names should be prefixed by "DBPREFIX_" to be compatible with the applyDbUpgradeToAllDB method you should use below<br />
$sql = "CREATE TABLE DBPREFIX_xxxxxxx ....";<br />
<br />
// The method below is applying your DB schema update request to all tables, including the BGA framework utility tables like "zz_replayXXXX" or "zz_savepointXXXX".<br />
// You should really use this request, in conjunction with "DBPREFIX_" in your $sql, so ALL tables are updated. All utility tables MUST have the same schema than the main table, otherwise the game may be blocked.<br />
self::applyDbUpgradeToAllDB( $sql );<br />
<br />
}}<br />
<br />
Note: of course you need to change your dbmodel.sql accordingly, so that new games get your updated scheme.<br />
<br />
Note2: this is always risky to modify the DB scheme, so:<br />
_ it may be worthy to contact us before, so we can stop the realtime games during the update (this way, only turn based games are concerned by the DB live upgrade).<br />
_ if you can avoid it... try to avoid it :)<br />
<br />
=== Updating string to be translated ===<br />
<br />
When you update a string that has been marked to be translatable, please keep in mind that all current translations done by the BGA community will be lost.<br />
<br />
Consequently, when you are about to modify a string to be translated (after release), please ask you the following questions:<br />
* Is it just an English misspelling? In this case, it is better to fix the English translation of the string than the original string to be translated.<br />
* Has the meaning of the string changed? If yes, you HAVE to change the original string in order to invalidate all translations that has been done already.<br />
* Is there a similar string already used elsewhere in my game? In this case, you'd better use it again to enjoy immediately all translations already available.<br />
<br />
===Major changes===<br />
<br />
If you do some major changes to your game like:<br />
* Introducing a new expansion.<br />
* Major code rewriting/refactoring.<br />
<br />
... please tell us. In this case, we can:<br />
* Make your game back from "gold" to "public beta", to incite player to report bugs.<br />
* And eventually, publish a news about it :)</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Multipleaccounts&diff=2999Multipleaccounts2018-04-23T17:04:54Z<p>Sourisdudesert: </p>
<hr />
<div>== The Main Rule ==<br />
<br />
'''One BGA account = One person'''<br />
<br />
<br />
== Playing from the same IP ==<br />
<br />
This is '''authorized''' to play at the same table from the same IP (internet address).<br />
<br />
Warning: playing from the same location is a Premium feature. For details see: https://boardgamearena.com/#premium<br />
<br />
The warning message "this player plays from the same internet address as another player" is a '''simple warning'''. It is a useful warning, because the other players have the right to know that there are players at their table that are able to discuss out of game.<br />
<br />
If you want to play from the same internet address as another person:<br />
* The best option is not to play at the same table, or play at a table where you know everyone.<br />
* If you play with strangers, make them comfortable with the fact you are 2 (or more) different people: don't discuss about the game outside the chatroom, don't collaborate (or do kingmaking) with your partner.<br />
<br />
When some of your opponents are playing from the same IP:<br />
* You may politely refuse to play with them.<br />
* You should be vigilant and check that they are not collaborating during the game.<br />
* You don't have to report them until they are doing a concrete kingmaking action. If you report some players saying that "they are playing from the same IP" without any kingmaking proof, we will close your report.<br />
<br />
== Boosting your ELO by playing against yourself ==<br />
<br />
This is the most stupid and useless thing to do on BGA.<br />
<br />
Why? Because this is very easy to detect, and because the penalty is:<br />
* all your secondary account are removed.<br />
* your primary account is reset to 1500 ELO for all games.<br />
<br />
Why this is so easy to detect:<br />
* When you start having a very good ELO, all other good players will look at you and your game history. In the game history, this is really easy to see how you manage to have a good ELO.<br />
* In BGA, every game can be replayed. So if a game is suspect, anyone can replay it and check if this is a real game or a fake game.<br />
* In addition to this, we are using some automatic methods and some technical information that allow us to check if "one person = one account".<br />
* Consequently, it happens that some players manage to do ELO boosting, but at the end they are all detected and reset to 1500. This is why this is a waste of time for everyone, and this is why this is useless.<br />
<br />
If you have a lot of time to spend, please try to get better at this game and please do not try to cheat.</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=ServiceOutage&diff=2995ServiceOutage2018-04-21T09:21:45Z<p>Sourisdudesert: </p>
<hr />
<div><br />
<br />
No recent service outage.<br />
<br />
<br />
<br />
=== Our philosophy ===<br />
<br />
Having a gaming service available 24 hours a day, 7 days a week is not something easy to achieve for a (very) small team like ours. In addition, BGA is a realtime service, and any service outage may ruins games in progress.<br />
<br />
Our philosophy is to be transparent on service outages, by explaining why it happens, what has been impacted (and how long), and what we did to make sure it won't happen again. Explaining all of this is the goal of this page.<br />
<br />
Note: If an incident is in progress, '''we may not update this page in realtime'''.</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Faq&diff=2655Faq2017-08-23T13:29:48Z<p>Sourisdudesert: /* How you guys make money? Do you make a living of it? */</p>
<hr />
<div>[[Category:Help]]<br />
<br />
== General questions ==<br />
<br />
===What is Board Game Arena?===<br />
<br />
Board Game Arena (BGA) is an online board game platform. With BGA, you can play online and in real time against players from around the world. A selection of various board games and card games are available. In order to play, the only thing you need is your browser!<br />
<br />
===What do you mean by "real time play"?===<br />
<br />
On Board Game Arena your opponents are connected to the game platform during the entire game. They can see your moves and react to them immediately - as is the case in the real world.<br />
<br />
===What is "turn based play"?===<br />
<br />
This is often referred to as "asynchronous play" on other sites, and is used here to differentiate from "real time play". Instead of all players being around the table at the same time, players leave and come back. After your opponent takes a move you are notified that it is your turn (via email or on your next visit to the site). You then go to your game, take your turn, and the process repeats for the next player.<br />
<br />
For details please read [[Turn based FAQ]].<br />
<br />
===What do I need to play?===<br />
<br />
Your browser ... and that's it!<br />
<br />
Board Game Arena does not require anything else on your computer. Thus, you can play from any computer, anywhere, anytime!<br />
<br />
In order to make this possible, we are using the latest technologies available for the web. This is the reason you should play with the most up to date web browsers to enjoy an optimal BGA experience (read more about our [[Browser_support|browser policy]]).<br />
<br />
===How much does it cost to play on BGA?===<br />
<br />
Playing on BGA is free.<br />
<br />
You can also choose to help us by contributing to the website or by getting [http://en.boardgamearena.com/#!premium Premium] member.<br />
<br />
===What games are available on BGA?===<br />
<br />
Board Game Arena offers a selection of board and card games, but specializes in modern ("European style") adult games.<br />
<br />
[http://en.boardgamearena.com/#!gamelist See available games].<br />
<br />
== Meeting players and starting games ==<br />
<br />
===I launched a new table but nobody is joining?===<br />
<br />
For the most popular games, you can find players at any time of day. For other games, we advise you to come back at peak hour (around 22:00 CEST) if you can't find opponents at the moment.<br />
<br />
Tip: check the number of online/available players for a game before launching the table.<br />
<br />
Tip: if nobody is available for a realtime game, you can turn your table into a turn-based table, so another player can join even hours/days after you created it.<br />
<br />
===I joined a game. When does the game start?===<br />
<br />
'''For realtime games''':<br />
<br />
Each table has an administrator, who is the table creator. It is the responsibility of the table administrator to start the game when he or she is satisfied with the number of players who have joined the table.<br />
<br />
If you are the table administrator and can't launch the game, most of the time it's because there are not yet enough players who have joined the table.<br />
<br />
<br />
'''For turnbased games''':<br />
<br />
The game starts as soon as the maximum number of players has been reached. The table administrator can also start the game manually any time after the minimum number of required players have joined.<br />
<br />
===What does the small colored circle next to a player's name mean?===<br />
<br />
* http://fr.boardgamearena.com/theme/img/status/online_.png : this player is active. He or she completed an action very recently.<br />
* http://fr.boardgamearena.com/theme/img/status/inactive_.png : this player is inactive. He or she is connected to the website but has not performed any action recently.<br />
* http://fr.boardgamearena.com/theme/img/status/offline_.png : this player is offline.<br />
<br />
===What does the '% hits' statistic mean?===<br />
% hits = number of victory points / number of games played<br />
<br />
Players earn more victory points for winning a game that has more players (half a point per player). So:<br />
* When you win a 2 players game: 1 point.<br />
* When you win a 3 players game: 1.5 points.<br />
* When you win a 4 players game: 2 points.<br />
* etc.<br />
<br />
For example, a player who plays a three player game and wins a third of the time will have: "50% hits", while a player who plays a four person game and wins a third of the time, will have: "67% hits"<br />
<br />
== During the game ==<br />
<br />
===What do the icons next to players' names mean?===<br />
<br />
* http://fr.boardgamearena.com/theme/img/layout/active_player.gif : this player must make a move now.<br />
* http://fr.boardgamearena.com/theme/img/layout/active_player_clockalert.gif : this player must make a move now, and has used up their reflection time. Can someone wake them up? ;)<br />
* http://fr.boardgamearena.com/theme/img/layout/active_player_nonack.gif : this player must make a move now, but is probably not aware of this fact. If the situation doesn't change, it might suggest that this player has a connection issue.<br />
* http://fr.boardgamearena.com/theme/img/common/zombie.png : this player is a "zombie" (has left the game or been fired from the game). The game is going on without this player.<br />
<br />
When the "normal" avatar of a player is displayed, it means that this player is waiting for their turn to play.<br />
<br />
===A player has to make a move but he/she doesn't. What can I do?===<br />
<br />
* First, please remember that this player has the right to think as long as they need to about the next move... well as long as there is still some time left on the game clock, that is.<br />
* Then you can ask this player to confirm that he or she is still thinking about how to play.<br />
* If this player seems to be away, we advise you to wait a few minutes: this player may be experiencing some network problems or have left the computer temporarily.<br />
* If the player is not coming back, you can skip their turn as soon as the clock is negative. This player will get a "leave" penalty and you will win "by forfeit".<br />
<br />
For more details, please read [[Game clock]].<br />
<br />
===What is the current progression of the game I'm playing?===<br />
<br />
A percentage of progression is displayed on the top of the web page.<br />
There is also a progress bar at the bottom of the web page shows you the current progression of the game.<br />
<br />
<br />
===What is forbidden on Board Game Arena?===<br />
<br />
* Leaving a game in progress on purpose.<br />
* Taking an unnecessary and unreasonable amount of time at the end of game in an obvious losing situation.<br />
* Kingmaking: enabling another player to win on purpose while there is a better move to make for yourself.<br />
* Running out of time on the game clock.<br />
* Giving some piece of information about the current game situation that corrupts the normal game flow.<br />
* Communicating with another player about the game privately (ex: with MSN).<br />
* Provocation / triumphalism / defeatism ... anything which is not fair play.<br />
* Having a shocking avatar (no advertisement, no politics, ...)<br />
<br />
Going against these rules will affect your reputation.<br />
<br />
<br />
===What is absolutely forbidden in Board Game Arena?===<br />
<br />
* Creating multiple accounts and playing against oneself.<br />
* Insulting other players in any manner.<br />
<br />
Going against these rules can lead to the removal of your account and/or to the blacklisting of your IP.<br />
<br />
<br />
===What if some player does something wrong?===<br />
<br />
The Board Game Arena platform has been designed to encourage players to maintain good behavior. The reputation system allows you to distinguish between good and bad players. Then, it is up to you to decide whether to start a game with them or not.<br />
<br />
If you think a player has behaved badly during a game, you can give them a "red thumb" at the end of the game.<br />
<br />
If you think a player has committed a serious wrongdoing during a game (ex: insult), please report this player to us, using the "report this player" link from their profile or game result page, so that we can take appropriate measures.<br />
<br />
== Tournaments ==<br />
<br />
Tournaments is a BETA feature of BGA (for a long time).<br />
<br />
Tournament management is very complex. We'd like to open tournament creation to everyone at some time in the future but it need a lot of work and until then we always had something more urgent to do.<br />
<br />
When tournaments will be improved, this FAQ section will be improved too.<br />
<br />
<br />
== About board games we proposed on BGA ==<br />
<br />
<br />
===What is the legal status of this website?===<br />
<br />
All the games currently available on this site have been licensed or otherwise authorized by copyright holders. Please be aware that games available on BGA can be removed at the copyright holders demand (for example: if they publish their own adaptation of the game).<br />
<br />
Board Game Arena would like to thank all game publishers and game designers who allow us to have their games here, thus making it possible for this website to exist.<br />
<br />
=== How do we select games that are on BGA? Why the game XXX is not on BGA? ===<br />
<br />
To have a game published on BGA we need 2 things:<br />
* The authorization of the rights owner (most of the time: original publisher of the game).<br />
* A software developer who develops the adaptation (ie: has some time available to develop it).<br />
<br />
We (= BGA team) are trying a lot of board games ourselves. Sometimes we are lucky enough to play prototypes too. And of course we receive a lot of game suggestions through the BGA forum, the BoardGameGeek "most wanted games" list, or by any other means. Based on this we are asking game publishers for authorizations, and sometimes we also receive requests directly from game publishers - there is no rule.<br />
<br />
As it is today, BGA has a very good reputation and very productive relationships with almost all major board game publishers, but this is not enough: each situation is specific, and there can be various reasons why a game publisher can refuse to see a game adaptation on BGA (for example: board games with a third party licence, like "Star Wars", is practically impossible to negotiate).<br />
<br />
On the other hand, we got some authorizations for some very good games but no developers volunteering to develop them, or sometimes some of them don't manage to finish the job. Developers of adaptations are volunteers, and we don't blame them for this.<br />
<br />
Finally, some games are authorized and being developed, but the time frame is not good. For example, it happened that we had too many games to release and we decided to delay some of them. It also frequently happens that we must synchronize the release of a game with a publisher event, so the game adaptation can stay "on hold" for some months.<br />
<br />
So if you are asking yourself: why game XXX is not on BGA, it could be for various reasons:<br />
* Maybe we never asked authorization for this game. Note that usually we ask authorizations for every popular games (ex: "Most wanted games"). So if the game is popular, the reason is probably not this one.<br />
* The publisher refused.<br />
* The publisher accepted, but we didn't find a developer until now for this game.<br />
* The game adaptation is ready, but we are waiting for a specific event to release it.<br />
<br />
<br />
To conclude: yes we are taking into account your suggestions, but as you can see there are many factors than can influence the fact that a game is (or is not) on BGA. In addition, as a rule of thumb, we don't communicate about "why" this game is not on BGA. If we already got the authorization, we want to keep the "surprise", and if we didn't get the authorization, the game publisher may not want to explain the reasons.<br />
<br />
=== Are you taking into account the "Most wanted games" list? When will these games be on BGA? ===<br />
<br />
You should read first the previous section ("how do we select games that are on BGA?").<br />
<br />
So the answer is:<br />
* Yes, we are taking this list into account.<br />
* For most of these games we already asked for authorizations.<br />
* Some of these games won't be on BGA (authorization refused), some may be, some are in an "intermediate" step.<br />
* We don't communicate about future game releases anyway.<br />
<br />
=== Why do some games have expansions on BGA and some don't? ===<br />
<br />
You should read first the previous section ("how do we select games that are on BGA?").<br />
<br />
Game expansions follow the same steps than games. There can be various reasons why a game publisher doesn't want the expansion online, and sometimes we don't find a developer that has the time to develop it.<br />
<br />
===I'm a game publisher: why would I like to have my game on Board Game Arena?===<br />
<br />
The main goal of Board Game Arena is to make it easy for people to discover and love new games. We think that there are only two kinds of players on Board Game Arena: those who already bought the games they are playing online, and those who plan to buy them soon!<br />
<br />
As the activity of this website contributes to increasing a game's popularity and thus generates hard copy sales in the "real world", we think it is beneficial to the board game community: people from all over the world can play online, we can have fun developing this game platform to the best of our ability, and game publishers get money from the box sales and build a special relationship with their player's community.<br />
<br />
=== I'm a game publisher: how to get my game on Board Game Arena ===<br />
<br />
You should read our [https://boardgamearena.com/#!gamepublishers Board Game Arena for game publishers] section.<br />
<br />
== Turn-based mode ==<br />
<br />
Please read [[Turn based FAQ]].<br />
<br />
== Issues with BGA ==<br />
<br />
===What can I do if I have an issue with the website?===<br />
<br />
Most of the issues on this website should be solved with a simple web page refresh (or "F5").<br />
<br />
If you experience persistent issues, you can browse the [http://boardgamearena.com/#!bugs bug tool], see if someone already reported the issue, and add a new bug report if that's not the case. Please take some time to describe the bug you are reporting in detail so that we can quickly reproduce and fix it.<br />
<br />
=== Why is my bug still not fixed? ===<br />
<br />
We fix bugs every weeks. Of course we have priorities:<br />
* We give the highest priority to recent features and recent games, because the most important bugs are reported fast.<br />
* We give the highest priority to the bugs with the biggest number of "green thumb" on the [http://boardgamearena.com/#!bugs bug tool].<br />
* Usually we fix bugs by group. So if we decide to fix an important bug on a game, there is a chance that we will fix 3 or 4 minor bugs at the same time.<br />
<br />
BGA is known for the quality of its adaptations, and if you look at the bug tool, you can see that -considering the number of games and the size of the community- there are not so many critical bugs with a lot of "green thumbs".<br />
<br />
Please also note that BGA adaptations are realized by volunteers (even if most of them are also professional developers). It is not always easy for them to fix bugs, especially when some players are complaining violently and/or do not give precise information in bug reports.<br />
<br />
<br />
=== I played on smartphone / tablet / touch device and I have some difficulties: what can I do? ===<br />
<br />
As a rule of thumb, BGA does not support tablets/smartphones. There are tons of board game adaptations for tablets/smartphones, and some BGA adaptations are not well designed for small screens. Thus, we don't have plans to do a mobile / tablet version at the moment.<br />
<br />
So if you want to use BGA from a smartphone / tablet you can, but we don't promise to fix all bugs so it's at your own risk :)<br />
<br />
<br />
=== Why is BGA slow? Why do I have bad connections performances on BGA? ===<br />
<br />
We are constantly monitoring server responsiveness. Some incidents occurs, but most of the time BGA is responsive.<br />
<br />
We designed our game servers (ie: servers used when you are inside a game) to be very responsive. Usually, less than 2% of the game moves take more than 200 milliseconds to process, and less than 0.2% take more than 1 second.<br />
<br />
BGA servers are located in Europe (France), but we bought servers all across the world (19 locations) so that the big files (ex: images) are loaded fast even if you are far from us.<br />
<br />
Most of bad performances came from your internet connection or your system. Try to connect with a different browser / computer / internet connection to troubleshoot the issue.<br />
<br />
As a rule of thumb, if BGA is not responsive enough, you shouldn't engage yourself into a game because there is a risk for you to get clock penalties.<br />
<br />
=== I got issue with a specific player: how does the moderation works? ===<br />
<br />
You should read [[Moderation and grades]] page.<br />
<br />
== Contribute to BGA ==<br />
<br />
=== How can I contribute to BGA? ===<br />
<br />
Please visit page [http://boardgamearena.com/#!contribute Contribute to BGA].<br />
<br />
=== I'm a software developer. What can I do? ===<br />
<br />
We created a website specifically dedicated to board games adaptation development: [http://studio.boardgamearena.com BGA Studio].<br />
<br />
== About the BGA team ==<br />
<br />
=== Who are you? How to contact you? ===<br />
<br />
Please read page [[About us]].<br />
<br />
=== How you guys make money? Do you make a living of it? ===<br />
<br />
After 6 years working on BGA on their free time, both BGA founders (Sourisdudesert and Een) are now working full-time on BGA. This was really required by the growing audience playing on this website, and this has been made possible thanks to all Premium members (thank you again!).<br />
<br />
But to be honest, there is so much work to do on BGA that even two persons working full-time is not enough. This is not really an issue because we think the "community based" approach is the best for BGA and we'd like to continue to give you the possibility to contribute to make this service running.</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Faq&diff=2654Faq2017-08-23T13:27:44Z<p>Sourisdudesert: /* I'm a game publisher: how to get my game on Board Game Arena */</p>
<hr />
<div>[[Category:Help]]<br />
<br />
== General questions ==<br />
<br />
===What is Board Game Arena?===<br />
<br />
Board Game Arena (BGA) is an online board game platform. With BGA, you can play online and in real time against players from around the world. A selection of various board games and card games are available. In order to play, the only thing you need is your browser!<br />
<br />
===What do you mean by "real time play"?===<br />
<br />
On Board Game Arena your opponents are connected to the game platform during the entire game. They can see your moves and react to them immediately - as is the case in the real world.<br />
<br />
===What is "turn based play"?===<br />
<br />
This is often referred to as "asynchronous play" on other sites, and is used here to differentiate from "real time play". Instead of all players being around the table at the same time, players leave and come back. After your opponent takes a move you are notified that it is your turn (via email or on your next visit to the site). You then go to your game, take your turn, and the process repeats for the next player.<br />
<br />
For details please read [[Turn based FAQ]].<br />
<br />
===What do I need to play?===<br />
<br />
Your browser ... and that's it!<br />
<br />
Board Game Arena does not require anything else on your computer. Thus, you can play from any computer, anywhere, anytime!<br />
<br />
In order to make this possible, we are using the latest technologies available for the web. This is the reason you should play with the most up to date web browsers to enjoy an optimal BGA experience (read more about our [[Browser_support|browser policy]]).<br />
<br />
===How much does it cost to play on BGA?===<br />
<br />
Playing on BGA is free.<br />
<br />
You can also choose to help us by contributing to the website or by getting [http://en.boardgamearena.com/#!premium Premium] member.<br />
<br />
===What games are available on BGA?===<br />
<br />
Board Game Arena offers a selection of board and card games, but specializes in modern ("European style") adult games.<br />
<br />
[http://en.boardgamearena.com/#!gamelist See available games].<br />
<br />
== Meeting players and starting games ==<br />
<br />
===I launched a new table but nobody is joining?===<br />
<br />
For the most popular games, you can find players at any time of day. For other games, we advise you to come back at peak hour (around 22:00 CEST) if you can't find opponents at the moment.<br />
<br />
Tip: check the number of online/available players for a game before launching the table.<br />
<br />
Tip: if nobody is available for a realtime game, you can turn your table into a turn-based table, so another player can join even hours/days after you created it.<br />
<br />
===I joined a game. When does the game start?===<br />
<br />
'''For realtime games''':<br />
<br />
Each table has an administrator, who is the table creator. It is the responsibility of the table administrator to start the game when he or she is satisfied with the number of players who have joined the table.<br />
<br />
If you are the table administrator and can't launch the game, most of the time it's because there are not yet enough players who have joined the table.<br />
<br />
<br />
'''For turnbased games''':<br />
<br />
The game starts as soon as the maximum number of players has been reached. The table administrator can also start the game manually any time after the minimum number of required players have joined.<br />
<br />
===What does the small colored circle next to a player's name mean?===<br />
<br />
* http://fr.boardgamearena.com/theme/img/status/online_.png : this player is active. He or she completed an action very recently.<br />
* http://fr.boardgamearena.com/theme/img/status/inactive_.png : this player is inactive. He or she is connected to the website but has not performed any action recently.<br />
* http://fr.boardgamearena.com/theme/img/status/offline_.png : this player is offline.<br />
<br />
===What does the '% hits' statistic mean?===<br />
% hits = number of victory points / number of games played<br />
<br />
Players earn more victory points for winning a game that has more players (half a point per player). So:<br />
* When you win a 2 players game: 1 point.<br />
* When you win a 3 players game: 1.5 points.<br />
* When you win a 4 players game: 2 points.<br />
* etc.<br />
<br />
For example, a player who plays a three player game and wins a third of the time will have: "50% hits", while a player who plays a four person game and wins a third of the time, will have: "67% hits"<br />
<br />
== During the game ==<br />
<br />
===What do the icons next to players' names mean?===<br />
<br />
* http://fr.boardgamearena.com/theme/img/layout/active_player.gif : this player must make a move now.<br />
* http://fr.boardgamearena.com/theme/img/layout/active_player_clockalert.gif : this player must make a move now, and has used up their reflection time. Can someone wake them up? ;)<br />
* http://fr.boardgamearena.com/theme/img/layout/active_player_nonack.gif : this player must make a move now, but is probably not aware of this fact. If the situation doesn't change, it might suggest that this player has a connection issue.<br />
* http://fr.boardgamearena.com/theme/img/common/zombie.png : this player is a "zombie" (has left the game or been fired from the game). The game is going on without this player.<br />
<br />
When the "normal" avatar of a player is displayed, it means that this player is waiting for their turn to play.<br />
<br />
===A player has to make a move but he/she doesn't. What can I do?===<br />
<br />
* First, please remember that this player has the right to think as long as they need to about the next move... well as long as there is still some time left on the game clock, that is.<br />
* Then you can ask this player to confirm that he or she is still thinking about how to play.<br />
* If this player seems to be away, we advise you to wait a few minutes: this player may be experiencing some network problems or have left the computer temporarily.<br />
* If the player is not coming back, you can skip their turn as soon as the clock is negative. This player will get a "leave" penalty and you will win "by forfeit".<br />
<br />
For more details, please read [[Game clock]].<br />
<br />
===What is the current progression of the game I'm playing?===<br />
<br />
A percentage of progression is displayed on the top of the web page.<br />
There is also a progress bar at the bottom of the web page shows you the current progression of the game.<br />
<br />
<br />
===What is forbidden on Board Game Arena?===<br />
<br />
* Leaving a game in progress on purpose.<br />
* Taking an unnecessary and unreasonable amount of time at the end of game in an obvious losing situation.<br />
* Kingmaking: enabling another player to win on purpose while there is a better move to make for yourself.<br />
* Running out of time on the game clock.<br />
* Giving some piece of information about the current game situation that corrupts the normal game flow.<br />
* Communicating with another player about the game privately (ex: with MSN).<br />
* Provocation / triumphalism / defeatism ... anything which is not fair play.<br />
* Having a shocking avatar (no advertisement, no politics, ...)<br />
<br />
Going against these rules will affect your reputation.<br />
<br />
<br />
===What is absolutely forbidden in Board Game Arena?===<br />
<br />
* Creating multiple accounts and playing against oneself.<br />
* Insulting other players in any manner.<br />
<br />
Going against these rules can lead to the removal of your account and/or to the blacklisting of your IP.<br />
<br />
<br />
===What if some player does something wrong?===<br />
<br />
The Board Game Arena platform has been designed to encourage players to maintain good behavior. The reputation system allows you to distinguish between good and bad players. Then, it is up to you to decide whether to start a game with them or not.<br />
<br />
If you think a player has behaved badly during a game, you can give them a "red thumb" at the end of the game.<br />
<br />
If you think a player has committed a serious wrongdoing during a game (ex: insult), please report this player to us, using the "report this player" link from their profile or game result page, so that we can take appropriate measures.<br />
<br />
== Tournaments ==<br />
<br />
Tournaments is a BETA feature of BGA (for a long time).<br />
<br />
Tournament management is very complex. We'd like to open tournament creation to everyone at some time in the future but it need a lot of work and until then we always had something more urgent to do.<br />
<br />
When tournaments will be improved, this FAQ section will be improved too.<br />
<br />
<br />
== About board games we proposed on BGA ==<br />
<br />
<br />
===What is the legal status of this website?===<br />
<br />
All the games currently available on this site have been licensed or otherwise authorized by copyright holders. Please be aware that games available on BGA can be removed at the copyright holders demand (for example: if they publish their own adaptation of the game).<br />
<br />
Board Game Arena would like to thank all game publishers and game designers who allow us to have their games here, thus making it possible for this website to exist.<br />
<br />
=== How do we select games that are on BGA? Why the game XXX is not on BGA? ===<br />
<br />
To have a game published on BGA we need 2 things:<br />
* The authorization of the rights owner (most of the time: original publisher of the game).<br />
* A software developer who develops the adaptation (ie: has some time available to develop it).<br />
<br />
We (= BGA team) are trying a lot of board games ourselves. Sometimes we are lucky enough to play prototypes too. And of course we receive a lot of game suggestions through the BGA forum, the BoardGameGeek "most wanted games" list, or by any other means. Based on this we are asking game publishers for authorizations, and sometimes we also receive requests directly from game publishers - there is no rule.<br />
<br />
As it is today, BGA has a very good reputation and very productive relationships with almost all major board game publishers, but this is not enough: each situation is specific, and there can be various reasons why a game publisher can refuse to see a game adaptation on BGA (for example: board games with a third party licence, like "Star Wars", is practically impossible to negotiate).<br />
<br />
On the other hand, we got some authorizations for some very good games but no developers volunteering to develop them, or sometimes some of them don't manage to finish the job. Developers of adaptations are volunteers, and we don't blame them for this.<br />
<br />
Finally, some games are authorized and being developed, but the time frame is not good. For example, it happened that we had too many games to release and we decided to delay some of them. It also frequently happens that we must synchronize the release of a game with a publisher event, so the game adaptation can stay "on hold" for some months.<br />
<br />
So if you are asking yourself: why game XXX is not on BGA, it could be for various reasons:<br />
* Maybe we never asked authorization for this game. Note that usually we ask authorizations for every popular games (ex: "Most wanted games"). So if the game is popular, the reason is probably not this one.<br />
* The publisher refused.<br />
* The publisher accepted, but we didn't find a developer until now for this game.<br />
* The game adaptation is ready, but we are waiting for a specific event to release it.<br />
<br />
<br />
To conclude: yes we are taking into account your suggestions, but as you can see there are many factors than can influence the fact that a game is (or is not) on BGA. In addition, as a rule of thumb, we don't communicate about "why" this game is not on BGA. If we already got the authorization, we want to keep the "surprise", and if we didn't get the authorization, the game publisher may not want to explain the reasons.<br />
<br />
=== Are you taking into account the "Most wanted games" list? When will these games be on BGA? ===<br />
<br />
You should read first the previous section ("how do we select games that are on BGA?").<br />
<br />
So the answer is:<br />
* Yes, we are taking this list into account.<br />
* For most of these games we already asked for authorizations.<br />
* Some of these games won't be on BGA (authorization refused), some may be, some are in an "intermediate" step.<br />
* We don't communicate about future game releases anyway.<br />
<br />
=== Why do some games have expansions on BGA and some don't? ===<br />
<br />
You should read first the previous section ("how do we select games that are on BGA?").<br />
<br />
Game expansions follow the same steps than games. There can be various reasons why a game publisher doesn't want the expansion online, and sometimes we don't find a developer that has the time to develop it.<br />
<br />
===I'm a game publisher: why would I like to have my game on Board Game Arena?===<br />
<br />
The main goal of Board Game Arena is to make it easy for people to discover and love new games. We think that there are only two kinds of players on Board Game Arena: those who already bought the games they are playing online, and those who plan to buy them soon!<br />
<br />
As the activity of this website contributes to increasing a game's popularity and thus generates hard copy sales in the "real world", we think it is beneficial to the board game community: people from all over the world can play online, we can have fun developing this game platform to the best of our ability, and game publishers get money from the box sales and build a special relationship with their player's community.<br />
<br />
=== I'm a game publisher: how to get my game on Board Game Arena ===<br />
<br />
You should read our [https://boardgamearena.com/#!gamepublishers Board Game Arena for game publishers] section.<br />
<br />
== Turn-based mode ==<br />
<br />
Please read [[Turn based FAQ]].<br />
<br />
== Issues with BGA ==<br />
<br />
===What can I do if I have an issue with the website?===<br />
<br />
Most of the issues on this website should be solved with a simple web page refresh (or "F5").<br />
<br />
If you experience persistent issues, you can browse the [http://boardgamearena.com/#!bugs bug tool], see if someone already reported the issue, and add a new bug report if that's not the case. Please take some time to describe the bug you are reporting in detail so that we can quickly reproduce and fix it.<br />
<br />
=== Why is my bug still not fixed? ===<br />
<br />
We fix bugs every weeks. Of course we have priorities:<br />
* We give the highest priority to recent features and recent games, because the most important bugs are reported fast.<br />
* We give the highest priority to the bugs with the biggest number of "green thumb" on the [http://boardgamearena.com/#!bugs bug tool].<br />
* Usually we fix bugs by group. So if we decide to fix an important bug on a game, there is a chance that we will fix 3 or 4 minor bugs at the same time.<br />
<br />
BGA is known for the quality of its adaptations, and if you look at the bug tool, you can see that -considering the number of games and the size of the community- there are not so many critical bugs with a lot of "green thumbs".<br />
<br />
Please also note that BGA adaptations are realized by volunteers (even if most of them are also professional developers). It is not always easy for them to fix bugs, especially when some players are complaining violently and/or do not give precise information in bug reports.<br />
<br />
<br />
=== I played on smartphone / tablet / touch device and I have some difficulties: what can I do? ===<br />
<br />
As a rule of thumb, BGA does not support tablets/smartphones. There are tons of board game adaptations for tablets/smartphones, and some BGA adaptations are not well designed for small screens. Thus, we don't have plans to do a mobile / tablet version at the moment.<br />
<br />
So if you want to use BGA from a smartphone / tablet you can, but we don't promise to fix all bugs so it's at your own risk :)<br />
<br />
<br />
=== Why is BGA slow? Why do I have bad connections performances on BGA? ===<br />
<br />
We are constantly monitoring server responsiveness. Some incidents occurs, but most of the time BGA is responsive.<br />
<br />
We designed our game servers (ie: servers used when you are inside a game) to be very responsive. Usually, less than 2% of the game moves take more than 200 milliseconds to process, and less than 0.2% take more than 1 second.<br />
<br />
BGA servers are located in Europe (France), but we bought servers all across the world (19 locations) so that the big files (ex: images) are loaded fast even if you are far from us.<br />
<br />
Most of bad performances came from your internet connection or your system. Try to connect with a different browser / computer / internet connection to troubleshoot the issue.<br />
<br />
As a rule of thumb, if BGA is not responsive enough, you shouldn't engage yourself into a game because there is a risk for you to get clock penalties.<br />
<br />
=== I got issue with a specific player: how does the moderation works? ===<br />
<br />
You should read [[Moderation and grades]] page.<br />
<br />
== Contribute to BGA ==<br />
<br />
=== How can I contribute to BGA? ===<br />
<br />
Please visit page [http://boardgamearena.com/#!contribute Contribute to BGA].<br />
<br />
=== I'm a software developer. What can I do? ===<br />
<br />
We created a website specifically dedicated to board games adaptation development: [http://studio.boardgamearena.com BGA Studio].<br />
<br />
== About the BGA team ==<br />
<br />
=== Who are you? How to contact you? ===<br />
<br />
Please read page [[About us]].<br />
<br />
=== How you guys make money? Do you make a living of it? ===<br />
<br />
Since the beginning of 2016, one BGA Founder (Sourisdudesert) is working full-time on BGA. It was really required by the growing audience playing on this website, and this has been made possible thanks to all paying members (thank you again!).<br />
<br />
But to be honest, there is so much work to do on BGA that a single person is not enough. This is not really an issue because we think the "community based" approach is the best for BGA and we'd like to continue to give you the possibility to contribute to make this service running.</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Faq&diff=2653Faq2017-08-23T13:26:22Z<p>Sourisdudesert: /* How much does it cost to play on BGA? */</p>
<hr />
<div>[[Category:Help]]<br />
<br />
== General questions ==<br />
<br />
===What is Board Game Arena?===<br />
<br />
Board Game Arena (BGA) is an online board game platform. With BGA, you can play online and in real time against players from around the world. A selection of various board games and card games are available. In order to play, the only thing you need is your browser!<br />
<br />
===What do you mean by "real time play"?===<br />
<br />
On Board Game Arena your opponents are connected to the game platform during the entire game. They can see your moves and react to them immediately - as is the case in the real world.<br />
<br />
===What is "turn based play"?===<br />
<br />
This is often referred to as "asynchronous play" on other sites, and is used here to differentiate from "real time play". Instead of all players being around the table at the same time, players leave and come back. After your opponent takes a move you are notified that it is your turn (via email or on your next visit to the site). You then go to your game, take your turn, and the process repeats for the next player.<br />
<br />
For details please read [[Turn based FAQ]].<br />
<br />
===What do I need to play?===<br />
<br />
Your browser ... and that's it!<br />
<br />
Board Game Arena does not require anything else on your computer. Thus, you can play from any computer, anywhere, anytime!<br />
<br />
In order to make this possible, we are using the latest technologies available for the web. This is the reason you should play with the most up to date web browsers to enjoy an optimal BGA experience (read more about our [[Browser_support|browser policy]]).<br />
<br />
===How much does it cost to play on BGA?===<br />
<br />
Playing on BGA is free.<br />
<br />
You can also choose to help us by contributing to the website or by getting [http://en.boardgamearena.com/#!premium Premium] member.<br />
<br />
===What games are available on BGA?===<br />
<br />
Board Game Arena offers a selection of board and card games, but specializes in modern ("European style") adult games.<br />
<br />
[http://en.boardgamearena.com/#!gamelist See available games].<br />
<br />
== Meeting players and starting games ==<br />
<br />
===I launched a new table but nobody is joining?===<br />
<br />
For the most popular games, you can find players at any time of day. For other games, we advise you to come back at peak hour (around 22:00 CEST) if you can't find opponents at the moment.<br />
<br />
Tip: check the number of online/available players for a game before launching the table.<br />
<br />
Tip: if nobody is available for a realtime game, you can turn your table into a turn-based table, so another player can join even hours/days after you created it.<br />
<br />
===I joined a game. When does the game start?===<br />
<br />
'''For realtime games''':<br />
<br />
Each table has an administrator, who is the table creator. It is the responsibility of the table administrator to start the game when he or she is satisfied with the number of players who have joined the table.<br />
<br />
If you are the table administrator and can't launch the game, most of the time it's because there are not yet enough players who have joined the table.<br />
<br />
<br />
'''For turnbased games''':<br />
<br />
The game starts as soon as the maximum number of players has been reached. The table administrator can also start the game manually any time after the minimum number of required players have joined.<br />
<br />
===What does the small colored circle next to a player's name mean?===<br />
<br />
* http://fr.boardgamearena.com/theme/img/status/online_.png : this player is active. He or she completed an action very recently.<br />
* http://fr.boardgamearena.com/theme/img/status/inactive_.png : this player is inactive. He or she is connected to the website but has not performed any action recently.<br />
* http://fr.boardgamearena.com/theme/img/status/offline_.png : this player is offline.<br />
<br />
===What does the '% hits' statistic mean?===<br />
% hits = number of victory points / number of games played<br />
<br />
Players earn more victory points for winning a game that has more players (half a point per player). So:<br />
* When you win a 2 players game: 1 point.<br />
* When you win a 3 players game: 1.5 points.<br />
* When you win a 4 players game: 2 points.<br />
* etc.<br />
<br />
For example, a player who plays a three player game and wins a third of the time will have: "50% hits", while a player who plays a four person game and wins a third of the time, will have: "67% hits"<br />
<br />
== During the game ==<br />
<br />
===What do the icons next to players' names mean?===<br />
<br />
* http://fr.boardgamearena.com/theme/img/layout/active_player.gif : this player must make a move now.<br />
* http://fr.boardgamearena.com/theme/img/layout/active_player_clockalert.gif : this player must make a move now, and has used up their reflection time. Can someone wake them up? ;)<br />
* http://fr.boardgamearena.com/theme/img/layout/active_player_nonack.gif : this player must make a move now, but is probably not aware of this fact. If the situation doesn't change, it might suggest that this player has a connection issue.<br />
* http://fr.boardgamearena.com/theme/img/common/zombie.png : this player is a "zombie" (has left the game or been fired from the game). The game is going on without this player.<br />
<br />
When the "normal" avatar of a player is displayed, it means that this player is waiting for their turn to play.<br />
<br />
===A player has to make a move but he/she doesn't. What can I do?===<br />
<br />
* First, please remember that this player has the right to think as long as they need to about the next move... well as long as there is still some time left on the game clock, that is.<br />
* Then you can ask this player to confirm that he or she is still thinking about how to play.<br />
* If this player seems to be away, we advise you to wait a few minutes: this player may be experiencing some network problems or have left the computer temporarily.<br />
* If the player is not coming back, you can skip their turn as soon as the clock is negative. This player will get a "leave" penalty and you will win "by forfeit".<br />
<br />
For more details, please read [[Game clock]].<br />
<br />
===What is the current progression of the game I'm playing?===<br />
<br />
A percentage of progression is displayed on the top of the web page.<br />
There is also a progress bar at the bottom of the web page shows you the current progression of the game.<br />
<br />
<br />
===What is forbidden on Board Game Arena?===<br />
<br />
* Leaving a game in progress on purpose.<br />
* Taking an unnecessary and unreasonable amount of time at the end of game in an obvious losing situation.<br />
* Kingmaking: enabling another player to win on purpose while there is a better move to make for yourself.<br />
* Running out of time on the game clock.<br />
* Giving some piece of information about the current game situation that corrupts the normal game flow.<br />
* Communicating with another player about the game privately (ex: with MSN).<br />
* Provocation / triumphalism / defeatism ... anything which is not fair play.<br />
* Having a shocking avatar (no advertisement, no politics, ...)<br />
<br />
Going against these rules will affect your reputation.<br />
<br />
<br />
===What is absolutely forbidden in Board Game Arena?===<br />
<br />
* Creating multiple accounts and playing against oneself.<br />
* Insulting other players in any manner.<br />
<br />
Going against these rules can lead to the removal of your account and/or to the blacklisting of your IP.<br />
<br />
<br />
===What if some player does something wrong?===<br />
<br />
The Board Game Arena platform has been designed to encourage players to maintain good behavior. The reputation system allows you to distinguish between good and bad players. Then, it is up to you to decide whether to start a game with them or not.<br />
<br />
If you think a player has behaved badly during a game, you can give them a "red thumb" at the end of the game.<br />
<br />
If you think a player has committed a serious wrongdoing during a game (ex: insult), please report this player to us, using the "report this player" link from their profile or game result page, so that we can take appropriate measures.<br />
<br />
== Tournaments ==<br />
<br />
Tournaments is a BETA feature of BGA (for a long time).<br />
<br />
Tournament management is very complex. We'd like to open tournament creation to everyone at some time in the future but it need a lot of work and until then we always had something more urgent to do.<br />
<br />
When tournaments will be improved, this FAQ section will be improved too.<br />
<br />
<br />
== About board games we proposed on BGA ==<br />
<br />
<br />
===What is the legal status of this website?===<br />
<br />
All the games currently available on this site have been licensed or otherwise authorized by copyright holders. Please be aware that games available on BGA can be removed at the copyright holders demand (for example: if they publish their own adaptation of the game).<br />
<br />
Board Game Arena would like to thank all game publishers and game designers who allow us to have their games here, thus making it possible for this website to exist.<br />
<br />
=== How do we select games that are on BGA? Why the game XXX is not on BGA? ===<br />
<br />
To have a game published on BGA we need 2 things:<br />
* The authorization of the rights owner (most of the time: original publisher of the game).<br />
* A software developer who develops the adaptation (ie: has some time available to develop it).<br />
<br />
We (= BGA team) are trying a lot of board games ourselves. Sometimes we are lucky enough to play prototypes too. And of course we receive a lot of game suggestions through the BGA forum, the BoardGameGeek "most wanted games" list, or by any other means. Based on this we are asking game publishers for authorizations, and sometimes we also receive requests directly from game publishers - there is no rule.<br />
<br />
As it is today, BGA has a very good reputation and very productive relationships with almost all major board game publishers, but this is not enough: each situation is specific, and there can be various reasons why a game publisher can refuse to see a game adaptation on BGA (for example: board games with a third party licence, like "Star Wars", is practically impossible to negotiate).<br />
<br />
On the other hand, we got some authorizations for some very good games but no developers volunteering to develop them, or sometimes some of them don't manage to finish the job. Developers of adaptations are volunteers, and we don't blame them for this.<br />
<br />
Finally, some games are authorized and being developed, but the time frame is not good. For example, it happened that we had too many games to release and we decided to delay some of them. It also frequently happens that we must synchronize the release of a game with a publisher event, so the game adaptation can stay "on hold" for some months.<br />
<br />
So if you are asking yourself: why game XXX is not on BGA, it could be for various reasons:<br />
* Maybe we never asked authorization for this game. Note that usually we ask authorizations for every popular games (ex: "Most wanted games"). So if the game is popular, the reason is probably not this one.<br />
* The publisher refused.<br />
* The publisher accepted, but we didn't find a developer until now for this game.<br />
* The game adaptation is ready, but we are waiting for a specific event to release it.<br />
<br />
<br />
To conclude: yes we are taking into account your suggestions, but as you can see there are many factors than can influence the fact that a game is (or is not) on BGA. In addition, as a rule of thumb, we don't communicate about "why" this game is not on BGA. If we already got the authorization, we want to keep the "surprise", and if we didn't get the authorization, the game publisher may not want to explain the reasons.<br />
<br />
=== Are you taking into account the "Most wanted games" list? When will these games be on BGA? ===<br />
<br />
You should read first the previous section ("how do we select games that are on BGA?").<br />
<br />
So the answer is:<br />
* Yes, we are taking this list into account.<br />
* For most of these games we already asked for authorizations.<br />
* Some of these games won't be on BGA (authorization refused), some may be, some are in an "intermediate" step.<br />
* We don't communicate about future game releases anyway.<br />
<br />
=== Why do some games have expansions on BGA and some don't? ===<br />
<br />
You should read first the previous section ("how do we select games that are on BGA?").<br />
<br />
Game expansions follow the same steps than games. There can be various reasons why a game publisher doesn't want the expansion online, and sometimes we don't find a developer that has the time to develop it.<br />
<br />
===I'm a game publisher: why would I like to have my game on Board Game Arena?===<br />
<br />
The main goal of Board Game Arena is to make it easy for people to discover and love new games. We think that there are only two kinds of players on Board Game Arena: those who already bought the games they are playing online, and those who plan to buy them soon!<br />
<br />
As the activity of this website contributes to increasing a game's popularity and thus generates hard copy sales in the "real world", we think it is beneficial to the board game community: people from all over the world can play online, we can have fun developing this game platform to the best of our ability, and game publishers get money from the box sales and build a special relationship with their player's community.<br />
<br />
=== I'm a game publisher: how to get my game on Board Game Arena ===<br />
<br />
At first, you just have to write us an email (contact (at) boardgamearena.com) with a description of your game(s).<br />
<br />
Then, we add this game to the list of "available licences" on our website dedicated to game developers ([http://studio.boardgamearena.com BGA Studio]).<br />
<br />
The most difficult part is to find a developer among our community. Our only requirement is that the developer must love the game. Of course, the most popular the game is, the easiest it is to find a volunteer developer. Sometimes it is very fast, sometimes it takes months, sometimes it never happens. We can't say in advance.<br />
<br />
It is also possible to find your own developer: of course it accelerates the process a lot!<br />
<br />
== Turn-based mode ==<br />
<br />
Please read [[Turn based FAQ]].<br />
<br />
== Issues with BGA ==<br />
<br />
===What can I do if I have an issue with the website?===<br />
<br />
Most of the issues on this website should be solved with a simple web page refresh (or "F5").<br />
<br />
If you experience persistent issues, you can browse the [http://boardgamearena.com/#!bugs bug tool], see if someone already reported the issue, and add a new bug report if that's not the case. Please take some time to describe the bug you are reporting in detail so that we can quickly reproduce and fix it.<br />
<br />
=== Why is my bug still not fixed? ===<br />
<br />
We fix bugs every weeks. Of course we have priorities:<br />
* We give the highest priority to recent features and recent games, because the most important bugs are reported fast.<br />
* We give the highest priority to the bugs with the biggest number of "green thumb" on the [http://boardgamearena.com/#!bugs bug tool].<br />
* Usually we fix bugs by group. So if we decide to fix an important bug on a game, there is a chance that we will fix 3 or 4 minor bugs at the same time.<br />
<br />
BGA is known for the quality of its adaptations, and if you look at the bug tool, you can see that -considering the number of games and the size of the community- there are not so many critical bugs with a lot of "green thumbs".<br />
<br />
Please also note that BGA adaptations are realized by volunteers (even if most of them are also professional developers). It is not always easy for them to fix bugs, especially when some players are complaining violently and/or do not give precise information in bug reports.<br />
<br />
<br />
=== I played on smartphone / tablet / touch device and I have some difficulties: what can I do? ===<br />
<br />
As a rule of thumb, BGA does not support tablets/smartphones. There are tons of board game adaptations for tablets/smartphones, and some BGA adaptations are not well designed for small screens. Thus, we don't have plans to do a mobile / tablet version at the moment.<br />
<br />
So if you want to use BGA from a smartphone / tablet you can, but we don't promise to fix all bugs so it's at your own risk :)<br />
<br />
<br />
=== Why is BGA slow? Why do I have bad connections performances on BGA? ===<br />
<br />
We are constantly monitoring server responsiveness. Some incidents occurs, but most of the time BGA is responsive.<br />
<br />
We designed our game servers (ie: servers used when you are inside a game) to be very responsive. Usually, less than 2% of the game moves take more than 200 milliseconds to process, and less than 0.2% take more than 1 second.<br />
<br />
BGA servers are located in Europe (France), but we bought servers all across the world (19 locations) so that the big files (ex: images) are loaded fast even if you are far from us.<br />
<br />
Most of bad performances came from your internet connection or your system. Try to connect with a different browser / computer / internet connection to troubleshoot the issue.<br />
<br />
As a rule of thumb, if BGA is not responsive enough, you shouldn't engage yourself into a game because there is a risk for you to get clock penalties.<br />
<br />
=== I got issue with a specific player: how does the moderation works? ===<br />
<br />
You should read [[Moderation and grades]] page.<br />
<br />
== Contribute to BGA ==<br />
<br />
=== How can I contribute to BGA? ===<br />
<br />
Please visit page [http://boardgamearena.com/#!contribute Contribute to BGA].<br />
<br />
=== I'm a software developer. What can I do? ===<br />
<br />
We created a website specifically dedicated to board games adaptation development: [http://studio.boardgamearena.com BGA Studio].<br />
<br />
== About the BGA team ==<br />
<br />
=== Who are you? How to contact you? ===<br />
<br />
Please read page [[About us]].<br />
<br />
=== How you guys make money? Do you make a living of it? ===<br />
<br />
Since the beginning of 2016, one BGA Founder (Sourisdudesert) is working full-time on BGA. It was really required by the growing audience playing on this website, and this has been made possible thanks to all paying members (thank you again!).<br />
<br />
But to be honest, there is so much work to do on BGA that a single person is not enough. This is not really an issue because we think the "community based" approach is the best for BGA and we'd like to continue to give you the possibility to contribute to make this service running.</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Logos&diff=2586Logos2017-07-18T17:15:06Z<p>Sourisdudesert: /* BGA transparent horizontal logo */</p>
<hr />
<div>On this page you can find brand assets for Board Game Arena and easy way to create links to BGA.<br />
<br />
Please use "right click + save image as" to download needed images.<br />
<br />
= BGA buttons =<br />
<br />
You can use buttons below as links to BGA website.<br />
<br />
If you need a button that is not on the list please contact us (contact@boardgamearena.com).<br />
<br />
== Language independent ==<br />
<br />
[[File:bga_button.png]]<br />
<br />
== English ==<br />
<br />
Generic:<br />
<br />
[[File:Bga_button_play_online.png]]<br />
<br />
== French ==<br />
<br />
[[File:Bga_button_play_online_fr.png]]<br />
<br />
<br />
= BGA logos =<br />
<br />
== BGA transparent horizontal logo ==<br />
<br />
(should be used on a white background):<br />
<br />
[[File:LOGO FULL POSITIVE-HORIZONTAL COLOR RVB.png|800px]]<br />
<br />
== BGA transparent horizontal white logo ==<br />
<br />
(should be used on a black background):<br />
[[File:Logo_without_title.png|800px]]<br />
<br />
== BGA transparent vertical logo ==<br />
<br />
[[File:Main_rgb.png]]</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Logos&diff=2585Logos2017-07-18T17:14:50Z<p>Sourisdudesert: /* BGA icon */</p>
<hr />
<div>On this page you can find brand assets for Board Game Arena and easy way to create links to BGA.<br />
<br />
Please use "right click + save image as" to download needed images.<br />
<br />
= BGA buttons =<br />
<br />
You can use buttons below as links to BGA website.<br />
<br />
If you need a button that is not on the list please contact us (contact@boardgamearena.com).<br />
<br />
== Language independent ==<br />
<br />
[[File:bga_button.png]]<br />
<br />
== English ==<br />
<br />
Generic:<br />
<br />
[[File:Bga_button_play_online.png]]<br />
<br />
== French ==<br />
<br />
[[File:Bga_button_play_online_fr.png]]<br />
<br />
<br />
= BGA logos =<br />
<br />
== BGA transparent horizontal logo ==<br />
<br />
(should be used on a white background):<br />
[[File:LOGO FULL POSITIVE-HORIZONTAL COLOR RVB.png|800px]]<br />
<br />
== BGA transparent horizontal white logo ==<br />
<br />
(should be used on a black background):<br />
[[File:Logo_without_title.png|800px]]<br />
<br />
== BGA transparent vertical logo ==<br />
<br />
[[File:Main_rgb.png]]</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Logos&diff=2584Logos2017-07-18T17:14:29Z<p>Sourisdudesert: /* BGA transparent horizontal white logo */</p>
<hr />
<div>On this page you can find brand assets for Board Game Arena and easy way to create links to BGA.<br />
<br />
Please use "right click + save image as" to download needed images.<br />
<br />
= BGA buttons =<br />
<br />
You can use buttons below as links to BGA website.<br />
<br />
If you need a button that is not on the list please contact us (contact@boardgamearena.com).<br />
<br />
== Language independent ==<br />
<br />
[[File:bga_button.png]]<br />
<br />
== English ==<br />
<br />
Generic:<br />
<br />
[[File:Bga_button_play_online.png]]<br />
<br />
== French ==<br />
<br />
[[File:Bga_button_play_online_fr.png]]<br />
<br />
<br />
= BGA logos =<br />
<br />
== BGA transparent horizontal logo ==<br />
<br />
(should be used on a white background):<br />
[[File:LOGO FULL POSITIVE-HORIZONTAL COLOR RVB.png|800px]]<br />
<br />
== BGA transparent horizontal white logo ==<br />
<br />
(should be used on a black background):<br />
[[File:Logo_without_title.png|800px]]<br />
<br />
== BGA transparent vertical logo ==<br />
<br />
[[File:Main_rgb.png]]<br />
<br />
== BGA icon ==<br />
<br />
16x16:<br />
[[File:BGA logo 16.png]]<br />
<br />
<br />
75x75:<br />
[[File:BGA logo 75.png]]<br />
<br />
<br />
128x128:<br />
[[File:BGA logo 128.png]]<br />
<br />
<br />
512x512:<br />
[[File:BGA logo 512.png]]</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Logos&diff=2583Logos2017-07-18T17:14:11Z<p>Sourisdudesert: /* BGA transparent horizontal white logo */</p>
<hr />
<div>On this page you can find brand assets for Board Game Arena and easy way to create links to BGA.<br />
<br />
Please use "right click + save image as" to download needed images.<br />
<br />
= BGA buttons =<br />
<br />
You can use buttons below as links to BGA website.<br />
<br />
If you need a button that is not on the list please contact us (contact@boardgamearena.com).<br />
<br />
== Language independent ==<br />
<br />
[[File:bga_button.png]]<br />
<br />
== English ==<br />
<br />
Generic:<br />
<br />
[[File:Bga_button_play_online.png]]<br />
<br />
== French ==<br />
<br />
[[File:Bga_button_play_online_fr.png]]<br />
<br />
<br />
= BGA logos =<br />
<br />
== BGA transparent horizontal logo ==<br />
<br />
(should be used on a white background):<br />
[[File:LOGO FULL POSITIVE-HORIZONTAL COLOR RVB.png|800px]]<br />
<br />
== BGA transparent horizontal white logo ==<br />
<br />
(should be used on a black background):<br />
[[File:File:Logo_without_title.png|800px]]<br />
<br />
== BGA transparent vertical logo ==<br />
<br />
[[File:Main_rgb.png]]<br />
<br />
== BGA icon ==<br />
<br />
16x16:<br />
[[File:BGA logo 16.png]]<br />
<br />
<br />
75x75:<br />
[[File:BGA logo 75.png]]<br />
<br />
<br />
128x128:<br />
[[File:BGA logo 128.png]]<br />
<br />
<br />
512x512:<br />
[[File:BGA logo 512.png]]</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=%D0%94%D0%B0%D1%82%D0%BE%D1%82%D0%B5%D0%BA%D0%B0:Logo_without_title.png&diff=2582Датотека:Logo without title.png2017-07-18T17:13:47Z<p>Sourisdudesert: </p>
<hr />
<div></div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Logos&diff=2581Logos2017-07-18T17:13:25Z<p>Sourisdudesert: /* BGA transparent horizontal logo */</p>
<hr />
<div>On this page you can find brand assets for Board Game Arena and easy way to create links to BGA.<br />
<br />
Please use "right click + save image as" to download needed images.<br />
<br />
= BGA buttons =<br />
<br />
You can use buttons below as links to BGA website.<br />
<br />
If you need a button that is not on the list please contact us (contact@boardgamearena.com).<br />
<br />
== Language independent ==<br />
<br />
[[File:bga_button.png]]<br />
<br />
== English ==<br />
<br />
Generic:<br />
<br />
[[File:Bga_button_play_online.png]]<br />
<br />
== French ==<br />
<br />
[[File:Bga_button_play_online_fr.png]]<br />
<br />
<br />
= BGA logos =<br />
<br />
== BGA transparent horizontal logo ==<br />
<br />
(should be used on a white background):<br />
[[File:LOGO FULL POSITIVE-HORIZONTAL COLOR RVB.png|800px]]<br />
<br />
== BGA transparent horizontal white logo ==<br />
<br />
(should be used on a black background):<br />
[[File:BGA transparent horizontal white logo.png]]<br />
<br />
== BGA transparent vertical logo ==<br />
<br />
[[File:Main_rgb.png]]<br />
<br />
== BGA icon ==<br />
<br />
16x16:<br />
[[File:BGA logo 16.png]]<br />
<br />
<br />
75x75:<br />
[[File:BGA logo 75.png]]<br />
<br />
<br />
128x128:<br />
[[File:BGA logo 128.png]]<br />
<br />
<br />
512x512:<br />
[[File:BGA logo 512.png]]</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Logos&diff=2580Logos2017-07-18T17:12:59Z<p>Sourisdudesert: /* BGA transparent horizontal logo */</p>
<hr />
<div>On this page you can find brand assets for Board Game Arena and easy way to create links to BGA.<br />
<br />
Please use "right click + save image as" to download needed images.<br />
<br />
= BGA buttons =<br />
<br />
You can use buttons below as links to BGA website.<br />
<br />
If you need a button that is not on the list please contact us (contact@boardgamearena.com).<br />
<br />
== Language independent ==<br />
<br />
[[File:bga_button.png]]<br />
<br />
== English ==<br />
<br />
Generic:<br />
<br />
[[File:Bga_button_play_online.png]]<br />
<br />
== French ==<br />
<br />
[[File:Bga_button_play_online_fr.png]]<br />
<br />
<br />
= BGA logos =<br />
<br />
== BGA transparent horizontal logo ==<br />
<br />
(should be used on a white background):<br />
[[File:LOGO FULL POSITIVE-HORIZONTAL COLOR RVB.png|500px]]<br />
<br />
== BGA transparent horizontal white logo ==<br />
<br />
(should be used on a black background):<br />
[[File:BGA transparent horizontal white logo.png]]<br />
<br />
== BGA transparent vertical logo ==<br />
<br />
[[File:Main_rgb.png]]<br />
<br />
== BGA icon ==<br />
<br />
16x16:<br />
[[File:BGA logo 16.png]]<br />
<br />
<br />
75x75:<br />
[[File:BGA logo 75.png]]<br />
<br />
<br />
128x128:<br />
[[File:BGA logo 128.png]]<br />
<br />
<br />
512x512:<br />
[[File:BGA logo 512.png]]</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Logos&diff=2579Logos2017-07-18T17:11:53Z<p>Sourisdudesert: /* BGA transparent horizontal logo */</p>
<hr />
<div>On this page you can find brand assets for Board Game Arena and easy way to create links to BGA.<br />
<br />
Please use "right click + save image as" to download needed images.<br />
<br />
= BGA buttons =<br />
<br />
You can use buttons below as links to BGA website.<br />
<br />
If you need a button that is not on the list please contact us (contact@boardgamearena.com).<br />
<br />
== Language independent ==<br />
<br />
[[File:bga_button.png]]<br />
<br />
== English ==<br />
<br />
Generic:<br />
<br />
[[File:Bga_button_play_online.png]]<br />
<br />
== French ==<br />
<br />
[[File:Bga_button_play_online_fr.png]]<br />
<br />
<br />
= BGA logos =<br />
<br />
== BGA transparent horizontal logo ==<br />
<br />
(should be used on a white background):<br />
[[File:LOGO FULL POSITIVE-HORIZONTAL COLOR RVB.png|400px]]<br />
<br />
== BGA transparent horizontal white logo ==<br />
<br />
(should be used on a black background):<br />
[[File:BGA transparent horizontal white logo.png]]<br />
<br />
== BGA transparent vertical logo ==<br />
<br />
[[File:Main_rgb.png]]<br />
<br />
== BGA icon ==<br />
<br />
16x16:<br />
[[File:BGA logo 16.png]]<br />
<br />
<br />
75x75:<br />
[[File:BGA logo 75.png]]<br />
<br />
<br />
128x128:<br />
[[File:BGA logo 128.png]]<br />
<br />
<br />
512x512:<br />
[[File:BGA logo 512.png]]</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Logos&diff=2578Logos2017-07-18T17:11:01Z<p>Sourisdudesert: /* BGA transparent horizontal logo */</p>
<hr />
<div>On this page you can find brand assets for Board Game Arena and easy way to create links to BGA.<br />
<br />
Please use "right click + save image as" to download needed images.<br />
<br />
= BGA buttons =<br />
<br />
You can use buttons below as links to BGA website.<br />
<br />
If you need a button that is not on the list please contact us (contact@boardgamearena.com).<br />
<br />
== Language independent ==<br />
<br />
[[File:bga_button.png]]<br />
<br />
== English ==<br />
<br />
Generic:<br />
<br />
[[File:Bga_button_play_online.png]]<br />
<br />
== French ==<br />
<br />
[[File:Bga_button_play_online_fr.png]]<br />
<br />
<br />
= BGA logos =<br />
<br />
== BGA transparent horizontal logo ==<br />
<br />
(should be used on a white background):<br />
[[File:LOGO FULL POSITIVE-HORIZONTAL COLOR RVB.png]]<br />
<br />
== BGA transparent horizontal white logo ==<br />
<br />
(should be used on a black background):<br />
[[File:BGA transparent horizontal white logo.png]]<br />
<br />
== BGA transparent vertical logo ==<br />
<br />
[[File:Main_rgb.png]]<br />
<br />
== BGA icon ==<br />
<br />
16x16:<br />
[[File:BGA logo 16.png]]<br />
<br />
<br />
75x75:<br />
[[File:BGA logo 75.png]]<br />
<br />
<br />
128x128:<br />
[[File:BGA logo 128.png]]<br />
<br />
<br />
512x512:<br />
[[File:BGA logo 512.png]]</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=%D0%94%D0%B0%D1%82%D0%BE%D1%82%D0%B5%D0%BA%D0%B0:LOGO_FULL_POSITIVE-HORIZONTAL_COLOR_RVB.png&diff=2577Датотека:LOGO FULL POSITIVE-HORIZONTAL COLOR RVB.png2017-07-18T17:10:35Z<p>Sourisdudesert: </p>
<hr />
<div></div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Logos&diff=2576Logos2017-07-18T17:09:53Z<p>Sourisdudesert: /* BGA transparent vertical logo */</p>
<hr />
<div>On this page you can find brand assets for Board Game Arena and easy way to create links to BGA.<br />
<br />
Please use "right click + save image as" to download needed images.<br />
<br />
= BGA buttons =<br />
<br />
You can use buttons below as links to BGA website.<br />
<br />
If you need a button that is not on the list please contact us (contact@boardgamearena.com).<br />
<br />
== Language independent ==<br />
<br />
[[File:bga_button.png]]<br />
<br />
== English ==<br />
<br />
Generic:<br />
<br />
[[File:Bga_button_play_online.png]]<br />
<br />
== French ==<br />
<br />
[[File:Bga_button_play_online_fr.png]]<br />
<br />
<br />
= BGA logos =<br />
<br />
== BGA transparent horizontal logo ==<br />
<br />
(should be used on a white background):<br />
[[File:BGA transparent horizontal logo.png]]<br />
<br />
== BGA transparent horizontal white logo ==<br />
<br />
(should be used on a black background):<br />
[[File:BGA transparent horizontal white logo.png]]<br />
<br />
== BGA transparent vertical logo ==<br />
<br />
[[File:Main_rgb.png]]<br />
<br />
== BGA icon ==<br />
<br />
16x16:<br />
[[File:BGA logo 16.png]]<br />
<br />
<br />
75x75:<br />
[[File:BGA logo 75.png]]<br />
<br />
<br />
128x128:<br />
[[File:BGA logo 128.png]]<br />
<br />
<br />
512x512:<br />
[[File:BGA logo 512.png]]</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=%D0%94%D0%B0%D1%82%D0%BE%D1%82%D0%B5%D0%BA%D0%B0:Main_rgb.png&diff=2575Датотека:Main rgb.png2017-07-18T17:09:33Z<p>Sourisdudesert: </p>
<hr />
<div></div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Logos&diff=2574Logos2017-07-18T17:09:08Z<p>Sourisdudesert: </p>
<hr />
<div>On this page you can find brand assets for Board Game Arena and easy way to create links to BGA.<br />
<br />
Please use "right click + save image as" to download needed images.<br />
<br />
= BGA buttons =<br />
<br />
You can use buttons below as links to BGA website.<br />
<br />
If you need a button that is not on the list please contact us (contact@boardgamearena.com).<br />
<br />
== Language independent ==<br />
<br />
[[File:bga_button.png]]<br />
<br />
== English ==<br />
<br />
Generic:<br />
<br />
[[File:Bga_button_play_online.png]]<br />
<br />
== French ==<br />
<br />
[[File:Bga_button_play_online_fr.png]]<br />
<br />
<br />
= BGA logos =<br />
<br />
== BGA transparent horizontal logo ==<br />
<br />
(should be used on a white background):<br />
[[File:BGA transparent horizontal logo.png]]<br />
<br />
== BGA transparent horizontal white logo ==<br />
<br />
(should be used on a black background):<br />
[[File:BGA transparent horizontal white logo.png]]<br />
<br />
== BGA transparent vertical logo ==<br />
<br />
[[File:BGA_transparent_vertical_logo.png]]<br />
<br />
== BGA icon ==<br />
<br />
16x16:<br />
[[File:BGA logo 16.png]]<br />
<br />
<br />
75x75:<br />
[[File:BGA logo 75.png]]<br />
<br />
<br />
128x128:<br />
[[File:BGA logo 128.png]]<br />
<br />
<br />
512x512:<br />
[[File:BGA logo 512.png]]</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=%D0%94%D0%B0%D1%82%D0%BE%D1%82%D0%B5%D0%BA%D0%B0:Bga_button_play_online_fr.png&diff=2573Датотека:Bga button play online fr.png2017-07-18T17:08:46Z<p>Sourisdudesert: uploaded a new version of &quot;File:Bga button play online fr.png&quot;</p>
<hr />
<div></div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Logos&diff=2572Logos2017-07-18T17:08:17Z<p>Sourisdudesert: /* French */</p>
<hr />
<div>On this page you can find brand assets for Board Game Arena and easy way to create links to BGA.<br />
<br />
Please use "right click + save image as" to download needed images.<br />
<br />
= BGA buttons =<br />
<br />
You can use buttons below as links to BGA website.<br />
<br />
If you need a button that is not on the list please contact us (contact@boardgamearena.com).<br />
<br />
== Language independent ==<br />
<br />
[[File:bga_button.png]]<br />
<br />
== English ==<br />
<br />
Generic:<br />
<br />
[[File:Bga_button_play_online.png]]<br />
<br />
== French ==<br />
<br />
[[File:Bga_button_play_online_fr.png]]<br />
<br />
== German ==<br />
<br />
[[File:play_games_online_de.png]]<br />
<br />
== Spanish ==<br />
<br />
[[File:play_games_online_es.png]]<br />
<br />
== Italian ==<br />
<br />
[[File:play_games_online_it.png]]<br />
<br />
== Chinese (traditional) ==<br />
<br />
[[File:play_games_online_zh.png]]<br />
<br />
== Chinese (simplified) ==<br />
<br />
[[File:play_games_online_zh_cn.png]]<br />
<br />
== Japanese ==<br />
<br />
[[File:play_games_online_ja.png]]<br />
<br />
= BGA logos =<br />
<br />
== BGA transparent horizontal logo ==<br />
<br />
(should be used on a white background):<br />
[[File:BGA transparent horizontal logo.png]]<br />
<br />
== BGA transparent horizontal white logo ==<br />
<br />
(should be used on a black background):<br />
[[File:BGA transparent horizontal white logo.png]]<br />
<br />
== BGA transparent vertical logo ==<br />
<br />
[[File:BGA_transparent_vertical_logo.png]]<br />
<br />
== BGA icon ==<br />
<br />
16x16:<br />
[[File:BGA logo 16.png]]<br />
<br />
<br />
75x75:<br />
[[File:BGA logo 75.png]]<br />
<br />
<br />
128x128:<br />
[[File:BGA logo 128.png]]<br />
<br />
<br />
512x512:<br />
[[File:BGA logo 512.png]]</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=%D0%94%D0%B0%D1%82%D0%BE%D1%82%D0%B5%D0%BA%D0%B0:Bga_button_play_online_fr.png&diff=2571Датотека:Bga button play online fr.png2017-07-18T17:07:54Z<p>Sourisdudesert: </p>
<hr />
<div></div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Logos&diff=2570Logos2017-07-18T17:07:35Z<p>Sourisdudesert: /* French */</p>
<hr />
<div>On this page you can find brand assets for Board Game Arena and easy way to create links to BGA.<br />
<br />
Please use "right click + save image as" to download needed images.<br />
<br />
= BGA buttons =<br />
<br />
You can use buttons below as links to BGA website.<br />
<br />
If you need a button that is not on the list please contact us (contact@boardgamearena.com).<br />
<br />
== Language independent ==<br />
<br />
[[File:bga_button.png]]<br />
<br />
== English ==<br />
<br />
Generic:<br />
<br />
[[File:Bga_button_play_online.png]]<br />
<br />
== French ==<br />
<br />
[[File:Bga_button_play_it_online_fr.png]]<br />
<br />
== German ==<br />
<br />
[[File:play_games_online_de.png]]<br />
<br />
== Spanish ==<br />
<br />
[[File:play_games_online_es.png]]<br />
<br />
== Italian ==<br />
<br />
[[File:play_games_online_it.png]]<br />
<br />
== Chinese (traditional) ==<br />
<br />
[[File:play_games_online_zh.png]]<br />
<br />
== Chinese (simplified) ==<br />
<br />
[[File:play_games_online_zh_cn.png]]<br />
<br />
== Japanese ==<br />
<br />
[[File:play_games_online_ja.png]]<br />
<br />
= BGA logos =<br />
<br />
== BGA transparent horizontal logo ==<br />
<br />
(should be used on a white background):<br />
[[File:BGA transparent horizontal logo.png]]<br />
<br />
== BGA transparent horizontal white logo ==<br />
<br />
(should be used on a black background):<br />
[[File:BGA transparent horizontal white logo.png]]<br />
<br />
== BGA transparent vertical logo ==<br />
<br />
[[File:BGA_transparent_vertical_logo.png]]<br />
<br />
== BGA icon ==<br />
<br />
16x16:<br />
[[File:BGA logo 16.png]]<br />
<br />
<br />
75x75:<br />
[[File:BGA logo 75.png]]<br />
<br />
<br />
128x128:<br />
[[File:BGA logo 128.png]]<br />
<br />
<br />
512x512:<br />
[[File:BGA logo 512.png]]</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Logos&diff=2569Logos2017-07-18T17:07:17Z<p>Sourisdudesert: /* English */</p>
<hr />
<div>On this page you can find brand assets for Board Game Arena and easy way to create links to BGA.<br />
<br />
Please use "right click + save image as" to download needed images.<br />
<br />
= BGA buttons =<br />
<br />
You can use buttons below as links to BGA website.<br />
<br />
If you need a button that is not on the list please contact us (contact@boardgamearena.com).<br />
<br />
== Language independent ==<br />
<br />
[[File:bga_button.png]]<br />
<br />
== English ==<br />
<br />
Generic:<br />
<br />
[[File:Bga_button_play_online.png]]<br />
<br />
== French ==<br />
<br />
[[File:play_games_online_fr.png]]<br />
<br />
== German ==<br />
<br />
[[File:play_games_online_de.png]]<br />
<br />
== Spanish ==<br />
<br />
[[File:play_games_online_es.png]]<br />
<br />
== Italian ==<br />
<br />
[[File:play_games_online_it.png]]<br />
<br />
== Chinese (traditional) ==<br />
<br />
[[File:play_games_online_zh.png]]<br />
<br />
== Chinese (simplified) ==<br />
<br />
[[File:play_games_online_zh_cn.png]]<br />
<br />
== Japanese ==<br />
<br />
[[File:play_games_online_ja.png]]<br />
<br />
= BGA logos =<br />
<br />
== BGA transparent horizontal logo ==<br />
<br />
(should be used on a white background):<br />
[[File:BGA transparent horizontal logo.png]]<br />
<br />
== BGA transparent horizontal white logo ==<br />
<br />
(should be used on a black background):<br />
[[File:BGA transparent horizontal white logo.png]]<br />
<br />
== BGA transparent vertical logo ==<br />
<br />
[[File:BGA_transparent_vertical_logo.png]]<br />
<br />
== BGA icon ==<br />
<br />
16x16:<br />
[[File:BGA logo 16.png]]<br />
<br />
<br />
75x75:<br />
[[File:BGA logo 75.png]]<br />
<br />
<br />
128x128:<br />
[[File:BGA logo 128.png]]<br />
<br />
<br />
512x512:<br />
[[File:BGA logo 512.png]]</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=%D0%94%D0%B0%D1%82%D0%BE%D1%82%D0%B5%D0%BA%D0%B0:Bga_button_play_online.png&diff=2568Датотека:Bga button play online.png2017-07-18T17:06:42Z<p>Sourisdudesert: </p>
<hr />
<div></div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=%D0%94%D0%B0%D1%82%D0%BE%D1%82%D0%B5%D0%BA%D0%B0:Bga_button.png&diff=2567Датотека:Bga button.png2017-07-18T17:05:55Z<p>Sourisdudesert: uploaded a new version of &quot;File:Bga button.png&quot;</p>
<hr />
<div></div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=ServiceOutage&diff=2566ServiceOutage2017-07-18T09:48:25Z<p>Sourisdudesert: </p>
<hr />
<div><br />
<br />
=== Our philosophy ===<br />
<br />
Having a gaming service available 24 hours a day, 7 days a week is not something easy to achieve for a (very) small team like ours. In addition, BGA is a realtime service, and any service outage may ruins games in progress.<br />
<br />
Our philosophy is to be transparent on service outages, by explaining why it happens, what has been impacted (and how long), and what we did to make sure it won't happen again. Explaining all of this is the goal of this page.<br />
<br />
Note: If an incident is in progress, '''we may not update this page in realtime'''.</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=ServiceOutage&diff=2565ServiceOutage2017-07-18T06:02:39Z<p>Sourisdudesert: </p>
<hr />
<div><br />
<br />
== Our philosophy ==<br />
<br />
Having a gaming service available 24 hours a day, 7 days a week is not something easy to achieve for a (very) small team like ours. In addition, BGA is a realtime service, and any service outage may ruins games in progress.<br />
<br />
Our philosophy is to be transparent on service outages, by explaining why it happens, what has been impacted (and how long), and what we did to make sure it won't happen again. Explaining all of this is the goal of this page.<br />
<br />
Note: If an incident is in progress, '''we may not update this page in realtime'''.</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=ServiceOutage&diff=2564ServiceOutage2017-07-18T05:47:41Z<p>Sourisdudesert: Protected "ServiceOutage" ([edit=sysop] (indefinite) [move=sysop] (indefinite))</p>
<hr />
<div><br />
(test)</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=ServiceOutage&diff=2563ServiceOutage2017-07-18T05:46:44Z<p>Sourisdudesert: Created page with " (test)"</p>
<hr />
<div><br />
(test)</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Latest_incidents&diff=2552Latest incidents2017-07-14T17:36:04Z<p>Sourisdudesert: Created page with " No incident reported at now"</p>
<hr />
<div><br />
No incident reported at now</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=3D&diff=25063D2017-06-20T09:51:37Z<p>Sourisdudesert: </p>
<hr />
<div><br />
= Overview =<br />
<br />
Board Game Arena is using CSS 3D features to provide a basic 3D view of the games.<br />
<br />
This is not a "100% real" 3D as this is very difficult to play with real 3D model with CSS, but most of the time it provides a satisfying 3D view of the game.<br />
<br />
The objective of 3D is to provide a nice view of the game : 90% of the time, 2D is more suitable for playing. So we don't force developers to make sure games can be played in 3D : this is just a "bonus".<br />
<br />
= Enabling 3D =<br />
<br />
3D is enabled by default for your game.<br />
<br />
You can click on the "3D" button at the top right and see your game in 3D.<br />
<br />
If you don't want to allow players to use 3D with your game, you can add this to you "gameinfos.inc.php" file :<br />
<br />
'enable_3d' => false,<br />
<br />
= Detecting 3D =<br />
<br />
When 3D is "on", BGA adds CSS class "mode_3d" to the body element.<br />
<br />
In CSS, you should prefix all your 3D mode specific directives by ".mode_3d".<br />
<br />
In Javascript, you can detect 3D by using the following :<br />
<br />
if( this.control3dmode3d )<br />
{<br />
// Only executed in 3d mode<br />
}<br />
<br />
<br />
= Built-in 3D enhancements =<br />
<br />
BGA is doing some built-in 3D enhancements with your 3D adaptations, so your adaptation will have some 3D effects without any efforts :<br />
<br />
* When executing a slideToObject, a slideToObjectPos or a slideTemporaryObject, BGA is moving the objects vertically (up, then down).<br />
* It also happens when moving elements of a Stock module, or to a Zone module.<br />
<br />
<br />
= Enhance your adaptation for 3D =<br />
<br />
== Use Z axis ==<br />
<br />
Using CSS transform: translateZ, you can translate your HTML elements along the Z axis. Example :<br />
<br />
.floating_element {<br />
transform: translateZ( 20px ); /* This element is going to float 20px above the surface */<br />
}<br />
<br />
<br />
At any moment, you can know the Z position of an element from javascript using :<br />
<br />
this.getComputedTranslateZ( html_element );<br />
<br />
<br />
== Use pre-build BGA 3D classes ==<br />
<br />
By adding the following to your objects, they will look nicer in 3D :<br />
<br />
thickness: add a (3px) black thickness to your HTML element.<br />
<br />
roundthickness: (to be used with thickness) if your element is a circle, you should add roundthickness so your element thickness can be a circle too.<br />
<br />
whitethickness: (to be used with thickness) if you prefer to have a whitethickness instead of black.<br />
<br />
floatingabove : make your element "float" 10px above the surface, with a nice shadow.<br />
<br />
roundfloatingabove: (to be used with floatingabove) : if your element is a circle, use roundfloatingabove in addition to floatingabove.<br />
<br />
<br />
Note : if you found some generic CSS that may help some other developers for 3D enhancements, please send it to us so we can add it there.</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=3D&diff=25053D2017-06-20T09:34:16Z<p>Sourisdudesert: /* Use Z axis */</p>
<hr />
<div><br />
= Overview =<br />
<br />
Board Game Arena is using CSS 3D features to provide a basic 3D view of the games.<br />
<br />
This is not a "100% real" 3D as this is very difficult to play with real 3D model with CSS, but most of the time it provides a satisfying 3D view of the game.<br />
<br />
The objective of 3D is to provide a nice view of the game : 90% of the time, 3D is more suitable for playing. So we don't force developers to make sure games can be played in 3D : this is just a "bonus".<br />
<br />
= Enabling 3D =<br />
<br />
3D is enabled by default for your game.<br />
<br />
You can click on the "3D" button at the top right and see your game in 3D.<br />
<br />
If you don't want to allow players to use 3D with your game, you can add this to you "gameinfos.inc.php" file :<br />
<br />
'enable_3d' => false,<br />
<br />
= Detecting 3D =<br />
<br />
When 3D is "on", BGA adds CSS class "mode_3d" to the body element.<br />
<br />
In CSS, you should prefix all your 3D mode specific directives by ".mode_3d".<br />
<br />
In Javascript, you can detect 3D by using the following :<br />
<br />
if( this.control3dmode3d )<br />
{<br />
// Only executed in 3d mode<br />
}<br />
<br />
<br />
= Built-in 3D enhancements =<br />
<br />
BGA is doing some built-in 3D enhancements with your 3D adaptations, so your adaptation will have some 3D effects without any efforts :<br />
<br />
* When executing a slideToObject, a slideToObjectPos or a slideTemporaryObject, BGA is moving the objects vertically (up, then down).<br />
* It also happens when moving elements of a Stock module, or to a Zone module.<br />
<br />
<br />
= Enhance your adaptation for 3D =<br />
<br />
== Use Z axis ==<br />
<br />
Using CSS transform: translateZ, you can translate your HTML elements along the Z axis. Example :<br />
<br />
.floating_element {<br />
transform: translateZ( 20px ); /* This element is going to float 20px above the surface */<br />
}<br />
<br />
<br />
At any moment, you can know the Z position of an element from javascript using :<br />
<br />
this.getComputedTranslateZ( html_element );<br />
<br />
<br />
== Use pre-build BGA 3D classes ==<br />
<br />
By adding the following to your objects, they will look nicer in 3D :<br />
<br />
thickness: add a (3px) black thickness to your HTML element.<br />
<br />
roundthickness: (to be used with thickness) if your element is a circle, you should add roundthickness so your element thickness can be a circle too.<br />
<br />
whitethickness: (to be used with thickness) if you prefer to have a whitethickness instead of black.<br />
<br />
floatingabove : make your element "float" 10px above the surface, with a nice shadow.<br />
<br />
roundfloatingabove: (to be used with floatingabove) : if your element is a circle, use roundfloatingabove in addition to floatingabove.<br />
<br />
<br />
Note : if you found some generic CSS that may help some other developers for 3D enhancements, please send it to us so we can add it there.</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=3D&diff=25043D2017-06-20T09:27:46Z<p>Sourisdudesert: /* Detecting 3D */</p>
<hr />
<div><br />
= Overview =<br />
<br />
Board Game Arena is using CSS 3D features to provide a basic 3D view of the games.<br />
<br />
This is not a "100% real" 3D as this is very difficult to play with real 3D model with CSS, but most of the time it provides a satisfying 3D view of the game.<br />
<br />
The objective of 3D is to provide a nice view of the game : 90% of the time, 3D is more suitable for playing. So we don't force developers to make sure games can be played in 3D : this is just a "bonus".<br />
<br />
= Enabling 3D =<br />
<br />
3D is enabled by default for your game.<br />
<br />
You can click on the "3D" button at the top right and see your game in 3D.<br />
<br />
If you don't want to allow players to use 3D with your game, you can add this to you "gameinfos.inc.php" file :<br />
<br />
'enable_3d' => false,<br />
<br />
= Detecting 3D =<br />
<br />
When 3D is "on", BGA adds CSS class "mode_3d" to the body element.<br />
<br />
In CSS, you should prefix all your 3D mode specific directives by ".mode_3d".<br />
<br />
In Javascript, you can detect 3D by using the following :<br />
<br />
if( this.control3dmode3d )<br />
{<br />
// Only executed in 3d mode<br />
}<br />
<br />
<br />
= Built-in 3D enhancements =<br />
<br />
BGA is doing some built-in 3D enhancements with your 3D adaptations, so your adaptation will have some 3D effects without any efforts :<br />
<br />
* When executing a slideToObject, a slideToObjectPos or a slideTemporaryObject, BGA is moving the objects vertically (up, then down).<br />
* It also happens when moving elements of a Stock module, or to a Zone module.<br />
<br />
<br />
= Enhance your adaptation for 3D =<br />
<br />
== Use Z axis ==<br />
<br />
Using CSS transform: translateZ, you can translate your HTML elements along the Z axis. Example :<br />
<br />
.floating_element {<br />
transform: translateZ( 20px ); /* This element is going to float 20px above the surface */<br />
}</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=3D&diff=25033D2017-06-20T09:22:04Z<p>Sourisdudesert: /* Detecting 3D */</p>
<hr />
<div><br />
= Overview =<br />
<br />
Board Game Arena is using CSS 3D features to provide a basic 3D view of the games.<br />
<br />
This is not a "100% real" 3D as this is very difficult to play with real 3D model with CSS, but most of the time it provides a satisfying 3D view of the game.<br />
<br />
The objective of 3D is to provide a nice view of the game : 90% of the time, 3D is more suitable for playing. So we don't force developers to make sure games can be played in 3D : this is just a "bonus".<br />
<br />
= Enabling 3D =<br />
<br />
3D is enabled by default for your game.<br />
<br />
You can click on the "3D" button at the top right and see your game in 3D.<br />
<br />
If you don't want to allow players to use 3D with your game, you can add this to you "gameinfos.inc.php" file :<br />
<br />
'enable_3d' => false,<br />
<br />
= Detecting 3D =<br />
<br />
When 3D is "on", BGA adds CSS class "mode_3d" to the body element.<br />
<br />
In CSS, you should prefix all your 3D mode specific directives by ".mode_3d".<br />
<br />
In Javascript, you can detect 3D by using the following :<br />
<br />
if( this.control3dmode3d )<br />
{<br />
// Only executed in 3d mode<br />
}</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=3D&diff=25023D2017-06-20T09:19:50Z<p>Sourisdudesert: Created page with " = Overview = Board Game Arena is using CSS 3D features to provide a basic 3D view of the games. This is not a "100% real" 3D as this is very difficult to play with real 3D ..."</p>
<hr />
<div><br />
= Overview =<br />
<br />
Board Game Arena is using CSS 3D features to provide a basic 3D view of the games.<br />
<br />
This is not a "100% real" 3D as this is very difficult to play with real 3D model with CSS, but most of the time it provides a satisfying 3D view of the game.<br />
<br />
The objective of 3D is to provide a nice view of the game : 90% of the time, 3D is more suitable for playing. So we don't force developers to make sure games can be played in 3D : this is just a "bonus".<br />
<br />
= Enabling 3D =<br />
<br />
3D is enabled by default for your game.<br />
<br />
You can click on the "3D" button at the top right and see your game in 3D.<br />
<br />
If you don't want to allow players to use 3D with your game, you can add this to you "gameinfos.inc.php" file :<br />
<br />
'enable_3d' => false,<br />
<br />
= Detecting 3D =</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Studio&diff=2501Studio2017-06-20T09:14:51Z<p>Sourisdudesert: /* Other components */</p>
<hr />
<div>[[File:Bga_studio_small.jpg]]<br />
<br />
Note: Please DO NOT translate Studio Documentation, so that there can be one place where you can find the latest information available.<br />
<br />
== What is Board Game Arena Studio? ==<br />
<br />
'''Board Game Arena Studio''' is a platform to build online board game adaptations using the Board Game Arena platform.<br />
<br />
It is open to any gamer with software development skills :)<br />
<br />
BGA Studio website:<br />
http://en.studio.boardgamearena.com<br />
<br />
(original announcement on BGA forum: http://forum.boardgamearena.com/viewtopic.php?f=10&t=1973)<br />
<br />
== Discover BGA Studio in 5 presentations ==<br />
<br />
Why, how, what... to start discovering BGA Studio, we prepared 5 "powerpoint" presentations for you:<br />
<br />
* [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]<br />
* [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]<br />
* [http://www.slideshare.net/boardgamearena/the-bga-framework-at-a-glance The BGA Framework at a glance]<br />
* [http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine Focus on BGA game state machine]<br />
* [http://www.slideshare.net/boardgamearena/bga-studio-guidelines BGA developers guidelines]<br />
<br />
== How to join the BGA developer team? ==<br />
<br />
Please see this page: [[How to join BGA developer team?]]<br />
<br />
== Great, I'm in! ... How should I start? ==<br />
<br />
If you didn't already, check the presentations at the top of this page to get the basics.<br />
<br />
Then, you should checkout the [[First steps with BGA Studio]] to make sure that runs fine.<br />
<br />
After that, we advise you to take a peek at one of these game creation tutorials:<br />
* [[Tutorial reversi]] - an abstract strategy game played on an 8×8 uncheckered board for 2 players<br />
* [[Tutorial gomoku]] - an abstract strategy game tic-tac-toe style for 2 players<br />
* [[Tutorial hearts]] - a card game for 4 players<br />
<br />
Then start editing files and see what happens! ;)<br />
<br />
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'''].<br />
<br />
== BGA Studio documentation ==<br />
<br />
=== BGA Studio Framework reference ===<br />
<br />
This part of the documentation focuses on the development framework itself: functions and methods available to build your game.<br />
<br />
[[Studio file reference|File structure of a BGA game]]<br />
<br />
==== Game logic (Server side) ====<br />
<br />
* [[Main game logic: yourgamename.game.php]]<br />
* [[Your game state machine: states.inc.php]]<br />
* [[Game database model: dbmodel.sql]]<br />
* [[Players actions: yourgamename.action.php]]<br />
* [[Game material description: material.inc.php]]<br />
* [[Game statistics: stats.inc.php]]<br />
<br />
==== Game interface (Client side) ====<br />
<br />
* [[Game interface logic: yourgamename.js]]<br />
* [[Game art: img directory]]<br />
* [[Game interface stylesheet: yourgamename.css]]<br />
* [[Game layout: view and template: yourgamename.view.php and yourgamename_yourgamename.tpl]]<br />
* [[Your game mobile version]]<br />
<br />
==== Other components ====<br />
<br />
* [[Translations]] (how to make your game translatable)<br />
* [[Game options and preferences: gameoptions.inc.php]]<br />
* [[Game meta-information: gameinfos.inc.php]]<br />
* [[Game replay]]<br />
* [[3D]]<br />
<br />
=== BGA Studio game components reference ===<br />
<br />
Game components are useful tools you can use in your game adaptations.<br />
<br />
* [[Deck]]: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).<br />
* [[Counter]]: a JS component to manage a counter that can increase/decrease (ex: player's score).<br />
* [[Draggable]]: a JS component to manage drag'n'drop actions.<br />
* [[ExpandableSection]]: a JS component to manage a rectangular block of HTML than can be displayed/hidden.<br />
* [[Scrollmap]]: a JS component to manage a scrollable game area (useful when the game area can be infinite. Examples: Saboteur or Takenoko games).<br />
* [[Stock]]: a JS component to manage and display a set of game elements displayed at a position.<br />
* [[Wrapper]]: a JS component to wrap a &lt;div&gt; element around his child, even if these elements are absolute positioned.<br />
* [[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).<br />
<br />
=== BGA Studio user guide ===<br />
<br />
This part of the documentation is a user guide for the BGA Studio online development environment.<br />
<br />
* [[BGA game Lifecycle]]<br />
* [[First steps with BGA Studio]]<br />
* [[Tutorial reversi]] <br />
* [[Tutorial gomoku]] <br />
* [[Tutorial hearts]]<br />
* [[Create a game in BGA Studio: Complete Walkthrough]]<br />
* [[Tools and tips of BGA Studio]]<br />
* [[BGA Studio Cookbook]]<br />
* [[Practical debugging]]<br />
* [[Studio logs]]<br />
* [[Studio FAQ]]<br />
* [[Troubleshooting]]<br />
* [[Pre-release checklist]]<br />
* [[Post-release phase]]<br />
* [[BGA Code Sharing]]<br />
<br />
== Other resources ==<br />
<br />
[http://forum.boardgamearena.com/viewforum.php?f=12 Development forum]<br />
<br />
[http://forum.boardgamearena.com/viewforum.php?f=4 Bugs forum]</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=SandboxScripts&diff=2471SandboxScripts2017-06-15T16:39:46Z<p>Sourisdudesert: /* Game log (history) */</p>
<hr />
<div><br />
This is the reference of functions you can call from your Sandbox scripts.<br />
<br />
= Javascript =<br />
<br />
BGA Sandbox scripts are written in Javascript.<br />
<br />
Using Javascript, you can write scripts to automate moves for your Sandbox games & provide rules reinforcement.<br />
<br />
Important : in the opposite of the most common usage of Javascript, Sandbox scripts are executed '''on server side'''.<br />
<br />
= BGA API =<br />
<br />
To interact with your BGA Sandbox game, we provide you an API.<br />
<br />
With this API, you can get properties values of game elements from the current game situation, modify them and/or trigger the game actions (ex : move this element here, flip this card, and so on).<br />
<br />
= Quick start =<br />
<br />
== Hello World Script ==<br />
<br />
From Sandbox editor "interface view" tab, select an element, and access to its property (top right icon).<br />
<br />
Go to "Scripts (advanced)" section.<br />
<br />
In front of "When this element is clicked", enter "onMyClick".<br />
<br />
Close the window. Go to "script view" tab.<br />
<br />
Enter the following :<br />
<br />
function onMyClick( element_id )<br />
{<br />
bga.log("Hello world! You just clicked on element " + element_id + ". Congrats!");<br />
}<br />
<br />
Save & publish your project, starts a test session, click on the previous element : your message appears in the log on the right!<br />
<br />
== Top useful tips ==<br />
<br />
* You don't have to save&publish from the Sandbox editor for each modification of your script : each time you save your script (control+S), the script used for all test sessions is updated. Note that the production version on BGA is of course NOT updated until you explicitly save&publish again your project.<br />
<br />
* Alternatively to bga.log(), you can use bga.exit( "my message" ) to debug your script. With bga.exit, the script execution immediately stops and all previous game changes are cancelled, so this is very practical to try and retry an action until your script is fine.<br />
<br />
* We advise you to develop first a full playable version of the game without the scripts, and THEN to script it.<br />
<br />
* This is not mandatory to script the full game! You can start by automate most painful game actions first, publish the game, and then continue later :)<br />
<br />
= Functions you can use in your Sandbox scripts=<br />
<br />
== Debugging functions ==<br />
<br />
=== bga.trace( txt / obj ) ===<br />
<br />
Write something immediately in the BGA log (on the right of the screen).<br />
<br />
This is the most practical way to debug your script :)<br />
<br />
Important : bga.trace is for debugging purpose only and won't be displayed on production.<br />
<br />
Note : you can also pass an object in parameter. This will dump the content of this object in the log.<br />
<br />
Note : in the opposite of bga.log, bga.trace is NOT cancelled if the game action failed (after a call to bga.cancel or bga.error). This makes bga.trace very practical to debug a game action that failed, and for this reason you should probably NEVER use bga.log for debugging purpose.<br />
<br />
<br />
// Example : write "Hello world" in the log<br />
bga.trace( "Hello world" );<br />
<br />
// Example : dump an associative array in the log<br />
bga.trace( { mykey: 'myvalue', another_key: 'another_value' } );<br />
<br />
=== bga.exit( txt / obj ) ===<br />
<br />
Stop the script immediately, display the "txt" messages and cancel (ie : rollback) on every previous API call except bga.trace :<br />
<br />
ALL previous BGA api call are canceled and there will be no visible changes on the interface (ex : no moves, no visible property changes, ...). Only "bga.trace" API commands are kept so you can debug.<br />
<br />
bga.exit is very practical when you want to repeat a game action again and again to debug it : with a call to bga.exit at the end of your script, you make sure that your game situation will be kept unchanged after each test.<br />
<br />
// Example :<br />
bga.exit( "My script is stopped by this call" );<br />
<br />
// Example with dumping a javascript variable<br />
bga.exit( my_variable_to_dump );<br />
<br />
== Cancelling a game action ==<br />
<br />
=== bga.cancel( txt ) ===<br />
<br />
This is the function to use when a player is doing something against game rules.<br />
<br />
The text message in parameter will be displayed to this player as a "red message", so he/she can understand the rule.<br />
<br />
All previous BGA api call are cancelled, and there will be no visible changes on the interface.<br />
<br />
// Example :<br />
bga.cancel( _("You cannot move this piece here") );<br />
<br />
Note : most of the time, you should wrap your text inside a _() translation marker to make this string translatable.<br />
<br />
=== bga.error( text ) ===<br />
<br />
This is the function to use when some unexpected error happens in your script.<br />
<br />
The text message will be displayed to user, with mention "Unexpected error". The player will be incited to fill a bug report. The purpose of the message is to help you to identify the bug.<br />
<br />
All previous BGA api call are cancelled, and there will be no visible changes on the interface.<br />
<br />
// Example :<br />
if( card_picked === null )<br />
{<br />
bga.error( "Cannot find a card to pick !" );<br />
}<br />
<br />
Note : you should NEVER wrap text inside bga.error with _() translation marker, because unexpected error should not be translate (so you can eventually recognize them when reported by players in bug report).<br />
<br />
== Game log (history) ==<br />
<br />
=== bga.log( txt, (optional) args ) ===<br />
<br />
Write something in the BGA log on the right.<br />
<br />
// Example : simple log<br />
bga.log( _("A new round starts") );<br />
<br />
You may add arguments to your log, like this :<br />
<br />
// Example: log with argument to display a card name.<br />
// In this example, variable "event_name" is specified afterwards.<br />
// Note that using this, game translators only have to translate one "Event XXX is triggered" string for all possible events.<br />
bga.log( _("Event ${event_name} is triggered"), { event_name: _( "Armageddon" ) } ) );<br />
<br />
Note that argument "player_name" is ALWAYS pre-set with the name of the current player, so you can use it immediately.<br />
<br />
// Example :<br />
bga.log( _("${player_name} draw a card from the deck") );<br />
<br />
=== bga.speechBubble( target, text, (optional) args, (optional) delay, (optional) duration, (optional) size ) ===<br />
<br />
Display a "speeck bubble", attached to the specified target, containing the specified text.<br />
<br />
You can use "args" to customize text exactly like with bga.log.<br />
<br />
delay : milliseconds to wait before displaying the speech bubble (default : 0).<br />
duration : how long to show the speech bubble in milliseconds (default : 3000).<br />
size : size of the text in percent (default: 100)<br />
<br />
// Example :<br />
bga.speechBubble( _("I play ${nbr} cards"), { nbr : 4 }, 0 );<br />
bga.speechBubble( _("Good for you!"), { }, 2000 );<br />
<br />
== Get / search game elements and their properties ==<br />
<br />
== bga.getElement( selector, (optionnal) fields ) ==<br />
<br />
Allow you to retrieve informations about one game element specified using "selector" argument.<br />
<br />
Return null if no element is found.<br />
<br />
Note : getElement throw an error if several elements matches the selector. If you want to retrieve several elements, you should use "getElements" instead of "getElement".<br />
<br />
The following examples are showing all the possible use of bga.getElement :<br />
<br />
// Basic example :<br />
<br />
// Retrieve the ID of a game element using its name ("Deck")<br />
var deck_id = bga.getElement( { name: "Deck" } );<br />
// Return : 1234 <br />
<br />
// Examples using "field" parameter :<br />
<br />
// Retrieve a specific property from a game element using its name ("Deck")<br />
var deck_id = bga.getElement( { name: "Deck" }, 'x' );<br />
// Return : 20<br />
<br />
// Retrieve several properties from the previous element<br />
var deck_properties = bga.getElement( { name: "Deck" }, ['name','id','parent', 'x','y','canShuffle'] );<br />
// Return : { name:'Deck', id:1234, parent:4321, x: 20, y:50, canShuffle: true }<br />
<br />
// Note : as you can see, getElement returns:<br />
// _ the element ID by default, or<br />
// _ a single value if you request a single field, or<br />
// _ an object if you request several fields<br />
<br />
// Examples using different "selector" paramter<br />
<br />
// Retrieve an element name from its id<br />
var deck_name = bga.getElement( { id: 1234 }, ['name'] );<br />
// Return : "Deck"<br />
<br />
// Retrieve the last child element of another element<br />
// Here, we are requesting for elements who has element with ID=1234 (Deck) as their parent<br />
// Note the use of "limit:1" which allows us to retrieve only 1 element.<br />
var first_card_on_deck_id = bga.getElement( { parent: 1234, limit:1 } );<br />
//<br />
<br />
<br />
=== bga.getElementById( id )===<br />
<br />
Get an object with all the properties of the element with specified ID.<br />
<br />
Throw an exception if the element does not exists.<br />
<br />
<br />
===bga.getElementsByIds( ids )===<br />
<br />
Get all specified elements with an array of ids.<br />
<br />
Return an associative array (element_id => element).<br />
<br />
<br />
===bga.getElementsByParent( parent_id )===<br />
<br />
Get all children (ie : all elements contained) of the specified element_id.<br />
<br />
Ex : if you call getElementsByParent on a deck of cards, you'll get all cards.<br />
<br />
// Example : Get all cards of a deck with name "mydeck"<br />
var cards = bga.getElementsByParent( bga.getElementByName( 'mydeck' ) );<br />
<br />
<br />
===bga.getElementIdByName( name )===<br />
<br />
Get the ID of a Sandbox element from its name.<br />
<br />
Return null if there are no element with this name.<br />
Throw an exception if there are more than 1 element with this name.<br />
<br />
// Example :<br />
var chess_square = bga.getElementIdByName( 'h3' );<br />
<br />
<br />
===bga.getElementsIdsByName( name )===<br />
<br />
Get the IDs of all Sandbox elements with this name.<br />
<br />
// Example :<br />
var pawn_pieces_ids = bga.getElementsIdByName( 'pawn' );<br />
<br />
// Result : [ 41, 42, 43, ... ]<br />
<br />
== Utility methods ==<br />
<br />
=== bga.isOn( element_id, parent_id ) ===<br />
<br />
Return true if "element_id" is a descendant of "parent_id" (ie : if element_id game element has been placed on parent_id game element).<br />
<br />
// Example :<br />
if( bga.isOn( bga.getElementIfByName( 'Turn counter' ), bga.getElementIfByName( 'Turn 6' ) )<br />
{<br />
// Trigger game end<br />
}<br />
<br />
== Trigger most common game actions ==<br />
<br />
===moveElement( element_id, target_id )===<br />
<br />
Move element to specified target id.<br />
<br />
The exact destination of element depends on target "howToArrange" property ("How elements are arranged on it?" : spreaded/deck/...).<br />
<br />
// Example :<br />
bga.moveElement( bga.getElementIdByName( 'Turn counter' ), bga.getElementIdByName( 'Turn 3' ) );<br />
<br />
<br />
== Other functions ==<br />
<br />
=== pause( milliseconds ) ===<br />
<br />
Pause the client interface during a specified number of milliseconds.<br />
<br />
If you do not use bga.pause, all Sandbox game actions are executed immediately and synchronously.<br />
<br />
// Example :<br />
bga.log( "1" ); // Will be displayed immediately on the log<br />
bga.pause( 3000 ); // pause during 3 seconds<br />
bga.log( "2" ); // Will be displayed after the 3 second on the log<br />
bga.log( "3" ); // Will be displayed right after the previous one, without delay.<br />
<br />
<br />
Tips : if you want to execute several consecutive "moveTo", you should "bga.pause" between them, otherwise your element will move directly to the final destination.</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=SandboxScripts&diff=2470SandboxScripts2017-06-15T16:35:27Z<p>Sourisdudesert: /* pause( milliseconds ) */</p>
<hr />
<div><br />
This is the reference of functions you can call from your Sandbox scripts.<br />
<br />
= Javascript =<br />
<br />
BGA Sandbox scripts are written in Javascript.<br />
<br />
Using Javascript, you can write scripts to automate moves for your Sandbox games & provide rules reinforcement.<br />
<br />
Important : in the opposite of the most common usage of Javascript, Sandbox scripts are executed '''on server side'''.<br />
<br />
= BGA API =<br />
<br />
To interact with your BGA Sandbox game, we provide you an API.<br />
<br />
With this API, you can get properties values of game elements from the current game situation, modify them and/or trigger the game actions (ex : move this element here, flip this card, and so on).<br />
<br />
= Quick start =<br />
<br />
== Hello World Script ==<br />
<br />
From Sandbox editor "interface view" tab, select an element, and access to its property (top right icon).<br />
<br />
Go to "Scripts (advanced)" section.<br />
<br />
In front of "When this element is clicked", enter "onMyClick".<br />
<br />
Close the window. Go to "script view" tab.<br />
<br />
Enter the following :<br />
<br />
function onMyClick( element_id )<br />
{<br />
bga.log("Hello world! You just clicked on element " + element_id + ". Congrats!");<br />
}<br />
<br />
Save & publish your project, starts a test session, click on the previous element : your message appears in the log on the right!<br />
<br />
== Top useful tips ==<br />
<br />
* You don't have to save&publish from the Sandbox editor for each modification of your script : each time you save your script (control+S), the script used for all test sessions is updated. Note that the production version on BGA is of course NOT updated until you explicitly save&publish again your project.<br />
<br />
* Alternatively to bga.log(), you can use bga.exit( "my message" ) to debug your script. With bga.exit, the script execution immediately stops and all previous game changes are cancelled, so this is very practical to try and retry an action until your script is fine.<br />
<br />
* We advise you to develop first a full playable version of the game without the scripts, and THEN to script it.<br />
<br />
* This is not mandatory to script the full game! You can start by automate most painful game actions first, publish the game, and then continue later :)<br />
<br />
= Functions you can use in your Sandbox scripts=<br />
<br />
== Debugging functions ==<br />
<br />
=== bga.trace( txt / obj ) ===<br />
<br />
Write something immediately in the BGA log (on the right of the screen).<br />
<br />
This is the most practical way to debug your script :)<br />
<br />
Important : bga.trace is for debugging purpose only and won't be displayed on production.<br />
<br />
Note : you can also pass an object in parameter. This will dump the content of this object in the log.<br />
<br />
Note : in the opposite of bga.log, bga.trace is NOT cancelled if the game action failed (after a call to bga.cancel or bga.error). This makes bga.trace very practical to debug a game action that failed, and for this reason you should probably NEVER use bga.log for debugging purpose.<br />
<br />
<br />
// Example : write "Hello world" in the log<br />
bga.trace( "Hello world" );<br />
<br />
// Example : dump an associative array in the log<br />
bga.trace( { mykey: 'myvalue', another_key: 'another_value' } );<br />
<br />
=== bga.exit( txt / obj ) ===<br />
<br />
Stop the script immediately, display the "txt" messages and cancel (ie : rollback) on every previous API call except bga.trace :<br />
<br />
ALL previous BGA api call are canceled and there will be no visible changes on the interface (ex : no moves, no visible property changes, ...). Only "bga.trace" API commands are kept so you can debug.<br />
<br />
bga.exit is very practical when you want to repeat a game action again and again to debug it : with a call to bga.exit at the end of your script, you make sure that your game situation will be kept unchanged after each test.<br />
<br />
// Example :<br />
bga.exit( "My script is stopped by this call" );<br />
<br />
// Example with dumping a javascript variable<br />
bga.exit( my_variable_to_dump );<br />
<br />
== Cancelling a game action ==<br />
<br />
=== bga.cancel( txt ) ===<br />
<br />
This is the function to use when a player is doing something against game rules.<br />
<br />
The text message in parameter will be displayed to this player as a "red message", so he/she can understand the rule.<br />
<br />
All previous BGA api call are cancelled, and there will be no visible changes on the interface.<br />
<br />
// Example :<br />
bga.cancel( _("You cannot move this piece here") );<br />
<br />
Note : most of the time, you should wrap your text inside a _() translation marker to make this string translatable.<br />
<br />
=== bga.error( text ) ===<br />
<br />
This is the function to use when some unexpected error happens in your script.<br />
<br />
The text message will be displayed to user, with mention "Unexpected error". The player will be incited to fill a bug report. The purpose of the message is to help you to identify the bug.<br />
<br />
All previous BGA api call are cancelled, and there will be no visible changes on the interface.<br />
<br />
// Example :<br />
if( card_picked === null )<br />
{<br />
bga.error( "Cannot find a card to pick !" );<br />
}<br />
<br />
Note : you should NEVER wrap text inside bga.error with _() translation marker, because unexpected error should not be translate (so you can eventually recognize them when reported by players in bug report).<br />
<br />
== Game log (history) ==<br />
<br />
=== bga.log( txt, (optional) args ) ===<br />
<br />
Write something in the BGA log on the right.<br />
<br />
// Example : simple log<br />
bga.log( _("A new round starts") );<br />
<br />
You may add arguments to your log, like this :<br />
<br />
// Example: log with argument to display a card name.<br />
// In this example, variable "event_name" is specified afterwards.<br />
// Note that using this, game translators only have to translate one "Event XXX is triggered" string for all possible events.<br />
bga.log( _("Event ${event_name} is triggered"), { event_name: _( "Armageddon" ) } ) );<br />
<br />
Note that argument "player_name" is ALWAYS pre-set with the name of the current player, so you can use it immediately.<br />
<br />
// Example :<br />
bga.log( _("${player_name} draw a card from the deck") );<br />
<br />
== Get / search game elements and their properties ==<br />
<br />
== bga.getElement( selector, (optionnal) fields ) ==<br />
<br />
Allow you to retrieve informations about one game element specified using "selector" argument.<br />
<br />
Return null if no element is found.<br />
<br />
Note : getElement throw an error if several elements matches the selector. If you want to retrieve several elements, you should use "getElements" instead of "getElement".<br />
<br />
The following examples are showing all the possible use of bga.getElement :<br />
<br />
// Basic example :<br />
<br />
// Retrieve the ID of a game element using its name ("Deck")<br />
var deck_id = bga.getElement( { name: "Deck" } );<br />
// Return : 1234 <br />
<br />
// Examples using "field" parameter :<br />
<br />
// Retrieve a specific property from a game element using its name ("Deck")<br />
var deck_id = bga.getElement( { name: "Deck" }, 'x' );<br />
// Return : 20<br />
<br />
// Retrieve several properties from the previous element<br />
var deck_properties = bga.getElement( { name: "Deck" }, ['name','id','parent', 'x','y','canShuffle'] );<br />
// Return : { name:'Deck', id:1234, parent:4321, x: 20, y:50, canShuffle: true }<br />
<br />
// Note : as you can see, getElement returns:<br />
// _ the element ID by default, or<br />
// _ a single value if you request a single field, or<br />
// _ an object if you request several fields<br />
<br />
// Examples using different "selector" paramter<br />
<br />
// Retrieve an element name from its id<br />
var deck_name = bga.getElement( { id: 1234 }, ['name'] );<br />
// Return : "Deck"<br />
<br />
// Retrieve the last child element of another element<br />
// Here, we are requesting for elements who has element with ID=1234 (Deck) as their parent<br />
// Note the use of "limit:1" which allows us to retrieve only 1 element.<br />
var first_card_on_deck_id = bga.getElement( { parent: 1234, limit:1 } );<br />
//<br />
<br />
<br />
=== bga.getElementById( id )===<br />
<br />
Get an object with all the properties of the element with specified ID.<br />
<br />
Throw an exception if the element does not exists.<br />
<br />
<br />
===bga.getElementsByIds( ids )===<br />
<br />
Get all specified elements with an array of ids.<br />
<br />
Return an associative array (element_id => element).<br />
<br />
<br />
===bga.getElementsByParent( parent_id )===<br />
<br />
Get all children (ie : all elements contained) of the specified element_id.<br />
<br />
Ex : if you call getElementsByParent on a deck of cards, you'll get all cards.<br />
<br />
// Example : Get all cards of a deck with name "mydeck"<br />
var cards = bga.getElementsByParent( bga.getElementByName( 'mydeck' ) );<br />
<br />
<br />
===bga.getElementIdByName( name )===<br />
<br />
Get the ID of a Sandbox element from its name.<br />
<br />
Return null if there are no element with this name.<br />
Throw an exception if there are more than 1 element with this name.<br />
<br />
// Example :<br />
var chess_square = bga.getElementIdByName( 'h3' );<br />
<br />
<br />
===bga.getElementsIdsByName( name )===<br />
<br />
Get the IDs of all Sandbox elements with this name.<br />
<br />
// Example :<br />
var pawn_pieces_ids = bga.getElementsIdByName( 'pawn' );<br />
<br />
// Result : [ 41, 42, 43, ... ]<br />
<br />
== Utility methods ==<br />
<br />
=== bga.isOn( element_id, parent_id ) ===<br />
<br />
Return true if "element_id" is a descendant of "parent_id" (ie : if element_id game element has been placed on parent_id game element).<br />
<br />
// Example :<br />
if( bga.isOn( bga.getElementIfByName( 'Turn counter' ), bga.getElementIfByName( 'Turn 6' ) )<br />
{<br />
// Trigger game end<br />
}<br />
<br />
== Trigger most common game actions ==<br />
<br />
===moveElement( element_id, target_id )===<br />
<br />
Move element to specified target id.<br />
<br />
The exact destination of element depends on target "howToArrange" property ("How elements are arranged on it?" : spreaded/deck/...).<br />
<br />
// Example :<br />
bga.moveElement( bga.getElementIdByName( 'Turn counter' ), bga.getElementIdByName( 'Turn 3' ) );<br />
<br />
<br />
== Other functions ==<br />
<br />
=== pause( milliseconds ) ===<br />
<br />
Pause the client interface during a specified number of milliseconds.<br />
<br />
If you do not use bga.pause, all Sandbox game actions are executed immediately and synchronously.<br />
<br />
// Example :<br />
bga.log( "1" ); // Will be displayed immediately on the log<br />
bga.pause( 3000 ); // pause during 3 seconds<br />
bga.log( "2" ); // Will be displayed after the 3 second on the log<br />
bga.log( "3" ); // Will be displayed right after the previous one, without delay.<br />
<br />
<br />
Tips : if you want to execute several consecutive "moveTo", you should "bga.pause" between them, otherwise your element will move directly to the final destination.</div>Sourisdudeserthttps://sr.doc.boardgamearena.com/index.php?title=Game_meta-information:_gameinfos.inc.php&diff=2323Game meta-information: gameinfos.inc.php2017-04-24T07:36:18Z<p>Sourisdudesert: </p>
<hr />
<div><br />
From this file, you can edit the various meta-information of your game.<br />
<br />
Once you modified the file, don't forget to click on "Reload game informations" from the Control Panel in order in can be taken into account.<br />
<br />
Most information provided in this file are self-explainable. Some information, though:<br />
<br />
* You are not allowed to set the "'''is_beta'''" to 0 before the game has been released on BGA and stabilized.<br />
<br />
* "'''fast/medium/slow_additional_time'''": please set high values here: after the game has been released, we will lower these value to match the real game duration.<br />
<br />
* "'''players'''":<br />
** during the first step of development of a game, you'd better allow the "1 player" configuration: much easy to start/stop a game this way.<br />
** if you change the minimum number of players from for example 1 to 2, make sure the new tables you create are not restricted from 1 to 1 player otherwise when you create a new table and this account setting is used, there will be a conflict with the new minimum number of players allowed.<br />
<br />
* '''suggest_player_number''' / '''not_recommend_player_number''': don't specify anything here if there is no configuration that is REALLY better/worst than another one. You can check player's poll on BoardGameGeek game page if you have any doubt.<br />
<br />
== Custom "buy this game" button ==<br />
<br />
By default, the "buy this game" button is a link to an Amazon search with the name of the game.<br />
<br />
You can replace it by a different URL / game button label with :<br />
<br />
'custom_buy_button' => array(<br />
'url' => 'http://yoururl.com',<br />
'label' => 'Name of the website'<br />
),<br />
<br />
Note : button label will be "Buy on <Name of the website>"<br />
<br />
== Tags ==<br />
<br />
Any number of '''Tags''' can be attribute to your game. Tags are useful to place your game in the correct place and to give a good quick overview of what the game is about to players.<br />
<br />
Main game category (you MUST specify one tag AND ONLY ONE from this category):<br />
* 1: Abstract game<br />
* 2: Casual games<br />
* 3: For regular players<br />
* 4: For core gamers<br />
<br />
Other tags (you can specify any numbers of tags):<br />
* 10: Short game (<10 minutes)<br />
* 11: Medium length game (10 minutes to 30 minutes)<br />
* 12: Long game (>30mn)<br />
* 20: Awarded game (Win a prestigious award) (the game must have been at the '''first''' place of one the [http://boardgamegeek.com/wiki/page/Gaming_Industry_Awards# following major awards list]).<br />
* 22: Prototype (This game has not been published yet)<br />
* 23: Classic (This game is a classic from Public Domain)<br />
* 30: 2 players (2p game / best with 2 players)<br />
* 100: Fantasy theme<br />
* 101: Science Fiction them<br />
* 102: Historical theme<br />
* 103: Adventure<br />
* 104: Exploration<br />
* 105: Conquest<br />
* 106: Building<br />
* 200: Card game (Cards plays a central role in this game)<br />
* 201: Dice<br />
* 202: Solo game<br />
* 203: Worker placement<br />
* 204: Hand management<br />
* 205: Bluff<br />
* 206: Tile placement<br />
* 207: Combinations<br />
* 208: Majority<br />
* 209: Race<br />
* 210: Collection</div>Sourisdudesert