Board Game Arena - Contribucións do/a usuario/a [gl]

Gamehelpcoupcitystate

2018-12-25T07:33:38Z

Quietmint: Remove rounds to win

== Introduction ==
In Coup, players vie for control of a corrupt city-state in renaissance Italy. Through your influence in the court (the character cards in your hand), bluff, steal, and murder your opponents to become the last player standing and rise to power. There is no second place.

== Setup ==
The 15-card deck contains 3 copies of 5 different characters (''Ambassador'', ''Assassin'', ''Captain'', ''Contessa'', ''Duke'').

Each player begins with ₤2 (or ₤1 in a two-player game) and 2 cards. Money is public knowledge, but character cards in hand are secret.

== Actions ==
On your turn, take any action you can afford:

=== General actions (always available) ===

• '''Income''': Take ₤1 from the treasury. Cannot be blocked.

• '''Foreign Aid''': Take ₤2 from the treasury. Any player claiming to be the ''Duke'' can block.

• '''Coup''': Pay ₤7 to the treasury and make another player lose influence (kill a character card). Cannot be blocked. If you start your turn with ₤10, you must choose this action.

=== Character actions (must claim to have that character card in hand) ===

• '''Tax''' (as the ''Duke''): Take ₤3 from the treasury. Cannot be blocked.

• '''Steal''' (as the ''Captain''): Take ₤2 from another player. The targeted player can block by claiming to be the ''Ambassador''/''Inquisitor'' or the ''Captain''.

• '''Exchange''' (as the ''Ambassador''): Draw 2 cards from the court deck, then return 2 cards to the deck. Cannot be blocked.

• '''Assassinate''' (as the ''Assassin''): Pay ₤3 to the treasury and make another player lose influence (kill a character card). The targeted player can block by claiming to be the ''Contessa''.

== Challenges ==

Any player making a character claim can be challenged. A challenge always results in one player losing a character. The challenged player reveals a card from his/her hand.

• If bluffing, the revealed card is killed.

• If truthful, the revealed card is shuffled into the deck, replaced, and the challenger kills a card from his/her hand.

Dead character cards remain face-up and their influence can no longer be used. If both of your characters die, you're eliminated. The last player remaining wins!

== Variant: Factions ==

This variant divides players into two factions (teams), the Monarchists and the Populists. As long as there are two factions, players cannot block or target their teammates (however, '''Convert''' and challenges are always allowed). If there is only one faction in play, infighting takes over and no restriction applies.

=== Additional actions ===

• '''Convert''': Pay ₤1 to the almshouse to change your own faction, or pay ₤2 to the almshouse to change another player's faction. Cannot be blocked.

• '''Embezzle''' (any character except the ''Duke''): Take all coins from the almshouse if you are NOT the ''Duke''. Cannot be blocked.

If the '''Embezzle''' action is challenged, the challenged player reveals both cards in hand. If any ''Dukes'' are revealed (bluffing), one is killed (any other revealed card is shuffled into the deck and replaced). Otherwise (truthful), both revealed cards are shuffled into the deck, replaced, and the challenger kills a card from his/her hand as normal.

== Variant: Inquisitor ==

This variant replaces the ''Ambassador'' character with the ''Inquisitor''. The ''Inquisitor'' still blocks stealing and has two character actions:

=== Replacement character actions ===

• '''Exchange''' (as the ''Inquisitor''): Draw 1 card from the court deck, then return 1 card to the deck. Cannot be blocked.

• '''Examine''' (as the ''Inquisitor''): Secretly look at 1 card in another player's hand. Choose whether to return the card to the owner or force the owner to exchange it with the court deck. Cannot be blocked.

Game art: img directory

2018-11-25T18:33:22Z

Quietmint: /* Use CSS Sprites */

== Requested images ==

The following images are requested by BGA:

;game_box.png
* It is displayed on the main site on the game description page and when creating a table (280x280 px).
* It should be a 3D image of a physical copy of the game box as it appears in an online shop.
* It is better to take the version of the game that is coherent with the game art used in the adaptation, and from the original publisher of the game.
* The background of the image must be transparent.
* If you don't have a 3D version of the game box, you can use the following website to create one: http://www.3d-pack.com/

;game_box180.png
;game_box75.png

* Don't modify these images, they are auto generated by "Reload game box image" action. If you have another copy of your source make sure you update you copy of these files after they have been generated and not override with old copied.

;game_icon.png

* It is the icon displayed in the lists of games and tables (50x50 px).
* The objective of this icon is to make the game recognizable among the other games. A good idea is to take a part of the game cover that is distinctive (ex: the game title).
* This one does not have to be transparent. This image should not have a border

;publisher.png
* It is the logo of the publisher of the game, displayed on the game description page.
* The width must be 150 px. The height can be anything (reasonable). The image could be transparent.

;publisher2.png (optional)
* If the game has been co-published by 2 publishers, you should upload a second image named "publisher2.png" (same characteristics as the first one).

'''Important''': when you modify these images, you MUST click on "Reload game box image" from the Control Panel in order your update can be taken into account.

== Game art ==

You must upload in img directory all images of your game interface.

=== Images loading ===

'''Be careful''': by default, ALL images of your img directory are loaded on a player's browser when he loads the game. For this reason, don't let in your img directory images that are not useful, otherwise it's going to slowdown the game load.

Note that you can tune the way images are loaded with Javascript method "dontPreloadImage" (see [[Game_interface_logic:_yourgamename.js|Game Interface Logic]]).

General recommendation it to have no more than dozen of image files, 2Mb max each. However if there is heavy game resources specific to a player (i.e. player board of specific color or set of cards) it is better to separate them and "don't pre-load" since in any given game only some of them will be used.

=== Images format ===

You can use 3 image format while building your game interface:
;jpg images

should be used for non-transparent images. Jpg are usually lighter than Pngs, so please choose Jpg for big pictures (ex: game board, cards) when you don't need transparency to accelerate game load.

;png images

should be used for transparent images.

;gif images

can be used for animated images. This is not recommended to use gif animated images as they can upset players, but for some specific interface element this could be useful.

=== Use CSS Sprites ===

To limit the number of images load and make the game load faster, you must use CSS sprites, i.e. you must gather several images in a single one. However, there are limitations. Do not make any CSS image sprite with dimensions that exceed 4096x4096 pixels or it will not work on mobile devices (Android max texture size is 4096 pixels, test your own browser at [http://webglreport.com/ WebGL Report]).

To learn more on CSS Sprites:
* [http://www.w3schools.com/css/css_image_sprites.asp CSS sprites (W3C documentation)].
* [[Game interface stylesheet: yourgamename.css]]

=== Shrink images ===

If you get high resolution images from publisher you need to shrink them since web display requires much lower resolution than printing.

* Shrink images without loss of quality https://tinypng.com/ or http://www.iloveimg.com/

== Image Manipulation Tools ==

You have no choice but to use one of the image manipulating tools to create a successful game adaptation, you would have to
deal with
* Converting to supported formats
* Adding transparency
* Stitching
* Shrinking with no quality loss
* Resizing

For that you need a good tools, recommended tools (if you know more add them here)
* Gimp (linux) - general GUI image editor
* Paint.net (Windows) - general GUI image editor
* ImageMagic (All platforms) - https://www.imagemagick.org/script/download.php - command line image editor, great for mass manipulations and scripting

Gamehelptaluva

2018-11-12T05:57:44Z

Quietmint:

== System Compatibility ==
This game requires 3D mode. [https://www.google.com/chrome/ Google Chrome] is the recommended browser for best performance and highest image quality. It is '''not recommended''' to play on smartphones or tablets.

== Introduction ==
In Taluva, players build temples, towers, and huts to settle a volcanic island emerging from the South Pacific. The game ends in an early victory if a player builds '''all buildings of two types'''. Otherwise, the game ends when no tiles remain and the winner is the player who built the most '''temples''' (in case of a tie, the most '''towers''' and then the most '''huts''').

== Setup ==
Each player receives 3 temples, 2 towers, and 20 huts.

12 tiles per player are shuffled to form a draw pile. Each tile is composed of 3 hexagon spaces: A volcano and two other terrain types (from most common to least: jungle, clearing, sand, rock, lake).

== Place A Tile ==

Begin your turn by drawing and placing a tile. Click the space on the board where you want to place the volcano. Choose from one of two options:

=== Expand the landscape ===
Place your tile on the edge of the island adjacent to any existing tile.

=== Volcanic eruption ===
Place your tile on top of two existing tiles so the volcano covers another volcano. Your tile must have a different rotation than the tile below and cannot overhang the ocean. You may destroy huts as long as you do not destroy an entire settlement (see below). Destroyed huts remain out of play.

== Build Buildings ==

End your turn by building one or more buildings on empty space(s) of any terrain type except volcano. A chain of your adjacent buildings forms a ''settlement''.

Choose from one of four options:

=== New settlement ===

* Begin a new settlement by placing a '''hut''' on a first-level space not adjacent to any of your existing settlements.

=== Expand settlement ===

* Expand an existing settlement by choosing a terrain type. On all adjacent spaces of that type, build '''huts''' equal to the height (one hut on first-level spaces, two huts on second-level spaces, etc.). You must have enough huts to build on all eligible spaces. In the example below, the red player can build 2 huts on lakes (one on each) or 1 hut on sand (but cannot build only 1 hut on lake).
[[File:Taluva-expand.png]]

=== Temple ===

* Build a '''temple''' adjacent to one of your existing settlements occupying 3 or more spaces that does not already contain a temple. In the previous example, the red player could build a temple on sand if she built huts on both lakes in a prior turn. Note that it is the number of ''spaces'', not buildings, that determines whether a temple can be built in the settlement.

=== Tower ===
* Build a '''tower''' on a third-level space (or higher) adjacent to one of your existing settlements that does not already contain a tower.

You are allowed to build in such a way that two of your settlements join together, such that there are two temples or two towers in the same settlement, for example.

'''Beware! If you cannot build, you will be eliminated from the game.'''

Gamehelptaluva

2018-11-11T15:18:28Z

Quietmint:

== System Compatibility ==
This game requires 3D mode. It is '''not recommended''' to play on smartphones or tablets due to the performance requirements. On desktop, [https://www.google.com/chrome/ Google Chrome] is the recommended browser.

== Introduction ==
In Taluva, players build temples, towers, and huts to settle a volcanic island emerging from the South Pacific. The game ends in an early victory if a player builds '''all buildings of two types'''. Otherwise, the game ends when no tiles remain and the winner is the player who built the most '''temples''' (in case of a tie, the most '''towers''' and then the most '''huts''').

== Setup ==
Each player receives 3 temples, 2 towers, and 20 huts.

12 tiles per player are shuffled to form a draw pile. Each tile is composed of 3 hexagon spaces: A volcano and two other terrain types (from most common to least: jungle, clearing, sand, rock, lake).

== Place A Tile ==

Begin your turn by drawing and placing a tile. Click the space on the board where you want to place the volcano. Choose from one of two options:

=== Expand the landscape ===
Place your tile on the edge of the island adjacent to any existing tile.

=== Volcanic eruption ===
Place your tile on top of two existing tiles so the volcano covers another volcano. Your tile must have a different rotation than the tile below and cannot overhang the ocean. You may destroy huts as long as you do not destroy an entire settlement (see below). Destroyed huts remain out of play.

== Build Buildings ==

End your turn by building one or more buildings on empty space(s) of any terrain type except volcano. A chain of your adjacent buildings forms a ''settlement''.

Choose from one of four options:

=== New settlement ===

* Begin a new settlement by placing a '''hut''' on a first-level space not adjacent to any of your existing settlements.

=== Expand settlement ===

* Expand an existing settlement by choosing a terrain type. On all adjacent spaces of that type, build '''huts''' equal to the height (one hut on first-level spaces, two huts on second-level spaces, etc.). You must have enough huts to build on all eligible spaces. In the example below, the red player can build 2 huts on lakes (one on each) or 1 hut on sand (but cannot build only 1 hut on lake).
[[File:Taluva-expand.png]]

=== Temple ===

* Build a '''temple''' adjacent to one of your existing settlements occupying 3 or more spaces that does not already contain a temple. In the previous example, the red player could build a temple on sand if she built huts on both lakes in a prior turn. Note that it is the number of ''spaces'', not buildings, that determines whether a temple can be built in the settlement.

=== Tower ===
* Build a '''tower''' on a third-level space (or higher) adjacent to one of your existing settlements that does not already contain a tower.

You are allowed to build in such a way that two of your settlements join together, such that there are two temples or two towers in the same settlement, for example.

'''Beware! If you cannot build, you will be eliminated from the game.'''

Gamehelptaluva

2018-06-04T15:10:15Z

Quietmint: /* Build Buildings */

== Introduction ==
In Taluva, players build temples, towers, and huts to settle a volcanic island emerging from the South Pacific. The game ends in an early victory if a player builds '''all buildings of two types'''. Otherwise, the game ends when no tiles remain and the winner is the player who built the most '''temples''' (in case of a tie, the most '''towers''' and then the most '''huts''').

== Setup ==
Each player receives 3 temples, 2 towers, and 20 huts.

12 tiles per player are shuffled to form a draw pile. Each tile is composed of 3 hexagon spaces: A volcano and two other terrain types (from most common to least: jungle, clearing, sand, rock, lake).

== Place A Tile ==

Begin your turn by drawing and placing a tile. Click the space on the board where you want to place the volcano. Choose from one of two options:

=== Expand the landscape ===
Place your tile on the edge of the island adjacent to any existing tile.

=== Volcanic eruption ===
Place your tile on top of two existing tiles so the volcano covers another volcano. Your tile must have a different rotation than the tile below and cannot overhang the ocean. You may destroy huts as long as you do not destroy an entire settlement (see below). Destroyed huts remain out of play.

== Build Buildings ==

End your turn by building one or more buildings on empty space(s) of any terrain type except volcano. A chain of your adjacent buildings forms a ''settlement''.

Choose from one of four options:

=== New settlement ===

* Begin a new settlement by placing a '''hut''' on a first-level space not adjacent to any of your existing settlements.

=== Expand settlement ===

* Expand an existing settlement by choosing a terrain type. On all adjacent spaces of that type, build '''huts''' equal to the height (one hut on first-level spaces, two huts on second-level spaces, etc.). You must have enough huts to build on all eligible spaces. In the example below, the red player can build 2 huts on lakes (one on each) or 1 hut on sand (but cannot build only 1 hut on lake).
[[File:Taluva-expand.png]]

=== Temple ===

* Build a '''temple''' adjacent to one of your existing settlements occupying 3 or more spaces that does not already contain a temple. In the previous example, the red player could build a temple on sand if she built huts on both lakes in a prior turn. Note that it is the number of ''spaces'', not buildings, that determines whether a temple can be built in the settlement.

=== Tower ===
* Build a '''tower''' on a third-level space (or higher) adjacent to one of your existing settlements that does not already contain a tower.

You are allowed to build in such a way that two of your settlements join together, such that there are two temples or two towers in the same settlement, for example.

'''Beware! If you cannot build, you will be eliminated from the game.'''

Gamehelptaluva

2018-04-06T12:36:54Z

Quietmint:

== Introduction ==
In Taluva, players build temples, towers, and huts to settle a volcanic island emerging from the South Pacific. The game ends in an early victory if a player builds '''all buildings of two types'''. Otherwise, the game ends when no tiles remain and the winner is the player who built the most '''temples''' (in case of a tie, the most '''towers''' and then the most '''huts''').

== Setup ==
Each player receives 3 temples, 2 towers, and 20 huts.

12 tiles per player are shuffled to form a draw pile. Each tile is composed of 3 hexagon spaces: A volcano and two other terrain types (from most common to least: jungle, clearing, sand, rock, lake).

== Place A Tile ==

Begin your turn by drawing and placing a tile. Click the space on the board where you want to place the volcano. Choose from one of two options:

=== Expand the landscape ===
Place your tile on the edge of the island adjacent to any existing tile.

=== Volcanic eruption ===
Place your tile on top of two existing tiles so the volcano covers another volcano. Your tile must have a different rotation than the tile below and cannot overhang the ocean. You may destroy huts as long as you do not destroy an entire settlement (see below). Destroyed huts remain out of play.

== Build Buildings ==

End your turn by building one or more buildings on empty space(s) of any terrain type except volcano. A chain of your adjacent buildings forms a ''settlement''.

Choose from one of four options:

* Begin a new settlement by placing a '''hut''' on a first-level space not adjacent to any of your existing settlements.

* Expand an existing settlement by choosing a terrain type. On all adjacent spaces of that type, build '''huts''' equal to the height (one hut on first-level spaces, two huts on second-level spaces, etc.). You must have enough huts to build on all eligible spaces. In the example below, the red player can build 2 huts on lakes (one on each) or 1 hut on sand (but cannot build only 1 hut on lake).
[[File:Taluva-expand.png]]

* Build a '''temple''' adjacent to one of your existing settlements occupying 3 or more spaces that does not already contain a temple. In the previous example, the red player could build a temple on sand if she built huts on both lakes in a prior turn. Note that it is the number of ''spaces'', not buildings, that determines whether a temple can be built in the settlement.

* Build a '''tower''' on a third-level space (or higher) adjacent to one of your existing settlements that does not already contain a tower.

You are allowed to build in such a way that two of your settlements join together, such that there are two temples or two towers in the same settlement, for example.

'''Beware! If you cannot build, you will be eliminated from the game.'''

Gamehelptaluva

2018-04-03T03:36:24Z

Quietmint:

== Introduction ==
In Taluva, players build temples, towers, and huts to settle a volcanic island emerging from the South Pacific. The game ends in an early victory if a player builds '''all buildings of two types'''. Otherwise, the game ends when no tiles remain and the winner is the player who built the most '''temples''' (in case of a tie, the most '''towers''' and then the most '''huts''').

== Setup ==
Each player receives 3 temples, 2 towers, and 20 huts.

12 tiles per player are shuffled to form a draw pile. Each tile is composed of 3 hexagon spaces: A volcano and two other terrain types (from most common to least: jungle, clearing, sand, rock, lake).

== Place A Tile ==

Begin your turn by drawing and placing a tile. Choose from one of two options:

* Expand the landscape: Place your tile on the edge of the island adjacent to any existing tile.

* Volcanic eruption: Place your tile on top of two existing tiles so the volcano covers another volcano. Your tile must have a different rotation than the tile below and cannot overhang the ocean. You may destroy huts as long as you do not destroy an entire settlement (see below). Destroyed huts remain out of play.

== Build Buildings ==

End your turn by building one or more buildings on empty space(s) of any terrain type except volcano. A chain of your adjacent buildings forms a ''settlement''.

Choose from one of four options:

* Begin a new settlement by placing a '''hut''' on a first-level space not adjacent to any of your existing settlements.

* Expand an existing settlement by choosing a terrain type. On all adjacent spaces of that type, build '''huts''' equal to the height (one hut on first-level spaces, two huts on second-level spaces, etc.). You must have enough huts to build on all eligible spaces. In the example below, the red player can build 2 huts on lakes (one on each) or 1 hut on sand (but cannot build only 1 hut on lake).
[[File:Taluva-expand.png]]

* Build a '''temple''' adjacent to one of your existing settlements occupying 3 or more spaces that does not already contain a temple. In the previous example, the red player could build a temple on sand if she built huts on both lakes in a prior turn. Note that it is the number of ''spaces'', not buildings, that determines whether a temple can be built in the settlement.

* Build a '''tower''' on a third-level space (or higher) adjacent to one of your existing settlements that does not already contain a tower.

You are allowed to build in such a way that two of your settlements join together, such that there are two temples or two towers in the same settlement, for example.

'''Beware! If you cannot build, you will be eliminated from the game.'''

Ficheiro:Taluva-expand.png

2018-04-03T03:10:07Z

Quietmint:

Gamehelpcouptaluva

2018-03-27T10:20:18Z

Quietmint: moved Gamehelpcouptaluva to Gamehelptaluva

#REDIRECT [[Gamehelptaluva]]

Gamehelptaluva

2018-03-27T10:20:18Z

Quietmint: moved Gamehelpcouptaluva to Gamehelptaluva

Gamehelptaluva

2018-03-27T10:20:04Z

Quietmint: Created page with "== Introduction == In Taluva, players build temples, towers, and huts to settle a volcanic island emerging from the South Pacific. The game ends in an early victory if a playe..."

Studio

2018-01-17T02:55:18Z

Quietmint: /* Other resources */

[[File:Bga_studio_small.jpg]]

Note: Please DO NOT translate Studio Documentation, so that there can be one place where you can find the latest information available.

== What is Board Game Arena Studio? ==

'''Board Game Arena Studio''' is a platform to build online board game adaptations using the Board Game Arena platform.

It is open to any gamer with software development skills :)

BGA Studio website: http://en.studio.boardgamearena.com

Original announcement on BGA forum: http://forum.boardgamearena.com/viewtopic.php?f=10&t=1973

== Discover BGA Studio in 5 presentations ==

Why, how, what... to start discovering BGA Studio, we prepared 5 "powerpoint" presentations for you:

* [http://www.slideshare.net/boardgamearena/5-reasons-why-you-should-use-bga-studio-for-your-online-board-game 5 reasons why you should use BGA Studio for your online board game]
* [http://www.slideshare.net/boardgamearena/the-8-steps-to-create-a-board-game-on-board-game-arena The 8 steps to create a board game on Board Game Arena]
* [http://www.slideshare.net/boardgamearena/the-bga-framework-at-a-glance The BGA Framework at a glance]
* [http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine Focus on BGA game state machine]
* [http://www.slideshare.net/boardgamearena/bga-studio-guidelines BGA developers guidelines]

== How to join the BGA developer team? ==

Please see this page: [[How to join BGA developer team?]]

== Great, I'm in! ... How should I start? ==

If you didn't already, check the presentations at the top of this page to get the basics.

Then, you should checkout the [[First steps with BGA Studio]] to make sure that runs fine.

After that, we strongly advise you to take one of these game creation tutorials:
* [[Tutorial reversi]] - an abstract strategy game played on an 8×8 uncheckered board for 2 players
* [[Tutorial gomoku]] - an abstract strategy game tic-tac-toe style for 2 players
* [[Tutorial hearts]] - a card game for 4 players

Then start editing files and see what happens! ;)

If you have any questions, please check out the '''[[Studio FAQ]]''' first, then if you didn't find the answer you were looking for, please post your question on the [http://forum.boardgamearena.com/viewforum.php?f=12 '''development forum'''].

== BGA Studio documentation ==

=== BGA Studio Framework reference ===

This part of the documentation focuses on the development framework itself: functions and methods available to build your game.

[[Studio file reference|File structure of a BGA game]]

==== Game logic (Server side) ====

* [[Main game logic: yourgamename.game.php]]
* [[Your game state machine: states.inc.php]]
* [[Game database model: dbmodel.sql]]
* [[Players actions: yourgamename.action.php]]
* [[Game material description: material.inc.php]]
* [[Game statistics: stats.inc.php]]

==== Game interface (Client side) ====

* [[Game interface logic: yourgamename.js]]
* [[Game art: img directory]]
* [[Game interface stylesheet: yourgamename.css]]
* [[Game layout: view and template: yourgamename.view.php and yourgamename_yourgamename.tpl]]
* [[Your game mobile version]]

==== Other components ====

* [[Translations]] (how to make your game translatable)
* [[Game options and preferences: gameoptions.inc.php]]
* [[Game meta-information: gameinfos.inc.php]]
* [[Game replay]]
* [[3D]]

=== BGA Studio game components reference ===

Game components are useful tools you can use in your game adaptations.

* [[Deck]]: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).
* [[Counter]]: a JS component to manage a counter that can increase/decrease (ex: player's score).
* [[Draggable]]: a JS component to manage drag'n'drop actions.
* [[ExpandableSection]]: a JS component to manage a rectangular block of HTML than can be displayed/hidden.
* [[Scrollmap]]: a JS component to manage a scrollable game area (useful when the game area can be infinite. Examples: Saboteur or Takenoko games).
* [[Stock]]: a JS component to manage and display a set of game elements displayed at a position.
* [[Wrapper]]: a JS component to wrap a <div> element around his child, even if these elements are absolute positioned.
* [[Zone]]: a JS component to manage a zone of the board where several game elements can come and leave, but should be well displayed together (See for example: token's places at Can't Stop).

=== BGA Studio user guide ===

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

* [[BGA game Lifecycle]]
* [[First steps with BGA Studio]]
* [[Tutorial reversi]]
* [[Tutorial gomoku]]
* [[Tutorial hearts]]
* [[Create a game in BGA Studio: Complete Walkthrough]]
* [[Tools and tips of BGA Studio]] - Tips and instructions on setting up development environment
* [[Practical debugging]] - Tips focused on debugging
* [[Studio logs]] - Instructions for log access
* [[BGA Studio Cookbook]] - Tips and instructions on using API's, libraries and frameworks
* [[BGA Studio Guidelines]]
* [[Troubleshooting]] - Most common "I am really stuck" situations
* [[Studio FAQ]]
* [[Pre-release checklist]] - Go throught this list if you think you done development
* [[Post-release phase]]
* [[BGA Code Sharing]] - Shared resources, projects on git hub, common code, other links

== Other resources ==

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

[https://en.boardgamearena.com/#!bugs Bug tracking system]

Browser support

2018-01-14T20:57:30Z

Quietmint: IE 11, not IE 9

<h3>For the best experience, we recommend:</h3>
* '''Google Chrome 10+''' [http://www.google.com/chrome Windows] [http://www.google.com/chrome?platform=mac Mac] [http://www.google.com/chrome?platform=linux Linux]
* '''Mozilla Firefox 4+''' [http://www.mozilla.org/products/firefox/ Windows] [http://www.mozilla.org/products/firefox/ Mac] [http://www.mozilla.org/products/firefox/ Linux]

Board Game Arena takes advantage of the most recent web technology to make it possible for you to play without installing anything on your computer: no software to download or update, no plugins to install, etc.
Consequently, to play you need to use a modern web browser. Generally speaking, the more recent your web browser is, the more pleasant your game experience on Board Game Arena will be.

This website makes intensive use of Javascript and your browser's graphics capabilities. Thus, if you want to have the best gaming experience with Board Game Arena, you should use one of the browsers listed above. However, we officially support the following browsers:

* Google Chrome 4+
* Mozilla Firefox 3.5+
* Internet Explorer 11+
* Microsoft Edge
* Safari 4+

We also support playing on iPads or similar tablets, or mobile phones.

[[Category:Help]]

Gamehelpcoupcitystate

2018-01-09T06:33:48Z

Quietmint:

== Introduction ==
In Coup, players vie for control of a corrupt city-state in renaissance Italy. Through your influence in the court (the character cards in your hand), bluff, steal, and murder your opponents to become the last player standing and rise to power. There is no second place.

== Setup ==
The 15-card deck contains 3 copies of 5 different characters (''Ambassador'', ''Assassin'', ''Captain'', ''Contessa'', ''Duke'').

Each player begins with ₤2 (or ₤1 in a two-player game) and 2 cards. Money is public knowledge, but character cards in hand are secret.

== Actions ==
On your turn, take any action you can afford:

=== General actions (always available) ===

• '''Income''': Take ₤1 from the treasury. Cannot be blocked.

• '''Foreign Aid''': Take ₤2 from the treasury. Any player claiming to be the ''Duke'' can block.

• '''Coup''': Pay ₤7 to the treasury and make another player lose influence (kill a character card). Cannot be blocked. If you start your turn with ₤10, you must choose this action.

=== Character actions (must claim to have that character card in hand) ===

• '''Tax''' (as the ''Duke''): Take ₤3 from the treasury. Cannot be blocked.

• '''Steal''' (as the ''Captain''): Take ₤2 from another player. The targeted player can block by claiming to be the ''Ambassador''/''Inquisitor'' or the ''Captain''.

• '''Exchange''' (as the ''Ambassador''): Draw 2 cards from the court deck, then return 2 cards to the deck. Cannot be blocked.

• '''Assassinate''' (as the ''Assassin''): Pay ₤3 to the treasury and make another player lose influence (kill a character card). The targeted player can block by claiming to be the ''Contessa''.

== Challenges ==

Any player making a character claim can be challenged. A challenge always results in one player losing a character. The challenged player reveals a card from his/her hand.

• If bluffing, the revealed card is killed.

• If truthful, the revealed card is shuffled into the deck, replaced, and the challenger kills a card from his/her hand.

Dead character cards remain face-up and their influence can no longer be used. If both of your characters die, you're eliminated. The last player remaining wins!

== Variant: Rounds to win ==

The standard game of Coup is only one round. This variant allows you to play a longer game, continuing for multiple rounds until one player accumulates a predetermined number of wins.

== Variant: Factions ==

This variant divides players into two factions (teams), the Monarchists and the Populists. As long as there are two factions, players cannot block or target their teammates (however, '''Convert''' and challenges are always allowed). If there is only one faction in play, infighting takes over and no restriction applies.

=== Additional actions ===

• '''Convert''': Pay ₤1 to the almshouse to change your own faction, or pay ₤2 to the almshouse to change another player's faction. Cannot be blocked.

• '''Embezzle''' (any character except the ''Duke''): Take all coins from the almshouse if you are NOT the ''Duke''. Cannot be blocked.

If the '''Embezzle''' action is challenged, the challenged player reveals both cards in hand. If any ''Dukes'' are revealed (bluffing), one is killed (any other revealed card is shuffled into the deck and replaced). Otherwise (truthful), both revealed cards are shuffled into the deck, replaced, and the challenger kills a card from his/her hand as normal.

== Variant: Inquisitor ==

This variant replaces the ''Ambassador'' character with the ''Inquisitor''. The ''Inquisitor'' still blocks stealing and has two character actions:

=== Replacement character actions ===

• '''Exchange''' (as the ''Inquisitor''): Draw 1 card from the court deck, then return 1 card to the deck. Cannot be blocked.

• '''Examine''' (as the ''Inquisitor''): Secretly look at 1 card in another player's hand. Choose whether to return the card to the owner or force the owner to exchange it with the court deck. Cannot be blocked.

Game options and preferences: gameoptions.inc.php

2018-01-08T01:12:16Z

Quietmint: /* Game Options */

In this file, you can define your game options (= game variants) and user preferences.

Note: If your game has no variants or preferences, you don't have to modify this file.

== Game Options ==

Game options is something selected by table creator and usually correspond to game variation, for example if game includes expansion or certain special rule.

* '''displaycondition''' checks the conditions before displaying the option for selection. All conditions must be true for the option to display. Supported condition types:
** ''otheroption'' condition ensures another option is set to this given value
* '''startcondition''' checks the conditions 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:
** ''minplayers'' condition ensures at least this many players
** ''maxplayers'' conditions ensure at most this many players

<pre>
$game_options = array(
100 => array(
'name' => totranslate('my game option'),
'values' => array(
// A simple value for this option:
1 => array(
'name' => totranslate('option 1')
),

// A simple value for this option.
// If this value is chosen, the value of "tmdisplay" is displayed in the game lobby
2 => array(
'name' => totranslate('option 2'),
'tmdisplay' => totranslate('option 2')
),

// Another value, with other options:
// beta=true => this option is in beta version right now.
// nobeginner=true => this option is not recommended for beginners
3 => array(
'name' => totranslate('option 3'),
'beta' => true,
'nobeginner' => true
),
)
),

101 => array(
'name' => totranslate('Draft variant'),
'values' => array(
1 => array(
'name' => totranslate('No draft')
),
2 => array(
'name' => totranslate('Draft'),
'tmdisplay' => totranslate('Draft'),
'premium' => true,
'nobeginner' => true
),
),
'displaycondition' => array( // Note: do not display this option unless these conditions are met
array(
'type' => 'otheroption',
'id' => 100,
'value' => array(2, 3, 4)
)
),
'startcondition' => array(
1 => array(),
2 => array(
array(
'type' => 'maxplayers',
'value' => 3,
'message' => totranslate('Draft option is available for 3 players maximum.')
)
),
),
'disable' => true
),

102 => array(
'name' => totranslate('Takeovers'),
'values' => array(
2 => array(
'name' => totranslate('No takeover')
),
1 => array(
'name' => totranslate('Allow takeovers'),
'tmdisplay' => totranslate('Takeovers'),
'premium' => true,
'nobeginner' => true
),
),
'displaycondition' => array( // Note: do not display this option unless these conditions are met
array(
'type' => 'otheroption',
'id' => 100,
'value' => array(3, 4)
)
),
'startcondition' => array(
2 => array(),
1 => array(
array(
'type' => 'maxplayers',
'value' => 2,
'message' => totranslate('Rebel vs Imperium Takeover Scenario is available for 2 players only.')
)
),
),
'disable' => true
)
);
</pre>

Note²: All options defined in this file should have a corresponding "game state labels" with the same ID (see "initGameStateLabels" in yourgame.game.php)

self::initGameStateLabels ( array (
...
"my_first_game_variant" => 100,
) );

IMPORTANT: After you edited and deployed this file you have to go to control panel and press "Reload game options configuration"

== User Preferences ==

User preferences is something cosmetic about the game interface which however can create user wars, so you can satisfy all user
by giving them individual preferences. Do not use this unless absolutely necessary and usually only after game has been in production
for a while. If you add these currently only admins can apply these settings, so you would have to contact them after editing this file.

<pre>
$game_preferences = array(
100 => array(
'name' => totranslate('Notation style'),
'needReload' => true, // after user changes this preference game interface would auto-reload
'values' => array(
1 => array( 'name' => totranslate( 'Classic' ), 'cssPref' => 'notation_classic' ),
2 => array( 'name' => totranslate( 'Tournament' ), 'cssPref' => 'notation_tournament' )
)
)
);
</pre>

There is two ways to check/apply this. In java Script

if (this.prefs[100].value == 2) ...

This checks if preferences 100 has selected value 2.

Second, if cssPref specified it will be applied to the body tag. So you can use different css styling for the preference.

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

Gamehelpcoupcitystate

2018-01-06T16:37:56Z

Quietmint:

== Introduction ==
In Coup, players vie for control of a corrupt city-state in renaissance Italy. Through your influence in the court (the character cards in your hand), bluff, steal, and murder your opponents to become the last player standing and rise to power. There is no second place.

== Setup ==
The 15-card deck contains 3 copies of 5 different characters (''Ambassador'', ''Assassin'', ''Captain'', ''Contessa'', ''Duke'').

Each player begins with ₤2 (or ₤1 in a two-player game) and 2 cards. Money is public knowledge, but character cards in hand are secret.

== Actions ==
On your turn, take any action you can afford:

=== General actions (always available) ===

• '''Income''': Take ₤1 from the treasury. Cannot be blocked.

• '''Foreign Aid''': Take ₤2 from the treasury. Any player claiming to be the ''Duke'' can block.

• '''Coup''': Pay ₤7 to the treasury and make another player lose influence (kill a character card). Cannot be blocked. If you start your turn with ₤10, you must choose this action.

=== Character actions (must claim to have that character card in hand) ===

• '''Tax''' (as the ''Duke''): Take ₤3 from the treasury. Cannot be blocked.

• '''Steal''' (as the ''Captain''): Take ₤2 from another player. The targeted player can block by claiming to be the ''Ambassador'' or the ''Captain''.

• '''Exchange''' (as the ''Ambassador''): Draw 2 cards from the court deck, then return 2 cards to the deck. Cannot be blocked.

• '''Assassinate''' (as the ''Assassin''): Pay ₤3 to the treasury and make another player lose influence (kill a character card). The targeted player can block by claiming to be the ''Contessa''.

== Challenges ==

Any player making a character claim can be challenged. A challenge always results in one player losing a character. The challenged player reveals a card from his/her hand.

• If bluffing, the revealed card is killed.

• If truthful, the revealed card is shuffled into the deck, replaced, and the challenger kills a card from his/her hand.

Dead character cards remain face-up and their influence can no longer be used. If both of your characters die, you're eliminated. The last player remaining wins!

== Variant: Rounds to win ==

The standard game of Coup is only one round. This variant allows you to play a longer game, continuing for multiple rounds until one player accumulates a predetermined number of wins (1 - 5).

== Variant: Factions ==

This variant divides players into two factions or teams, the Monarchists and the Populists. As long as there are two factions, players cannot '''Assassinate''', '''Coup''', '''Steal''', or block '''Foreign Aid''' against teammates (however, '''Convert''' and challenges are always allowed). If there is only one faction in play, no restriction applies.

=== Additional actions ===

• '''Convert''': Pay ₤1 to the almshouse to change your own faction, or pay ₤2 to the almshouse to change another player's faction. Cannot be blocked.

• '''Embezzle''': Take all coins from the almshouse if you are NOT the ''Duke''. Cannot be blocked.

If the '''Embezzle''' action is challenged, the challenged player reveals both cards in hand. If any ''Dukes'' are revealed (bluffing), one is killed (any other revealed card is shuffled into the deck and replaced). Otherwise (truthful), both revealed cards are shuffled into the deck, replaced, and the challenger kills a card from his/her hand as normal.

Gamehelpcoupcitystate

2018-01-06T07:42:30Z

Quietmint: /* Variant: Factions */

== Introduction ==
In Coup, players vie for control of a corrupt city-state in renaissance Italy. Through your influence in the court (the character cards in your hand), bluff, steal, and murder your opponents to become the last player standing and rise to power.

== Setup ==
The 15-card deck contains 3 copies of 5 different characters (''Ambassador'', ''Assassin'', ''Captain'', ''Contessa'', ''Duke'').

Each player begins with ₤2 (or ₤1 in a two-player game) and 2 cards. Money is public knowledge, but character cards in hand are secret.

== Actions ==
On your turn, take any action you can afford:

=== General actions (always available) ===

• '''Income''': Take ₤1 from the treasury. Cannot be blocked.

• '''Foreign Aid''': Take ₤2 from the treasury. Any player claiming to be the ''Duke'' can block.

• '''Coup''': Pay ₤7 to the treasury and make another player lose influence (kill a character card). Cannot be blocked. If you start your turn with ₤10, you must choose this action.

=== Character actions (must claim to have that character card in hand) ===

• '''Tax''' (as the ''Duke''): Take ₤3 from the treasury. Cannot be blocked.

• '''Steal''' (as the ''Captain''): Take ₤2 from another player. The targeted player can block by claiming to be the ''Ambassador'' or the ''Captain''.

• '''Exchange''' (as the ''Ambassador''): Draw 2 cards from the court deck, then return 2 cards to the deck. Cannot be blocked.

• '''Assassinate''' (as the ''Assassin''): Pay ₤3 to the treasury and make another player lose influence (kill a character card). The targeted player can block by claiming to be the ''Contessa''.

== Challenges ==

Any player making a character claim can be challenged. A challenge always results in one player losing a character. The challenged player reveals a card from his/her hand.

• If bluffing, the revealed card is killed.

• If truthful, the revealed card is shuffled into the deck, replaced, and the challenger kills a card from his/her hand.

Dead character cards remain face-up and their influence can no longer be used. If both of your characters die, you're eliminated. The last player remaining wins! There is no second place.

== Variant: Rounds to win ==

The standard game of Coup is only one round. This variant allows you to play a longer game, continuing for multiple rounds until one player accumulates a predetermined number of wins (1 - 5).

== Variant: Factions ==

This variant divides players into two factions or teams, the Monarchists and the Populists. As long as there are two factions, players cannot '''Assassinate''', '''Coup''', '''Steal''', or block '''Foreign Aid''' against teammates (however, '''Convert''' and challenges are always allowed). If there is only one faction in play, no restriction applies.

=== Additional actions ===

• '''Convert''': Pay ₤1 to the almshouse to change your own faction, or pay ₤2 to the almshouse to change another player's faction. Cannot be blocked.

• '''Embezzle''': Take all coins from the almshouse if you are NOT the ''Duke''. Cannot be blocked.

If the '''Embezzle''' action is challenged, the challenged player reveals both cards in hand. If any ''Dukes'' are revealed (bluffing), one is killed (any other revealed card is shuffled into the deck and replaced). Otherwise (truthful), both revealed cards are shuffled into the deck, replaced, and the challenger kills a card from his/her hand as normal.

Gamehelpcoupcitystate

2018-01-04T04:30:40Z

Quietmint: /* Variant: Factions */

== Introduction ==
In Coup, players vie for control of a corrupt city-state in renaissance Italy. Through your influence in the court (the character cards in your hand), bluff, steal, and murder your opponents to become the last player standing and rise to power.

== Setup ==
The 15-card deck contains 3 copies of 5 different characters (''Ambassador'', ''Assassin'', ''Captain'', ''Contessa'', ''Duke'').

Each player begins with ₤2 (or ₤1 in a two-player game) and 2 cards. Money is public knowledge, but character cards in hand are secret.

== Actions ==
On your turn, take any action you can afford:

=== General actions (always available) ===

• '''Income''': Take ₤1 from the treasury. Cannot be blocked.

• '''Foreign Aid''': Take ₤2 from the treasury. Any player claiming to be the ''Duke'' can block.

• '''Coup''': Pay ₤7 to the treasury and make another player lose influence (kill a character card). Cannot be blocked. If you start your turn with ₤10, you must choose this action.

=== Character actions (must claim to have that character card in hand) ===

• '''Tax''' (as the ''Duke''): Take ₤3 from the treasury. Cannot be blocked.

• '''Steal''' (as the ''Captain''): Take ₤2 from another player. The targeted player can block by claiming to be the ''Ambassador'' or the ''Captain''.

• '''Exchange''' (as the ''Ambassador''): Draw 2 cards from the court deck, then return 2 cards to the deck. Cannot be blocked.

• '''Assassinate''' (as the ''Assassin''): Pay ₤3 to the treasury and make another player lose influence (kill a character card). The targeted player can block by claiming to be the ''Contessa''.

== Challenges ==

Any player making a character claim can be challenged. A challenge always results in one player losing a character. The challenged player reveals a card from his/her hand.

• If bluffing, the revealed card is killed.

• If truthful, the revealed card is shuffled into the deck, replaced, and the challenger kills a card from his/her hand.

Dead character cards remain face-up and their influence can no longer be used. If both of your characters die, you're eliminated. The last player remaining wins! There is no second place.

== Variant: Rounds to win ==

The standard game of Coup is only one round. This variant allows you to play a longer game, continuing for multiple rounds until one player accumulates a predetermined number of wins (1 - 5).

== Variant: Factions ==

This variant divides players into two factions or teams. While there are two factions, players cannot '''Assassinate''', '''Coup''', '''Steal''', or block '''Foreign Aid''' against teammates (however, '''Convert''' and challenges are always allowed). If there is only one faction in play, no restriction applies.

=== Additional actions ===

• '''Convert''': Pay ₤1 to the almshouse to change your own faction, or pay ₤2 to the almshouse to change another player's faction. Cannot be blocked.

• '''Embezzle''': Take all coins from the almshouse if you are NOT the ''Duke''. Cannot be blocked.

If the '''Embezzle''' action is challenged, the challenged player reveals both cards in hand. If any ''Dukes'' are revealed (bluffing), one is killed (the other revealed card is shuffled into the deck and replaced). Otherwise (truthful), both revealed cards are shuffled into the deck, replaced, and the challenger kills a card from his/her hand as normal.

Gamehelpcoupcitystate

2018-01-04T04:02:28Z

Quietmint: Factions

== Introduction ==
In Coup, players vie for control of a corrupt city-state in renaissance Italy. Through your influence in the court (the character cards in your hand), bluff, steal, and murder your opponents to become the last player standing and rise to power.

== Setup ==
The 15-card deck contains 3 copies of 5 different characters (''Ambassador'', ''Assassin'', ''Captain'', ''Contessa'', ''Duke'').

Each player begins with ₤2 (or ₤1 in a two-player game) and 2 cards. Money is public knowledge, but character cards in hand are secret.

== Actions ==
On your turn, take any action you can afford:

=== General actions (always available) ===

• '''Income''': Take ₤1 from the treasury. Cannot be blocked.

• '''Foreign Aid''': Take ₤2 from the treasury. Any player claiming to be the ''Duke'' can block.

• '''Coup''': Pay ₤7 to the treasury and make another player lose influence (kill a character card). Cannot be blocked. If you start your turn with ₤10, you must choose this action.

=== Character actions (must claim to have that character card in hand) ===

• '''Tax''' (as the ''Duke''): Take ₤3 from the treasury. Cannot be blocked.

• '''Steal''' (as the ''Captain''): Take ₤2 from another player. The targeted player can block by claiming to be the ''Ambassador'' or the ''Captain''.

• '''Exchange''' (as the ''Ambassador''): Draw 2 cards from the court deck, then return 2 cards to the deck. Cannot be blocked.

• '''Assassinate''' (as the ''Assassin''): Pay ₤3 to the treasury and make another player lose influence (kill a character card). The targeted player can block by claiming to be the ''Contessa''.

== Challenges ==

Any player making a character claim can be challenged. A challenge always results in one player losing a character. The challenged player reveals a card from his/her hand.

• If bluffing, the revealed card is killed.

• If truthful, the revealed card is shuffled into the deck, replaced, and the challenger kills a card from his/her hand.

Dead character cards remain face-up and their influence can no longer be used. If both of your characters die, you're eliminated. The last player remaining wins! There is no second place.

== Variant: Rounds to win ==

The standard game of Coup is only one round. This variant allows you to play a longer game, continuing for multiple rounds until one player accumulates a predetermined number of wins (1 - 5).

== Variant: Factions ==

This variant divides players into two factions or teams. While there are two factions, players cannot '''Assassinate''', '''Coup''', '''Steal''', or block '''Foreign Aid''' against teammates (however, '''Convert''' and challenges are always allowed). If there is only one faction in play, no restriction applies.

There are two new general actions:

• '''Convert''': Pay ₤1 to the almshouse to change your own faction, or pay ₤2 to the almshouse to change another player's faction. Cannot be blocked.

• '''Embezzle''': Take all coins from the almshouse if you are NOT the ''Duke''. Cannot be blocked.

If the '''Embezzle''' action is challenged, the challenged player reveals both cards in hand. If any ''Dukes'' are revealed (bluffing), one is killed (the other revealed card is shuffled into the deck and replaced). Otherwise (truthful), both revealed cards are shuffled into the deck, replaced, and the challenger kills a card from his/her hand as normal.

Main game logic: yourgamename.game.php

2018-01-02T22:00:25Z

Quietmint: /* Game states and active players */

This file is the main file for your game logic. Here you initialize the game, persist data, implement the rules and notify changes to the client interface.

== File Structure ==

The details on how the file is structured is described directly with comments on the code skeleton provided to you.

Basically, here's this structure:
* EmptyGame (constructor): where you define global variables.
* setupNewGame: initial setup of the game.
* getAllDatas: where you retrieve all game data during a complete reload of the game.
* getGameProgression: where you compute the game progression indicator.
* Utility functions: your utility functions.
* Player actions: the entry points for players actions.
* 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]).
* 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]).
* zombieTurn: what to do it's the turn of a zombie player.

== Accessing player informations ==

; getPlayersNumber()
: Returns the number of players playing at the table
: Note: doesn't work in setupNewGame so use count($players) instead

; getActivePlayerId()
: Get the "active_player", whatever what is the current state type.
: Note: it does NOT mean that this player is active right now, because state type could be "game" or "multiplayer"
: Note: avoid using this method in a "multiplayer" state because it does not mean anything.

; getActivePlayerName()
: Get the "active_player" name
: Note: avoid using this method in a "multiplayer" state because it does not mean anything.

; loadPlayersBasicInfos()
: Get an associative array with generic data about players (ie: not game specific data).
: The key of the associative array is the player id.
: The content of each value is:
: * player_name
: * player_color (ex: ff0000)

; getCurrentPlayerId()
: Get the "current_player". The current player is the one from which the action originated (the one who send the request).
: '''Be careful''': It is not always the active player.
: In general, you shouldn't use this method, unless you are in "multiplayer" state.

; getCurrentPlayerName()
: Get the "current_player" name
: Be careful using this method (see above).

; getCurrentPlayerColor()
: Get the "current_player" color
: Be careful using this method (see above).

; isCurrentPlayerZombie()
: Check the "current_player" zombie status. If true, player is zombie, i.e. left or was kicked out of the game.

== Accessing database ==

The main game logic should be the only point from where you should access to the game database. You access your database using SQL queries with the methods below.

'''IMPORTANT'''

BGA is using [http://dev.mysql.com/doc/refman/5.0/en/sql-syntax-transactions.html database transactions]. It means that your database changes WON'T BE APPLIED to the database until your request ends normally. Using transaction is in fact very useful for you: at any time, if your game logic detects that something is wrong (ex: unallowed move), you just have to throw an exception and all the changes already performed on the game situation will be removed.

; DbQuery( $sql )
: This is the generic method to access the database.
: It can execute any type of SELECT/UPDATE/DELETE/REPLACE query on the database.
: You should use it for UPDATE/DELETE/REPLACE query. For SELECT queries, the specialized methods below are much better.

; getUniqueValueFromDB( $sql )
: Returns a unique value from DB or null if no value is found.
: $sql must be a SELECT query.
: Raise an exception if more than 1 row is returned.

; getCollectionFromDB( $sql, $bSingleValue=false )
: Returns an associative array of rows for a sql SELECT query.
: The key of the resulting associative array is the first field specified in the SELECT query.
: The value of the resulting associative array if an associative array with all the field specified in the SELECT query and associated values.
: First column must be a primary or alternate key.
: The resulting collection can be empty.
: If you specified $bSingleValue=true and if your SQL query request 2 fields A and B, the method returns an associative array "A=>B"

Example 1:
<pre>
self::getCollectionFromDB( "SELECT player_id id, player_name name, player_score score FROM player" );

Result:
array(
1234 => array( 'id'=>1234, 'name'=>'myuser0', 'score'=>1 ),
1235 => array( 'id'=>1235, 'name'=>'myuser1', 'score'=>0 )
)
</pre>
Example 2:
<pre>
self::getCollectionFromDB( "SELECT player_id id, player_name name FROM player", true );

Result:
array(
1234 => 'myuser0',
1235 => 'myuser1'
)

</pre>

; getNonEmptyCollectionFromDB( $sql )
: Idem than previous one, but raise an exception if the collection is empty

; getObjectFromDB( $sql )
: Returns one row for the sql SELECT query as an associative array or null if there is no result
: Raise an exception if the query return more than one row

Example:
<pre>
self::getObjectFromDB( "SELECT player_id id, player_name name, player_score score FROM player WHERE player_id='$player_id'" );

Result:
array(
'id'=>1234, 'name'=>'myuser0', 'score'=>1
)
</pre>

; getNonEmptyObjectFromDB( $sql )
: Idem than previous one, but raise an exception if no row is found

; getObjectListFromDB( $sql, $bUniqueValue=false )
: Return an array of rows for a sql SELECT query.
: the result if the same than "getCollectionFromDB" except that the result is a simple array (and not an associative array).
: The result can be empty.
: If you specified $bUniqueValue=true and if your SQL query request 1 field, the method returns directly an array of values.

Example 1:
<pre>
self::getObjectListFromDB( "SELECT player_id id, player_name name, player_score score FROM player" );

Result:
array(
array( 'id'=>1234, 'name'=>'myuser0', 'score'=>1 ),
array( 'id'=>1235, 'name'=>'myuser1', 'score'=>0 )
)
</pre>
Example 2:
<pre>
self::getObjectListFromDB( "SELECT player_name name FROM player", true );

Result:
array(
'myuser0',
'myuser1'
)

</pre>

; getDoubleKeyCollectionFromDB( $sql, $bSingleValue=false )
: Return an associative array of associative array, from a SQL SELECT query.
: First array level correspond to first column specified in SQL query.
: Second array level correspond to second column specified in SQL query.
: If bSingleValue = true, keep only third column on result

; DbGetLastId()
: Return the PRIMARY key of the last inserted row (see PHP mysql_insert_id function).

; DbAffectedRow()
: Return the number of row affected by the last operation

; escapeStringForDB( $string )
: You must use this function on every string type data in your database that contains unsafe data.
: (unsafe = can be modified by a player).
: This method makes sure that no SQL injection will be done through the string used.
: Note: if you using standard types in ajax actions, like AT_alphanum it is sanitized before arrival,
: this is only needed if you manage to get unchecked string, like in the games where user has to enter text as a response.

<pre>

</pre>

Note: see Editing [[Game database model: dbmodel.sql]] to know how to define your database model.

== Use globals ==

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.

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.

'''initGameStateLabels'''

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.

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.

<pre>
self::initGameStateLabels( array(
"my_first_global_variable" => 10,
"my_second_global_variable" => 11
) );
</pre>

'''setGameStateInitialValue( $value_label, $value_value )'''

Init your global value. Must be called before any use of your global, so you should call this method from your "setupNewGame" method.

'''getGameStateValue( $value_label )'''

Retrieve the current value of a global.

'''setGameStateValue( $value_label, $value_value )'''

Set the current value of a global.

'''incGameStateValue( $value_label, $increment )'''

Increment the current value of a global. If increment is negative, decrement the value of the global.

Return the final value of the global.

== Game states and active players ==

; checkAction( $actionName, $bThrowException=true )
: Check if action is valid regarding current game state (exception if fails).
: The action is valid if it is listed as a "possibleactions" in the current game state (see game state description).
: 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.
: 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.

; activeNextPlayer()
: Make the next player active in the natural player order.
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.

; activePrevPlayer()
: Make the previous player active (in the natural player order).
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.

; $this->gamestate->changeActivePlayer( $player_id )
: You can call this method to make any player active.
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.

; $this->gamestate->getActivePlayerList()
: With this method you can retrieve the list of the active player at any time.
: During a "game" type gamestate, it will return a void array.
: During a "activeplayer" type gamestate, it will return an array with one value (the active player id).
: during a "multipleactiveplayer" type gamestate, it will return an array of the active players id.
: Note: you should only use this method is the latter case.

; $this->gamestate->setAllPlayersMultiactive()
: With this method, all playing players are made active.
: 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.

; $this->gamestate->setPlayersMultiactive( $players, $next_state )
: Make a specific list of players active during a multiactive gamestate.
: Bare in mind it doesn't deactivate other previously active players. To do this, execute this SQL beforehand:
self::DbQuery('UPDATE player SET player_is_multiactive = 0');
: "players" is the array of player id that should be made active.
: In case "players" is empty, the method trigger the "next_state" transition to go to the next game state.

; $this->gamestate->setPlayerNonMultiactive( $player_id, $next_state )
: During a multiactive game state, make the specified player inactive.
: Usually, you call this method during a multiactive game state after a player did his action.
: If this player was the last active player, the method trigger the "next_state" transition to go to the next game state.

; $this->gamestate->checkPossibleAction( $action )
: (rarely used)
: This works exactly like "checkAction", except that it do NOT check if current player is active.
: 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.
: 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.

; $this->gamestate->nextState( $transition )
: 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.

; $this->gamestate->state()
: Get an associative array of current game state attributes, see [[Your game state machine: states.inc.php]] for state attributes.
$state=$this->gamestate->state(); if( $state['name'] == 'myGameState' ) {...}

== Players turn order ==

'''getNextPlayerTable()'''

Return an associative array which associate each player with the next player around the table.

In addition, key 0 is associated to the first player to play.

Example: if three player with ID 1, 2 and 3 are around the table, in this order, the method returns:
<pre>
array(
1 => 2,
2 => 3,
3 => 1,
0 => 1
);
</pre>

'''getPrevPlayerTable()'''

Same as above, but the associative array associate the previous player around the table.

'''getPlayerAfter( $player_id )'''

Get player playing after given player in natural playing order.

'''getPlayerBefore( $player_id )'''

Get player playing before given player in natural playing order.

Note: There is no API to modify this order, if you have custom player order you have to maintain it in your database
and have custom function to access it.

== Notify players ==

To understand notifications, please read [http://www.slideshare.net/boardgamearena/the-bga-framework-at-a-glance The BGA Framework at a glance] first.

'''IMPORTANT'''

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.
Notifications sent between the game start (setupNewGame) and the end of the "action" method of the first active state will never reach their destination.

'''notifyAllPlayers( $notification_type, $notification_log, $notification_args )'''

Send a notification to all players of the game.

* notification_type:
A string that defines the type of your notification.

Your game interface Javascript logic will use this to know what is the type of the received notification (and to trigger the corresponding method).

* notification_log:
A string that defines what is to be displayed in the game log.

You can use an empty string here (""). In this case, nothing is displayed in the game log.

If you define a real string here, you should use "clienttranslate" method to make sure it can be translate.

You can use arguments in your notification_log strings, that refers to values defines in the "notification_args" argument (see below). NB: Make sure you only use single quotes ('), otherwise PHP will try to interpolate the variable and will ignore the values in the args array.

Note: you CAN use some HTML inside your notification log, and it is working. However:
_ pay attention to keep the log clear.
_ try to not include some HTML tags inside the "clienttranslate" method, otherwise it will make the translators work more difficult. You can use a notification argument instead, and provide your HTML through this argument.

* notification_args:
The arguments of your notifications, as an associative array.

This array will be transmitted to the game interface logic, in order the game interface can be updated.

Complete notifyAllPlayers example (from "Reversi"):

<pre>
self::notifyAllPlayers( "playDisc", clienttranslate( '${player_name} plays a disc and turns over ${returned_nbr} disc(s)' ),
array(
'player_id' => $player_id,
'player_name' => self::getActivePlayerName(),
'returned_nbr' => count( $turnedOverDiscs ),
'x' => $x,
'y' => $y
) );
</pre>

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.

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.

'''notifyPlayer( $player_id, $notification_type, $notification_log, $notification_args )'''

Same as above, except that the notification is sent to one player only.

This method must be used each time some private information must be transmitted to a player.

Important: the variable for player name must be ${player_name} in order to be highlighted with the player color in the game log

== Game statistics ==

There are 2 types of statistics:
* a "player" statistic is a statistic associated to a player
* a "table" statistics is a statistic not associated to a player (global statistic for this game).

See [[Game statistics: stats.inc.php]] to see how you defines statistics for your game.

'''initStat( $table_or_player, $name, $value, $player_id = null )'''

Create a statistic entry with a default value.
This method must be called for each statistics of your game, in your setupNewGame method.

'$table_or_player' must be set to "table" if this is a table statistics, or "player" if this is a player statistics.

'$name' is the name of your statistics, as it has been defined in your stats.inc.php file.

'$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.

'''setStat( $value, $name, $player_id = null )'''

Set a statistic $name to $value.

If "$player_id" is not specified, setStat consider it is a TABLE statistic.

If "$player_id" is specified, setStat consider it is a PLAYER statistic.

'''incStat( $delta, $name, $player_id = null )'''

Increment (or decrement) specified statistic value by $delta value. Same behavior as setStat function.

'''getStat( $name, $player_id = null )'''

Return the value of statistic specified by $name. Useful when creating derivative statistics such as average.

== Translations ==

See [[Translations]]

== Manage player scores and Tie breaker ==

=== Normal scoring ===

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

During the game, you update player's score directly by updating "player_score" field of "player" table in database.

Examples:
<pre>

// +2 points to active player
self::DbQuery( "UPDATE player SET player_score=player_score+2 WHERE player_id='".self::getActivePlayerId()."'" );

// Set score of active player to 5
self::DbQuery( "UPDATE player SET player_score=5 WHERE player_id='".self::getActivePlayerId()."'" );

</pre>

Note: don't forget to notify the client side in order the score control can be updated accordingly.

=== Tie breaker ===

Tie breaker is used when two players get the same score at the end of a game.

Tie breaker is using "player_score_aux" field of "player" table. It is updated exactly like the "player_score" field.

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.

When you are using "player_score_aux" functionality, you must describe the formula to use in your gameinfos.inc.php file like this:

<pre>
'tie_breaker_description' => totranslate("Describe here your tie breaker formula"),
</pre>

This description will be used as a tooltip to explain to players how this auxiliary score has been calculated.

=== Co-operative game ===

To make everyone lose in full-coop game:

Add the following in gameinfos.inc.php :
'is_coop' => 1, // full cooperative

And score zero to everyone.

=== Semi-coop ===

If the game is not full-coop, then everyone lose = everyone is tie. I.e. set score to 0 to everybody.

=== One winner only ===
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:

<pre>
// 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
// The game end result will display "Winner" for the 1st player and "Loser" for all other players
'losers_not_ranked' => true,
</pre>

Quantum and Coup are implemented like this, as you can see here:
* https://boardgamearena.com/#!gamepanel?game=quantum&section=lastresults
* https://boardgamearena.com/#!gamepanel?game=coupcitystate&section=lastresults

=== Solo ===

If game supports solo variant, a negative score means defeat, a positive score means victory.

=== Player elimination ===

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.

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

Usage:

* Player to eliminate should NOT be active anymore (preferably use the feature in a "game" type game state).
* In your PHP code:
self::eliminatePlayer( <player_to_eliminate_id> );
* 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.
* 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.

== Reflexion time ==

; function giveExtraTime( $player_id, $specific_time=null )
: Give standard extra time to this player.
: Standard extra time depends on the speed of the game (small with "slow" game option, bigger with other options).
: You can also specify an exact time to add, in seconds, with the "specified_time" argument (rarely used).

== Managing errors and exceptions ==

Note: when you throw an exception, all database changes and all notifications are cancelled immediately. This way, the game situation that were existing before the request is completely restored.

; throw new BgaUserException ( $error_message)
: Base class to notify a user error
: You must throw this exception when a player want to do something that he is not allowed to do.
: The error message will be shown to the player as a "red message", so it must be translated.
: Throwing such an exception is NOT considered as a bug, so it is not traced in BGA error logs.

Example from Gomoku:
<pre>
throw new BgaUserException( self::_("There is already a stone on this intersection, you can't play there") );
</pre>

; throw new BgaVisibleSystemException ( $error_message)
: You must throw this exception when you detect something that is not supposed to happened into your code.
: The error message is shown to the user as an "Unexpected error", in order he can report it in the forum.
: The error message is logged in BGA error logs. If it happens regularly, we will report it to you.

; throw new BgaSystemException ( $error_message)
: 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.
: 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.

== Zombie mode ==

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.

While developing your zombie mode, keep in mind that:
* Do not refer to the rules, because this situation is not planned by the rules.
* 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?
* The idea is NOT to develop an artificial intelligence for the game.

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.

Each time a zombie player must play, your "zombieTurn" method is called.

Parameters:
* $state: the name of the current game state.
* $active_player: the id of the active player.

Most of the time, your zombieTurn method looks like this:

<pre>
function zombieTurn( $state, $active_player )
{
$statename = $state['name'];

if( $statename == 'myFirstGameState'
|| $statename == 'my2ndGameState'
|| $statename == 'my3rdGameState'
....
)
{
$this->gamestate->nextState( "zombiePass" );
}
else
throw new BgaVisibleSystemException( "Zombie mode not supported at this game state: ".$statename );
}
</pre>

Note that in the example above, all corresponding game state should implement "zombiePass" as a transition.

== Player color preferences ==

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.

Making your game compatible with colors preferences is very easy and requires only 1 line of PHP and 1 configuration change :

On your gameinfos.inc.php file, add the following lines :

// Favorite colors support : if set to "true", support attribution of favorite colors based on player's preferences (see reattributeColorsBasedOnPreferences PHP method)
'favorite_colors_support' => true,

Then, on your main <your_game>.game.php file, find the "reloadPlayersBasicInfos" call in your "setupNewGame" method and replace :

$sql .= implode( $values, ',' );
self::DbQuery( $sql );
self::reloadPlayersBasicInfos();

By :

$sql .= implode( $values, ',' );
self::DbQuery( $sql );
self::reattributeColorsBasedOnPreferences( $players, array( /* LIST HERE THE AVAILABLE COLORS OF YOUR GAME INSTEAD OF THESE ONES */"ff0000", "008000", "0000ff", "ffa500", "773300" ) );
self::reloadPlayersBasicInfos();

The "reattributeColorsBasedOnPreferences" method reattributes all colors, taking into account players color preferences and available colors.

Note that you must update the colors to indicate the colors available for your game.

2 important remarks :
* 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.
* 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.

Colours currently listed as a choice in preferences:

* #ff0000 Red
* #008000 Green
* #0000ff Blue
* #ffa500 Yellow
* #000000 Black
* #ffffff White

== Debugging and Tracing ==

To debug php code you can use some tracing functions available from the parent class such as debug, trace, error, warn, dump.

self::debug("Ahh!");
self::dump('my_var',$my_var);

See [[Practical_debugging]] section for complete information about debugging interfaces and where to find logs.

Gamehelpcoupcitystate

2018-01-02T21:31:56Z

Quietmint: /* Setup */

Gamehelpcoupcitystate

2018-01-02T21:31:14Z

Quietmint:

Gamehelpcoupcitystate

2018-01-02T21:30:56Z

Quietmint:

Gamehelpcoupcitystate

2018-01-02T21:30:19Z

Quietmint:

Gamehelpcoupcitystate

2018-01-02T21:28:17Z

Quietmint:

Gamehelpcoupcitystate

2018-01-02T21:04:31Z

Quietmint: Created page with "In Coup, you head a family vying for control of a corrupt Italian city-state. Through your influence in the court (the character cards in your hand), bluff, steal, and murder ..."

In Coup, you head a family vying for control of a corrupt Italian city-state. Through your influence in the court (the character cards in your hand), bluff, steal, and murder your opponents to become the last player standing and rise to power.

The 15-card deck contains 3 copies of 5 different characters (''Ambassador'', ''Assassin'', ''Captain'', ''Contessa'', ''Duke''). Each player begins with ₤2 (or ₤1 in a two-player game) and 2 cards. Money is public knowledge, but character cards in hand are secret.

On your turn, take any action you can afford:
* General actions (always available):
** '''Income''': Take ₤1 from the treasury. Cannot be blocked.
** '''Foreign Aid''': Take ₤2 from the treasury. Any player claiming to be the ''Duke'' can block.
** '''Coup''': Pay ₤7 to the treasury and make another player lose influence (kill a character card). Cannot be blocked. If you start your turn with ₤10, you must choose this action.
* Character actions (must claim to have that character card in hand):
** '''Tax''' (as the ''Duke''): Take ₤3 from the treasury. Cannot be blocked.
** '''Steal''' (as the ''Captain''): Take ₤2 from another player. The targeted player can block by claiming to be the ''Ambassador'' or the ''Captain''.
** '''Exchange''' (as the ''Ambassador''): Draw 2 cards from the court deck, then return 2 cards to the deck. Cannot be blocked.
** '''Assassinate''' (as the ''Assassin''): Pay ₤3 to the treasury and make another player lose influence (kill a character card). The targeted player can block by claiming to be the ''Contessa''.

Any player making a character claim can be challenged. The challenged player reveals a card from his/her hand. If bluffing, that card is killed. If truthful, that card is shuffled into the deck, replaced, and the challenger kills a card from his/her hand. Dead character cards remain face-up for all players to see. Their influence can no longer be used. If both of your characters die, you're eliminated. The last player remaining wins! There is no second place.

== Game options and variants ==

* '''Rounds to win''': A standard game of Coup is only one round. As the game is quite short, you may wish to play multiple rounds until one player accumulates a predetermined number of wins (1 - 5). Consider the number of players when selecting this option (e.g., 5 rounds to win means you'll play up to 9 rounds in a two-player game but up to 25 rounds in a six-player game).

Main game logic: yourgamename.game.php

2017-12-06T00:36:00Z

Quietmint: /* One player wins and everybody else loses */

This file is the main file for your game logic. Here you initialize the game, persist data, implement the rules and notify changes to the client interface.

== File Structure ==

The details on how the file is structured is described directly with comments on the code skeleton provided to you.

Basically, here's this structure:
* EmptyGame (constructor): where you define global variables.
* setupNewGame: initial setup of the game.
* getAllDatas: where you retrieve all game data during a complete reload of the game.
* getGameProgression: where you compute the game progression indicator.
* Utility functions: your utility functions.
* Player actions: the entry points for players actions.
* 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]).
* 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]).
* zombieTurn: what to do it's the turn of a zombie player.

== Accessing player informations ==

; getPlayersNumber()
: Returns the number of players playing at the table
: Note: doesn't work in setupNewGame so use count($players) instead

; getActivePlayerId()
: Get the "active_player", whatever what is the current state type.
: Note: it does NOT mean that this player is active right now, because state type could be "game" or "multiplayer"
: Note: avoid using this method in a "multiplayer" state because it does not mean anything.

; getActivePlayerName()
: Get the "active_player" name
: Note: avoid using this method in a "multiplayer" state because it does not mean anything.

; loadPlayersBasicInfos()
: Get an associative array with generic data about players (ie: not game specific data).
: The key of the associative array is the player id.
: The content of each value is:
: * player_name
: * player_color (ex: ff0000)

; getCurrentPlayerId()
: Get the "current_player". The current player is the one from which the action originated (the one who send the request).
: '''Be careful''': It is not always the active player.
: In general, you shouldn't use this method, unless you are in "multiplayer" state.

; getCurrentPlayerName()
: Get the "current_player" name
: Be careful using this method (see above).

; getCurrentPlayerColor()
: Get the "current_player" color
: Be careful using this method (see above).

; isCurrentPlayerZombie()
: Check the "current_player" zombie status. If true, player is zombie, i.e. left or was kicked out of the game.

== Accessing database ==

The main game logic should be the only point from where you should access to the game database. You access your database using SQL queries with the methods below.

'''IMPORTANT'''

BGA is using [http://dev.mysql.com/doc/refman/5.0/en/sql-syntax-transactions.html database transactions]. It means that your database changes WON'T BE APPLIED to the database until your request ends normally. Using transaction is in fact very useful for you: at any time, if your game logic detects that something is wrong (ex: unallowed move), you just have to throw an exception and all the changes already performed on the game situation will be removed.

; DbQuery( $sql )
: This is the generic method to access the database.
: It can execute any type of SELECT/UPDATE/DELETE/REPLACE query on the database.
: You should use it for UPDATE/DELETE/REPLACE query. For SELECT queries, the specialized methods below are much better.

; getUniqueValueFromDB( $sql )
: Returns a unique value from DB or null if no value is found.
: $sql must be a SELECT query.
: Raise an exception if more than 1 row is returned.

; getCollectionFromDB( $sql, $bSingleValue=false )
: Returns an associative array of rows for a sql SELECT query.
: The key of the resulting associative array is the first field specified in the SELECT query.
: The value of the resulting associative array if an associative array with all the field specified in the SELECT query and associated values.
: First column must be a primary or alternate key.
: The resulting collection can be empty.
: If you specified $bSingleValue=true and if your SQL query request 2 fields A and B, the method returns an associative array "A=>B"

Example 1:
<pre>
self::getCollectionFromDB( "SELECT player_id id, player_name name, player_score score FROM player" );

Result:
array(
1234 => array( 'id'=>1234, 'name'=>'myuser0', 'score'=>1 ),
1235 => array( 'id'=>1235, 'name'=>'myuser1', 'score'=>0 )
)
</pre>
Example 2:
<pre>
self::getCollectionFromDB( "SELECT player_id id, player_name name FROM player", true );

Result:
array(
1234 => 'myuser0',
1235 => 'myuser1'
)

</pre>

; getNonEmptyCollectionFromDB( $sql )
: Idem than previous one, but raise an exception if the collection is empty

; getObjectFromDB( $sql )
: Returns one row for the sql SELECT query as an associative array or null if there is no result
: Raise an exception if the query return more than one row

Example:
<pre>
self::getObjectFromDB( "SELECT player_id id, player_name name, player_score score FROM player WHERE player_id='$player_id'" );

Result:
array(
'id'=>1234, 'name'=>'myuser0', 'score'=>1
)
</pre>

; getNonEmptyObjectFromDB( $sql )
: Idem than previous one, but raise an exception if no row is found

; getObjectListFromDB( $sql, $bUniqueValue=false )
: Return an array of rows for a sql SELECT query.
: the result if the same than "getCollectionFromDB" except that the result is a simple array (and not an associative array).
: The result can be empty.
: If you specified $bUniqueValue=true and if your SQL query request 1 field, the method returns directly an array of values.

Example 1:
<pre>
self::getObjectListFromDB( "SELECT player_id id, player_name name, player_score score FROM player" );

Result:
array(
array( 'id'=>1234, 'name'=>'myuser0', 'score'=>1 ),
array( 'id'=>1235, 'name'=>'myuser1', 'score'=>0 )
)
</pre>
Example 2:
<pre>
self::getObjectListFromDB( "SELECT player_name name FROM player", true );

Result:
array(
'myuser0',
'myuser1'
)

</pre>

; getDoubleKeyCollectionFromDB( $sql, $bSingleValue=false )
: Return an associative array of associative array, from a SQL SELECT query.
: First array level correspond to first column specified in SQL query.
: Second array level correspond to second column specified in SQL query.
: If bSingleValue = true, keep only third column on result

; DbGetLastId()
: Return the PRIMARY key of the last inserted row (see PHP mysql_insert_id function).

; DbAffectedRow()
: Return the number of row affected by the last operation

; escapeStringForDB( $string )
: You must use this function on every string type data in your database that contains unsafe data.
: (unsafe = can be modified by a player).
: This method makes sure that no SQL injection will be done through the string used.
: Note: if you using standard types in ajax actions, like AT_alphanum it is sanitized before arrival,
: this is only needed if you manage to get unchecked string, like in the games where user has to enter text as a response.

<pre>

</pre>

Note: see Editing [[Game database model: dbmodel.sql]] to know how to define your database model.

== Use globals ==

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.

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.

'''initGameStateLabels'''

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.

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.

<pre>
self::initGameStateLabels( array(
"my_first_global_variable" => 10,
"my_second_global_variable" => 11
) );
</pre>

'''setGameStateInitialValue( $value_label, $value_value )'''

Init your global value. Must be called before any use of your global, so you should call this method from your "setupNewGame" method.

'''getGameStateValue( $value_label )'''

Retrieve the current value of a global.

'''setGameStateValue( $value_label, $value_value )'''

Set the current value of a global.

'''incGameStateValue( $value_label, $increment )'''

Increment the current value of a global. If increment is negative, decrement the value of the global.

Return the final value of the global.

== Game states and active players ==

; checkAction( $actionName, $bThrowException=true )
: Check if action is valid regarding current game state (exception if fails).
: The action is valid if it is listed as a "possibleactions" in the current game state (see game state description).
: 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.
: 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.

; activeNextPlayer()
: Make the next player active in the natural player order.
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.

; activePrevPlayer()
: Make the previous player active (in the natural player order).
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.

; $this->gamestate->changeActivePlayer( $player_id )
: You can call this method to make any player active.
: Note: you CANT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.

; $this->gamestate->getActivePlayerList()
: With this method you can retrieve the list of the active player at any time.
: During a "game" type gamestate, it will return a void array.
: During a "activeplayer" type gamestate, it will return an array with one value (the active player id).
: during a "multipleactiveplayer" type gamestate, it will return an array of the active players id.
: Note: you should only use this method is the latter case.

; $this->gamestate->setAllPlayersMultiactive()
: With this method, all playing players are made active.
: 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.

; $this->gamestate->setPlayersMultiactive( $players, $next_state )
: Make a specific list of players active during a multiactive gamestate.
: Bare in mind it doesn't deactivate other previously active players.
: "players" is the array of player id that should be made active.
: In case "players" is empty, the method trigger the "next_state" transition to go to the next game state.

; $this->gamestate->setPlayerNonMultiactive( $player_id, $next_state )
: During a multiactive game state, make the specified player inactive.
: Usually, you call this method during a multiactive game state after a player did his action.
: If this player was the last active player, the method trigger the "next_state" transition to go to the next game state.

; $this->gamestate->checkPossibleAction( $action )
: (rarely used)
: This works exactly like "checkAction", except that it do NOT check if current player is active.
: 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.
: 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.

; $this->gamestate->nextState( $transition )
: 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.

; $this->gamestate->state()
: Get an associative array of current game state attributes, see [[Your game state machine: states.inc.php]] for state attributes.
$state=$this->gamestate->state(); if( $state['name'] == 'myGameState' ) {...}

== Players turn order ==

'''getNextPlayerTable()'''

Return an associative array which associate each player with the next player around the table.

In addition, key 0 is associated to the first player to play.

Example: if three player with ID 1, 2 and 3 are around the table, in this order, the method returns:
<pre>
array(
1 => 2,
2 => 3,
3 => 1,
0 => 1
);
</pre>

'''getPrevPlayerTable()'''

Same as above, but the associative array associate the previous player around the table.

'''getPlayerAfter( $player_id )'''

Get player playing after given player in natural playing order.

'''getPlayerBefore( $player_id )'''

Get player playing before given player in natural playing order.

Note: There is no API to modify this order, if you have custom player order you have to maintain it in your database
and have custom function to access it.

== Notify players ==

To understand notifications, please read [http://www.slideshare.net/boardgamearena/the-bga-framework-at-a-glance The BGA Framework at a glance] first.

'''IMPORTANT'''

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.
Notifications sent between the game start (setupNewGame) and the end of the "action" method of the first active state will never reach their destination.

'''notifyAllPlayers( $notification_type, $notification_log, $notification_args )'''

Send a notification to all players of the game.

* notification_type:
A string that defines the type of your notification.

Your game interface Javascript logic will use this to know what is the type of the received notification (and to trigger the corresponding method).

* notification_log:
A string that defines what is to be displayed in the game log.

You can use an empty string here (""). In this case, nothing is displayed in the game log.

If you define a real string here, you should use "clienttranslate" method to make sure it can be translate.

You can use arguments in your notification_log strings, that refers to values defines in the "notification_args" argument (see below). NB: Make sure you only use single quotes ('), otherwise PHP will try to interpolate the variable and will ignore the values in the args array.

Note: you CAN use some HTML inside your notification log, and it is working. However:
_ pay attention to keep the log clear.
_ try to not include some HTML tags inside the "clienttranslate" method, otherwise it will make the translators work more difficult. You can use a notification argument instead, and provide your HTML through this argument.

* notification_args:
The arguments of your notifications, as an associative array.

This array will be transmitted to the game interface logic, in order the game interface can be updated.

Complete notifyAllPlayers example (from "Reversi"):

<pre>
self::notifyAllPlayers( "playDisc", clienttranslate( '${player_name} plays a disc and turns over ${returned_nbr} disc(s)' ),
array(
'player_id' => $player_id,
'player_name' => self::getActivePlayerName(),
'returned_nbr' => count( $turnedOverDiscs ),
'x' => $x,
'y' => $y
) );
</pre>

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.

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.

'''notifyPlayer( $player_id, $notification_type, $notification_log, $notification_args )'''

Same as above, except that the notification is sent to one player only.

This method must be used each time some private information must be transmitted to a player.

Important: the variable for player name must be ${player_name} in order to be highlighted with the player color in the game log

== Game statistics ==

There are 2 types of statistics:
* a "player" statistic is a statistic associated to a player
* a "table" statistics is a statistic not associated to a player (global statistic for this game).

See [[Game statistics: stats.inc.php]] to see how you defines statistics for your game.

'''initStat( $table_or_player, $name, $value, $player_id = null )'''

Create a statistic entry with a default value.
This method must be called for each statistics of your game, in your setupNewGame method.

'$table_or_player' must be set to "table" if this is a table statistics, or "player" if this is a player statistics.

'$name' is the name of your statistics, as it has been defined in your stats.inc.php file.

'$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.

'''setStat( $value, $name, $player_id = null )'''

Set a statistic $name to $value.

If "$player_id" is not specified, setStat consider it is a TABLE statistic.

If "$player_id" is specified, setStat consider it is a PLAYER statistic.

'''incStat( $delta, $name, $player_id = null )'''

Increment (or decrement) specified statistic value by $delta value. Same behavior as setStat function.

'''getStat( $name, $player_id = null )'''

Return the value of statistic specified by $name. Useful when creating derivative statistics such as average.

== Translations ==

See [[Translations]]

== Manage player scores and Tie breaker ==

=== Normal scoring ===

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

During the game, you update player's score directly by updating "player_score" field of "player" table in database.

Examples:
<pre>

// +2 points to active player
self::DbQuery( "UPDATE player SET player_score=player_score+2 WHERE player_id='".self::getActivePlayerId()."'" );

// Set score of active player to 5
self::DbQuery( "UPDATE player SET player_score=5 WHERE player_id='".self::getActivePlayerId()."'" );

</pre>

Note: don't forget to notify the client side in order the score control can be updated accordingly.

=== Tie breaker ===

Tie breaker is used when two players get the same score at the end of a game.

Tie breaker is using "player_score_aux" field of "player" table. It is updated exactly like the "player_score" field.

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.

When you are using "player_score_aux" functionality, you must describe the formula to use in your gameinfos.inc.php file like this:

<pre>
'tie_breaker_description' => totranslate("Describe here your tie breaker formula"),
</pre>

This description will be used as a tooltip to explain to players how this auxiliary score has been calculated.

=== Co-operative game ===

To make everyone lose in full-coop game:

Add the following in gameinfos.inc.php :
'is_coop' => 1, // full cooperative

And score zero to everyone.

=== Semi-coop ===

If the game is not full-coop, then everyone lose = everyone is tie. I.e. set score to 0 to everybody.

=== One winner only ===
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:

<pre>
// 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
// The game end result will display "Winner" for the 1st player and "Loser" for all other players
'losers_not_ranked' => true,
</pre>

Quantum and Coup are implemented like this, as you can see here:
* https://boardgamearena.com/#!gamepanel?game=quantum&section=lastresults
* https://boardgamearena.com/#!gamepanel?game=coupcitystate&section=lastresults

=== Solo ===

If game supports solo variant, a negative score means defeat, a positive score means victory.

=== Player elimination ===

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.

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

Usage:

* Player to eliminate should NOT be active anymore (preferably use the feature in a "game" type game state).
* In your PHP code:
self::eliminatePlayer( <player_to_eliminate_id> );
* 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.
* 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.

== Reflexion time ==

; function giveExtraTime( $player_id, $specific_time=null )
: Give standard extra time to this player.
: Standard extra time depends on the speed of the game (small with "slow" game option, bigger with other options).
: You can also specify an exact time to add, in seconds, with the "specified_time" argument (rarely used).

== Managing errors and exceptions ==

Note: when you throw an exception, all database changes and all notifications are cancelled immediately. This way, the game situation that were existing before the request is completely restored.

; throw new BgaUserException ( $error_message)
: Base class to notify a user error
: You must throw this exception when a player want to do something that he is not allowed to do.
: The error message will be shown to the player as a "red message", so it must be translated.
: Throwing such an exception is NOT considered as a bug, so it is not traced in BGA error logs.

Example from Gomoku:
<pre>
throw new BgaUserException( self::_("There is already a stone on this intersection, you can't play there") );
</pre>

; throw new BgaVisibleSystemException ( $error_message)
: You must throw this exception when you detect something that is not supposed to happened into your code.
: The error message is shown to the user as an "Unexpected error", in order he can report it in the forum.
: The error message is logged in BGA error logs. If it happens regularly, we will report it to you.

; throw new BgaSystemException ( $error_message)
: 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.
: 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.

== Zombie mode ==

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.

While developing your zombie mode, keep in mind that:
* Do not refer to the rules, because this situation is not planned by the rules.
* 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?
* The idea is NOT to develop an artificial intelligence for the game.

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.

Each time a zombie player must play, your "zombieTurn" method is called.

Parameters:
* $state: the name of the current game state.
* $active_player: the id of the active player.

Most of the time, your zombieTurn method looks like this:

<pre>
function zombieTurn( $state, $active_player )
{
$statename = $state['name'];

if( $statename == 'myFirstGameState'
|| $statename == 'my2ndGameState'
|| $statename == 'my3rdGameState'
....
)
{
$this->gamestate->nextState( "zombiePass" );
}
else
throw new BgaVisibleSystemException( "Zombie mode not supported at this game state: ".$statename );
}
</pre>

Note that in the example above, all corresponding game state should implement "zombiePass" as a transition.

== Player color preferences ==

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.

Making your game compatible with colors preferences is very easy and requires only 1 line of PHP and 1 configuration change :

On your gameinfos.inc.php file, add the following lines :

// Favorite colors support : if set to "true", support attribution of favorite colors based on player's preferences (see reattributeColorsBasedOnPreferences PHP method)
'favorite_colors_support' => true,

Then, on your main <your_game>.game.php file, find the "reloadPlayersBasicInfos" call in your "setupNewGame" method and replace :

$sql .= implode( $values, ',' );
self::DbQuery( $sql );
self::reloadPlayersBasicInfos();

By :

$sql .= implode( $values, ',' );
self::DbQuery( $sql );
self::reattributeColorsBasedOnPreferences( $players, array( /* LIST HERE THE AVAILABLE COLORS OF YOUR GAME INSTEAD OF THESE ONES */"ff0000", "008000", "0000ff", "ffa500", "773300" ) );
self::reloadPlayersBasicInfos();

The "reattributeColorsBasedOnPreferences" method reattributes all colors, taking into account players color preferences and available colors.

Note that you must update the colors to indicate the colors available for your game.

2 important remarks :
* 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.
* 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.

Colours currently listed as a choice in preferences:

* #ff0000 Red
* #008000 Green
* #0000ff Blue
* #ffa500 Yellow
* #000000 Black
* #ffffff White

== Debugging and Tracing ==

To debug php code you can use some tracing functions available from the parent class such as debug, trace, error, warn, dump.

self::debug("Ahh!");
self::dump('my_var',$my_var);

See [[Practical_debugging]] section for complete information about debugging interfaces and where to find logs.

BGA Code Sharing

2017-11-29T02:38:52Z

Quietmint:

This page is for listing of externally hosted bga projects, tools and resources, as well as internal project
intended for sharing

== Projects hosted not in studio ==

See the table a link and nickname of the developer on bga (same as used for dev forum), and short description

'''Important notice about artwork on BGA Open Source projects: original hi-resolution images from publishers must not be published on the repositories. In addition, this is better to specify that the images derivated from publishers artwork are copyrighted and cannot be licensed under a free license like Creative Commons.
'''

{| class="wikitable"
|-
! NAME
! CODE LINK
! DEVELOPER
|-
| Shared Code (not a game)
| https://github.com/elaskavaia/bga-sharedcode
| Victoria_La
|-
| Eruption
| https://github.com/AndyKerrison/bga-eruption
| Andy_K
|-
| Nile
| https://github.com/AndyKerrison/bga-nile
| Andy_K
|-
| Assyria
| https://github.com/sebastien-prudhomme/bga-assyria
| daikinee
|-
| Florenza: The Card Game
| https://github.com/alberto-bottarini/bga-florenza
| tarini
|-
| Incan Gold
| https://github.com/AntonioSoler/bga-incangold
| Morgalad
|-
| Marco Polo
| https://github.com/rcitaliano/MarcoPolo
| rcitaliano
|-
| Bonbons
| https://github.com/AntonioSoler/bga-bonbons
| Morgalad
|-
| Takara Island
| https://github.com/AntonioSoler/bga-takaraisland
| Morgalad
|-
| Noir: Killer vs Inspector
| https://bitbucket.org/chhuang76/bga_noirkvi
| ch huang
|-
| Hearts (Tutorial)
| https://github.com/elaskavaia/bga-heartsla
| Victoria_La
|-
| The Battle for Hill 218
| https://github.com/danielholmes/battle-for-hill-218
| Daniel Holmes (dhau)
|-
| Coup: City State
| https://github.com/quietmint/bga-coupcitystate
| quietmint
|}

== Projects on studio ==

Links to studio project which owner wish share as read only.
Project owner please add you project here, dev nickname and short description if you would like to share it.
For the projects below any developer can add themselves to a project as read-only from http://en.studio.boardgamearena.com/#!projects page.

{| class="wikitable"
|-
! NAME
! CODE LINK
! DEVELOPER
|-
| Shared Code
| http://en.studio.boardgamearena.com/#!studiogame?game=sharedcode
| Victoria_La
|-
| Original BGA template
| http://en.studio.boardgamearena.com/#!studiogame?game=template
| Victoria_La
|-
|}

== Other useful resources ==

* Archive of tutorial projects https://www.dropbox.com/s/rsd5r4v49xudpp0/Studio.zip?dl=0
** Note: Hearts project is corrupted there, use Hearts tutorial project above
* Website with bunch of textures and sounds http://www.grsites.com/archive/textures/
* Shrink images without loss of quality https://tinypng.com/ or http://www.iloveimg.com/ (recommended by Gregory Isabelli)
* CSS shapes https://css-tricks.com/examples/ShapesOfCSS/
* PDF Scraper - extract images - http://www.extractpdf.com/