https://ms.doc.boardgamearena.com/api.php?action=feedcontributions&feedformat=atom&user=Een 2026-09-20T15:57:21Z Sumbangan pengguna MediaWiki 1.39.0 https://ms.doc.boardgamearena.com/index.php?title=Gamehelplogger&diff=1829 2016-05-19T21:35:03Z

<p>Een: </p> <hr /> <div>From the official rules:<br /> [http://www.icehousegames.org/wiki/index.php?title=Logger http://www.icehousegames.org/wiki/index.php?title=Logger]<br /> <br /> <br /> <br /> == '''Background''' ==<br /> <br /> <br /> Four rival lumberjacks are competing to chop down the most trees for their business. However, standing in their way are tree-hugging hippies protesting the deforestation.<br /> <br /> <br /> <br /> == '''Glossary''' ==<br /> <br /> <br /> The following terms are used in Logger:<br /> <br /> '''Tree''' - Any seedling, sapling or mature tree on the board.<br /> <br /> '''Seedling''' - A large pyramid<br /> <br /> '''Sapling''' - A large pyramid with a medium pyramid stacked on it<br /> <br /> '''Mature Tree''' - A stack of pyramids. From top to bottom: small, medium, large.<br /> <br /> '''Protester''' - Denoted by a volcano cap<br /> <br /> '''Logger''' - A piece representing the player. Denoted by a medium pyramid of a color not used for trees. Non-Icehouse pieces like meeples may be also used.<br /> <br /> <br /> == '''Setup''' ==<br /> <br /> <br /> Place a seedling on the center of the board. The remaining pyramid pieces from the Rainbow stash are kept aside in a common pool. Starting with the first player, each player places his logger on a corner of the board. Each player also starts with 1 protester in his or her supply (2 protesters for a 2-player game). Remember who went first as this will be important at the end game.<br /> <br /> <br /> == '''Goal''' ==<br /> <br /> <br /> The winner is the player with the most points at the end of the game. Though scoring 10 points triggers the end game, having 10 points may not be enough for victory.<br /> <br /> <br /> == '''Gameplay''' ==<br /> <br /> <br /> No Diagonals - Diagonals do not exist in Logger. Any rule pertaining to adjacency or movement is orthogonal only.<br /> <br /> Each player's turn consists of three parts: Movement, Growth and Action.<br /> <br /> Movement - Move your logger up to two spaces. Loggers may not occupy or walk through spaces occupied by trees or other loggers.<br /> <br /> Growth - All trees in the same row and column your logger occupies grow 1 stage. All seedlings become saplings and all saplings become mature trees. Mature trees produce 1 seedling in any space adjacent to them if able. Please note growth of all trees is considered simultaneous, so no tree should experience two stages of growth in one turn, nor should any seedlings newly spawned from a mature tree this turn. All trees in your logger's row and column must grow or create a new seedling if able.<br /> <br /> Action - There are three options in the Action phase: Plant, Protest and Chop. You must perform an action if able. This phase is skipped if your logger is unable to perform any action.<br /> <br /> Plant - Plant one seedling in any space adjacent to your logger.<br /> <br /> Protest - You may place one or more protesters from your supply onto mature trees. Protested trees may not be directly chopped down by any player.<br /> <br /> Chop - Chop down an unprotested mature tree adjacent to your logger by removing it from the board. Chopping will create a domino effect. Any mature tree behind the first chopped tree will also be considered chopped and so on regardless if they have protesters on them not. This process stops when either the edge of the board or a space occupied by anything other than a mature tree is reached. Score 1 point for each tree removed in this way. Add any protesters from felled trees to your supply.<br /> <br /> For example, a given row can have this formation: Player-Mature Tree-Mature Tree-Sapling-Mature Tree. When the player chops the first tree, the second one will be removed as well. However, the domino effect ends at the sapling because it is not fully mature. The sapling and the last mature tree remain on the board.<br /> <br /> <br /> == '''End Game''' ==<br /> <br /> <br /> Logger is a game of equal turns. When a player reaches 10 points, the end game condition is reached. All players who have not had a turn this round will get one final turn. (Example: Player 2 reaches 10 points. Players 3 and 4 will receive one additional turn, but Player 1 does not. However, if Player 4 reaches 10 points, the game ends immediately.)<br /> <br /> The player with the most points at the end of the game wins. In case of a tie, the player with more protesters in reserve wins.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelplogger&diff=1828 2016-05-19T21:34:41Z

<p>Een: Link to official rules</p> <hr /> <div>From the official rules:<br /> [http://www.icehousegames.org/wiki/index.php?title=Logger|http://www.icehousegames.org/wiki/index.php?title=Logger]<br /> <br /> <br /> <br /> == '''Background''' ==<br /> <br /> <br /> Four rival lumberjacks are competing to chop down the most trees for their business. However, standing in their way are tree-hugging hippies protesting the deforestation.<br /> <br /> <br /> <br /> == '''Glossary''' ==<br /> <br /> <br /> The following terms are used in Logger:<br /> <br /> '''Tree''' - Any seedling, sapling or mature tree on the board.<br /> <br /> '''Seedling''' - A large pyramid<br /> <br /> '''Sapling''' - A large pyramid with a medium pyramid stacked on it<br /> <br /> '''Mature Tree''' - A stack of pyramids. From top to bottom: small, medium, large.<br /> <br /> '''Protester''' - Denoted by a volcano cap<br /> <br /> '''Logger''' - A piece representing the player. Denoted by a medium pyramid of a color not used for trees. Non-Icehouse pieces like meeples may be also used.<br /> <br /> <br /> == '''Setup''' ==<br /> <br /> <br /> Place a seedling on the center of the board. The remaining pyramid pieces from the Rainbow stash are kept aside in a common pool. Starting with the first player, each player places his logger on a corner of the board. Each player also starts with 1 protester in his or her supply (2 protesters for a 2-player game). Remember who went first as this will be important at the end game.<br /> <br /> <br /> == '''Goal''' ==<br /> <br /> <br /> The winner is the player with the most points at the end of the game. Though scoring 10 points triggers the end game, having 10 points may not be enough for victory.<br /> <br /> <br /> == '''Gameplay''' ==<br /> <br /> <br /> No Diagonals - Diagonals do not exist in Logger. Any rule pertaining to adjacency or movement is orthogonal only.<br /> <br /> Each player's turn consists of three parts: Movement, Growth and Action.<br /> <br /> Movement - Move your logger up to two spaces. Loggers may not occupy or walk through spaces occupied by trees or other loggers.<br /> <br /> Growth - All trees in the same row and column your logger occupies grow 1 stage. All seedlings become saplings and all saplings become mature trees. Mature trees produce 1 seedling in any space adjacent to them if able. Please note growth of all trees is considered simultaneous, so no tree should experience two stages of growth in one turn, nor should any seedlings newly spawned from a mature tree this turn. All trees in your logger's row and column must grow or create a new seedling if able.<br /> <br /> Action - There are three options in the Action phase: Plant, Protest and Chop. You must perform an action if able. This phase is skipped if your logger is unable to perform any action.<br /> <br /> Plant - Plant one seedling in any space adjacent to your logger.<br /> <br /> Protest - You may place one or more protesters from your supply onto mature trees. Protested trees may not be directly chopped down by any player.<br /> <br /> Chop - Chop down an unprotested mature tree adjacent to your logger by removing it from the board. Chopping will create a domino effect. Any mature tree behind the first chopped tree will also be considered chopped and so on regardless if they have protesters on them not. This process stops when either the edge of the board or a space occupied by anything other than a mature tree is reached. Score 1 point for each tree removed in this way. Add any protesters from felled trees to your supply.<br /> <br /> For example, a given row can have this formation: Player-Mature Tree-Mature Tree-Sapling-Mature Tree. When the player chops the first tree, the second one will be removed as well. However, the domino effect ends at the sapling because it is not fully mature. The sapling and the last mature tree remain on the board.<br /> <br /> <br /> == '''End Game''' ==<br /> <br /> <br /> Logger is a game of equal turns. When a player reaches 10 points, the end game condition is reached. All players who have not had a turn this round will get one final turn. (Example: Player 2 reaches 10 points. Players 3 and 4 will receive one additional turn, but Player 1 does not. However, if Player 4 reaches 10 points, the game ends immediately.)<br /> <br /> The player with the most points at the end of the game wins. In case of a tie, the player with more protesters in reserve wins.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelplogger&diff=1827 2016-05-19T21:33:50Z

<p>Een: </p> <hr /> <div>From the official rules:<br /> [http://www.icehousegames.org/wiki/index.php?title=Logger]<br /> <br /> <br /> <br /> == '''Background''' ==<br /> <br /> <br /> Four rival lumberjacks are competing to chop down the most trees for their business. However, standing in their way are tree-hugging hippies protesting the deforestation.<br /> <br /> <br /> <br /> == '''Glossary''' ==<br /> <br /> <br /> The following terms are used in Logger:<br /> <br /> '''Tree''' - Any seedling, sapling or mature tree on the board.<br /> <br /> '''Seedling''' - A large pyramid<br /> <br /> '''Sapling''' - A large pyramid with a medium pyramid stacked on it<br /> <br /> '''Mature Tree''' - A stack of pyramids. From top to bottom: small, medium, large.<br /> <br /> '''Protester''' - Denoted by a volcano cap<br /> <br /> '''Logger''' - A piece representing the player. Denoted by a medium pyramid of a color not used for trees. Non-Icehouse pieces like meeples may be also used.<br /> <br /> <br /> == '''Setup''' ==<br /> <br /> <br /> Place a seedling on the center of the board. The remaining pyramid pieces from the Rainbow stash are kept aside in a common pool. Starting with the first player, each player places his logger on a corner of the board. Each player also starts with 1 protester in his or her supply (2 protesters for a 2-player game). Remember who went first as this will be important at the end game.<br /> <br /> <br /> == '''Goal''' ==<br /> <br /> <br /> The winner is the player with the most points at the end of the game. Though scoring 10 points triggers the end game, having 10 points may not be enough for victory.<br /> <br /> <br /> == '''Gameplay''' ==<br /> <br /> <br /> No Diagonals - Diagonals do not exist in Logger. Any rule pertaining to adjacency or movement is orthogonal only.<br /> <br /> Each player's turn consists of three parts: Movement, Growth and Action.<br /> <br /> Movement - Move your logger up to two spaces. Loggers may not occupy or walk through spaces occupied by trees or other loggers.<br /> <br /> Growth - All trees in the same row and column your logger occupies grow 1 stage. All seedlings become saplings and all saplings become mature trees. Mature trees produce 1 seedling in any space adjacent to them if able. Please note growth of all trees is considered simultaneous, so no tree should experience two stages of growth in one turn, nor should any seedlings newly spawned from a mature tree this turn. All trees in your logger's row and column must grow or create a new seedling if able.<br /> <br /> Action - There are three options in the Action phase: Plant, Protest and Chop. You must perform an action if able. This phase is skipped if your logger is unable to perform any action.<br /> <br /> Plant - Plant one seedling in any space adjacent to your logger.<br /> <br /> Protest - You may place one or more protesters from your supply onto mature trees. Protested trees may not be directly chopped down by any player.<br /> <br /> Chop - Chop down an unprotested mature tree adjacent to your logger by removing it from the board. Chopping will create a domino effect. Any mature tree behind the first chopped tree will also be considered chopped and so on regardless if they have protesters on them not. This process stops when either the edge of the board or a space occupied by anything other than a mature tree is reached. Score 1 point for each tree removed in this way. Add any protesters from felled trees to your supply.<br /> <br /> For example, a given row can have this formation: Player-Mature Tree-Mature Tree-Sapling-Mature Tree. When the player chops the first tree, the second one will be removed as well. However, the domino effect ends at the sapling because it is not fully mature. The sapling and the last mature tree remain on the board.<br /> <br /> <br /> == '''End Game''' ==<br /> <br /> <br /> Logger is a game of equal turns. When a player reaches 10 points, the end game condition is reached. All players who have not had a turn this round will get one final turn. (Example: Player 2 reaches 10 points. Players 3 and 4 will receive one additional turn, but Player 1 does not. However, if Player 4 reaches 10 points, the game ends immediately.)<br /> <br /> The player with the most points at the end of the game wins. In case of a tie, the player with more protesters in reserve wins.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelpkoikoi&diff=1772 2016-02-14T17:46:00Z

<p>Een: /* About &quot;First play&quot; */</p> <hr /> <div>== About yaku (card combinations) ==<br /> <br /> You can use the '''in game help icon''' to display a popup listing all the possible yaku and how many points they are worth. <br /> <br /> All the yaku are '''combinative''', except the &quot;Bright&quot; cards yaku, which are exclusive (you will always score the biggest available).<br /> <br /> == About multipliers ==<br /> <br /> As is often the case with traditional games, there is a lot of variants for playing Koi-koi, especially in regards to scoring.<br /> <br /> For Board Game Arena, two variants are provided through the options when creating the game:<br /> * - '''Soft &quot;Koi!&quot;''' is a variant adapted from [http://www.sloperama.com/hanafuda/rules.html the Sloperama site rules] which is all about saying &quot;Koi!&quot;. Of course you run the risk of your opponent making a yaku and scoring for the month (round) before you can score yourself, but in exchange for that risk, each time you will get '''a multiplier''' so that if you manage to increase your score with another yaku, you will score a lot more. Also, a starting multiplier will be set for the month if some &quot;Bright cards&quot; have been drawn for the field when dealing for the month. So this is an aggressive variant with a lot of points available if you push your luck.<br /> * - '''Hard &quot;Koi!&quot;''' is a variant adapted from [https://web.archive.org/web/20120421175954/http://hanafubuki.org/koikoi.html the Hanafubuki site rules] which is less incitative to call &quot;Koi!&quot; since you won't get a multiplier just for saying &quot;Koi!&quot;. Instead, '''your opponent''' will! If you say &quot;Koi!&quot; at least once, then if your opponent manages to score his score will be doubled. Still, at some point you'll risk it, because if you manage to improve your yaku to score 7 points or more, then '''your score''' will be doubled.<br /> <br /> Please also note how draws are handled:<br /> * - if a month ends by lack of cards in hand and no player has managed to form a yaku, the dealer for the month (first player) gets 6 points ('''&quot;dealer's privilege&quot;''');<br /> * - if a month ends by lack of cards in hand and at least a player managed to form a yaku (and said &quot;Koi!&quot; to continue), it's a draw and nobody gets any points.<br /> <br /> == About &quot;Viewing&quot; yaku ==<br /> <br /> A few variants have been implementend for the &quot;Viewing the Moon&quot; and &quot;Viewing the Cherry Blossoms&quot; yaku:<br /> * - '''Viewing yaku enabled''' : both yaku are available (this is the default)<br /> * - '''Rain ruins the party''' : if a player captures at least one card of November (rain), the party is ruined, both yaku are unavailable for this player<br /> * - '''Viewing yaku disabled''' : both yaku are unavailable.<br /> <br /> == About &quot;First play&quot; ==<br /> <br /> Getting the first play (and thus being the first to choose from the field) is a nice advantage. Some variants have been made available upon request:<br /> * - '''Winner starts the next month''' : the winner for the current month gets to play first the next month (this is the default)<br /> * - '''Loser starts the next month''' : the player who lost this month gets to play first the next month<br /> * - '''Alternate starting player''' : the player who didn't get to play first this month will play first the following month.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelpkoikoi&diff=1771 2016-02-14T17:45:24Z

<p>Een: First to play variant</p> <hr /> <div>== About yaku (card combinations) ==<br /> <br /> You can use the '''in game help icon''' to display a popup listing all the possible yaku and how many points they are worth. <br /> <br /> All the yaku are '''combinative''', except the &quot;Bright&quot; cards yaku, which are exclusive (you will always score the biggest available).<br /> <br /> == About multipliers ==<br /> <br /> As is often the case with traditional games, there is a lot of variants for playing Koi-koi, especially in regards to scoring.<br /> <br /> For Board Game Arena, two variants are provided through the options when creating the game:<br /> * - '''Soft &quot;Koi!&quot;''' is a variant adapted from [http://www.sloperama.com/hanafuda/rules.html the Sloperama site rules] which is all about saying &quot;Koi!&quot;. Of course you run the risk of your opponent making a yaku and scoring for the month (round) before you can score yourself, but in exchange for that risk, each time you will get '''a multiplier''' so that if you manage to increase your score with another yaku, you will score a lot more. Also, a starting multiplier will be set for the month if some &quot;Bright cards&quot; have been drawn for the field when dealing for the month. So this is an aggressive variant with a lot of points available if you push your luck.<br /> * - '''Hard &quot;Koi!&quot;''' is a variant adapted from [https://web.archive.org/web/20120421175954/http://hanafubuki.org/koikoi.html the Hanafubuki site rules] which is less incitative to call &quot;Koi!&quot; since you won't get a multiplier just for saying &quot;Koi!&quot;. Instead, '''your opponent''' will! If you say &quot;Koi!&quot; at least once, then if your opponent manages to score his score will be doubled. Still, at some point you'll risk it, because if you manage to improve your yaku to score 7 points or more, then '''your score''' will be doubled.<br /> <br /> Please also note how draws are handled:<br /> * - if a month ends by lack of cards in hand and no player has managed to form a yaku, the dealer for the month (first player) gets 6 points ('''&quot;dealer's privilege&quot;''');<br /> * - if a month ends by lack of cards in hand and at least a player managed to form a yaku (and said &quot;Koi!&quot; to continue), it's a draw and nobody gets any points.<br /> <br /> == About &quot;Viewing&quot; yaku ==<br /> <br /> A few variants have been implementend for the &quot;Viewing the Moon&quot; and &quot;Viewing the Cherry Blossoms&quot; yaku:<br /> * - '''Viewing yaku enabled''' : both yaku are available (this is the default)<br /> * - '''Rain ruins the party''' : if a player captures at least one card of November (rain), the party is ruined, both yaku are unavailable for this player<br /> * - '''Viewing yaku disabled''' : both yaku are unavailable.<br /> <br /> == About &quot;First play&quot; ==<br /> <br /> Getting the first play (and thus being the first to choose from the field) is a nice advantage. Some variants have been added upon request:<br /> * - '''Winner starts the next month''' : the winner for the current month gets to play first the next month (this is the default)<br /> * - '''Loser starts the next month''' : the player who lost this month gets to play first the next month<br /> * - '''Alternate starting player''' : the player who didn't get to play first this month will play first the following month.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelpkoikoi&diff=1770 2016-02-14T17:23:39Z

<p>Een: </p> <hr /> <div>== About yaku (card combinations) ==<br /> <br /> You can use the '''in game help icon''' to display a popup listing all the possible yaku and how many points they are worth. <br /> <br /> All the yaku are '''combinative''', except the &quot;Bright&quot; cards yaku, which are exclusive (you will always score the biggest available).<br /> <br /> == About multipliers ==<br /> <br /> As is often the case with traditional games, there is a lot of variants for playing Koi-koi, especially in regards to scoring.<br /> <br /> For Board Game Arena, two variants are provided through the options when creating the game:<br /> * - '''Soft &quot;Koi!&quot;''' is a variant adapted from [http://www.sloperama.com/hanafuda/rules.html the Sloperama site rules] which is all about saying &quot;Koi!&quot;. Of course you run the risk of your opponent making a yaku and scoring for the month (round) before you can score yourself, but in exchange for that risk, each time you will get '''a multiplier''' so that if you manage to increase your score with another yaku, you will score a lot more. Also, a starting multiplier will be set for the month if some &quot;Bright cards&quot; have been drawn for the field when dealing for the month. So this is an aggressive variant with a lot of points available if you push your luck.<br /> * - '''Hard &quot;Koi!&quot;''' is a variant adapted from [https://web.archive.org/web/20120421175954/http://hanafubuki.org/koikoi.html the Hanafubuki site rules] which is less incitative to call &quot;Koi!&quot; since you won't get a multiplier just for saying &quot;Koi!&quot;. Instead, '''your opponent''' will! If you say &quot;Koi!&quot; at least once, then if your opponent manages to score his score will be doubled. Still, at some point you'll risk it, because if you manage to improve your yaku to score 7 points or more, then '''your score''' will be doubled.<br /> <br /> Please also note how draws are handled:<br /> * - if a month ends by lack of cards in hand and no player has managed to form a yaku, the dealer for the month (first player) gets 6 points ('''&quot;dealer's privilege&quot;''');<br /> * - if a month ends by lack of cards in hand and at least a player managed to form a yaku (and said &quot;Koi!&quot; to continue), it's a draw and nobody gets any points.<br /> <br /> == About &quot;Viewing&quot; yaku ==<br /> <br /> A few variants have been implementend for the &quot;Viewing the Moon&quot; and &quot;Viewing the Cherry Blossoms&quot; yaku:<br /> * - '''Viewing yaku enabled''' : both yaku are available<br /> * - '''Rain ruins the party''' : if a player captures at least one card of November (rain), the party is ruined, both yaku are unavailable for this player<br /> * - '''Viewing yaku disabled''' : both yaku are unavailable.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelpkoikoi&diff=1769 2016-02-04T22:15:19Z

<p>Een: </p> <hr /> <div>== About yaku (card combinations) ==<br /> <br /> You can use the '''in game help icon''' to display a popup listing all the possible yaku and how many points they are worth. <br /> <br /> All the yaku are '''combinative''', except the &quot;Bright&quot; cards yaku, which are exclusive (you will always score the biggest available).<br /> <br /> == About multipliers ==<br /> <br /> As is often the case with traditional games, there is a lot of variants for playing Koi-koi, especially in regards to scoring.<br /> <br /> For Board Game Arena, two variants are provided through the options when creating the game:<br /> * - '''Soft &quot;Koi!&quot;''' is a variant adapted from [http://www.sloperama.com/hanafuda/rules.html the Sloperama site rules] which is all about saying &quot;Koi!&quot;. Of course you run the risk of your opponent making a yaku and scoring for the month (round) before you can score yourself, but in exchange for that risk, each time you will get '''a multiplier''' so that if you manage to increase your score with another yaku, you will score a lot more. Also, a starting multiplier will be set for the month if some &quot;Bright cards&quot; have been drawn for the field when dealing for the month. So this is an aggressive variant with a lot of points available if you push your luck.<br /> * - '''Hard &quot;Koi!&quot;''' is a variant adapted from [https://web.archive.org/web/20120421175954/http://hanafubuki.org/koikoi.html the Hanafubuki site rules] which is less incitative to call &quot;Koi!&quot; since you won't get a multiplier just for saying &quot;Koi!&quot;. Instead, '''your opponent''' will! If you say &quot;Koi!&quot; at least once, then if your opponent manages to score his score will be doubled. Still, at some point you'll risk it, because if you manage to improve your yaku to score 7 points or more, then '''your score''' will be doubled.<br /> <br /> Please also note how draws are handled:<br /> * - if a month ends by lack of cards in hand and no player has managed to form a yaku, the dealer for the month (first player) gets 6 points ('''&quot;dealer's privilege&quot;''');<br /> * - if a month ends by lack of cards in hand and at least a player managed to form a yaku (and said &quot;Koi!&quot; to continue), it's a draw and nobody gets any points.<br /> <br /> == About &quot;Viewing&quot; yaku ==<br /> <br /> A few variants have been implementend for the &quot;Viewing the Moon&quot; and &quot;Viewing the Cherry Blossoms&quot; yaku:<br /> * - '''Standard''' : both yaku are available<br /> * - '''Rain ruins the party''' : if a player captures at least one card of November (rain), the party is ruined, both yaku are unavailable for this player<br /> * - '''No viewing yaku''' : both yaku are unavailable.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelpkoikoi&diff=1768 2016-02-04T22:13:38Z

<p>Een: </p> <hr /> <div>== About yaku (card combinations) ==<br /> <br /> You can use the '''in game help icon''' to display a popup listing all the possible yaku and how many points they are worth. <br /> <br /> All the yaku are '''combinative''', except the &quot;Bright&quot; cards yaku, which are exclusive (you will always score the biggest available).<br /> <br /> == About multipliers ==<br /> <br /> As is often the case with traditional games, there is a lot of variants for playing Koi-koi, especially in regards to scoring.<br /> <br /> For Board Game Arena, two variants are provided through the options when creating the game:<br /> * - '''Soft &quot;Koi!&quot;''' is a variant adapted from [http://www.sloperama.com/hanafuda/rules.html the Sloperama site rules] which is all about saying &quot;Koi!&quot;. Of course you run the risk of your opponent making a yaku and scoring for the month (round) before you can score yourself, but in exchange for that risk, each time you will get '''a multiplier''' so that if you manage to increase your score with another yaku, you will score a lot more. Also, a starting multiplier will be set for the month if some &quot;Bright cards&quot; have been drawn for the field when dealing for the month. So this is an aggressive variant with a lot of points available if you push your luck.<br /> * - '''Hard &quot;Koi!&quot;''' is a variant adapted from [https://web.archive.org/web/20120421175954/http://hanafubuki.org/koikoi.html the Hanafubuki site rules] which is less incitative to call &quot;Koi!&quot; since you won't get a multiplier just for saying &quot;Koi!&quot;. Instead, '''your opponent''' will! If you say &quot;Koi!&quot; at least once, then if your opponent manages to score his score will be doubled. Still, at some point you'll risk it, because if you manage to improve your yaku to score 7 points or more, then '''your score''' will be doubled.<br /> <br /> Please also note that:<br /> * - if a month ends by lack of cards in hand and no player has managed to form a yaku, the dealer for the month (first player) gets 6 points (&quot;dealer's privilege&quot;);<br /> * - if a month ends by lack of cards in hand and at least a player managed to form a yaku (and said &quot;Koi!&quot; to continue), it's a draw and nobody gets any points.<br /> <br /> == About &quot;Viewing&quot; yaku ==<br /> <br /> A few variants have been implementend for the &quot;Viewing the Moon&quot; and &quot;Viewing the Cherry Blossoms&quot; yaku:<br /> * - '''Standard''' : both yaku are available<br /> * - '''Rain ruins the party''' : if a player captures at least one card of November (rain), the party is ruined, both yaku are unavailable for this player<br /> * - '''No viewing yaku''' : both yaku are unavailable.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Main_game_logic:_yourgamename.game.php&diff=1765 2016-02-04T10:06:15Z

<p>Een: /* Notify players */ tip on player name highlighting</p> <hr /> <div><br /> 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.<br /> <br /> == File Structure ==<br /> <br /> The details on how the file is structured is described directly with comments on the code skeleton provided to you.<br /> <br /> Basically, here's this structure:<br /> * EmptyGame (constructor): where you define global variables.<br /> * setupNewGame: initial setup of the game.<br /> * getAllDatas: where you retrieve all game data during a complete reload of the game.<br /> * getGameProgression: where you compute the game progression indicator.<br /> * Utility functions: your utility functions.<br /> * Player actions: the entry points for players actions. <br /> * Game state arguments: methods to return additional data on specific game states ([http://en.doc.boardgamearena.com/Your_game_state_machine:_states.inc.php#args more info here]).<br /> * Game state actions: the logic to run when entering a new game state ([http://en.doc.boardgamearena.com/Your_game_state_machine:_states.inc.php#action more info here]).<br /> * zombieTurn: what to do it's the turn of a zombie player.<br /> <br /> == Accessing player informations ==<br /> <br /> ; getPlayersNumber()<br /> : Returns the number of players playing at the table<br /> : Note: doesn't work in setupNewGame so use count($players) instead<br /> <br /> ; getActivePlayerId()<br /> : Get the &quot;active_player&quot;, whatever what is the current state type.<br /> : Note: it does NOT mean that this player is active right now, because state type could be &quot;game&quot; or &quot;multiplayer&quot;<br /> : Note: avoid using this method in a &quot;multiplayer&quot; state because it does not mean anything.<br /> <br /> ; getActivePlayerName()<br /> : Get the &quot;active_player&quot; name<br /> : Note: avoid using this method in a &quot;multiplayer&quot; state because it does not mean anything.<br /> <br /> ; loadPlayersBasicInfos()<br /> : Get an associative array with generic data about players (ie: not game specific data).<br /> : The key of the associative array is the player id.<br /> : The content of each value is:<br /> : * player_name<br /> : * player_color (ex: ff0000)<br /> <br /> ; getCurrentPlayerId()<br /> : Get the &quot;current_player&quot;. The current player is the one from which the action originated (the one who send the request).<br /> : '''Be careful''': It is not always the active player.<br /> : In general, you shouldn't use this method, unless you are in &quot;multiplayer&quot; state.<br /> <br /> ; getCurrentPlayerName()<br /> : Get the &quot;current_player&quot; name<br /> : Be careful using this method (see above).<br /> <br /> ; getCurrentPlayerColor()<br /> : Get the &quot;current_player&quot; color<br /> : Be careful using this method (see above).<br /> <br /> ; isCurrentPlayerZombie()<br /> : Check the &quot;current_player&quot; zombie status. If true, player leave the game.<br /> <br /> == Accessing database ==<br /> <br /> 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.<br /> <br /> '''IMPORTANT'''<br /> <br /> 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.<br /> <br /> ; DbQuery( $sql )<br /> : This is the generic method to access the database.<br /> : It can execute any type of SELECT/UPDATE/DELETE/REPLACE query on the database.<br /> : You should use it for UPDATE/DELETE/REPLACE query. For SELECT queries, the specialized methods below are much better.<br /> <br /> ; getUniqueValueFromDB( $sql )<br /> : Returns a unique value from DB or null if no value is found.<br /> : $sql must be a SELECT query.<br /> : Raise an exception if more than 1 row is returned.<br /> <br /> ; getCollectionFromDB( $sql, $bSingleValue=false )<br /> : Returns an associative array of rows for a sql SELECT query.<br /> : The key of the resulting associative array is the first field specified in the SELECT query.<br /> : The value of the resulting associative array if an associative array with all the field specified in the SELECT query and associated values.<br /> : First column must be a primary or alternate key.<br /> : The resulting collection can be empty.<br /> : If you specified $bSingleValue=true and if your SQL query request 2 fields A and B, the method returns an associative array &quot;A=&gt;B&quot;<br /> <br /> Example 1:<br /> &lt;pre&gt;<br /> self::getCollectionFromDB( &quot;SELECT player_id id, player_name name, player_score score FROM player&quot; );<br /> <br /> Result:<br /> array(<br /> 1234 =&gt; array( 'id'=&gt;1234, 'name'=&gt;'myuser0', 'score'=&gt;1 ),<br /> 1235 =&gt; array( 'id'=&gt;1235, 'name'=&gt;'myuser1', 'score'=&gt;0 )<br /> )<br /> &lt;/pre&gt;<br /> Example 2:<br /> &lt;pre&gt;<br /> self::getCollectionFromDB( &quot;SELECT player_id id, player_name name FROM player&quot;, true );<br /> <br /> Result:<br /> array(<br /> 1234 =&gt; 'myuser0',<br /> 1235 =&gt; 'myuser1'<br /> )<br /> <br /> &lt;/pre&gt;<br /> <br /> ; getNonEmptyCollectionFromDB( $sql )<br /> : Idem than previous one, but raise an exception if the collection is empty<br /> <br /> ; function getObjectFromDB( $sql )<br /> : Returns one row for the sql SELECT query as an associative array or null if there is no result<br /> : Raise an exception if the query return more than one row<br /> <br /> Example:<br /> &lt;pre&gt;<br /> self::getObjectFromDB( &quot;SELECT player_id id, player_name name, player_score score FROM player WHERE player_id='$player_id'&quot; );<br /> <br /> Result:<br /> array(<br /> 'id'=&gt;1234, 'name'=&gt;'myuser0', 'score'=&gt;1 <br /> )<br /> &lt;/pre&gt;<br /> <br /> ; getNonEmptyObjectFromDB( $sql )<br /> : Idem than previous one, but raise an exception if no row is found<br /> <br /> ; getObjectListFromDB( $sql, $bUniqueValue=false )<br /> : Return an array of rows for a sql SELECT query.<br /> : the result if the same than &quot;getCollectionFromDB&quot; except that the result is a simple array (and not an associative array).<br /> : The result can be empty.<br /> : If you specified $bUniqueValue=true and if your SQL query request 1 field, the method returns directly an array of values.<br /> <br /> Example 1:<br /> &lt;pre&gt;<br /> self::getObjectListFromDB( &quot;SELECT player_id id, player_name name, player_score score FROM player&quot; );<br /> <br /> Result:<br /> array(<br /> array( 'id'=&gt;1234, 'name'=&gt;'myuser0', 'score'=&gt;1 ),<br /> array( 'id'=&gt;1235, 'name'=&gt;'myuser1', 'score'=&gt;0 )<br /> )<br /> &lt;/pre&gt;<br /> Example 2:<br /> &lt;pre&gt;<br /> self::getObjectListFromDB( &quot;SELECT player_name name FROM player&quot;, true );<br /> <br /> Result:<br /> array(<br /> 'myuser0',<br /> 'myuser1'<br /> )<br /> <br /> &lt;/pre&gt;<br /> <br /> ; getDoubleKeyCollectionFromDB( $sql, $bSingleValue=false )<br /> : Return an associative array of associative array, from a SQL SELECT query.<br /> : First array level correspond to first column specified in SQL query.<br /> : Second array level correspond to second column specified in SQL query.<br /> : If bSingleValue = true, keep only third column on result<br /> <br /> <br /> ; DbGetLastId()<br /> : Return the PRIMARY key of the last inserted row (see PHP mysql_insert_id function).<br /> <br /> ; DbAffectedRow()<br /> : Return the number of row affected by the last operation<br /> <br /> ; escapeStringForDB( $string )<br /> : You must use this function on every string type data in your database that contains unsafe data.<br /> : (unsafe = can be modified by a player).<br /> : This method makes sure that no SQL injection will be done through the string used.<br /> <br /> &lt;pre&gt;<br /> self::getObjectFromDB( &quot;SELECT player_name name, player_color color FROM player WHERE player_id='1234'&quot; );<br /> <br /> Result:<br /> array(<br /> 'id' =&gt; 1234,<br /> 'name' =&gt; 'myuser1',<br /> 'color' =&gt; 'ff0000'<br /> )<br /> <br /> &lt;/pre&gt;<br /> <br /> Note: see Editing [[Game database model: dbmodel.sql]] to know how to define your database model.<br /> <br /> == Use globals ==<br /> <br /> Sometimes, you have to keep a single integer value that is global to your game, and you don't want to create a DB table specifically for it.<br /> <br /> Using a BGA framework &quot;global&quot;, you can do such a thing. Your value will be stored in the &quot;global&quot; table in database, and you can access it with simple methods.<br /> <br /> '''initGameStateLabels'''<br /> <br /> This method is located at the beginning of your game logic. This is the place you defines the globals used in your game logic, by assigning them IDs.<br /> <br /> You can define up to 79 globals, with IDs from 10 to 89. You must NOT use globals outside this range as globals are used by other components of the framework.<br /> <br /> &lt;pre&gt;<br /> self::initGameStateLabels( array( <br /> &quot;my_first_global_variable&quot; =&gt; 10,<br /> &quot;my_second_global_variable&quot; =&gt; 11<br /> ) );<br /> &lt;/pre&gt;<br /> <br /> '''setGameStateInitialValue( $value_label, $value_value )'''<br /> <br /> Init your global value. Must be called before any use of your global, so you should call this method from your &quot;setupNewGame&quot; method.<br /> <br /> '''getGameStateValue( $value_label )'''<br /> <br /> Retrieve the current value of a global.<br /> <br /> '''setGameStateValue( $value_label, $value_value )'''<br /> <br /> Set the current value of a global.<br /> <br /> '''incGameStateValue( $value_label, $increment )'''<br /> <br /> Increment the current value of a global. If increment is negative, decrement the value of the global.<br /> <br /> Return the final value of the global.<br /> <br /> == Game states and active players ==<br /> <br /> ; checkAction( $actionName, $bThrowException=true )<br /> : Check if action is valid regarding current game state (exception if fails)<br /> : The action is valid if it is listed as a &quot;possibleactions&quot; in the current game state (see game state description).<br /> : This method MUST be called in the first place in ALL your PHP methods that handle players action, in order to make sure a player can't do an action when the rules disallow it at this moment of the game.<br /> : if &quot;bThrowException&quot; is set to &quot;false&quot;, the function return false in case of failure instead of throwing and exception. This is useful when several actions are possible in order to test each of them without throwing exceptions.<br /> <br /> ; activeNextPlayer()<br /> : Make the next player active in the natural player order.<br /> : Note: you CANT use this method in a &quot;activeplayer&quot; or &quot;multipleactiveplayer&quot; state. You must use a &quot;game&quot; type game state for this.<br /> <br /> ; activePrevPlayer()<br /> : Make the previous player active (in the natural player order).<br /> : Note: you CANT use this method in a &quot;activeplayer&quot; or &quot;multipleactiveplayer&quot; state. You must use a &quot;game&quot; type game state for this.<br /> <br /> ; $this-&gt;gamestate-&gt;changeActivePlayer( $player_id )<br /> : You can call this method to make any player active.<br /> : Note: you CANT use this method in a &quot;activeplayer&quot; or &quot;multipleactiveplayer&quot; state. You must use a &quot;game&quot; type game state for this.<br /> <br /> <br /> ; $this-&gt;gamestate-&gt;getActivePlayerList()<br /> : With this method you can retrieve the list of the active player at any time.<br /> : During a &quot;game&quot; type gamestate, it will return a void array.<br /> : During a &quot;activeplayer&quot; type gamestate, it will return an array with one value (the active player id).<br /> : during a &quot;multipleactiveplayer&quot; type gamestate, it will return an array of the active players id.<br /> : Note: you should only use this method is the latter case.<br /> <br /> ; $this-&gt;gamestate-&gt;setAllPlayersMultiactive()<br /> : With this method, all playing players are made active.<br /> : Usually, you use this method at the beginning (ex: &quot;st&quot; action method) of a multiplayer game state when all players have to do some action.<br /> <br /> ; $this-&gt;gamestate-&gt;setPlayersMultiactive( $players, $next_state )<br /> : Make a specific list of players active during a multiactive gamestate.<br /> : Bare in mind it doesn't deactivate other previously active players.<br /> : &quot;players&quot; is the array of player id that should be made active.<br /> : In case &quot;players&quot; is empty, the method trigger the &quot;next_state&quot; transition to go to the next game state.<br /> <br /> ; $this-&gt;gamestate-&gt;setPlayerNonMultiactive( $player_id, $next_state )<br /> : During a multiactive game state, make the specified player inactive.<br /> : Usually, you call this method during a multiactive game state after a player did his action.<br /> : If this player was the last active player, the method trigger the &quot;next_state&quot; transition to go to the next game state.<br /> <br /> ; $this-&gt;gamestate-&gt;checkPossibleAction( $action )<br /> : (rarely used)<br /> : This works exactly like &quot;checkAction&quot;, except that it do NOT check if current player is active.<br /> : This is used specifically in certain game states when you want to authorize some additional actions for players that are not active at the moment.<br /> : Example: in Libertalia game, you want to authorize players to change their mind about card played. They are of course not active at the time they change their mind, so you cannot use &quot;checkAction&quot; and use &quot;checkPossibleAction&quot; instead.<br /> <br /> == Players turn order ==<br /> <br /> '''getNextPlayerTable()'''<br /> <br /> Return an associative array which associate each player with the next player around the table.<br /> <br /> In addition, key 0 is associated to the first player to play.<br /> <br /> Example: if three player with ID 1, 2 and 3 are around the table, in this order, the method returns:<br /> &lt;pre&gt;<br /> array( <br /> 1 =&gt; 2, <br /> 2 =&gt; 3, <br /> 3 =&gt; 1, <br /> 0 =&gt; 1 <br /> );<br /> &lt;/pre&gt;<br /> <br /> '''getPrevPlayerTable()'''<br /> <br /> Same as above, but the associative array associate the previous player around the table.<br /> <br /> '''getPlayerAfter( $player_id )'''<br /> <br /> Get player playing after given player in natural playing order.<br /> <br /> '''getPlayerBefore( $player_id )'''<br /> <br /> Get player playing before given player in natural playing order.<br /> <br /> == Notify players ==<br /> <br /> To understand notifications, please read [http://www.slideshare.net/boardgamearena/the-bga-framework-at-a-glance The BGA Framework at a glance] first.<br /> <br /> '''IMPORTANT'''<br /> <br /> Notifications are sent at the very end of the request, when it ends normally. It means that if you throw an exception for any reason (ex: move not allowed), no notifications will be sent to players.<br /> Notifications sent between the game start (setupNewGame) and the end of the &quot;action&quot; method of the first active state will never reach their destination.<br /> <br /> '''notifyAllPlayers( $notification_type, $notification_log, $notification_args )'''<br /> <br /> Send a notification to all players of the game.<br /> <br /> * notification_type:<br /> A string that defines the type of your notification.<br /> <br /> Your game interface Javascript logic will use this to know what is the type of the received notification (and to trigger the corresponding method).<br /> <br /> * notification_log:<br /> A string that defines what is to be displayed in the game log.<br /> <br /> You can use an empty string here (&quot;&quot;). In this case, nothing is displayed in the game log.<br /> <br /> If you define a real string here, you should use &quot;clienttranslate&quot; method to make sure it can be translate.<br /> <br /> You can use arguments in your notification_log strings, that refers to values defines in the &quot;notification_args&quot; 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.<br /> <br /> Note: you CAN use some HTML inside your notification log, and it is working. However:<br /> _ pay attention to keep the log clear.<br /> _ try to not include some HTML tags inside the &quot;clienttranslate&quot; method, otherwise it will make the translators work more difficult. You can use a notification argument instead, and provide your HTML through this argument.<br /> <br /> * notification_args:<br /> The arguments of your notifications, as an associative array.<br /> <br /> This array will be transmitted to the game interface logic, in order the game interface can be updated.<br /> <br /> Complete notifyAllPlayers example (from &quot;Reversi&quot;):<br /> <br /> &lt;pre&gt;<br /> self::notifyAllPlayers( &quot;playDisc&quot;, clienttranslate( '${player_name} plays a disc and turns over ${returned_nbr} disc(s)' ), array(<br /> 'player_id' =&gt; $player_id,<br /> 'player_name' =&gt; self::getActivePlayerName(),<br /> 'returned_nbr' =&gt; count( $turnedOverDiscs ),<br /> 'x' =&gt; $x,<br /> 'y' =&gt; $y<br /> ) );<br /> &lt;/pre&gt;<br /> <br /> You can see in the example above the use of the &quot;clienttranslate&quot; method, and the use of 2 arguments &quot;player_name&quot; and &quot;returned_nbr&quot; in the notification log.<br /> <br /> Important: NO private data must be sent with this method, as a cheater could see it even it is not used explicitly by the game interface logic. If you want to send private information to a player, please use notifyPlayer below.<br /> <br /> '''notifyPlayer( $player_id, $notification_type, $notification_log, $notification_args )'''<br /> <br /> Same as above, except that the notification is sent to one player only.<br /> <br /> This method must be used each time some private information must be transmitted to a player.<br /> <br /> Important: the variable for player name must be ${player_name} in order to be highlighted with the player color in the game log<br /> <br /> == Game statistics ==<br /> <br /> There are 2 types of statistics:<br /> * a &quot;player&quot; statistic is a statistic associated to a player<br /> * a &quot;table&quot; statistics is a statistic not associated to a player (global statistic for this game).<br /> <br /> See [[Game statistics: stats.inc.php]] to see how you defines statistics for your game.<br /> <br /> '''initStat( $table_or_player, $name, $value, $player_id=null )'''<br /> Create a statistic entry for the specified statistics with a default value.<br /> This method must be called for each statistics of your game, in your setupNewGame method.<br /> <br /> 'table_or_player' must be set to &quot;table&quot; if this is a table statistics, or &quot;player&quot; if this is a player statistics.<br /> <br /> 'name' is the name of your statistics, as it has been defined in your stats.inc.php file.<br /> <br /> 'value' is the initial value of the statistics. If this is a player statistics and if the player is not specified by &quot;player_id&quot; argument, the value is set for ALL players.<br /> <br /> <br /> '''function setStat( $value, $name, $player_id = null )'''<br /> <br /> Set a statistic value.<br /> <br /> If &quot;player_id&quot; is not specified, setStat consider it is a TABLE statistic.<br /> <br /> If &quot;player_id&quot; is specified, setStat consider it is a PLAYER statistic.<br /> <br /> '''incStat( $delta, $name, $player_id = null )'''<br /> <br /> Increment (or decrement) specified statistic value. Same behavior as above.<br /> <br /> == Translations ==<br /> <br /> See [[Translations]]<br /> <br /> == Manage player scores and Tie breaker ==<br /> <br /> At the end of the game, players automatically get a rank depending on their score: the player with the biggest score is #1, the player with the second biggest score is #2, and so on...<br /> <br /> During the game, you update player's score directly by updating &quot;player_score&quot; field of &quot;player&quot; table in database.<br /> <br /> Examples:<br /> &lt;pre&gt;<br /> <br /> // +2 points to active player<br /> self::DbQuery( &quot;UPDATE player SET player_score=player_score+2 WHERE player_id='&quot;.self::getActivePlayerId().&quot;'&quot; );<br /> <br /> // Set score of active player to 5<br /> self::DbQuery( &quot;UPDATE player SET player_score=5 WHERE player_id='&quot;.self::getActivePlayerId().&quot;'&quot; );<br /> <br /> &lt;/pre&gt;<br /> <br /> Note: don't forget to notify the client side in order the score control can be updated accordingly.<br /> <br /> '''Tie breaker'''<br /> <br /> Tie breaker is used when two players get the same score at the end of a game.<br /> <br /> Tie breaker is using &quot;player_score_aux&quot; field of &quot;player&quot; table. It is updated exactly like the &quot;player_score&quot; field.<br /> <br /> Tie breaker score is displayed only for players who are tied at the end of the game. Most of the time, it is not supposed to be displayed explicitly during the game.<br /> <br /> When you are using &quot;player_score_aux&quot; functionality, you must describe the formula to use in your gameinfos.inc.php file like this:<br /> <br /> &lt;pre&gt;<br /> 'tie_breaker_description' =&gt; totranslate(&quot;Describe here your tie breaker formula&quot;),<br /> &lt;/pre&gt;<br /> <br /> This description will be used as a tooltip to explain to players how this auxiliary score has been calculated.<br /> <br /> == Reflexion time ==<br /> <br /> ; function giveExtraTime( $player_id, $specific_time=null )<br /> : Give standard extra time to this player.<br /> : Standard extra time depends on the speed of the game (small with &quot;slow&quot; game option, bigger with other options).<br /> : You can also specify an exact time to add, in seconds, with the &quot;specified_time&quot; argument (rarely used).<br /> <br /> == Managing errors and exceptions ==<br /> <br /> Note: when you throw an exception, all database changes and all notifications are cancelled immediately. This way, the game situation that were existing before the request is completely restored.<br /> <br /> ; throw new BgaUserException ( $error_message)<br /> : Base class to notify a user error<br /> : You must throw this exception when a player want to do something that he is not allowed to do.<br /> : The error message will be shown to the player as a &quot;red message&quot;, so it must be translated.<br /> : Throwing such an exception is NOT considered as a bug, so it is not traced in BGA error logs.<br /> <br /> Example from Gomoku:<br /> &lt;pre&gt;<br /> throw new BgaUserException( self::_(&quot;There is already a stone on this intersection, you can't play there&quot;) );<br /> &lt;/pre&gt;<br /> <br /> <br /> ; throw new BgaVisibleSystemException ( $error_message)<br /> : You must throw this exception when you detect something that is not supposed to happened into your code.<br /> : The error message is shown to the user as an &quot;Unexpected error&quot;, in order he can report it in the forum.<br /> : The error message is logged in BGA error logs. If it happens regularly, we will report it to you.<br /> <br /> ; throw new BgaSystemException ( $error_message)<br /> : Base class to notify a system exception. The message will be hidden from the user, but show in the logs. Use this if the message contains technical information.<br /> : You shouldn't use this type of exception except if you think the information shown could be critical. Indeed: a generic error message will be shown to the user, so it's going to be difficult for you to see what happened.<br /> <br /> == Zombie mode ==<br /> <br /> When a player leaves a game for any reason (expelled, quit), he becomes a &quot;zombie player&quot;. In this case, the results of the game won't count for statistics, but this is cool if the other players can finish the game anyway. That's why zombie mode exists: allow the other player to finish the game, even if the situation is not ideal.<br /> <br /> While developing your zombie mode, keep in mind that:<br /> * Do not refer to the rules, because this situation is not planned by the rules.<br /> * Try to figure that you are playing with your friends and one of them has to leave: how can we finish the game without killing the spirit of the game?<br /> * The idea is NOT to develop an artificial intelligence for the game.<br /> <br /> Most of the time, the best thing to do when it is zombie player turn is to jump immediately to a state where he is not active anymore. For example, if he is in a game state where he has a choice between playing A and playing B, the best thing to do is NOT to choose A or B, but to pass. So, even if there's no &quot;pass&quot; action in the rules, add a &quot;zombiepass&quot; transitition in your game state and use it.<br /> <br /> Each time a zombie player must play, your &quot;zombieTurn&quot; method is called.<br /> <br /> Parameters:<br /> * $state: the name of the current game state.<br /> * $active_player: the id of the active player.<br /> <br /> Most of the time, your zombieTurn method looks like this:<br /> <br /> &lt;pre&gt;<br /> function zombieTurn( $state, $active_player )<br /> {<br /> $statename = $state['name'];<br /> <br /> if( $statename == 'myFirstGameState'<br /> || $statename == 'my2ndGameState'<br /> || $statename == 'my3rdGameState'<br /> ....<br /> )<br /> {<br /> $this-&gt;gamestate-&gt;nextState( &quot;zombiePass&quot; );<br /> }<br /> else<br /> throw new BgaVisibleSystemException( &quot;Zombie mode not supported at this game state: &quot;.$statename );<br /> }<br /> &lt;/pre&gt;<br /> <br /> Note that in the example above, all corresponding game state should implement &quot;zombiePass&quot; as a transition.<br /> <br /> == Player elimination ==<br /> <br /> In some games, this is useful to eliminate a player from the game in order he/she can start another game without waiting for the current game end.<br /> <br /> This case should be rare. Please don't use player elimination feature if some player just has to wait the last 10% of the game for game end. This feature should be used only in games where players are eliminated all along the game (typical examples: &quot;Perudo&quot; or &quot;The Werewolves of Miller's Hollow&quot;).<br /> <br /> Usage:<br /> <br /> * Player to eliminate should NOT be active anymore (preferably use the feature in a &quot;game&quot; type game state).<br /> * In your PHP code:<br /> self::eliminatePlayer( &lt;player_to_eliminate_id&gt; );<br /> * the player is informed in a dialog box that he no longer have to played and can start another game if he/she wants too (whith buttons &quot;stay at this table&quot; &quot;quit table and back to main site&quot;). In any case, the player is free to tart&amp;join another table from now.<br /> * When your game is over, all players who have been eliminated before receive a &quot;notification&quot; (the small &quot;!&quot; icon on the top right of the BGA interface) that indicate them that &quot;the game has ended&quot; and invite them to review the game results.<br /> <br /> == Player color preferences ==<br /> <br /> <br /> BGA players (Club members) may now choose their preferred color for playing. For example, if they are used to play green for every board game, they can select &quot;green&quot; in their BGA preferences page.<br /> <br /> Making your game compatible with colors preferences is very easy and requires only 1 line of PHP and 1 configuration change :<br /> <br /> On your gameinfos.inc.php file, add the following lines :<br /> <br /> // Favorite colors support : if set to &quot;true&quot;, support attribution of favorite colors based on player's preferences (see reattributeColorsBasedOnPreferences PHP method)<br /> 'favorite_colors_support' =&gt; true,<br /> <br /> Then, on your main &lt;your_game&gt;.game.php file, find the &quot;reloadPlayersBasicInfos&quot; call in your &quot;setupNewGame&quot; method and replace :<br /> <br /> $sql .= implode( $values, ',' );<br /> self::DbQuery( $sql );<br /> self::reloadPlayersBasicInfos();<br /> <br /> By :<br /> <br /> $sql .= implode( $values, ',' );<br /> self::DbQuery( $sql );<br /> self::reattributeColorsBasedOnPreferences( $players, array( /* LIST HERE THE AVAILABLE COLORS OF YOUR GAME INSTEAD OF THESE ONES */&quot;ff0000&quot;, &quot;008000&quot;, &quot;0000ff&quot;, &quot;ffa500&quot;, &quot;773300&quot; ) );<br /> self::reloadPlayersBasicInfos();<br /> <br /> <br /> The &quot;reattributeColorsBasedOnPreferences&quot; method reattributes all colors, taking into account players color preferences and available colors.<br /> <br /> Note that you must update the colors to indicate the colors available for your game.<br /> <br /> 2 important remarks :<br /> * for some games (ex : Chess), the color has an influence on a mechanism of the game, most of the time by giving a special advantage to a player (ex : Starting the game). Color preference mechanism must NOT be used in such a case.<br /> * your logic should NEVER consider that the first player has the color X, that the second player has the color Y, and so on. If this is the case, your game will NOT be compatible with reattributeColorsBasedOnPreferences as this method attribute colors to players based on their preferences and not based as their order at the table.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelpkoikoi&diff=1764 2016-02-04T08:58:19Z

<p>Een: Added variants</p> <hr /> <div>== About yaku (card combinations) ==<br /> <br /> You can use the '''in game help icon''' to display a popup listing all the possible yaku and how many points they are worth. <br /> <br /> All the yaku are '''combinative''', except the &quot;Bright&quot; cards yaku, which are exclusive (you will always score the biggest available).<br /> <br /> == About multipliers ==<br /> <br /> As is often the case with traditional games, there is a lot of variants for playing Koi-koi, especially in regards to scoring.<br /> <br /> For Board Game Arena, two variants are provided through the options when creating the game:<br /> * - '''Soft &quot;Koi!&quot;''' is a variant adapted from [http://www.sloperama.com/hanafuda/rules.html the Sloperama site rules] which is all about saying &quot;Koi!&quot;. Of course you run the risk of your opponent making a yaku and scoring for the month (round) before you can score yourself, but in exchange for that risk, each time you will get '''a multiplier''' so that if you manage to increase your score with another yaku, you will score a lot more. Also, a starting multiplier will be set for the month if some &quot;Bright cards&quot; have been drawn for the field when dealing for the month. So this is an aggressive variant with a lot of points available if you push your luck.<br /> * - '''Hard &quot;Koi!&quot;''' is a variant adapted from [https://web.archive.org/web/20120421175954/http://hanafubuki.org/koikoi.html the Hanafubuki site rules] which is less incitative to call &quot;Koi!&quot; since you won't get a multiplier just for saying &quot;Koi!&quot;. Instead, '''your opponent''' will! If you say &quot;Koi!&quot; at least once, then if your opponent manages to score his score will be doubled. Still, at some point you'll risk it, because if you manage to improve your yaku to score 7 points or more, then '''your score''' will be doubled.<br /> <br /> == A few variants ==<br /> <br /> For the &quot;Viewing the Moon&quot; and &quot;Viewing the Cherry Blossoms&quot; :<br /> * - '''Standard''' : both yaku are available<br /> * - '''Rain ruins the party''' : if a player captures at least one card of November (rain), the party is ruined, both yaku are unavailable for this player<br /> * - '''No viewing yaku''' : both yaku are unavailable.<br /> <br /> For managing draws at the end of the month :<br /> * - '''No points awarded''' : no player gets any points in case of a draw<br /> * - '''Dealer`s privilege''' : the dealer (first player) gets 6 points in case of a draw.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelpkoikoi&diff=1761 2016-02-01T17:23:27Z

<p>Een: </p> <hr /> <div>== About yaku (card combinations) ==<br /> <br /> You can use the '''in game help icon''' to display a popup listing all the possible yaku and how many points they are worth. <br /> <br /> All the yaku are '''combinative''', except the &quot;Bright&quot; cards yaku, which are exclusive (you will always score the biggest available).<br /> <br /> == About multipliers ==<br /> <br /> As is often the case with traditional games, there is a lot of variants for playing Koi-koi, especially in regards to scoring.<br /> <br /> For Board Game Arena, two variants are provided through the options when creating the game:<br /> * - '''Soft &quot;Koi!&quot;''' is a variant adapted from [http://www.sloperama.com/hanafuda/rules.html the Sloperama site rules] which is all about saying &quot;Koi!&quot;. Of course you run the risk of your opponent making a yaku and scoring for the month (round) before you can score yourself, but in exchange for that risk, each time you will get '''a multiplier''' so that if you manage to increase your score with another yaku, you will score a lot more. Also, a starting multiplier will be set for the month if some &quot;Bright cards&quot; have been drawn for the field when dealing for the month. So this is an aggressive variant with a lot of points available if you push your luck.<br /> * - '''Hard &quot;Koi!&quot;''' is a variant adapted from [https://web.archive.org/web/20120421175954/http://hanafubuki.org/koikoi.html the Hanafubuki site rules] which is less incitative to call &quot;Koi!&quot; since you won't get a multiplier just for saying &quot;Koi!&quot;. Instead, '''your opponent''' will! If you say &quot;Koi!&quot; at least once, then if your opponent manages to score his score will be doubled. Still, at some point you'll risk it, because if you manage to improve your yaku to score 7 points or more, then '''your score''' will be doubled.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelpkoikoi&diff=1760 2016-02-01T17:21:10Z

<p>Een: </p> <hr /> <div>== About yaku (card combinations) ==<br /> <br /> You can use the '''in game help icon''' to display a popup listing all the possible yaku and how many points they are worth. <br /> <br /> All the yaku are '''combinative''', except the &quot;Bright&quot; cards yaku, which are exclusive (you will always score the biggest available).<br /> <br /> == About multipliers ==<br /> <br /> As is often the case with traditional games, there is a lot of variants for playing Koi-koi, especially in regards to scoring.<br /> <br /> For Board Game Arena, two variants are provided through the options when creating the game:<br /> * '''Soft &quot;Koi!&quot;''' is a variant adapted from [http://www.sloperama.com/hanafuda/rules.html the Sloperama site rules] which is all about saying &quot;Koi!&quot;. Of course you run the risk of your opponent making a yaku and scoring for the month (round) before you can score yourself, but in exchange for that risk, each time you will get '''a multiplier''' so that if you manage to increase your score with another yaku, you will score a lot more. Also, a starting multiplier will be set for the month if some &quot;Bright cards&quot; have been drawn for the field when dealing for the month. So this is an aggressive variant with a lot of points available if you push your luck.<br /> * '''Hard &quot;Koi!&quot;''' is a variant adapted from [https://web.archive.org/web/20120421175954/http://hanafubuki.org/koikoi.html the Hanafubuki site rules] which is less incitative to call &quot;Koi!&quot; since you won't get a multiplier just for saying &quot;Koi!&quot;. Instead, '''your opponent''' will! If you say &quot;Koi!&quot; at least once, then if your opponent manages to score his score will be doubled. Still, at some point you'll risk it, because if you manage to improve your yaku to score 7 points or more, then '''your score''' will be doubled.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelpkoikoi&diff=1759 2016-02-01T17:15:54Z

<p>Een: </p> <hr /> <div>== About yaku (card combinations) ==<br /> <br /> You can use the '''in game help icon''' to display a popup listing all the possible yaku and how many points they are worth. <br /> <br /> All the yaku are '''combinative''', except the &quot;Bright&quot; cards yaku, which are exclusive (you will always score the biggest available).<br /> <br /> == About multipliers ==<br /> <br /> As is often the case with traditional games, there is a lot of variants for playing Koi-koi, especially in regards to scoring.<br /> <br /> For Board Game Arena, two variants are provided through the options when creating the game:<br /> * Soft &quot;Koi!&quot; is a variant adapted from [http://www.sloperama.com/hanafuda/rules.html the Sloperama site rules] which is all about saying &quot;Koi!&quot;. Of course you run the risk of your opponent making a yaku and scoring for the month (round) before you can score yourself, but in exchange for that risk, each time you will get '''a multiplier''' so that if you manage to increase your score with another yaku, you will score a lot more. Also, a starting multiplier will be set for the month if some &quot;Bright cards&quot; have been drawn for the field when dealing for the month. So this is an aggressive variant with a lot of points available if you push your luck.<br /> * Hard &quot;Koi!&quot; is a variant adapted from [https://web.archive.org/web/20120421175954/http://hanafubuki.org/koikoi.html the Hanafubuki site rules] which is less incitative to call &quot;Koi!&quot; since you won't get a multiplier just for saying &quot;Koi!&quot;. Instead, '''your opponent''' will! If you say &quot;Koi!&quot; at least once, then if your opponent manages to score his score will be doubled. Still, at some point you'll risk it, because if you manage to improve your yaku to score 7 points or more, then '''your score''' will be doubled.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelpkoikoi&diff=1758 2016-02-01T14:44:58Z

<p>Een: Created page with &quot;== About yaku (card combinations) == You can use the &#039;&#039;&#039;in game help icon&#039;&#039;&#039; to display a popup listing all the possible yaku and how many points they are worth. All the ya...&quot;</p> <hr /> <div>== About yaku (card combinations) ==<br /> <br /> You can use the '''in game help icon''' to display a popup listing all the possible yaku and how many points they are worth. <br /> <br /> All the yaku are '''combinative''', except the &quot;Bright&quot; cards yaku, which are exclusive (you will always score the biggest available).<br /> <br /> == About multipliers ==<br /> <br /> As is often the case with traditional games, there is a lot of variants for playing Koi-koi, especially in regards to scoring.<br /> <br /> For Board Game Arena, two variants are provided through the options when creating the game:<br /> * Soft &quot;Koi!&quot; is a variant adapted from [http://www.sloperama.com/hanafuda/rules.html the Sloperama site rules] which is all about saying &quot;Koi!&quot;. Of course you run the risk of your opponent making a yaku and scoring for the month (round) before you can score yourself, but in exchange for that risk, you get '''a multiplier''' so that if you manage to increase your score with another yaku, you will score a lot more. Also, a starting multiplier will be set for the month if some &quot;Bright cards&quot; have been drawn for the field when dealing for the month. So this is an aggressive variant with a lot of points available if you push your luck.<br /> * Hard &quot;Koi:&quot; is a variant adapted from [https://web.archive.org/web/20120421175954/http://hanafubuki.org/koikoi.html the Hanafubuki site rules] which is less incitative to call &quot;Koi!&quot; since you won't get a multiplier just for saying &quot;Koi!&quot;. Instead, '''your opponent''' will! If you say &quot;Koi!&quot; at least once, then if your opponent manages to score his score will be doubled. Still, at some point you'll risk it, because if you manage to improve your yaku to score 7 points or more, then '''your score''' will be doubled.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Your_game_mobile_version&diff=1719 2015-12-27T12:05:13Z

<p>Een: </p> <hr /> <div><br /> Board Game Arena is now adaptated for Mobiles and Tablets too.<br /> <br /> It is very easy to have a mobile version of the game you developed with BGA Studio. In fact, your game is probably already 100% playable on mobile.<br /> <br /> However, to provide your players the best experience, you should follow the 2 advices below.<br /> <br /> <br /> == Declare your interface minimum width ==<br /> <br /> By default, your game can run in an window up to 740 pixels width. Considering the informations of the right column (player's panel), it fits on a 1024px wide screen.<br /> <br /> However, you can choose to declare that your game is able to run with a smaller width. This way, the game will appear much better on mobile and tablets.<br /> <br /> For example, Reversi board is only 540px wide. If we stay with the default width (740px), the game interface displayed on mobile will be too large and some space will be lost on the left and on the right. Consequently the Reversi board is going to appear very small on the mobile screen, and players will have to &quot;pinch &amp; zoom&quot; to display it correctly.<br /> <br /> To avoid that, we can specify that the game can be played with an interface with a minimum width of 540 pixels, by adding the following to gameinfos.inc.php :<br /> <br /> <br /> // Game interface width range (pixels)<br /> // Note: game interface = space on the left side, without the column on the right<br /> 'game_interface_width' =&gt; array(<br /> <br /> // Minimum width<br /> // default: 760<br /> // maximum possible value: 760 (ie: your game interface should fit with a 760px width (correspond to a 1024px screen)<br /> // minimum possible value: 320 (the lowest value you specify, the better the display is on mobile)<br /> 'min' =&gt; 540,<br /> <br /> // Maximum width<br /> // default: null (ie: no limit, the game interface is as big as the player's screen allows it).<br /> // maximum possible value: unlimited<br /> // minimum possible value: 760<br /> 'max' =&gt; null<br /> ),<br /> <br /> <br /> And that's it! Now, BGA can choose the better display for your game interface, whatever the device.<br /> <br /> '''Important'''<br /> <br /> If you declare that your interface can run with a 540 pixels width, it must effectively run on an interface with 540 pixels width.<br /> <br /> Note that this doesn't mean that your interface must ALWAYS be 540 pixels width: you just have to make your interface fluid and/or to use CSS media query to fit in any width.<br /> <br /> Examples :<br /> <br /> * On Can't Stop, when the screen is too wide, we move the dices on another position (below the main board) to fit in the width :<br /> <br /> @media only screen and (max-width: 990px) {<br /> <br /> #dicechoices {<br /> left: 180px;<br /> top: 530px;<br /> }<br /> #cantstop_wrap {<br /> height: 900px;<br /> width: 550px;<br /> }<br /> }<br /> <br /> * On Seasons, we have some panels on the right of the board. On small screens, we display these panels below the board:<br /> <br /> <br /> @media only screen and (max-width: 970px) {<br /> <br /> #board {<br /> float: none;<br /> margin: auto;<br /> }<br /> .seasons_rightpanel {<br /> margin-left: 0px;<br /> }<br /> <br /> }<br /> <br /> <br /> Tip: on mobile, BGA displays player panels at the top of the page (instead of displaying them on the right). When doing this, BGA applies the CSS class &quot;mobile_version&quot; to the root HTML element. If you want you can use this CSS &quot;mobile_version&quot; class to optimize some of your game adaptations to this change.<br /> <br /> == Touchscreen compatibility ==<br /> <br /> Most of your games should work with touchscreen devices without needing any changes.<br /> <br /> Note: when your game is running on a touchscreen device, the global CSS class &quot;touch-device&quot; is added to the root HTML element (and &quot;notouch-device&quot; is added for the opposite).<br /> <br /> What may not work :<br /> * &quot;:hover&quot; CSS switch. Because there is no mouse, &quot;:hover&quot; won't be triggered. This is not an issue unless it is needed to play the game. In addition, some touch devices consider that a short touch must trigger a &quot;:hover&quot; (and should apply corresponding CSS), which can block an interaction in your game. We advise you to explicitely disable &quot;:hover&quot; effects when your game is running on a touchscreen device.<br /> * Mouseover events : like the previous one : if you associated Javascript events to &quot;onmouseover&quot; event, it won't work on tablets.<br /> * Drag'n'drop : it won't work. To make it work, you should listen to &quot;ontouchstart&quot;, &quot;ontouchmove&quot; and &quot;ontouchend&quot; event and trigger the same logic you already have for &quot;onmousedown&quot;, &quot;onmousemove&quot; and &quot;onmouseup&quot;. You should also make sure to stop the Javascript &quot;ontouchmove&quot; event (ex: dojo.stopEvent( evt ) ) during the drag n drop, otherwise the interface is going to scroll while drag'n'dropping.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Your_game_mobile_version&diff=1718 2015-12-27T11:30:35Z

<p>Een: </p> <hr /> <div><br /> Board Game Arena is now adaptated for Mobiles and Tablets too.<br /> <br /> It is very easy to have a mobile version of the game you developed with BGA Studio. In fact, your game is probably already 100% playable on mobile.<br /> <br /> However, to provide your players the best experience, you should follow the 2 advices below.<br /> <br /> <br /> == Declare your interface minimum width ==<br /> <br /> By default, your game can run in an window up to 740 pixels width. Considering the informations of the right column (player's panel), it fits on a 1024px wide screen.<br /> <br /> However, you can choose to declare that your game is able to run with a smaller width. This way, the game will appear much better on mobile and tablets.<br /> <br /> For example, Reversi board is only 540px wide. If we stay with the default width (740px), the game interface displayed on mobile will be too large and some space will be lost on the left and on the right. Consequently the Reversi board is going to appear very small on the mobile screen, and players will have to &quot;pinch &amp; zoom&quot; to display it correctly.<br /> <br /> To avoid that, we can specify that the game can be played with an interface with a minimum width of 540 pixels, by adding the following to gameinfos.inc.php :<br /> <br /> <br /> // Game interface width range (pixels)<br /> // Note: game interface = space on the left side, without the column on the right<br /> 'game_interface_width' =&gt; array(<br /> <br /> // Minimum width<br /> // default: 760<br /> // maximum possible value: 760 (ie: your game interface should fit with a 760px width (correspond to a 1024px screen)<br /> // minimum possible value: 320 (the lowest value you specify, the better the display is on mobile)<br /> 'min' =&gt; 540,<br /> <br /> // Maximum width<br /> // default: null (ie: no limit, the game interface is as big as the player's screen allows it).<br /> // maximum possible value: unlimited<br /> // minimum possible value: 760<br /> 'max' =&gt; null<br /> ),<br /> <br /> <br /> And that's it! Now, BGA can choose the better display for your game interface, whatever the device.<br /> <br /> '''Important'''<br /> <br /> If you declare that your interface can run with a 540 pixels width, it must effectively run on an interface with 540 pixels width.<br /> <br /> Note that it doesn't mean that your interface must ALWAYS be 540 pixels width : you just have to make your interface fluid and/or to use CSS media query to fit in any width.<br /> <br /> Examples :<br /> <br /> * On Can't Stop, when the screen is too wide, we move the dices on another position (below the main board) to fit in the width :<br /> <br /> @media only screen and (max-width: 990px) {<br /> <br /> #dicechoices {<br /> left: 180px;<br /> top: 530px;<br /> }<br /> #cantstop_wrap {<br /> height: 900px;<br /> width: 550px;<br /> }<br /> }<br /> <br /> * On Seasons, we have some panels on the right of the boards. On small screen, we display these panels below :<br /> <br /> <br /> @media only screen and (max-width: 970px) {<br /> <br /> #board {<br /> float: none;<br /> margin: auto;<br /> }<br /> .seasons_rightpanel {<br /> margin-left: 0px;<br /> }<br /> <br /> }<br /> <br /> <br /> Tips : on mobile, BGA displays players' panels at the top of the page (instead of displaying them on the right). When doing this, BGA applies the CSS class &quot;mobile_version&quot; to the root HTML element. If you want you can use this CSS &quot;mobile_version&quot; class to synchronize some of your game adaptations to this change.<br /> <br /> == Touchscreen compatibility ==<br /> <br /> Most of your game should work with touchscreen device.<br /> <br /> Note : When your game is running on a touchscreen device, the global CSS class &quot;touch-device&quot; is added to the root HTML element (and &quot;notouch-device&quot; is added in the contrary).<br /> <br /> What may not work :<br /> * &quot;:hover&quot; CSS switch. Because there is no mouse, &quot;:hover&quot; won't be triggered. This is not an issue unless it is needed to play the game. In addition, some touch device considers that a short touch must trigger a &quot;:hover&quot; (and should apply corresponding CSS), which can block an interaction in your game. We advise you to explicitely disable &quot;:hover&quot; effects when your game is running on a touchscreen device.<br /> * Mouseover events : like the previous one : if you associated Javascript events to &quot;onmouseover&quot; event, it won't work on tablets.<br /> * Drag'n'drop : it won't work. To make it work, you should listen to &quot;ontouchstart&quot;, &quot;ontouchmove&quot; and &quot;ontouchend&quot; event and trigger the same logic you already have for &quot;onmousedown&quot;, &quot;onmousemove&quot; and &quot;onmouseup&quot;. You should also make sure to stop the Javascript &quot;ontouchmove&quot; event (ex: dojo.stopEvent( evt ) ) during the drag n drop, otherwise the interface is going to scroll while drag'n'droping.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Game_database_model:_dbmodel.sql&diff=1581 2015-07-26T09:19:51Z

<p>Een: </p> <hr /> <div>In this file you specify the database schema of your game.<br /> <br /> This file contains SQL queries that will be executed during the creation of your game table.<br /> <br /> '''Note:''' you can't change the database schema during the game.<br /> <br /> == Create your schema ==<br /> <br /> To build this file, we recommend you to build the tables you need with the PhpMyAdmin tool (see BGA user guide), and then to export them and to copy/paste the content inside this file.<br /> <br /> '''Note:''' you must not use for a column the same name as for the table, as the framework replay function relies on regexp substitution to save/restore a previous state in a clone table with another name.<br /> <br /> == Default tables ==<br /> <br /> Important: by default, BGA creates 4 tables for your game: global, stats, gamelog, and player.<br /> <br /> You must not modify the schema of global, stats and gamelog tables (and you must not access them directly with SQL queries in your PHP code).<br /> <br /> You may add columns to &quot;player&quot; table. This is very practical to add simple values associated with players.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> ALTER TABLE `player` ADD `player_reserve_size` SMALLINT UNSIGNED NOT NULL DEFAULT '7';<br /> &lt;/pre&gt;<br /> <br /> For your information, the useful columns of default &quot;player&quot; table are:<br /> * player_no: the index of player in natural playing order.<br /> * player_id<br /> * player_name: (note: you should better access this date with getActivePlayerName() or loadPlayersBasicInfos() methods)<br /> * player_score: the current score of the player (displayed in the player panel). You must update this field to update player's scores.<br /> * player_score_aux: the secondary score, used as a tie breaker. You must update this field according to tie breaking rules of the game (see also: [[Main_game_logic:_yourgamename.game.php#Manage_player_scores_and_Tie_breaker|Manage_player_scores_and_Tie_breaker]])<br /> <br /> == CREATE TABLES ==<br /> you can create tables, using engine InnoDB<br /> &lt;pre&gt;<br /> CREATE TABLE IF NOT EXISTS `hands` <br /> (<br /> `id` INT(10) UNSIGNED NOT NULL AUTO_INCREMENT, <br /> `player_id` TINYINT(1) NOT NULL,<br /> `1` BOOL NOT NULL DEFAULT 1, <br /> `2` BOOL NOT NULL DEFAULT 1, <br /> `3` BOOL NOT NULL DEFAULT 1, <br /> `4` BOOL NOT NULL DEFAULT 1, <br /> `5` BOOL NOT NULL DEFAULT 1, <br /> `6` BOOL NOT NULL DEFAULT 1, <br /> `7` BOOL NOT NULL DEFAULT 1, <br /> PRIMARY KEY (`id`)<br /> ) ENGINE=InnoDB DEFAULT CHARSET=utf8 AUTO_INCREMENT=1 ;<br /> &lt;/pre&gt;<br /> <br /> '''Note''': if you put comments, you cannot do it in same line than code,<br /> &lt;pre&gt;<br /> `3` BOOL NOT NULL DEFAULT 1, -- activated or not<br /> &lt;/pre&gt;<br /> <br /> will comment also starting from `3` BOOL, and code will not be taken into account.<br /> <br /> == Link ==<br /> You can add your Db inits in function SetupNewGame() from file 'gamename.game.php'<br /> <br /> == Errors Log ==<br /> To trace Database creation check the logs that you can access in /admin/studio.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Css_Customization&diff=1570 2015-07-07T20:12:59Z

<p>Een: /* Sharing customization */</p> <hr /> <div><br /> This feature allows you to customize Board Game Arena with some CSS.<br /> <br /> = Why this feature? =<br /> <br /> At first, because this is cool :)<br /> <br /> Then, a lot of players told us that BGA should look better, and we constantly tried to make it look much better. But as it is a community-based website, we found out that we should allow YOU to participate. So this is why you can customize BGA appearance and share your customization with others.<br /> <br /> <br /> = How does it work? =<br /> <br /> From your account preferences, &quot;advanced&quot; tab, you can write some CSS. As soon as you click on &quot;save&quot;, it is integrated to BGA CSS for your account.<br /> <br /> You should use your browser developer tools (F12 on Chrome and Firefox) to get the ids/classes of the element that you want to change, and try to change them with these tools first. Finally, you can copy/paste your updates on the CSS customization form.<br /> <br /> = What is CSS ? =<br /> <br /> Well... if you don't know what CSS is, sorry but you shouldn't try to customize BGA appearance with this tool.<br /> <br /> = Reset CSS =<br /> <br /> Just above the CSS customization form, there is a link to reset all your changes and get back to the normal BGA. Please '''bookmark this link''' before doing any change to your CSS code. If you break the website by any manner, you'll be able to restore the original BGA instantly.<br /> <br /> = Modify images =<br /> <br /> Most of the images on BGA are loaded through &quot;background-image&quot; CSS command. This way, you can update it and load any image. You can host image on any server, or on a website like [http://imgur.com/ imgur].<br /> <br /> = Sharing customization =<br /> <br /> Using the link above the CSS customization form, you can share your customization with anyone.<br /> <br /> Please DO NOT send a link that breaks the website. If we detect some attempt to fool users, we will immediately take action against you.<br /> <br /> = Troubleshooting =<br /> <br /> == The CSS code I wrote is not taken into account ==<br /> <br /> At first, check the sourcecode of the BGA page. If your CSS code does not appear there, then the most probable reason is that you did a syntax error in your CSS code, so we didn't take a part of your code into account.<br /> <br /> If it appears, then it should be an error in one of your declaration (ex: wrong #id).</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Css_Customization&diff=1569 2015-07-07T20:11:42Z

<p>Een: /* Modify images */</p> <hr /> <div><br /> This feature allows you to customize Board Game Arena with some CSS.<br /> <br /> = Why this feature? =<br /> <br /> At first, because this is cool :)<br /> <br /> Then, a lot of players told us that BGA should look better, and we constantly tried to make it look much better. But as it is a community-based website, we found out that we should allow YOU to participate. So this is why you can customize BGA appearance and share your customization with others.<br /> <br /> <br /> = How does it work? =<br /> <br /> From your account preferences, &quot;advanced&quot; tab, you can write some CSS. As soon as you click on &quot;save&quot;, it is integrated to BGA CSS for your account.<br /> <br /> You should use your browser developer tools (F12 on Chrome and Firefox) to get the ids/classes of the element that you want to change, and try to change them with these tools first. Finally, you can copy/paste your updates on the CSS customization form.<br /> <br /> = What is CSS ? =<br /> <br /> Well... if you don't know what CSS is, sorry but you shouldn't try to customize BGA appearance with this tool.<br /> <br /> = Reset CSS =<br /> <br /> Just above the CSS customization form, there is a link to reset all your changes and get back to the normal BGA. Please '''bookmark this link''' before doing any change to your CSS code. If you break the website by any manner, you'll be able to restore the original BGA instantly.<br /> <br /> = Modify images =<br /> <br /> Most of the images on BGA are loaded through &quot;background-image&quot; CSS command. This way, you can update it and load any image. You can host image on any server, or on a website like [http://imgur.com/ imgur].<br /> <br /> = Sharing customization =<br /> <br /> Using the link above the CSS customization form, you can share your customization with anyone.<br /> <br /> Please DO NOT send a link that break the website. If we detect some attempt to fool users, we will immediately take action against you.<br /> <br /> = Troubleshooting =<br /> <br /> == The CSS code I wrote is not taken into account ==<br /> <br /> At first, check the sourcecode of the BGA page. If your CSS code does not appear there, then the most probable reason is that you did a syntax error in your CSS code, so we didn't take a part of your code into account.<br /> <br /> If it appears, then it should be an error in one of your declaration (ex: wrong #id).</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Css_Customization&diff=1568 2015-07-07T20:10:38Z

<p>Een: /* How it works? */</p> <hr /> <div><br /> This feature allows you to customize Board Game Arena with some CSS.<br /> <br /> = Why this feature? =<br /> <br /> At first, because this is cool :)<br /> <br /> Then, a lot of players told us that BGA should look better, and we constantly tried to make it look much better. But as it is a community-based website, we found out that we should allow YOU to participate. So this is why you can customize BGA appearance and share your customization with others.<br /> <br /> <br /> = How does it work? =<br /> <br /> From your account preferences, &quot;advanced&quot; tab, you can write some CSS. As soon as you click on &quot;save&quot;, it is integrated to BGA CSS for your account.<br /> <br /> You should use your browser developer tools (F12 on Chrome and Firefox) to get the ids/classes of the element that you want to change, and try to change them with these tools first. Finally, you can copy/paste your updates on the CSS customization form.<br /> <br /> = What is CSS ? =<br /> <br /> Well... if you don't know what CSS is, sorry but you shouldn't try to customize BGA appearance with this tool.<br /> <br /> = Reset CSS =<br /> <br /> Just above the CSS customization form, there is a link to reset all your changes and get back to the normal BGA. Please '''bookmark this link''' before doing any change to your CSS code. If you break the website by any manner, you'll be able to restore the original BGA instantly.<br /> <br /> = Modify images =<br /> <br /> Most of images on BGA are loaded through &quot;background-image&quot; CSS command. This way, you can update it and load any image. You can host image on any server, or on a website like [http://imgur.com/ imgur].<br /> <br /> <br /> = Sharing customization =<br /> <br /> Using the link above the CSS customization form, you can share your customization with anyone.<br /> <br /> Please DO NOT send a link that break the website. If we detect some attempt to fool users, we will immediately take action against you.<br /> <br /> = Troubleshooting =<br /> <br /> == The CSS code I wrote is not taken into account ==<br /> <br /> At first, check the sourcecode of the BGA page. If your CSS code does not appear there, then the most probable reason is that you did a syntax error in your CSS code, so we didn't take a part of your code into account.<br /> <br /> If it appears, then it should be an error in one of your declaration (ex: wrong #id).</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Faq&diff=1517 2015-04-28T20:46:56Z

<p>Een: /* Issues with BGA */</p> <hr /> <div>[[Category:Help]]<br /> <br /> == General questions ==<br /> <br /> ===What is Board Game Arena?===<br /> <br /> Board Game Arena (BGA) is an online board game platform. With BGA, you can play online and in real time against players from the whole world. A selection of various board games and card games is available. In order to play, the only thing you need is your browser!<br /> <br /> ===What do you mean by &quot;real time play&quot;?===<br /> <br /> On Board Game Arena your opponents are connected to the game platform during the entire game. They can see your moves and react to them immediately - as is the case in the real world.<br /> <br /> ===What is &quot;turn based play&quot;?===<br /> <br /> This is often referred to as &quot;asynchronous play&quot; on other sites, and is used here to differentiate from &quot;real time play&quot;. Instead of all players being around the table at the same time, players leave and come back. After your opponent takes a move you are notified that it is your turn (via email or on your next visit to the site). You then go to your game, take your turn, and the process repeats for the next player.<br /> <br /> For details please read [[Turn based FAQ]].<br /> <br /> ===What do I need to play?===<br /> <br /> Your browser ... and that's it!<br /> <br /> Board Game Arena does not require anything else on your computer. Thus, you can play from any computer, anywhere, anytime!<br /> <br /> In order to make this possible we are using the latest technologies available for the web. This is the reason you should play with the most up to date web browsers to enjoy an optimal BGA experience (read more about our [[Browser_support|browser policy]]).<br /> <br /> ===How much does it cost to play on BGA?===<br /> <br /> Playing on BGA is free.<br /> <br /> You can also choose to help us by making a donation and becoming a [http://en.boardgamearena.com/#!club Board Game Arena club] member.<br /> <br /> <br /> ===What are the games available on BGA?===<br /> <br /> Board Game Arena offers a various selection of board and card games, but specializes in modern (&quot;European style&quot;) adult games.<br /> <br /> [http://en.boardgamearena.com/#!gamelist See available games].<br /> <br /> == Meeting players and starting games ==<br /> <br /> ===I launched a new table but nobody is joining?===<br /> <br /> For the most popular games you can find players at any time of the day. For other games we advise you to come back at peak hour (around 22:00 CEST) if you can't find opponents at the moment.<br /> <br /> Tip: check the number of online/available players for a game before launching the table.<br /> <br /> Tip: if nobody is available for a realtime game, you can turn your table into a turn-based table, so another player can join even hours/days after you created it.<br /> <br /> ===I joined a game. When does the game start?===<br /> <br /> '''For realtime games''':<br /> <br /> Each table has an administrator, which is the table creator. It is the responsibility of the table administrator to start the game when he is satisfied with the number of players having joined the table.<br /> <br /> If you are the table administrator and can't launch the game, most of the time it's because there is not yet enough players joined the table.<br /> <br /> <br /> '''For turnbased games''':<br /> <br /> The game starts as soon as the maximum number of players has been reached. The table administrator can also starts the game manually if the minimum number of required players has been reached.<br /> <br /> ===What is the meaning of the small color circle next to players names?===<br /> <br /> * http://fr.boardgamearena.com/theme/img/status/online_.png : this player is active. He completed an action very recently.<br /> * http://fr.boardgamearena.com/theme/img/status/inactive_.png : this player is inactive. He is connected to the website but did not perform any action recently.<br /> * http://fr.boardgamearena.com/theme/img/status/offline_.png : this player is offline.<br /> <br /> <br /> ===What does the '% hits' statistic mean?===<br /> % hits = number of victory points / number of games played<br /> <br /> Where number of victory points is the following:<br /> * When you win a 2 players game: 1 point.<br /> * When you win a 3 players game: 1.5 points.<br /> * When you win a 4 players game: 2 points.<br /> * etc.<br /> <br /> This way, &quot;50%&quot; means that you win 50% of 2 players game, or 33% of 3 players game, etc.<br /> <br /> <br /> <br /> == During the game ==<br /> <br /> ===What is the meaning of the icons next to players names?===<br /> <br /> * http://fr.boardgamearena.com/theme/img/layout/active_player.gif : this player must make a move now.<br /> * http://fr.boardgamearena.com/theme/img/layout/active_player_clockalert.gif : this player must make a move now, and he has spent his reflexion time. Can someone wake him up? ;)<br /> * http://fr.boardgamearena.com/theme/img/layout/active_player_nonack.gif : this player must make a move now, but is probably not aware of the fact. If the situation does not evolve, it might be that this player has some connection issue.<br /> * http://fr.boardgamearena.com/theme/img/common/zombie.png : this player is a &quot;zombie&quot; (he left the game or has been fired from the game). The game goes on without this player.<br /> <br /> When the &quot;normal&quot; avatar of a player is displayed, it means that this player is waiting for his turn to play.<br /> <br /> <br /> ===A player has to make a move but he/she doesn't. What can I do?===<br /> <br /> * First, please remember that this player has the right to think as long as he needs to about the next move... well as long as he still has some time left on the game clock, that is.<br /> * Then you can ask this player to confirm that he is still thinking about how to play.<br /> * If this player seems to be away, we advise you to wait a few minutes: this player may be experiencing some network problems or have left his computer temporarily.<br /> * If the player is not coming back, you can skip his turn as soon as his clock is negative. He will get a &quot;leave&quot; penalty and you will will &quot;by forfeit&quot;.<br /> <br /> For more details, please read [[Game clock]].<br /> <br /> ===What is the current progression of the game I'm playing?===<br /> <br /> A percentage of progression is displayed on the top of the web page.<br /> There is also a progress bar at the bottom of the web page shows you the current progression of the game.<br /> <br /> <br /> ===What is forbidden on Board Game Arena?===<br /> <br /> * Leaving a game in progress on purpose.<br /> * Taking an unnecessary and unreasonable amount of time at the end of game in an obvious losing situation.<br /> * Kingmaking: enabling another player to win on purpose while there is a better move to make for yourself.<br /> * Running out of time on the game clock.<br /> * Giving some piece of information about the current game situation that corrupts the normal game flow.<br /> * Communicating with another player about the game privately (ex: with MSN).<br /> * Provocation / triumphalism / defeatism ... anything which is not fair play.<br /> * Having a shocking avatar (no advertisement, no politics, ...)<br /> <br /> Going against these rules will affect your reputation.<br /> <br /> <br /> ===What is absolutely forbidden in Board Game Arena?===<br /> <br /> * Creating multiple accounts and playing against oneself.<br /> * Insulting other players in any manner.<br /> <br /> Going against these rules can lead to the removal of your account and/or to the blacklisting of your IP.<br /> <br /> <br /> ===What if some player does something wrong?===<br /> <br /> The Board Game Arena platform has been designed to encourage players to maintain good behavior. The reputation system allows you to distinguish between good and bad players. Then, it is up to you to decide whether to start a game with them or not.<br /> <br /> If you think a player has behaved badly during a game, you can give him a &quot;red thumb&quot; at the end of the game.<br /> <br /> If you think a player has committed a serious wrongdoing during a game (ex: insult), please report this player to us, using the &quot;report this player&quot; link from his profile or game result page, so that we can take appropriate measures.<br /> <br /> == Tournaments ==<br /> <br /> Tournaments is a BETA feature of BGA (for a long time).<br /> <br /> Tournament management is very complex. We'd like to open tournament creation to everyone at some time in the future but it need a lot of work and until then we always had something more urgent to do.<br /> <br /> When tournaments will be improved, this FAQ section will be improved too.<br /> <br /> <br /> == About board games we proposed on BGA ==<br /> <br /> <br /> ===What is the legal status of this website?===<br /> <br /> All the games currently available on this site have been licensed or otherwise authorized by copyright holders. Please be aware that games available on BGA can be removed at the copyright holders demand (for example: if they publish their own adaptation of the game).<br /> <br /> Board Game Arena would like to thank all game publishers and game designers who allow us to have their games here, thus making it possible for this website to exist.<br /> <br /> === How do we select games that are on BGA? Why the game XXX is not on BGA? ===<br /> <br /> To have a game published on BGA we need 2 things:<br /> * The authorization of the rights owner (most of the time: original publisher of the game).<br /> * A software developer who develops the adaptation (ie: has some time available to develop it).<br /> <br /> We (= BGA team) are trying a lot of board games ourselves. Sometimes we are lucky enough to play prototypes too. And of course we receive a lot of game suggestions through the BGA forum, the BoardGameGeek &quot;most wanted games&quot; list, or by any other means. Based on this we are asking game publishers for authorizations, and sometimes we also receive requests directly from game publishers - there is no rule.<br /> <br /> As it is today, BGA has a very good reputation and very productive relationships with almost all major board game publishers, but this is not enough: each situation is specific, and there can be various reasons why a game publisher can refuse to see a game adaptation on BGA (for example: board games with a third party licence, like &quot;Star Wars&quot;, is practically impossible to negotiate).<br /> <br /> On the other hand, we got some authorizations for some very good games but no developers volunteering to develop them, or sometimes some of them don't manage to finish the job. Developers of adaptations are volunteers, and we don't blame them for this.<br /> <br /> Finally, some games are authorized and being developed, but the time frame is not good. For example, it happened that we had too many games to release and we decided to delay some of them. It also frequently happens that we must synchronize the release of a game with a publisher event, so the game adaptation can stay &quot;on hold&quot; for some months.<br /> <br /> So if you are asking yourself: why game XXX is not on BGA, it could be for various reasons:<br /> * Maybe we never asked authorization for this game. Note that usually we ask authorizations for every popular games (ex: &quot;Most wanted games&quot;). So if the game is popular, the reason is probably not this one.<br /> * The publisher refused.<br /> * The publisher accepted, but we didn't find a developer until now for this game.<br /> * The game adaptation is ready, but we are waiting for a specific event to release it.<br /> <br /> <br /> To conclude: yes we are taking into account your suggestions, but as you can see there are many factors than can influence the fact that a game is (or is not) on BGA. In addition, as a rule of thumb, we don't communicate about &quot;why&quot; this game is not on BGA. If we already got the authorization, we want to keep the &quot;surprise&quot;, and if we didn't get the authorization, the game publisher may not want to explain the reasons.<br /> <br /> === Are you taking into account the &quot;Most wanted games&quot; list? When will these games be on BGA? ===<br /> <br /> You should read first the previous section (&quot;how do we select games that are on BGA?&quot;).<br /> <br /> So the answer is:<br /> * Yes, we are taking this list into account.<br /> * For most of these games we already asked for authorizations.<br /> * Some of these games won't be on BGA (authorization refused), some may be, some are in an &quot;intermediate&quot; step.<br /> * We don't communicate about future game releases anyway.<br /> <br /> === Why do some games have expansions on BGA and some don't? ===<br /> <br /> You should read first the previous section (&quot;how do we select games that are on BGA?&quot;).<br /> <br /> Game expansions follow the same steps than games. There can be various reasons why a game publisher doesn't want the expansion online, and sometimes we don't find a developer that has the time to develop it.<br /> <br /> ===I'm a game publisher: why would I like to have my game on Board Game Arena?===<br /> <br /> The main goal of Board Game Arena is to make it easy for people to discover and love new games. We think that there are only two kinds of players on Board Game Arena: those who already bought the games they are playing online, and those who plan to buy them soon!<br /> <br /> As the activity of this website contributes to increasing a game's popularity and thus generates hard copy sales in the &quot;real world&quot;, we think it is beneficial to the board game community: people from all over the world can play online, we can have fun developing this game platform to the best of our ability, and game publishers get money from the box sales and build a special relationship with their player's community.<br /> <br /> === I'm a game publisher: how to get my game on Board Game Arena ===<br /> <br /> At first, you just have to write us an email (contact (at) boardgamearena.com) with a description of your game(s).<br /> <br /> Then, we add this game to the list of &quot;available licences&quot; on our website dedicated to game developers ([http://studio.boardgamearena.com BGA Studio]).<br /> <br /> The most difficult part is to find a developer among our community. Our only requirement is that the developer must love the game. Of course, the most popular the game is, the easiest it is to find a volunteer developer. Sometimes it is very fast, sometimes it takes months, sometimes it never happens. We can't say in advance.<br /> <br /> It is also possible to find your own developer: of course it accelerates the process a lot!<br /> <br /> == Turn-based mode ==<br /> <br /> Please read [[Turn based FAQ]].<br /> <br /> == Issues with BGA ==<br /> <br /> ===What can I do if I have an issue with the website?===<br /> <br /> Most of the issues on this website should be solved with a simple web page refresh (or &quot;F5&quot;).<br /> <br /> If you experience persistent issues, you can browse the [http://boardgamearena.com/#!bugs bug tool], see if someone already reported the issue, and add a new bug report if that's not the case. Please take some time to describe the bug you are reporting in detail so that we can quickly reproduce and fix it.<br /> <br /> === Why is my bug still not fixed? ===<br /> <br /> We fix bugs every weeks. Of course we have priorities:<br /> * We give the highest priority to recent features and recent games, because the most important bugs are reported fast.<br /> * We give the highest priority to the bugs with the biggest number of &quot;green thumb&quot; on the [http://boardgamearena.com/#!bugs bug tool].<br /> * Usually we fix bugs by group. So if we decide to fix an important bug on a game, there is a chance that we will fix 3 or 4 minor bugs at the same time.<br /> <br /> BGA is known for the quality of its adaptations, and if you look at the bug tool, you can see that -considering the number of games and the size of the community- there are not so many critical bugs with a lot of &quot;green thumbs&quot;.<br /> <br /> Please also note that BGA adaptations are realized by volunteers (even if most of them are also professional developers). It is not always easy for them to fix bugs, especially when some players are complaining violently and/or do not give precise information in bug reports.<br /> <br /> <br /> === I played on smartphone / tablet / touch device and I have some difficulties: what can I do? ===<br /> <br /> As a rule of thumb, BGA does not support tablets/smartphones. There are tons of board game adaptations for tablets/smartphones, and some BGA adaptations are not well designed for small screens. Thus, we don't have plans to do a mobile / tablet version at the moment.<br /> <br /> So if you want to use BGA from a smartphone / tablet you can, but we don't promise to fix all bugs so it's at your own risk :)<br /> <br /> <br /> === Why is BGA slow? Why do I have bad connections performances on BGA? ===<br /> <br /> We are constantly monitoring server responsiveness. Some incidents occurs, but most of the time BGA is responsive.<br /> <br /> We designed our game servers (ie: servers used when you are inside a game) to be very responsive. Usually, less than 2% of the game moves take more than 200 milliseconds to process, and less than 0.2% take more than 1 second.<br /> <br /> BGA servers are located in Europe (France), but we bought servers all across the world (19 locations) so that the big files (ex: images) are loaded fast even if you are far from us.<br /> <br /> Most of bad performances came from your internet connection or your system. Try to connect with a different browser / computer / internet connection to troubleshoot the issue.<br /> <br /> As a rule of thumb, is BGA is not responsive enough, you shouldn't engage yourself into a game because there is a risk for you to get clock penalties.<br /> <br /> === I got issue with a specific player: how does the moderation works? ===<br /> <br /> You should read [[Moderation and grades]] page.<br /> <br /> == Contribute to BGA ==<br /> <br /> === How can I contribute to BGA? ===<br /> <br /> Please visit page [http://boardgamearena.com/#!contribute Contribute to BGA].<br /> <br /> === I'm a software developer. What can I do? ===<br /> <br /> We created a website specifically dedicated to board games adaptation development: [http://studio.boardgamearena.com BGA Studio].<br /> <br /> == About the BGA team ==<br /> <br /> === Who are you? How to contact you? ===<br /> <br /> Please read page [[About us]].<br /> <br /> === How you guys make money? Do you make a living of it? ===<br /> <br /> Yes we still work aside, and yes there is a huge work to be done here everyday.<br /> <br /> There is essentially Club membership, but this is not enough. What we'd like to do is basically continue like this because we think this &quot;community based&quot; approach is the best for BGA.<br /> <br /> What we are trying to do, in addition, is to find a way to create a commercial activity in game portal development, distinct from BGA. This way we could have a flexible work with a source of revenue, distinct from BGA, that allows us to finance the time we spent on BGA.<br /> <br /> === Do you recruit? ===<br /> <br /> If we had enough money we would start by &quot;recruiting ourselves&quot; :)</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Faq&diff=1516 2015-04-28T20:41:49Z

<p>Een: /* How you guys make money? Do you make a living of it? */</p> <hr /> <div>[[Category:Help]]<br /> <br /> == General questions ==<br /> <br /> ===What is Board Game Arena?===<br /> <br /> Board Game Arena (BGA) is an online board game platform. With BGA, you can play online and in real time against players from the whole world. A selection of various board games and card games is available. In order to play, the only thing you need is your browser!<br /> <br /> ===What do you mean by &quot;real time play&quot;?===<br /> <br /> On Board Game Arena your opponents are connected to the game platform during the entire game. They can see your moves and react to them immediately - as is the case in the real world.<br /> <br /> ===What is &quot;turn based play&quot;?===<br /> <br /> This is often referred to as &quot;asynchronous play&quot; on other sites, and is used here to differentiate from &quot;real time play&quot;. Instead of all players being around the table at the same time, players leave and come back. After your opponent takes a move you are notified that it is your turn (via email or on your next visit to the site). You then go to your game, take your turn, and the process repeats for the next player.<br /> <br /> For details please read [[Turn based FAQ]].<br /> <br /> ===What do I need to play?===<br /> <br /> Your browser ... and that's it!<br /> <br /> Board Game Arena does not require anything else on your computer. Thus, you can play from any computer, anywhere, anytime!<br /> <br /> In order to make this possible we are using the latest technologies available for the web. This is the reason you should play with the most up to date web browsers to enjoy an optimal BGA experience (read more about our [[Browser_support|browser policy]]).<br /> <br /> ===How much does it cost to play on BGA?===<br /> <br /> Playing on BGA is free.<br /> <br /> You can also choose to help us by making a donation and becoming a [http://en.boardgamearena.com/#!club Board Game Arena club] member.<br /> <br /> <br /> ===What are the games available on BGA?===<br /> <br /> Board Game Arena offers a various selection of board and card games, but specializes in modern (&quot;European style&quot;) adult games.<br /> <br /> [http://en.boardgamearena.com/#!gamelist See available games].<br /> <br /> == Meeting players and starting games ==<br /> <br /> ===I launched a new table but nobody is joining?===<br /> <br /> For the most popular games you can find players at any time of the day. For other games we advise you to come back at peak hour (around 22:00 CEST) if you can't find opponents at the moment.<br /> <br /> Tip: check the number of online/available players for a game before launching the table.<br /> <br /> Tip: if nobody is available for a realtime game, you can turn your table into a turn-based table, so another player can join even hours/days after you created it.<br /> <br /> ===I joined a game. When does the game start?===<br /> <br /> '''For realtime games''':<br /> <br /> Each table has an administrator, which is the table creator. It is the responsibility of the table administrator to start the game when he is satisfied with the number of players having joined the table.<br /> <br /> If you are the table administrator and can't launch the game, most of the time it's because there is not yet enough players joined the table.<br /> <br /> <br /> '''For turnbased games''':<br /> <br /> The game starts as soon as the maximum number of players has been reached. The table administrator can also starts the game manually if the minimum number of required players has been reached.<br /> <br /> ===What is the meaning of the small color circle next to players names?===<br /> <br /> * http://fr.boardgamearena.com/theme/img/status/online_.png : this player is active. He completed an action very recently.<br /> * http://fr.boardgamearena.com/theme/img/status/inactive_.png : this player is inactive. He is connected to the website but did not perform any action recently.<br /> * http://fr.boardgamearena.com/theme/img/status/offline_.png : this player is offline.<br /> <br /> <br /> ===What does the '% hits' statistic mean?===<br /> % hits = number of victory points / number of games played<br /> <br /> Where number of victory points is the following:<br /> * When you win a 2 players game: 1 point.<br /> * When you win a 3 players game: 1.5 points.<br /> * When you win a 4 players game: 2 points.<br /> * etc.<br /> <br /> This way, &quot;50%&quot; means that you win 50% of 2 players game, or 33% of 3 players game, etc.<br /> <br /> <br /> <br /> == During the game ==<br /> <br /> ===What is the meaning of the icons next to players names?===<br /> <br /> * http://fr.boardgamearena.com/theme/img/layout/active_player.gif : this player must make a move now.<br /> * http://fr.boardgamearena.com/theme/img/layout/active_player_clockalert.gif : this player must make a move now, and he has spent his reflexion time. Can someone wake him up? ;)<br /> * http://fr.boardgamearena.com/theme/img/layout/active_player_nonack.gif : this player must make a move now, but is probably not aware of the fact. If the situation does not evolve, it might be that this player has some connection issue.<br /> * http://fr.boardgamearena.com/theme/img/common/zombie.png : this player is a &quot;zombie&quot; (he left the game or has been fired from the game). The game goes on without this player.<br /> <br /> When the &quot;normal&quot; avatar of a player is displayed, it means that this player is waiting for his turn to play.<br /> <br /> <br /> ===A player has to make a move but he/she doesn't. What can I do?===<br /> <br /> * First, please remember that this player has the right to think as long as he needs to about the next move... well as long as he still has some time left on the game clock, that is.<br /> * Then you can ask this player to confirm that he is still thinking about how to play.<br /> * If this player seems to be away, we advise you to wait a few minutes: this player may be experiencing some network problems or have left his computer temporarily.<br /> * If the player is not coming back, you can skip his turn as soon as his clock is negative. He will get a &quot;leave&quot; penalty and you will will &quot;by forfeit&quot;.<br /> <br /> For more details, please read [[Game clock]].<br /> <br /> ===What is the current progression of the game I'm playing?===<br /> <br /> A percentage of progression is displayed on the top of the web page.<br /> There is also a progress bar at the bottom of the web page shows you the current progression of the game.<br /> <br /> <br /> ===What is forbidden on Board Game Arena?===<br /> <br /> * Leaving a game in progress on purpose.<br /> * Taking an unnecessary and unreasonable amount of time at the end of game in an obvious losing situation.<br /> * Kingmaking: enabling another player to win on purpose while there is a better move to make for yourself.<br /> * Running out of time on the game clock.<br /> * Giving some piece of information about the current game situation that corrupts the normal game flow.<br /> * Communicating with another player about the game privately (ex: with MSN).<br /> * Provocation / triumphalism / defeatism ... anything which is not fair play.<br /> * Having a shocking avatar (no advertisement, no politics, ...)<br /> <br /> Going against these rules will affect your reputation.<br /> <br /> <br /> ===What is absolutely forbidden in Board Game Arena?===<br /> <br /> * Creating multiple accounts and playing against oneself.<br /> * Insulting other players in any manner.<br /> <br /> Going against these rules can lead to the removal of your account and/or to the blacklisting of your IP.<br /> <br /> <br /> ===What if some player does something wrong?===<br /> <br /> The Board Game Arena platform has been designed to encourage players to maintain good behavior. The reputation system allows you to distinguish between good and bad players. Then, it is up to you to decide whether to start a game with them or not.<br /> <br /> If you think a player has behaved badly during a game, you can give him a &quot;red thumb&quot; at the end of the game.<br /> <br /> If you think a player has committed a serious wrongdoing during a game (ex: insult), please report this player to us, using the &quot;report this player&quot; link from his profile or game result page, so that we can take appropriate measures.<br /> <br /> == Tournaments ==<br /> <br /> Tournaments is a BETA feature of BGA (for a long time).<br /> <br /> Tournament management is very complex. We'd like to open tournament creation to everyone at some time in the future but it need a lot of work and until then we always had something more urgent to do.<br /> <br /> When tournaments will be improved, this FAQ section will be improved too.<br /> <br /> <br /> == About board games we proposed on BGA ==<br /> <br /> <br /> ===What is the legal status of this website?===<br /> <br /> All the games currently available on this site have been licensed or otherwise authorized by copyright holders. Please be aware that games available on BGA can be removed at the copyright holders demand (for example: if they publish their own adaptation of the game).<br /> <br /> Board Game Arena would like to thank all game publishers and game designers who allow us to have their games here, thus making it possible for this website to exist.<br /> <br /> === How do we select games that are on BGA? Why the game XXX is not on BGA? ===<br /> <br /> To have a game published on BGA we need 2 things:<br /> * The authorization of the rights owner (most of the time: original publisher of the game).<br /> * A software developer who develops the adaptation (ie: has some time available to develop it).<br /> <br /> We (= BGA team) are trying a lot of board games ourselves. Sometimes we are lucky enough to play prototypes too. And of course we receive a lot of game suggestions through the BGA forum, the BoardGameGeek &quot;most wanted games&quot; list, or by any other means. Based on this we are asking game publishers for authorizations, and sometimes we also receive requests directly from game publishers - there is no rule.<br /> <br /> As it is today, BGA has a very good reputation and very productive relationships with almost all major board game publishers, but this is not enough: each situation is specific, and there can be various reasons why a game publisher can refuse to see a game adaptation on BGA (for example: board games with a third party licence, like &quot;Star Wars&quot;, is practically impossible to negotiate).<br /> <br /> On the other hand, we got some authorizations for some very good games but no developers volunteering to develop them, or sometimes some of them don't manage to finish the job. Developers of adaptations are volunteers, and we don't blame them for this.<br /> <br /> Finally, some games are authorized and being developed, but the time frame is not good. For example, it happened that we had too many games to release and we decided to delay some of them. It also frequently happens that we must synchronize the release of a game with a publisher event, so the game adaptation can stay &quot;on hold&quot; for some months.<br /> <br /> So if you are asking yourself: why game XXX is not on BGA, it could be for various reasons:<br /> * Maybe we never asked authorization for this game. Note that usually we ask authorizations for every popular games (ex: &quot;Most wanted games&quot;). So if the game is popular, the reason is probably not this one.<br /> * The publisher refused.<br /> * The publisher accepted, but we didn't find a developer until now for this game.<br /> * The game adaptation is ready, but we are waiting for a specific event to release it.<br /> <br /> <br /> To conclude: yes we are taking into account your suggestions, but as you can see there are many factors than can influence the fact that a game is (or is not) on BGA. In addition, as a rule of thumb, we don't communicate about &quot;why&quot; this game is not on BGA. If we already got the authorization, we want to keep the &quot;surprise&quot;, and if we didn't get the authorization, the game publisher may not want to explain the reasons.<br /> <br /> === Are you taking into account the &quot;Most wanted games&quot; list? When will these games be on BGA? ===<br /> <br /> You should read first the previous section (&quot;how do we select games that are on BGA?&quot;).<br /> <br /> So the answer is:<br /> * Yes, we are taking this list into account.<br /> * For most of these games we already asked for authorizations.<br /> * Some of these games won't be on BGA (authorization refused), some may be, some are in an &quot;intermediate&quot; step.<br /> * We don't communicate about future game releases anyway.<br /> <br /> === Why do some games have expansions on BGA and some don't? ===<br /> <br /> You should read first the previous section (&quot;how do we select games that are on BGA?&quot;).<br /> <br /> Game expansions follow the same steps than games. There can be various reasons why a game publisher doesn't want the expansion online, and sometimes we don't find a developer that has the time to develop it.<br /> <br /> ===I'm a game publisher: why would I like to have my game on Board Game Arena?===<br /> <br /> The main goal of Board Game Arena is to make it easy for people to discover and love new games. We think that there are only two kinds of players on Board Game Arena: those who already bought the games they are playing online, and those who plan to buy them soon!<br /> <br /> As the activity of this website contributes to increasing a game's popularity and thus generates hard copy sales in the &quot;real world&quot;, we think it is beneficial to the board game community: people from all over the world can play online, we can have fun developing this game platform to the best of our ability, and game publishers get money from the box sales and build a special relationship with their player's community.<br /> <br /> === I'm a game publisher: how to get my game on Board Game Arena ===<br /> <br /> At first, you just have to write us an email (contact (at) boardgamearena.com) with a description of your game(s).<br /> <br /> Then, we add this game to the list of &quot;available licences&quot; on our website dedicated to game developers ([http://studio.boardgamearena.com BGA Studio]).<br /> <br /> The most difficult part is to find a developer among our community. Our only requirement is that the developer must love the game. Of course, the most popular the game is, the easiest it is to find a volunteer developer. Sometimes it is very fast, sometimes it takes months, sometimes it never happens. We can't say in advance.<br /> <br /> It is also possible to find your own developer: of course it accelerates the process a lot!<br /> <br /> == Turn-based mode ==<br /> <br /> Please read [[Turn based FAQ]].<br /> <br /> == Issues with BGA ==<br /> <br /> ===What can I do if I have an issue with the website?===<br /> <br /> Most of the issues on this website should be solved with a simple web page refresh (or &quot;F5&quot;).<br /> <br /> If you experience persistent issues, you can browse the [http://boardgamearena.com/#!bugs bug tool], see if someone already reported the issue, and add a new bug report if that's not the case. Please take some time to describe the bug you are reporting in detail so that we can quickly reproduce and fix it.<br /> <br /> === Why is my bug still not fixed? ===<br /> <br /> We fix bugs every weeks. Of course we have priorities:<br /> * We give the highest priority to recent features and recent games, because the most important bugs are reported fast.<br /> * We give the highest priority to the bugs with the biggest number of &quot;green thumb&quot; on the [http://boardgamearena.com/#!bugs bug tool].<br /> * Usually we fix bugs by group. So if we decide to fix an important bug on a game, there is chance that we fix 3 or 4 minor bug at the same time.<br /> <br /> BGA is known for the quality of its adaptation, and if you look at the bug tool, you can see that -considering the number of games and the size of the community- there are not so much critical bugs with many &quot;green thumb&quot;.<br /> <br /> Please also note that BGA adaptations are realized by volunteers and not professional developers (even if most of them are also professional developers). This is not always easy for them to fix bugs, especially when some players are complaining violently and/or do not give precise information in bug reports.<br /> <br /> <br /> === I played on smartphone / tablet / touch device and I have some difficulties: what can I do? ===<br /> <br /> As a rule of thumb, BGA do not support tablet/smartphones. There are tons of board gamers adaptations for tablet/smartphones, and some BGA adaptations are not well designed for small screens. Thus, we don't have plan to do a mobile / tablet version at now.<br /> <br /> So if you want to use BGA from a smartphone / tablet you can, but we don't promise to fix all bugs so it's at your own risk :)<br /> <br /> <br /> === Why BGA is slow? Why do I have bad connections performances on BGA? ===<br /> <br /> We are constantly monitoring server responsiveness. Some incidents occurs, but most of the time BGA is responsive.<br /> <br /> We designed our game servers (ie: servers used when you are inside a game) to be very responsive. Usually, less than 2% of the game moves take more than 200 milliseconds to process, and less than 0.2% take more than 1 seconds.<br /> <br /> BGA servers are located in Europe (France), but we bought servers all across the world (19 locations) so that the big files (ex: images) are loaded fast even if you are far from us.<br /> <br /> Most of bad performances came from your internet connection or your system. Try to connect with a different browser / computer / internet connection to troubleshoot the issue.<br /> <br /> As a rule of thumb, is BGA is not responsive enough, you shouldn't engage yourself into a game because there is a risk for you to get clock penalties.<br /> <br /> === I got issue with a specific player: how does the moderation works? ===<br /> <br /> You should read [[Moderation and grades]] page.<br /> <br /> == Contribute to BGA ==<br /> <br /> === How can I contribute to BGA? ===<br /> <br /> Please visit page [http://boardgamearena.com/#!contribute Contribute to BGA].<br /> <br /> === I'm a software developer. What can I do? ===<br /> <br /> We created a website specifically dedicated to board games adaptation development: [http://studio.boardgamearena.com BGA Studio].<br /> <br /> == About the BGA team ==<br /> <br /> === Who are you? How to contact you? ===<br /> <br /> Please read page [[About us]].<br /> <br /> === How you guys make money? Do you make a living of it? ===<br /> <br /> Yes we still work aside, and yes there is a huge work to be done here everyday.<br /> <br /> There is essentially Club membership, but this is not enough. What we'd like to do is basically continue like this because we think this &quot;community based&quot; approach is the best for BGA.<br /> <br /> What we are trying to do, in addition, is to find a way to create a commercial activity in game portal development, distinct from BGA. This way we could have a flexible work with a source of revenue, distinct from BGA, that allows us to finance the time we spent on BGA.<br /> <br /> === Do you recruit? ===<br /> <br /> If we had enough money we would start by &quot;recruiting ourselves&quot; :)</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Faq&diff=1515 2015-04-28T20:40:01Z

<p>Een: /* About board games we proposed on BGA */</p> <hr /> <div>[[Category:Help]]<br /> <br /> == General questions ==<br /> <br /> ===What is Board Game Arena?===<br /> <br /> Board Game Arena (BGA) is an online board game platform. With BGA, you can play online and in real time against players from the whole world. A selection of various board games and card games is available. In order to play, the only thing you need is your browser!<br /> <br /> ===What do you mean by &quot;real time play&quot;?===<br /> <br /> On Board Game Arena your opponents are connected to the game platform during the entire game. They can see your moves and react to them immediately - as is the case in the real world.<br /> <br /> ===What is &quot;turn based play&quot;?===<br /> <br /> This is often referred to as &quot;asynchronous play&quot; on other sites, and is used here to differentiate from &quot;real time play&quot;. Instead of all players being around the table at the same time, players leave and come back. After your opponent takes a move you are notified that it is your turn (via email or on your next visit to the site). You then go to your game, take your turn, and the process repeats for the next player.<br /> <br /> For details please read [[Turn based FAQ]].<br /> <br /> ===What do I need to play?===<br /> <br /> Your browser ... and that's it!<br /> <br /> Board Game Arena does not require anything else on your computer. Thus, you can play from any computer, anywhere, anytime!<br /> <br /> In order to make this possible we are using the latest technologies available for the web. This is the reason you should play with the most up to date web browsers to enjoy an optimal BGA experience (read more about our [[Browser_support|browser policy]]).<br /> <br /> ===How much does it cost to play on BGA?===<br /> <br /> Playing on BGA is free.<br /> <br /> You can also choose to help us by making a donation and becoming a [http://en.boardgamearena.com/#!club Board Game Arena club] member.<br /> <br /> <br /> ===What are the games available on BGA?===<br /> <br /> Board Game Arena offers a various selection of board and card games, but specializes in modern (&quot;European style&quot;) adult games.<br /> <br /> [http://en.boardgamearena.com/#!gamelist See available games].<br /> <br /> == Meeting players and starting games ==<br /> <br /> ===I launched a new table but nobody is joining?===<br /> <br /> For the most popular games you can find players at any time of the day. For other games we advise you to come back at peak hour (around 22:00 CEST) if you can't find opponents at the moment.<br /> <br /> Tip: check the number of online/available players for a game before launching the table.<br /> <br /> Tip: if nobody is available for a realtime game, you can turn your table into a turn-based table, so another player can join even hours/days after you created it.<br /> <br /> ===I joined a game. When does the game start?===<br /> <br /> '''For realtime games''':<br /> <br /> Each table has an administrator, which is the table creator. It is the responsibility of the table administrator to start the game when he is satisfied with the number of players having joined the table.<br /> <br /> If you are the table administrator and can't launch the game, most of the time it's because there is not yet enough players joined the table.<br /> <br /> <br /> '''For turnbased games''':<br /> <br /> The game starts as soon as the maximum number of players has been reached. The table administrator can also starts the game manually if the minimum number of required players has been reached.<br /> <br /> ===What is the meaning of the small color circle next to players names?===<br /> <br /> * http://fr.boardgamearena.com/theme/img/status/online_.png : this player is active. He completed an action very recently.<br /> * http://fr.boardgamearena.com/theme/img/status/inactive_.png : this player is inactive. He is connected to the website but did not perform any action recently.<br /> * http://fr.boardgamearena.com/theme/img/status/offline_.png : this player is offline.<br /> <br /> <br /> ===What does the '% hits' statistic mean?===<br /> % hits = number of victory points / number of games played<br /> <br /> Where number of victory points is the following:<br /> * When you win a 2 players game: 1 point.<br /> * When you win a 3 players game: 1.5 points.<br /> * When you win a 4 players game: 2 points.<br /> * etc.<br /> <br /> This way, &quot;50%&quot; means that you win 50% of 2 players game, or 33% of 3 players game, etc.<br /> <br /> <br /> <br /> == During the game ==<br /> <br /> ===What is the meaning of the icons next to players names?===<br /> <br /> * http://fr.boardgamearena.com/theme/img/layout/active_player.gif : this player must make a move now.<br /> * http://fr.boardgamearena.com/theme/img/layout/active_player_clockalert.gif : this player must make a move now, and he has spent his reflexion time. Can someone wake him up? ;)<br /> * http://fr.boardgamearena.com/theme/img/layout/active_player_nonack.gif : this player must make a move now, but is probably not aware of the fact. If the situation does not evolve, it might be that this player has some connection issue.<br /> * http://fr.boardgamearena.com/theme/img/common/zombie.png : this player is a &quot;zombie&quot; (he left the game or has been fired from the game). The game goes on without this player.<br /> <br /> When the &quot;normal&quot; avatar of a player is displayed, it means that this player is waiting for his turn to play.<br /> <br /> <br /> ===A player has to make a move but he/she doesn't. What can I do?===<br /> <br /> * First, please remember that this player has the right to think as long as he needs to about the next move... well as long as he still has some time left on the game clock, that is.<br /> * Then you can ask this player to confirm that he is still thinking about how to play.<br /> * If this player seems to be away, we advise you to wait a few minutes: this player may be experiencing some network problems or have left his computer temporarily.<br /> * If the player is not coming back, you can skip his turn as soon as his clock is negative. He will get a &quot;leave&quot; penalty and you will will &quot;by forfeit&quot;.<br /> <br /> For more details, please read [[Game clock]].<br /> <br /> ===What is the current progression of the game I'm playing?===<br /> <br /> A percentage of progression is displayed on the top of the web page.<br /> There is also a progress bar at the bottom of the web page shows you the current progression of the game.<br /> <br /> <br /> ===What is forbidden on Board Game Arena?===<br /> <br /> * Leaving a game in progress on purpose.<br /> * Taking an unnecessary and unreasonable amount of time at the end of game in an obvious losing situation.<br /> * Kingmaking: enabling another player to win on purpose while there is a better move to make for yourself.<br /> * Running out of time on the game clock.<br /> * Giving some piece of information about the current game situation that corrupts the normal game flow.<br /> * Communicating with another player about the game privately (ex: with MSN).<br /> * Provocation / triumphalism / defeatism ... anything which is not fair play.<br /> * Having a shocking avatar (no advertisement, no politics, ...)<br /> <br /> Going against these rules will affect your reputation.<br /> <br /> <br /> ===What is absolutely forbidden in Board Game Arena?===<br /> <br /> * Creating multiple accounts and playing against oneself.<br /> * Insulting other players in any manner.<br /> <br /> Going against these rules can lead to the removal of your account and/or to the blacklisting of your IP.<br /> <br /> <br /> ===What if some player does something wrong?===<br /> <br /> The Board Game Arena platform has been designed to encourage players to maintain good behavior. The reputation system allows you to distinguish between good and bad players. Then, it is up to you to decide whether to start a game with them or not.<br /> <br /> If you think a player has behaved badly during a game, you can give him a &quot;red thumb&quot; at the end of the game.<br /> <br /> If you think a player has committed a serious wrongdoing during a game (ex: insult), please report this player to us, using the &quot;report this player&quot; link from his profile or game result page, so that we can take appropriate measures.<br /> <br /> == Tournaments ==<br /> <br /> Tournaments is a BETA feature of BGA (for a long time).<br /> <br /> Tournament management is very complex. We'd like to open tournament creation to everyone at some time in the future but it need a lot of work and until then we always had something more urgent to do.<br /> <br /> When tournaments will be improved, this FAQ section will be improved too.<br /> <br /> <br /> == About board games we proposed on BGA ==<br /> <br /> <br /> ===What is the legal status of this website?===<br /> <br /> All the games currently available on this site have been licensed or otherwise authorized by copyright holders. Please be aware that games available on BGA can be removed at the copyright holders demand (for example: if they publish their own adaptation of the game).<br /> <br /> Board Game Arena would like to thank all game publishers and game designers who allow us to have their games here, thus making it possible for this website to exist.<br /> <br /> === How do we select games that are on BGA? Why the game XXX is not on BGA? ===<br /> <br /> To have a game published on BGA we need 2 things:<br /> * The authorization of the rights owner (most of the time: original publisher of the game).<br /> * A software developer who develops the adaptation (ie: has some time available to develop it).<br /> <br /> We (= BGA team) are trying a lot of board games ourselves. Sometimes we are lucky enough to play prototypes too. And of course we receive a lot of game suggestions through the BGA forum, the BoardGameGeek &quot;most wanted games&quot; list, or by any other means. Based on this we are asking game publishers for authorizations, and sometimes we also receive requests directly from game publishers - there is no rule.<br /> <br /> As it is today, BGA has a very good reputation and very productive relationships with almost all major board game publishers, but this is not enough: each situation is specific, and there can be various reasons why a game publisher can refuse to see a game adaptation on BGA (for example: board games with a third party licence, like &quot;Star Wars&quot;, is practically impossible to negotiate).<br /> <br /> On the other hand, we got some authorizations for some very good games but no developers volunteering to develop them, or sometimes some of them don't manage to finish the job. Developers of adaptations are volunteers, and we don't blame them for this.<br /> <br /> Finally, some games are authorized and being developed, but the time frame is not good. For example, it happened that we had too many games to release and we decided to delay some of them. It also frequently happens that we must synchronize the release of a game with a publisher event, so the game adaptation can stay &quot;on hold&quot; for some months.<br /> <br /> So if you are asking yourself: why game XXX is not on BGA, it could be for various reasons:<br /> * Maybe we never asked authorization for this game. Note that usually we ask authorizations for every popular games (ex: &quot;Most wanted games&quot;). So if the game is popular, the reason is probably not this one.<br /> * The publisher refused.<br /> * The publisher accepted, but we didn't find a developer until now for this game.<br /> * The game adaptation is ready, but we are waiting for a specific event to release it.<br /> <br /> <br /> To conclude: yes we are taking into account your suggestions, but as you can see there are many factors than can influence the fact that a game is (or is not) on BGA. In addition, as a rule of thumb, we don't communicate about &quot;why&quot; this game is not on BGA. If we already got the authorization, we want to keep the &quot;surprise&quot;, and if we didn't get the authorization, the game publisher may not want to explain the reasons.<br /> <br /> === Are you taking into account the &quot;Most wanted games&quot; list? When will these games be on BGA? ===<br /> <br /> You should read first the previous section (&quot;how do we select games that are on BGA?&quot;).<br /> <br /> So the answer is:<br /> * Yes, we are taking this list into account.<br /> * For most of these games we already asked for authorizations.<br /> * Some of these games won't be on BGA (authorization refused), some may be, some are in an &quot;intermediate&quot; step.<br /> * We don't communicate about future game releases anyway.<br /> <br /> === Why do some games have expansions on BGA and some don't? ===<br /> <br /> You should read first the previous section (&quot;how do we select games that are on BGA?&quot;).<br /> <br /> Game expansions follow the same steps than games. There can be various reasons why a game publisher doesn't want the expansion online, and sometimes we don't find a developer that has the time to develop it.<br /> <br /> ===I'm a game publisher: why would I like to have my game on Board Game Arena?===<br /> <br /> The main goal of Board Game Arena is to make it easy for people to discover and love new games. We think that there are only two kinds of players on Board Game Arena: those who already bought the games they are playing online, and those who plan to buy them soon!<br /> <br /> As the activity of this website contributes to increasing a game's popularity and thus generates hard copy sales in the &quot;real world&quot;, we think it is beneficial to the board game community: people from all over the world can play online, we can have fun developing this game platform to the best of our ability, and game publishers get money from the box sales and build a special relationship with their player's community.<br /> <br /> === I'm a game publisher: how to get my game on Board Game Arena ===<br /> <br /> At first, you just have to write us an email (contact (at) boardgamearena.com) with a description of your game(s).<br /> <br /> Then, we add this game to the list of &quot;available licences&quot; on our website dedicated to game developers ([http://studio.boardgamearena.com BGA Studio]).<br /> <br /> The most difficult part is to find a developer among our community. Our only requirement is that the developer must love the game. Of course, the most popular the game is, the easiest it is to find a volunteer developer. Sometimes it is very fast, sometimes it takes months, sometimes it never happens. We can't say in advance.<br /> <br /> It is also possible to find your own developer: of course it accelerates the process a lot!<br /> <br /> == Turn-based mode ==<br /> <br /> Please read [[Turn based FAQ]].<br /> <br /> == Issues with BGA ==<br /> <br /> ===What can I do if I have an issue with the website?===<br /> <br /> Most of the issues on this website should be solved with a simple web page refresh (or &quot;F5&quot;).<br /> <br /> If you experience persistent issues, you can browse the [http://boardgamearena.com/#!bugs bug tool], see if someone already reported the issue, and add a new bug report if that's not the case. Please take some time to describe the bug you are reporting in detail so that we can quickly reproduce and fix it.<br /> <br /> === Why is my bug still not fixed? ===<br /> <br /> We fix bugs every weeks. Of course we have priorities:<br /> * We give the highest priority to recent features and recent games, because the most important bugs are reported fast.<br /> * We give the highest priority to the bugs with the biggest number of &quot;green thumb&quot; on the [http://boardgamearena.com/#!bugs bug tool].<br /> * Usually we fix bugs by group. So if we decide to fix an important bug on a game, there is chance that we fix 3 or 4 minor bug at the same time.<br /> <br /> BGA is known for the quality of its adaptation, and if you look at the bug tool, you can see that -considering the number of games and the size of the community- there are not so much critical bugs with many &quot;green thumb&quot;.<br /> <br /> Please also note that BGA adaptations are realized by volunteers and not professional developers (even if most of them are also professional developers). This is not always easy for them to fix bugs, especially when some players are complaining violently and/or do not give precise information in bug reports.<br /> <br /> <br /> === I played on smartphone / tablet / touch device and I have some difficulties: what can I do? ===<br /> <br /> As a rule of thumb, BGA do not support tablet/smartphones. There are tons of board gamers adaptations for tablet/smartphones, and some BGA adaptations are not well designed for small screens. Thus, we don't have plan to do a mobile / tablet version at now.<br /> <br /> So if you want to use BGA from a smartphone / tablet you can, but we don't promise to fix all bugs so it's at your own risk :)<br /> <br /> <br /> === Why BGA is slow? Why do I have bad connections performances on BGA? ===<br /> <br /> We are constantly monitoring server responsiveness. Some incidents occurs, but most of the time BGA is responsive.<br /> <br /> We designed our game servers (ie: servers used when you are inside a game) to be very responsive. Usually, less than 2% of the game moves take more than 200 milliseconds to process, and less than 0.2% take more than 1 seconds.<br /> <br /> BGA servers are located in Europe (France), but we bought servers all across the world (19 locations) so that the big files (ex: images) are loaded fast even if you are far from us.<br /> <br /> Most of bad performances came from your internet connection or your system. Try to connect with a different browser / computer / internet connection to troubleshoot the issue.<br /> <br /> As a rule of thumb, is BGA is not responsive enough, you shouldn't engage yourself into a game because there is a risk for you to get clock penalties.<br /> <br /> === I got issue with a specific player: how does the moderation works? ===<br /> <br /> You should read [[Moderation and grades]] page.<br /> <br /> == Contribute to BGA ==<br /> <br /> === How can I contribute to BGA? ===<br /> <br /> Please visit page [http://boardgamearena.com/#!contribute Contribute to BGA].<br /> <br /> === I'm a software developer. What can I do? ===<br /> <br /> We created a website specifically dedicated to board games adaptation development: [http://studio.boardgamearena.com BGA Studio].<br /> <br /> == About the BGA team ==<br /> <br /> === Who are you? How to contact you? ===<br /> <br /> Please read page [[About us]].<br /> <br /> === How you guys make money? Do you make a living of it? ===<br /> <br /> Yes we still work aside, and yes there is a huge work to be done here everyday.<br /> <br /> There is essentially Club membership, but this is not enough. What we'd like to do is basically continue like this because we think this is the best approach for BGA.<br /> <br /> What we are trying to do, in addition, is to find a way to create a commercial activity in game portal development, distinct from BGA. This way we could have a flexible work with a source of revenue, distinct from BGA, that allow us to finance the time we spent on BGA.<br /> <br /> === Do you recruit? ===<br /> <br /> If we had enough money we would start by &quot;recruiting ourselves&quot; :)</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Game_clock&diff=1375 2015-02-18T21:21:12Z

<p>Een: </p> <hr /> <div>[[Category:Help]]<br /> On '''Board Game Arena''' you are playing &quot;live&quot; (real time) or &quot;turn-based&quot; (asynchronously). In both cases, you have an allotted delay to play your moves.<br /> <br /> Most of the time, your initial delay at the beginning of a game is some minutes (in realtime mode) or some days (in turn-based mode). During each turn, or on specific occasions, you get an additional delay. If you have no more time to play, you will get a &quot;clock&quot; penalty and your opponents can decide to skip your turns.<br /> <br /> == Time to think ==<br /> <br /> Your allotted time to think is displayed on the right of your player's name. When it's your turn to play, this time is also displayed at the top of the web page.<br /> <br /> == Game speed ==<br /> <br /> Table administrator can make a choice between some game speed profile (example: fast, normal, slow). There are many speeds for each mode (realtime and turn-based).<br /> <br /> The additional amount of time credited each turn depends on the chosen game speed profile. Be careful to check the game speed setting before the game starts to adjust your timing. The interface displays an estimation of the game duration based on recently played games with the same speed settings.<br /> <br /> Note: your allotted time to think cannot get higher that your initial time to think. For example, if you start the game with 5 minutes of thinking time, you time will be limited to 5 minutes maximum.<br /> <br /> Note: playing without a time limit is strongly discouraged, except if you are playing with friends, or to discover a new game. Remember that without time limit, you can't skip the turn of a player that is not playing.<br /> <br /> <br /> == Running out of time ==<br /> <br /> As soon as you run out of time (negative clock), you get a clock penalty.<br /> <br /> '''For realtime games''':<br /> <br /> When a player has a negative clock, any one of his opponents can make him skip his turn. Once this has been done, all following turns are skipped automatically.<br /> <br /> When you are in this situation (turns skipped automatically), you can get back in the game by clicking on the dedicated button &quot;get back in this game&quot;. Note that you are not allowed to get back in the game if your clock is still negative. However, as all your turn are skipped, it shouldn't take long before your clock becomes positive again.<br /> <br /> If you can't/don't manage to get back in the game before the game end, you will get '''both''' a &quot;leave&quot; penalty on your profile and an ELO penalty for this game.<br /> <br /> '''For turn-based games''':<br /> <br /> On turn-based games, you are warned by email when you are running out of time.<br /> <br /> When you are out of time, your opponents also receive an email notifying them that they can make you skip your turn (they can also choose to wait if they don't mind or if you told them that you would be offline for some time).<br /> <br /> == Continue the game after a &quot;skip turn&quot; ==<br /> <br /> If you are playing in a game where a player skips all his turns, you have 2 options:<br /> * You can continue to play the game until the end. This is recommended. In this case you will earn the ELO points you deserve for your victory.<br /> * You can abandon the game. All players with a negative clock will accept automatically and receive '''both''' an ELO penalty and a &quot;leave&quot; penalty. But the you and the other players with a positive clock won't get any ELO since the game didn't reach its end).<br /> <br /> == &quot;My opponent is too slow&quot; ==<br /> <br /> Each of us has different expectations on game speed. Please remember that as soon as a table has been set up at a given game speed, each player is allowed to use all his allotted time to think. If you want to play fast, set up or join only tables with &quot;fast&quot; mode on, but don't bully an opponent to play when he has the right to use his alloted time to think.<br /> <br /> <br /> == &quot;I would like to think a little&quot; ==<br /> <br /> If you are in a critical step of the game and want to take some time to think, you can click on the &quot;I would like to think a little&quot; link at the top right of the page.<br /> <br /> Thus, your opponents will get a message and won't be thinking that you are away from keyboard or disconnected.<br /> <br /> Clicking on this link is not mandatory, but we encourage its use as a courtesy.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Game_clock&diff=1373 2015-02-17T22:03:59Z

<p>Een: </p> <hr /> <div>[[Category:Help]]<br /> On '''Board Game Arena''' you are playing &quot;live&quot; (real time) or &quot;turn-based&quot; (asynchronously). In both cases, you have an allotted delay to play your moves.<br /> <br /> Most of the time, your initial delay at the beginning of a game is some minutes (in realtime mode) or some days (in turn-based mode). During each turn, or on specific occasions, you get an additional delay. If you have no more time to play, you will get a &quot;clock&quot; penalty and your opponents can decide to skip your turns.<br /> <br /> == Time to think ==<br /> <br /> Your allotted time to think is displayed on the right of your player's name. When it's your turn to play, this time is also displayed at the top of the web page.<br /> <br /> == Game speed ==<br /> <br /> Table administrator can make a choice between some game speed profile (example: fast, normal, slow). There are many speeds for each mode (realtime and turn-based).<br /> <br /> The additional amount of time credited each turn depends on the chosen game speed profile. Be careful to check the game speed setting before the game starts to adjust your timing. The interface displays an estimation of the game duration based on recently played games with the same speed settings.<br /> <br /> Note: your allotted time to think cannot get higher that your initial time to think. For example, if you start the game with 5 minutes of thinking time, you time will be limited to 5 minutes maximum.<br /> <br /> Note: playing without a time limit is strongly discouraged, except if you are playing with friends, or to discover a new game. Remember that without time limit, you can't skip the turn of a player that is not playing.<br /> <br /> <br /> == Running out of time ==<br /> <br /> As soon as you run out of time (negative clock), you get a clock penalty.<br /> <br /> '''For realtime games''':<br /> <br /> When a player has a negative clock, any one of his opponents can make him skip his turn. Once this has been done, all following turns are skipped automatically.<br /> <br /> When you are in this situation (turns skipped automatically), you can get back in the game by clicking on the dedicated button &quot;get back in this game&quot;. Note that you are not allowed to get back in the game if your clock is still negative. However, as all your turn are skipped, it shouldn't take long before your clock becomes positive again.<br /> <br /> If you can't/don't manage to get back in the game before the game end, you will get a &quot;leave&quot; penalty on your profile.<br /> <br /> '''For turn-based games''':<br /> <br /> On turn-based games, you are warned by email when you are running out of time.<br /> <br /> When you are out of time, your opponents receive an email notifying them that they can make you skip your turn.<br /> <br /> == Continue the game after a &quot;skip turn&quot; ==<br /> <br /> If you are playing in a game where a player skips all his turns, you have 2 options:<br /> * You can continue to play the game until the end. This is recommended. In this case you will earn the ELO points you deserve for your victory.<br /> * You can abandon the game. All players with a negative clock will accept automatically and receive both an ELO penalty and a &quot;leave&quot; penalty. But the you and the other players with a positive clock won't get any ELO since the game didn't reach its end).<br /> <br /> == &quot;My opponent is too slow&quot; ==<br /> <br /> Each of us has different expectations on game speed. Please remember that as soon as a table has been set up at a given game speed, each player is allowed to use all his allotted time to think. If you want to play fast, set up or join only tables with &quot;fast&quot; mode on, but don't bully an opponent to play when he has the right to use his alloted time to think.<br /> <br /> <br /> == &quot;I would like to think a little&quot; ==<br /> <br /> If you are in a critical step of the game and want to take some time to think, you can click on the &quot;I would like to think a little&quot; link at the top right of the page.<br /> <br /> Thus, your opponents will get a message and won't be thinking that you are away from keyboard or disconnected.<br /> <br /> Clicking on this link is not mandatory, but we encourage its use as a courtesy.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelpcheckers&diff=1278 2014-10-26T20:48:05Z

<p>Een: /* Game variants */</p> <hr /> <div>== Objective of the Game ==<br /> <br /> Checkers, also known as 'draughts', is a timeless abstract strategy game for two players dating back almost a thousand years. In the game you move your pieces until you've jumped over all pieces of your opponent and have removed them from the board. Players move one piece diagonally at a time in alternating play (starting with light). All references to squares refer to the dark squares only. The board is an 8 by 8 square of squares in alternating light or dark colours. Players should set up pieces on the 12 dark squares in the first three rows closest to them (the light spaces are completely ignored in the game), setting up three rows of 4 checkers.<br /> <br /> == Game variants ==<br /> <br /> There is a lot of Checkers variants. Four of them are available on Board Game Arena :<br /> <br /> :* International Checkers (10x10 board, men can capture backwards, kings can fly, one must capture as many pieces as possible)<br /> :* Straight Checkers (8x8 board, men cannot capture backwards, kings can capture backwards but cannot fly, one must capture if possible but not necessarily as many pieces as possible)<br /> :* Brazilian Checkers (8x8 board, men can capture backwards, kings can fly, one must capture as many pieces as possible)<br /> :* Russian Checkers (8x8 board, men can capture backwards, kings can fly and go on capturing immediately after getting crowned, one must capture if possible but not necessarily as many pieces as possible).<br /> <br /> Make sure to check the rules for the variant you are currently playing: the following detailed section applies only to Straight Checkers.<br /> <br /> == Straight Checkers ==<br /> <br /> ===Moving &amp; Capturing===<br /> <br /> Take turns moving a checker one space diagonally forward towards the opponent's side of the board on a square that contains no checkers of either player. You may 'jump' your opponents checkers by making a capturing move if your checker is located at most one space behind your opponent's checker (on your side). When capturing you jump over the checker moving two spaces in the same direction and then remove their piece from the game. Capturing multiple pieces using multiple jumps in the same turn is a key part of the game, when doing so you may change which direction they're moving diagonally, but they must still always move forward.<br /> <br /> :* If you have the opportunity to jump your opponent's checker, you must.<br /> :* You may continue capturing subsequent checkers until there are no more possible captures.<br /> :* If you have the opportunity to jump a choice of opponent's checkers, you may choose which but must capture one of them.<br /> <br /> ===Kings===<br /> <br /> When one of your pieces reaches the end of the opponent's board that piece is upgraded to a king, these may move in either direction now.<br /> <br /> :* Kings may move forward or backward diagonally.<br /> :* Kings can still only move one diagonal space at a time unless capturing.<br /> :* Kings may move both forward and backward in the same turn when capturing.<br /> <br /> ==Winning==<br /> <br /> Complete ''one'' of the following two objectives;<br /> <br /> :* Capture all of your opponent's pieces.<br /> <br /> '''or'''<br /> <br /> :* Block all your opponent's pieces so they can't make any more moves.<br /> <br /> ==Draws==<br /> <br /> A draw is declared if ''any'' of these conditions occur;<br /> <br /> :* The same situation repeats itself for the third time (not necessarily consecutive).<br /> <br /> '''or'''<br /> <br /> :* 25 moves have been played without moving a man forward or making a capture.<br /> <br /> ==Strategy==<br /> <br /> :* Be aggressive, you are more likely to win. Playing to the board sides are safer though without reward.<br /> :* Forward- always forward, it's alright to lose pieces as long as you take the opponent's, save your kings.<br /> :* Safety in numbers, don't leave your pieces alone, move them one after another in small groups to protect them.<br /> :* Protect the rear, protect forward or don't move your end row pieces as long as possible to prevent opponent's kings.<br /> :* Sacrifice when needed. draw out your opponent so you can get 2-1 trades the following turn, don't expose your kings without reward.<br /> :* Each king you get is a huge bonus, try to get as many as possible and don't waste them, sacrificing several pieces for a king can be alright.<br /> :* Don't forget to block your opponent when possible, you make not only that piece vulnerable but fail to protect it with a counter and give your opponent the chance to take multiple of your pieces in one turn.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelpcheckers&diff=1277 2014-10-26T20:47:34Z

<p>Een: /* Game variants */</p> <hr /> <div>== Objective of the Game ==<br /> <br /> Checkers, also known as 'draughts', is a timeless abstract strategy game for two players dating back almost a thousand years. In the game you move your pieces until you've jumped over all pieces of your opponent and have removed them from the board. Players move one piece diagonally at a time in alternating play (starting with light). All references to squares refer to the dark squares only. The board is an 8 by 8 square of squares in alternating light or dark colours. Players should set up pieces on the 12 dark squares in the first three rows closest to them (the light spaces are completely ignored in the game), setting up three rows of 4 checkers.<br /> <br /> == Game variants ==<br /> <br /> There is a lot of Checkers variants. Four of them are available on Board Game Arena :<br /> <br /> :* International Checkers (10x10 board, men can capture backwards, kings can fly, one must capture as many pieces as possible)<br /> :* Straight Checkers (8x8 board, men cannot capture backwards, kings can capture backwards but not fly, one must capture if possible but not necessarily as many pieces as possible)<br /> :* Brazilian Checkers (8x8 board, men can capture backwards, kings can fly, one must capture as many pieces as possible)<br /> :* Russian Checkers (8x8 board, men can capture backwards, kings can fly and go on capturing immediately after getting crowned, one must capture if possible but not necessarily as many pieces as possible).<br /> <br /> Make sure to check the rules for the variant you are currently playing: the following detailed section applies only to Straight Checkers.<br /> <br /> == Straight Checkers ==<br /> <br /> ===Moving &amp; Capturing===<br /> <br /> Take turns moving a checker one space diagonally forward towards the opponent's side of the board on a square that contains no checkers of either player. You may 'jump' your opponents checkers by making a capturing move if your checker is located at most one space behind your opponent's checker (on your side). When capturing you jump over the checker moving two spaces in the same direction and then remove their piece from the game. Capturing multiple pieces using multiple jumps in the same turn is a key part of the game, when doing so you may change which direction they're moving diagonally, but they must still always move forward.<br /> <br /> :* If you have the opportunity to jump your opponent's checker, you must.<br /> :* You may continue capturing subsequent checkers until there are no more possible captures.<br /> :* If you have the opportunity to jump a choice of opponent's checkers, you may choose which but must capture one of them.<br /> <br /> ===Kings===<br /> <br /> When one of your pieces reaches the end of the opponent's board that piece is upgraded to a king, these may move in either direction now.<br /> <br /> :* Kings may move forward or backward diagonally.<br /> :* Kings can still only move one diagonal space at a time unless capturing.<br /> :* Kings may move both forward and backward in the same turn when capturing.<br /> <br /> ==Winning==<br /> <br /> Complete ''one'' of the following two objectives;<br /> <br /> :* Capture all of your opponent's pieces.<br /> <br /> '''or'''<br /> <br /> :* Block all your opponent's pieces so they can't make any more moves.<br /> <br /> ==Draws==<br /> <br /> A draw is declared if ''any'' of these conditions occur;<br /> <br /> :* The same situation repeats itself for the third time (not necessarily consecutive).<br /> <br /> '''or'''<br /> <br /> :* 25 moves have been played without moving a man forward or making a capture.<br /> <br /> ==Strategy==<br /> <br /> :* Be aggressive, you are more likely to win. Playing to the board sides are safer though without reward.<br /> :* Forward- always forward, it's alright to lose pieces as long as you take the opponent's, save your kings.<br /> :* Safety in numbers, don't leave your pieces alone, move them one after another in small groups to protect them.<br /> :* Protect the rear, protect forward or don't move your end row pieces as long as possible to prevent opponent's kings.<br /> :* Sacrifice when needed. draw out your opponent so you can get 2-1 trades the following turn, don't expose your kings without reward.<br /> :* Each king you get is a huge bonus, try to get as many as possible and don't waste them, sacrificing several pieces for a king can be alright.<br /> :* Don't forget to block your opponent when possible, you make not only that piece vulnerable but fail to protect it with a counter and give your opponent the chance to take multiple of your pieces in one turn.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelpcheckers&diff=1276 2014-10-26T20:38:54Z

<p>Een: Make the description more accurate for BGA implementation</p> <hr /> <div>== Objective of the Game ==<br /> <br /> Checkers, also known as 'draughts', is a timeless abstract strategy game for two players dating back almost a thousand years. In the game you move your pieces until you've jumped over all pieces of your opponent and have removed them from the board. Players move one piece diagonally at a time in alternating play (starting with light). All references to squares refer to the dark squares only. The board is an 8 by 8 square of squares in alternating light or dark colours. Players should set up pieces on the 12 dark squares in the first three rows closest to them (the light spaces are completely ignored in the game), setting up three rows of 4 checkers.<br /> <br /> == Game variants ==<br /> <br /> There is a lot of Checkers variants. Four of them are available on Board Game Arena :<br /> <br /> :* International Checkers<br /> :* Straight Checkers<br /> :* Brazilian Checkers<br /> :* Russian Checkers.<br /> <br /> Make sure to check the rules for the variant you are currently playing: the following section applies only to Straight Checkers.<br /> <br /> == Straight Checkers ==<br /> <br /> ===Moving &amp; Capturing===<br /> <br /> Take turns moving a checker one space diagonally forward towards the opponent's side of the board on a square that contains no checkers of either player. You may 'jump' your opponents checkers by making a capturing move if your checker is located at most one space behind your opponent's checker (on your side). When capturing you jump over the checker moving two spaces in the same direction and then remove their piece from the game. Capturing multiple pieces using multiple jumps in the same turn is a key part of the game, when doing so you may change which direction they're moving diagonally, but they must still always move forward.<br /> <br /> :* If you have the opportunity to jump your opponent's checker, you must.<br /> :* You may continue capturing subsequent checkers until there are no more possible captures.<br /> :* If you have the opportunity to jump a choice of opponent's checkers, you may choose which but must capture one of them.<br /> <br /> ===Kings===<br /> <br /> When one of your pieces reaches the end of the opponent's board that piece is upgraded to a king, these may move in either direction now.<br /> <br /> :* Kings may move forward or backward diagonally.<br /> :* Kings can still only move one diagonal space at a time unless capturing.<br /> :* Kings may move both forward and backward in the same turn when capturing.<br /> <br /> ==Winning==<br /> <br /> Complete ''one'' of the following two objectives;<br /> <br /> :* Capture all of your opponent's pieces.<br /> <br /> '''or'''<br /> <br /> :* Block all your opponent's pieces so they can't make any more moves.<br /> <br /> ==Draws==<br /> <br /> A draw is declared if ''any'' of these conditions occur;<br /> <br /> :* The same situation repeats itself for the third time (not necessarily consecutive).<br /> <br /> '''or'''<br /> <br /> :* 25 moves have been played without moving a man forward or making a capture.<br /> <br /> ==Strategy==<br /> <br /> :* Be aggressive, you are more likely to win. Playing to the board sides are safer though without reward.<br /> :* Forward- always forward, it's alright to lose pieces as long as you take the opponent's, save your kings.<br /> :* Safety in numbers, don't leave your pieces alone, move them one after another in small groups to protect them.<br /> :* Protect the rear, protect forward or don't move your end row pieces as long as possible to prevent opponent's kings.<br /> :* Sacrifice when needed. draw out your opponent so you can get 2-1 trades the following turn, don't expose your kings without reward.<br /> :* Each king you get is a huge bonus, try to get as many as possible and don't waste them, sacrificing several pieces for a king can be alright.<br /> :* Don't forget to block your opponent when possible, you make not only that piece vulnerable but fail to protect it with a counter and give your opponent the chance to take multiple of your pieces in one turn.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=About_Board_Game_Arena&diff=1234 2014-10-11T09:57:05Z

<p>Een: </p> <hr /> <div>With '''Board Game Arena''' you can play board games online with the whole world.<br /> <br /> <br /> Board Game Arena is a next generation game platform which makes online gaming more simple and attractive:<br /> <br /> * Nothing to install: play straight from your browser, from anywhere, at anytime.<br /> * Real time: your opponents are online, you play &quot;live&quot;.<br /> * Simple: if you know the game, then you know how to play online.<br /> * Free.<br /> <br /> <br /> Board Game Arena offers a [http://en.boardgamearena.com/#!gamelist growing selection of board and card games]. We are specialized in modern adults games (&quot;European style games&quot;). This game platform has been designed to host any kind of game. This flexibility allow us to propose a '''new game every month'''.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelpcheckers&diff=1233 2014-10-07T21:42:09Z

<p>Een: /*  Objective of the Game */</p> <hr /> <div>== Objective of the Game ==<br /> <br /> Checkers, also known as 'draughts', is a timeless abstract strategy game for two players dating back almost a thousand years. In the game you move your pieces until you've jumped over all pieces of your opponent and have removed them from the board. Players move one piece diagonally at a time in alternating play (starting with light). All references to squares refer to the dark squares only. The board is an 8 by 8 square of squares in alternating light or dark colours. Players should set up pieces on the 12 dark squares in the first three rows closest to them (the light spaces are completely ignored in the game), setting up three rows of 4 checkers.<br /> <br /> ==Moving &amp; Capturing==<br /> <br /> Take turns moving a checker one space diagonally forward towards the opponent's side of the board on a square that contains no checkers of either player. You may 'jump' your opponents checkers by making a capturing move if your checker is located at most one space behind your opponent's checker (on your side). When capturing you jump over the checker moving two spaces in the same direction and then remove their piece from the game. Capturing multiple pieces using multiple jumps in the same turn is a key part of the game, when doing so you may change which direction they're moving diagonally, but they must still always move forward.<br /> <br /> :* If you have the opportunity to jump your opponent's checker, you must.<br /> :* You may continue capturing subsequent checkers until there are no more possible captures.<br /> :* If you have the opportunity to jump a choice of opponent's checkers, you may choose which but must capture one of them.<br /> <br /> <br /> ==Kings==<br /> <br /> When one of your pieces reaches the end of the opponent's board that piece is upgraded to a king, these may move in either direction now.<br /> <br /> :* Kings may move forward or backward diagonally.<br /> :* Kings can still only move one diagonal space at a time unless capturing.<br /> :* Kings may move both forward and backward in the same turn when capturing.<br /> <br /> <br /> ==Winning==<br /> <br /> Complete ''one'' of the following three objectives;<br /> <br /> <br /> :* Capture all of an opponent's pieces.<br /> <br /> '''or'''<br /> <br /> :* Block all your opponent's pieces so they can't make any more moves.<br /> <br /> '''or'''<br /> <br /> :* Have all your pieces on the opponent's far end of the board (your opponent will need to have captured half or more of your pieces).<br /> <br /> <br /> ==Draws==<br /> <br /> A draw is declared if ''any'' of these conditions occur;<br /> <br /> <br /> :* A game is a draw if neither opponent has the possibility to win the game.<br /> <br /> '''or'''<br /> <br /> :* The game is considered a draw when the same situation repeats itself for the third time (not necessarily consecutive).<br /> <br /> '''or'''<br /> <br /> :* A one king against one king endgame is often declared a draw.<br /> <br /> ==Strategy==<br /> <br /> :* Be aggressive, you are more likely to win. Playing to the board sides are safer though without reward.<br /> :* Forward- always forward, it's alright to lose pieces as long as you take the opponent's, save your kings.<br /> :* Safety in numbers, don't leave your pieces alone, move them one after another in small groups to protect them.<br /> :* Protect the rear, protect forward or don't move your end row pieces as long as possible to prevent opponent's kings.<br /> :* Sacrifice when needed. draw out your opponent so you can get 2-1 trades the following turn, don't expose your kings without reward.<br /> :* Each king you get is a huge bonus, try to get as many as possible and don't waste them, sacrificing several pieces for a king can be alright.<br /> :* Don't forget to block your opponent when possible, you make not only that piece vulnerable but fail to protect it with a counter and give your opponent the chance to take multiple of your pieces in one turn.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=TermsOfService&diff=1209 2014-08-31T14:28:39Z

<p>Een: </p> <hr /> <div><br /> = Board Game Arena Terms of Service =<br /> <br /> <br /> == Welcome to BGA! ==<br /> <br /> <br /> Thanks for using our services (“Services”). The Services are provided by Board Game Arena (&quot;BGA&quot;), located at G. Isabelli, 19 bd de la République, 92260 Fontenay-aux-Roses, France.<br /> <br /> By using our Services, you are agreeing to these terms. Please read them carefully.<br /> <br /> <br /> == Using our Services ==<br /> <br /> <br /> You must follow any policies made available to you within the Services.<br /> <br /> Don’t misuse our Services. For example, don’t interfere with our Services or try to access them using a method other than the interface and the instructions that we provide. You may use our Services only as permitted by law, including applicable export and re-export control laws and regulations. We may suspend or stop providing our Services to you if you do not comply with our terms or policies or if we are investigating suspected misconduct.<br /> <br /> Using our Services does not give you ownership of any intellectual property rights in our Services or the content you access. You may not use content from our Services unless you obtain permission from its owner or are otherwise permitted by law. These terms do not grant you the right to use any branding or logos used in our Services. Don’t remove, obscure, or alter any legal notices displayed in or along with our Services.<br /> <br /> Our Services display some content that is not from BGA. This content is the sole responsibility of the entity that makes it available. We may review content to determine whether it is illegal or violates our policies, and we may remove or refuse to display content that we reasonably believe violates our policies or the law. But that does not necessarily mean that we review content, so please don’t assume that we do.<br /> <br /> In connection with your use of the Services, we may send you service announcements, administrative messages, and other information. You may opt out of some of those communications.<br /> <br /> <br /> == Your BGA Account ==<br /> <br /> <br /> You may need a BGA Account in order to use some of our Services. You may create your own BGA Account, or your BGA Account may be assigned to you by an administrator, such as your employer or educational institution. If you are using a BGA Account assigned to you by an administrator, different or additional terms may apply and your administrator may be able to access or disable your account.<br /> <br /> To protect your BGA Account, keep your password confidential. You are responsible for the activity that happens on or through your BGA Account. Try not to reuse your BGA Account password on third-party applications. If you learn of any unauthorized use of your password or BGA Account, please change it immediately from your preferences.<br /> <br /> <br /> == Your responsibilities as a BGA player (&quot;the Player&quot;) ==<br /> <br /> <br /> The Player is solely responsible for any message, content and information posted by him on the site since, in its capacity as host of the service considered here, under the provisions of French Law No. 2004-575 of 21 June 2004 on confidence in the digital economy, BGA cannot be held responsible for the content posted or transmitted by Players on the Site and on which BGA exercises no control and monitoring.<br /> <br /> The Player expressly agrees, under penalty of criminal responsibility or civil liability, that the messages and content he will post on the Site are not likely to (without this list being exhaustive):<br /> <br /> * violate intellectual property rights of third parties: in this respect the Player undertakes not to reproduce or communicate publicly on the Site or the material protected under copyright, trademark filed as or more generally protected by other intellectual property rights held by third parties without the prior consent of the holders of such proprietary rights;<br /> * Contain computer viruses likely to interrupt, destroy or impair the functionality of the Site; <br /> * Being an apologist for crimes or contain illegal messages, threatening, or pedophile nature, pornographic, defamatory, obscene, hateful, racist, antisemitic, xenophobic, revisionist or contrary to public order or morality; <br /> * Infringe privacy or dignity of others; <br /> * Incite violence, fanaticism, crime, suicide, hatred due to religion, race, gender, sexual orientation, ethnicity;<br /> * Harass other players with whom the Player would be contacted when discussing the different communication areas of the site;<br /> * Promote or encourage any criminal activity or enterprise; <br /> * Solicit and / or disclose passwords and / or personal information for commercial or unlawful purposes; <br /> * Transmit any chain e-mails, unsolicited mass mailings, instant messages, commercials or unwanted unsolicited mail; <br /> * Contain advertisements and / or solicitations to offer products and / or commercial services through the Site;<br /> * Contain addresses or hypertext links to external sites whose content is contrary to the laws and regulations, which violate the rights of others or is contrary to these terms.<br /> <br /> The Player agrees to hold only one account on BGA, unless otherwise approved by BGA. We reserve the right to terminate any multiple accounts attributable to the same person.<br /> <br /> The Player agrees not to resort to the use of automated systems such as scripts to play or send messages.<br /> <br /> The Player is solely responsible for the keeping and confidentiality of their password and agrees not to communicate it to any other player or to use the account, the username and password of another Player.<br /> <br /> The Player guarantees the accuracy of information provided to BGA for purposes of registration and agrees to notify any subsequent changes.<br /> <br /> The Player acknowledges that BGA reserves, in case his use of the site would be contrary to these Terms or to generally applicable laws and regulatory provisions, the right to - immediately and without notice - deregister him from the Site services and / or to block his access to the Site.<br /> <br /> BGA reserves, assuming the Player would be responsible for an offense under the legislation or for affecting the rights of third parties, the right to provide, upon request of any legitimate authority (courts, administrative authorities, police), all information allowing or facilitating the identification of the offending Player.<br /> <br /> The Player is required to notify BGA, using the &quot;Report this player&quot; function, of any misuse of the Site of which he has knowledge, including any message whose contents violates the above prohibitions or more generally applicable laws and regulatory provisions.<br /> <br /> <br /> == Privacy and Copyright Protection ==<br /> <br /> <br /> BGA's [http://boardgamearena.com/#!doc/privacy privacy policies] explain how we treat your personal data and protect your privacy when you use our Services. By using our Services, you agree that BGA can use such data in accordance with our privacy policies.<br /> <br /> We respond to notices of alleged copyright infringement and terminate accounts of repeat infringers according to the process set out in France and the European Union.<br /> <br /> If you think somebody is violating your copyrights and want to notify us, you can contact us directly though our &quot;Contact&quot; section.<br /> <br /> BGA uses cookies. Cookies are stored on the computer of the subscriber, to record information relating to the navigation of the computer on the Site (such as pages viewed, date and time of visit, etc.) that BGA can read during subsequent visits. This allows for easier navigation and avoids having to provide at each new visit information that was already sent at an earlier date. It is stated that the shelf life of &quot;cookies&quot; created by BGA is less than 6 (six) months. BGA notifies the Player that the settings of his browser allows him to be alerted of the presence of &quot;cookies&quot; and to disable the use of &quot;cookies&quot; should he want to do so.<br /> <br /> <br /> == Your Content in our Services ==<br /> <br /> <br /> Some of our Services allow you to upload, submit, store, send or receive content. You retain ownership of any intellectual property rights that you hold in that content. In short, what belongs to you stays yours.<br /> <br /> When you upload, submit, store, send or receive content to or through our Services, you give BGA (and those we work with) a worldwide license to use, host, store, reproduce, modify, create derivative works (such as those resulting from translations, adaptations or other changes we make so that your content works better with our Services), communicate, publish, publicly perform, publicly display and distribute such content. The rights you grant in this license are for the limited purpose of operating, promoting, and improving our Services, and to develop new ones. This license continues even if you stop using our Services. Some Services may offer you ways to access and remove content that has been provided to that Service. Also, in some of our Services, there are terms or settings that narrow the scope of our use of the content submitted in those Services. Make sure you have the necessary rights to grant us this license for any content that you submit to our Services.<br /> <br /> Our automated systems analyze your content to provide you personally relevant features. This analysis occurs as the content is sent, received, and when it is stored.<br /> <br /> You can find more information about how BGA uses and stores content in the privacy policy or additional terms for particular Services. If you submit feedback or suggestions about our Services, we may use your feedback or suggestions without obligation to you.<br /> <br /> <br /> == About Software in our Services ==<br /> <br /> <br /> When a Service requires or includes downloadable software, this software may update automatically on your device once a new version or feature is available. Some Services may let you adjust your automatic update settings.<br /> <br /> BGA gives you a personal, worldwide, royalty-free, non-assignable and non-exclusive license to use the software provided to you by BGA as part of the Services. This license is for the sole purpose of enabling you to use and enjoy the benefit of the Services as provided by BGA, in the manner permitted by these terms. You may not copy, modify, distribute, sell, or lease any part of our Services or included software, nor may you reverse engineer or attempt to extract the source code of that software, unless laws prohibit those restrictions or you have our written permission.<br /> <br /> Open source software is important to us. Some software used in our Services may be offered under an open source license that we will make available to you. There may be provisions in the open source license that expressly override some of these terms.<br /> <br /> <br /> == Modifying and Terminating our Services ==<br /> <br /> <br /> We are constantly changing and improving our Services. We may add or remove functionalities or features, and we may suspend or stop a Service altogether.<br /> <br /> You can stop using our Services at any time, although we’ll be sorry to see you go. BGA may also stop providing Services to you, or add or create new limits to our Services at any time.<br /> <br /> We believe that you own your data and preserving your access to such data is important. If we discontinue a Service, where reasonably possible, we will give you reasonable advance notice and a chance to get information out of that Service.<br /> <br /> <br /> == Our Warranties and Disclaimers ==<br /> <br /> <br /> We provide our Services using a commercially reasonable level of skill and care and we hope that you will enjoy using them. But there are certain things that we don’t promise about our Services.<br /> <br /> OTHER THAN AS EXPRESSLY SET OUT IN THESE TERMS OR ADDITIONAL TERMS, NEITHER BGA NOR ITS SUPPLIERS OR DISTRIBUTORS MAKE ANY SPECIFIC PROMISES ABOUT THE SERVICES. FOR EXAMPLE, WE DON’T MAKE ANY COMMITMENTS ABOUT THE CONTENT WITHIN THE SERVICES, THE SPECIFIC FUNCTIONS OF THE SERVICES, OR THEIR RELIABILITY, AVAILABILITY, OR ABILITY TO MEET YOUR NEEDS. WE PROVIDE THE SERVICES “AS IS”.<br /> <br /> SOME JURISDICTIONS PROVIDE FOR CERTAIN WARRANTIES, LIKE THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. TO THE EXTENT PERMITTED BY LAW, WE EXCLUDE ALL WARRANTIES.<br /> <br /> <br /> == Liability for our Services ==<br /> <br /> <br /> WHEN PERMITTED BY LAW, BGA WILL NOT BE RESPONSIBLE FOR LOST PROFITS, REVENUES, OR DATA, FINANCIAL LOSSES OR INDIRECT, SPECIAL, CONSEQUENTIAL, EXEMPLARY, OR PUNITIVE DAMAGES.<br /> <br /> TO THE EXTENT PERMITTED BY LAW, THE TOTAL LIABILITY OF BGA, AND ITS SUPPLIERS AND DISTRIBUTORS, FOR ANY CLAIMS UNDER THESE TERMS, INCLUDING FOR ANY IMPLIED WARRANTIES, IS LIMITED TO THE AMOUNT YOU PAID US TO USE THE SERVICES (OR, IF WE CHOOSE, TO SUPPLYING YOU THE SERVICES AGAIN).<br /> <br /> IN ALL CASES, BGA, AND ITS SUPPLIERS AND DISTRIBUTORS, WILL NOT BE LIABLE FOR ANY LOSS OR DAMAGE THAT IS NOT REASONABLY FORESEEABLE.<br /> <br /> <br /> == Business uses of our Services ==<br /> <br /> <br /> If you are using our Services on behalf of a business, that business accepts these terms. It will hold harmless and indemnify BGA and its affiliates, officers, agents, and employees from any claim, suit or action arising from or related to the use of the Services or violation of these terms, including any liability or expense arising from claims, losses, damages, suits, judgments, litigation costs and attorneys’ fees.<br /> <br /> <br /> == About these Terms ==<br /> <br /> <br /> We may modify these terms or any additional terms that apply to a Service to, for example, reflect changes to the law or changes to our Services. You should look at the terms regularly. Changes will be effective immediately. If you do not agree to the modified terms for a Service, you should discontinue your use of that Service.<br /> <br /> If there is a conflict between these terms and the additional terms, the additional terms will control for that conflict.<br /> <br /> These terms control the relationship between BGA and you. They do not create any third party beneficiary rights.<br /> <br /> If you do not comply with these terms, and we don’t take action right away, this doesn’t mean that we are giving up any rights that we may have (such as taking action in the future).<br /> <br /> If it turns out that a particular term is not enforceable, this will not affect any other terms.<br /> <br /> The laws of France will apply to any disputes arising out of or relating to these terms or the Services. All claims arising out of or relating to these terms or the Services will be litigated exclusively in the French courts.<br /> <br /> For information about how to contact BGA, please visit our [http://boardgamearena.com/#!doc/contact contact page].</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelppuertorico&diff=1085 2014-03-02T10:27:41Z

<p>Een: /* Two players variant */</p> <hr /> <div><br /> == Goal ==<br /> <br /> Be the player with the most victory points at the end of the game by collecting:<br /> <br /> * victory points earned for buildings<br /> * victory point tokens earned at the captain phase<br /> * conditional victory points earned at the end of the game for occupied large buildings<br /> <br /> In case of a tie, the player owning the most doubloons and goods is the winner.<br /> <br /> == Rules summary ==<br /> <br /> The game is played over several rounds.<br /> At the start of a round, the governor selects a role, then each player in turn selects a role.<br /> At the end of the round, the governor token moves to the next player.<br /> <br /> When a role has been chosen, each player in turn plays the action for this role. Only the player who selected the role can use the role privilege.<br /> <br /> Available roles are the following:<br /> <br /> * Mayor: colonists set foot in the new world ! Privilege : the mayor can get one more colonist from the supply. Action : in turn, begining with the mayor, players get one colonist from the ship, until it is empty. Then players have to set colonists on their buildings and plantations.<br /> * Craftsman: goods are produced. Privilege : the craftsman can produce one more good of his choice. Action : produce goods for your occupied buildings and plantations.<br /> * Trader: goods are sold to the trading house. Privilege : the trader earns 1 extra doubloon if he sells. Action : sell one good the trading house doesn't have yet.<br /> * Settler : plantations settlement. Privilege : the settler can get a quarry instead of a plantation. Action : get a plantation chosen among those available.<br /> * Builder : buildings are bought and built. Privilege : the builder can get a building for 1 doubloon less than the regular price. Action : get a building chosen among those available.<br /> * Captain : victory points are won by shipping goods to the old world. Privilege : the captain earns one extra victory points if he ships some goods. Action : select a type of good to load on a cargo ship; 1 victory point is earned for each barrel of this type of good loaded on the ship.<br /> * Prospector : gold rush brings money ! Privilege : the prospector gets one doubloon from the bank. Action : none.<br /> <br /> Please also note that occupied violet buildings have modifier effects for role actions.<br /> <br /> End of game happens at the end of the round for which one of the following events comes to pass :<br /> <br /> * there is not enough colonists in the supply to refill the colonist ship at the end of the mayor phase<br /> * the last victory point token has been earned during the captain phase<br /> * at least one of the players built on his 12th and last free space in the city.<br /> <br /> == Playing online ==<br /> <br /> Choosing a role : click on the role of your choice in the list on the right of your game board.<br /> <br /> * Mayor role : accept or refuse to get an extra colonist from the supply. Colonists are then automatically recruited by players. Click on a building or a plantation to setup a colonist on it. Click on a colonist to send it back to San Juan (the counter for colonists in San Juan is situated in your player panel on the right of the page).<br /> <br /> * Craftsman role : goods production is automated (counters for goods owned are in the player panel on the right of the page). Then, choose one extra good that you can produce as your privilege.<br /> <br /> * Trader role : choose a good that you want to sell by clicking on the appropriate counter in your player panel.<br /> <br /> * Settler role : click on the plantation (or quarry) that you want. Placement on your board is automated.<br /> <br /> * Builder role : click on the building that you want to buy. Placement on your board is automated.<br /> <br /> * Captain role : click on the cargo boat on which you want to ship some goods. Then choose the type of good that you want to ship by clicking on the appropriate counter in your player panel. At the end of the captain phase, if you have some goods to store (warehouse or windrose), click on the corresponding counter. Stored goods will be highlighted by a red frame.<br /> <br /> * Prospector role : doubloon is earned immediately.<br /> <br /> Tooltips are available to give information on roles and buildings by hovering over game elements with the mouse.<br /> <br /> == 'Balanced game' variant ==<br /> <br /> This variant implements two game balance fixes giving each player an equal chance of winning as listed in the [http://en.wikipedia.org/wiki/Puerto_Rico_%28board_game%29 Puerto Rico (board game) Wikipedia page].<br /> <br /> * The prices of the Factory and University buildings are swapped so that the Factory costs 8 doubloons and the University costs 7 doubloons<br /> * Any player that starts with a corn plantation starts with 1 doubloon less than the players that start with an indigo plantation.<br /> <br /> == Two players variant ==<br /> <br /> Craftsman Angst : if this variant is selected, players alternate selecting a role as usual, until the Governor has selected '''three''' roles and the opponent has selected '''two''' roles (instead of three in a classic two players game), then the governor token goes to the opponent and a new round starts.<br /> This variant avoids the consecutive selection of two roles by the same player which happens on a change of round with the classic two player game rules.<br /> <br /> This variant is described on [http://www.boardgamegeek.com/thread/679955/the-craftsman-angst-variant-the-most-popular-revis Board Game Geek].<br /> <br /> <br /> '''Have a good game !'''</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelppuertorico&diff=1084 2014-03-02T10:26:22Z

<p>Een: </p> <hr /> <div><br /> == Goal ==<br /> <br /> Be the player with the most victory points at the end of the game by collecting:<br /> <br /> * victory points earned for buildings<br /> * victory point tokens earned at the captain phase<br /> * conditional victory points earned at the end of the game for occupied large buildings<br /> <br /> In case of a tie, the player owning the most doubloons and goods is the winner.<br /> <br /> == Rules summary ==<br /> <br /> The game is played over several rounds.<br /> At the start of a round, the governor selects a role, then each player in turn selects a role.<br /> At the end of the round, the governor token moves to the next player.<br /> <br /> When a role has been chosen, each player in turn plays the action for this role. Only the player who selected the role can use the role privilege.<br /> <br /> Available roles are the following:<br /> <br /> * Mayor: colonists set foot in the new world ! Privilege : the mayor can get one more colonist from the supply. Action : in turn, begining with the mayor, players get one colonist from the ship, until it is empty. Then players have to set colonists on their buildings and plantations.<br /> * Craftsman: goods are produced. Privilege : the craftsman can produce one more good of his choice. Action : produce goods for your occupied buildings and plantations.<br /> * Trader: goods are sold to the trading house. Privilege : the trader earns 1 extra doubloon if he sells. Action : sell one good the trading house doesn't have yet.<br /> * Settler : plantations settlement. Privilege : the settler can get a quarry instead of a plantation. Action : get a plantation chosen among those available.<br /> * Builder : buildings are bought and built. Privilege : the builder can get a building for 1 doubloon less than the regular price. Action : get a building chosen among those available.<br /> * Captain : victory points are won by shipping goods to the old world. Privilege : the captain earns one extra victory points if he ships some goods. Action : select a type of good to load on a cargo ship; 1 victory point is earned for each barrel of this type of good loaded on the ship.<br /> * Prospector : gold rush brings money ! Privilege : the prospector gets one doubloon from the bank. Action : none.<br /> <br /> Please also note that occupied violet buildings have modifier effects for role actions.<br /> <br /> End of game happens at the end of the round for which one of the following events comes to pass :<br /> <br /> * there is not enough colonists in the supply to refill the colonist ship at the end of the mayor phase<br /> * the last victory point token has been earned during the captain phase<br /> * at least one of the players built on his 12th and last free space in the city.<br /> <br /> == Playing online ==<br /> <br /> Choosing a role : click on the role of your choice in the list on the right of your game board.<br /> <br /> * Mayor role : accept or refuse to get an extra colonist from the supply. Colonists are then automatically recruited by players. Click on a building or a plantation to setup a colonist on it. Click on a colonist to send it back to San Juan (the counter for colonists in San Juan is situated in your player panel on the right of the page).<br /> <br /> * Craftsman role : goods production is automated (counters for goods owned are in the player panel on the right of the page). Then, choose one extra good that you can produce as your privilege.<br /> <br /> * Trader role : choose a good that you want to sell by clicking on the appropriate counter in your player panel.<br /> <br /> * Settler role : click on the plantation (or quarry) that you want. Placement on your board is automated.<br /> <br /> * Builder role : click on the building that you want to buy. Placement on your board is automated.<br /> <br /> * Captain role : click on the cargo boat on which you want to ship some goods. Then choose the type of good that you want to ship by clicking on the appropriate counter in your player panel. At the end of the captain phase, if you have some goods to store (warehouse or windrose), click on the corresponding counter. Stored goods will be highlighted by a red frame.<br /> <br /> * Prospector role : doubloon is earned immediately.<br /> <br /> Tooltips are available to give information on roles and buildings by hovering over game elements with the mouse.<br /> <br /> == 'Balanced game' variant ==<br /> <br /> This variant implements two game balance fixes giving each player an equal chance of winning as listed in the [http://en.wikipedia.org/wiki/Puerto_Rico_%28board_game%29 Puerto Rico (board game) Wikipedia page].<br /> <br /> * The prices of the Factory and University buildings are swapped so that the Factory costs 8 doubloons and the University costs 7 doubloons<br /> * Any player that starts with a corn plantation starts with 1 doubloon less than the players that start with an indigo plantation.<br /> <br /> == Two players variant ==<br /> <br /> Craftsman Angst : if this variant is selected, players alternate selecting a role as usual, until the Governor has selected three roles and the opponent has selected two (instead of three in a classic two players game), then the governor token goes to the opponent and a new round starts.<br /> So it avoids the consecutive selection of two roles by the same player that happens on a change of round with the classic two player game.<br /> <br /> This variant is described on [http://www.boardgamegeek.com/thread/679955/the-craftsman-angst-variant-the-most-popular-revis Board Game Geek].<br /> <br /> <br /> '''Have a good game !'''</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Stock&diff=1082 2014-02-24T18:33:09Z

<p>Een: </p> <hr /> <div><br /> &quot;Stock&quot; is a javascript component that you can use on your game interface to display a set of elements of the same size that need to be arranged in one or several lines.<br /> <br /> Stock is very flexible and is the most used component in BGA games.<br /> <br /> Stock is used for example:<br /> * To display set of cards, typically hands (ex: in Hearts, Seasons, The Boss, Race for the Galaxy, ...).<br /> * To display items in player panels (ex: Takenoko, Amyitis, ...)<br /> * ... in many other situations. For example, black dice and cubes on cards in Troyes are displayed with stock components.<br /> <br /> Using stock:<br /> * Your items are arranged nicely and sorted by type.<br /> * When adding (or removing) items to the set. All items slide smoothly to their new position in the set to host the new one.<br /> * Select/unselect items is a built-in functionnality.<br /> * You don't have to care about inserting/removing HTML piece of code: the entire life of the stock is managed by the component.<br /> <br /> == Using stock: a simple example ==<br /> <br /> Let's have a look on how the stock is used in game &quot;Hearts&quot; to display a hand of standard cards.<br /> <br /> At first, don't forget to add &quot;ebg/stock&quot; as a dependency:<br /> &lt;pre&gt;<br /> define([<br /> &quot;dojo&quot;,&quot;dojo/_base/declare&quot;,<br /> &quot;ebg/core/gamegui&quot;,<br /> &quot;ebg/counter&quot;,<br /> &quot;ebg/stock&quot; /// &lt;==== HERE<br /> ],<br /> &lt;/pre&gt;<br /> <br /> The stock is initialized in Javascript &quot;setup&quot; method like this:<br /> &lt;pre&gt;<br /> // Player hand<br /> this.playerHand = new ebg.stock();<br /> this.playerHand.create( this, $('myhand'), this.cardwidth, this.cardheight );<br /> &lt;/pre&gt;<br /> <br /> Explanations:<br /> * We create a new stock object for the player hand.<br /> * As parameters of the &quot;create&quot; method, we provide the width/height of an item (=a card), and the container div &quot;myhand&quot; - which is a simple void &quot;div&quot; element defines in our HTML template (.tpl).<br /> <br /> Then, we must tell the stock what are the items it is going to display during its life: the 52 cards of a standard card game. Of course, we did not create 52 different images, but create a &quot;CSS sprite&quot; image named &quot;cards.jpg&quot; with all the cards arranged in 4 rows and 13 columns.<br /> <br /> Here's how we tell stock what are the items type to display:<br /> &lt;pre&gt;<br /> // Explain there are 13 images per row in the CSS sprite image<br /> this.playerHand.image_items_per_row = 13;<br /> <br /> // Create cards types:<br /> for( var color=1;color&lt;=4;color++ )<br /> {<br /> for( var value=2;value&lt;=14;value++ )<br /> {<br /> // Build card type id<br /> var card_type_id = this.getCardUniqueId( color, value );<br /> this.playerHand.addItemType( card_type_id, card_type_id, g_gamethemeurl+'img/cards.jpg', card_type_id );<br /> }<br /> }<br /> &lt;/pre&gt;<br /> <br /> Explanations:<br /> * At first, we tell the stock component that our CSS sprite contains 13 items per row. This way, it can find the correct image for each card type id.<br /> * Then for the 4x13 cards, we call &quot;addItemType&quot; method that create the type. The arguments are the type id, the weight of the card (for sorting purpose), the URL of our CSS sprite, and the position of our card image in the CSS sprite.<br /> <br /> Note: in this specific example we need to generate a unique ID for each type of card based on its color and value. This is the only purpose of &quot;getCardUniqueId&quot;.<br /> <br /> From now, if we need to add - for example - the 5 of Heart to player's hand, we can do this.<br /> this.playerHand.addToStock( this.getCardUniqueId( 2 /* 2=hearts */, 5 ) );<br /> <br /> In reality, cards have some IDs, which are useful to manipulate them. This is the reason we are using &quot;addToStockWithId&quot; instead:<br /> this.playerHand.addToStock( this.getCardUniqueId( 2 /* 2=hearts */, 5 ), my_card_id );<br /> <br /> If afterwards we want to remove this card from the stock:<br /> this.playerHand.removeFromStockById( my_card_id );<br /> <br /> == Complete stock component reference ==<br /> <br /> '''create( page, container_div, item_width, item_height ):'''<br /> <br /> With create, you create a new stock component.<br /> Parameters:<br /> * page: the container page. Usually: &quot;this&quot;.<br /> * container_div: the container &quot;div&quot; element (a void div element in your template, with an id).<br /> * a stock item width and height, in pixels.<br /> <br /> (See &quot;Hearts&quot; example above).<br /> <br /> <br /> '''count():'''<br /> <br /> Return the total number of items in the stock right now.<br /> <br /> '''addItemType( type, weight, image, image_position ):'''<br /> <br /> Define a new type of item to the stock.<br /> <br /> <br /> This is mandatory to define a new item type before adding it to the stock. Example: if you want to have a stock control that can contains cubes of 3 different colors, you must add 3 item types (one for each color).<br /> <br /> Parameters:<br /> * type: ID of the type to add. You can choose any positive integer. All item types must have distinct IDs.<br /> * weight: weight of items of this type. Weight value is used to sort items of the stock during the display. Note that you can specify the same weight for all items (in this case they are not sorted and their order might change randomly at any time).<br /> * image: URL of item image. Most of the time, you will use a CSS sprite for stock item, so you have to specify CSS sprite image here.<br /> <br /> Be careful: you must specify the image url as this:<br /> &lt;pre&gt;<br /> g_gamethemeurl+'img/yourimage.png'<br /> &lt;/pre&gt;<br /> * image_position: if &quot;image&quot; specify the URL of a CSS sprite, you must specify the position of the item image in this CSS sprite. For example, if you have a CSS sprite with 3 cubes with a size of 20x20 pixels each (so your CSS image has for example a size of 20x60 or 60x20), you specify &quot;0&quot; for the first cube image, 1 for the second, 2 for the third.<br /> Important: there are more than one line of items in your CSS sprite, you must specify how many items per line you have in your CSS sprite like this:<br /> &lt;pre&gt;<br /> // Specify that there is 10 image items per row in images used in &quot;myStockObject&quot; control.<br /> this.myStockObject.image_items_per_row = 10;<br /> &lt;/pre&gt;<br /> <br /> '''addToStock( type, from )'''<br /> <br /> Add an item to the stock, with the specified type.<br /> <br /> To make your life easy, in most of the case we suggest you to use &quot;addToStockWithId&quot; in order to give an ID to the item added. &quot;addToStock&quot; is perfect when you are using a stock controls with items that are generic game material that does not need to be addressed individually (ex: a bunch of money tokens).<br /> <br /> Parameters:<br /> * type: ID of the item type to use (as specified in &quot;addItemType&quot;)<br /> * from: OPTIONNAL: if you specify a HTML item here, the item will appear on this item and will be slided to its position on the stock item.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> // Add a money token to the &quot;player money&quot; stock.<br /> // The money token will appear on &quot;player_id&quot; player panel and will move to its position.<br /> this.playerMoney.addToStock( MONEY_TOKEN, 'overall_player_board_'+player_id );<br /> &lt;/pre&gt;<br /> <br /> Important: for a given stock control, you must use either addToStock or addToStockWithId, but NEVER BOTH OF THEM.<br /> <br /> '''addToStockWithId( type, id, from )'''<br /> <br /> This is exactly the same method than &quot;addToStock&quot;, except that you associate an ID to the newly created item.<br /> <br /> This is especially useful:<br /> * When you need to know which item(s) has been selected by the user (see &quot;getSelectedItems&quot;).<br /> * When you need to remove a specific item from the stock with &quot;removeFromStockById&quot;<br /> <br /> Important: for a given stock control, you must use either addToStock or addToStockWithId, but NEVER BOTH OF THEM.<br /> <br /> '''removeFromStock( type, to )'''<br /> <br /> Remove an item of the specific type from the stock.<br /> <br /> &quot;to&quot; is an optional parameter. If &quot;to&quot; contains the ID of an HTML element, the item removed from the stock is slided to this HTML element before it disappear.<br /> <br /> '''removeFromStockById( id, to )'''<br /> <br /> Remove an item with a specific ID from the stock.<br /> <br /> &quot;to&quot; is an optional parameter. If &quot;to&quot; contains the ID of an HTML element, the item removed from the stock is slided to this HTML element before it disappear.<br /> <br /> '''removeAll()'''<br /> <br /> Remove all items from the stock.<br /> <br /> '''getPresentTypeList()'''<br /> <br /> Return an array with all the types of items present in the stock right now.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.myStockControl.removeAll();<br /> this.myStockControl.addToStock( 65 );<br /> this.myStockControl.addToStock( 34 );<br /> this.myStockControl.addToStock( 89 );<br /> this.myStockControl.addToStock( 65 );<br /> <br /> // The following returns: { 34:1, 65:1, 89:1 }<br /> var item_types = this.myStockControl.getPresentTypeList();<br /> &lt;/pre&gt;<br /> <br /> '''resetItemsPosition()'''<br /> <br /> If you moved an item from the stock control manually (ex: after a drag'n'drop) and want to reset their position to their original ones, you can call this method.<br /> <br /> '''item_margin'''<br /> <br /> By default, there is a margin of 5px between the items of a stock. You can change the member variable &quot;item_margin&quot; to change this.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.myStockControl.item_margin=5;<br /> &lt;/pre&gt;<br /> <br /> '''changeItemsWeight( newWeights )'''<br /> <br /> With this method you can change dynamically the weight of the item types in a stock control.<br /> <br /> Items are immediately re-sorted with the new weight.<br /> <br /> Example: with a stock control that contains classic cards, you can order them by value or by color. Using changeItemsWeight you can switch from one sort method to another when a player request this.<br /> <br /> newWeights is an associative array: item type id =&gt; new weight.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> // Item type 1 gets a new weight of 10, 2 a new weight of 20, 3 a new weight of 30.<br /> this.myStockControl.changeItemsWeight( { 1: 10, 2: 20, 3: 30 } );<br /> &lt;/pre&gt;<br /> <br /> '''setSelectionMode( mode )'''<br /> <br /> For each stock control, you can specify a selection mode:<br /> * 0: no item can be selected by the player.<br /> * 1: a maximum of one item can be selected by the player at the same time.<br /> * 2: several items can be selected by the player at the same time.<br /> <br /> '''setSelectionAppeareance( type )'''<br /> <br /> For each stock control, you can specify a selection highlighting type:<br /> * 'border': there will be a red border around selected items (this is the default). The attribute 'apparenceBorderWidth' can be used to manage the width of the border (in pixels).<br /> * 'disappear': the selected item will fade out and disappear. This is useful when the selection has the effect of destroying the item.<br /> * 'class': there will be an extra 'stockitem_selecte' css class added to the element when it is selected (and removed when unselected). You can override this class in the css file for your game.<br /> <br /> By default this class definition is:<br /> &lt;pre&gt;<br /> .stockitem_selected {<br /> border: 2px solid red ! important;<br /> }<br /> &lt;/pre&gt;<br /> <br /> If you want to override it for example to change the border color add this in your &lt;game&gt;.css file:<br /> &lt;pre&gt;<br /> .stockitem_selected {<br /> border: 2px solid orange ! important;<br /> }<br /> &lt;/pre&gt;<br /> <br /> NB: the 'class' highlighting type has not yet been deployed on the studio - 24/02/2014. This warning will be removed after the next upgrade.<br /> <br /> <br /> '''isSelected( id )'''<br /> <br /> Return true/false wether the specified item id has been selected or not.<br /> <br /> '''selectItem( id )'''<br /> <br /> Select the specified item.<br /> <br /> '''unselectItem( id )'''<br /> <br /> Unselect the specified item.<br /> <br /> '''unselectAll()'''<br /> <br /> Unselect all items of the stock.<br /> <br /> '''onChangeSelection'''<br /> <br /> This callback method is called when the player select/unselect an item of the stock.<br /> <br /> You can connect this to one of your method like this:<br /> &lt;pre&gt;<br /> dojo.connect( this.myStockControl, 'onChangeSelection', this, 'onMyMethodToCall' );<br /> <br /> (...)<br /> <br /> onMyMethodToCall: function( control_name )<br /> {<br /> // This method is called when myStockControl selected items changed<br /> var items = this.myStockControl.getSelectedItems();<br /> <br /> // (do something)<br /> },<br /> &lt;/pre&gt;<br /> <br /> Note: The &quot;control_name&quot; argument is the ID (the &quot;DOM&quot; id) of the &quot;div&quot; container of your stock control. Using &quot;control_name&quot;, you can use the same callback method for different Stock control and see which one trigger the method.<br /> <br /> '''getSelectedItems()'''<br /> <br /> Return the list of selected items, as an array with the following format:<br /> &lt;pre&gt;<br /> [<br /> { type:1, id: 1001 },<br /> { type:1, id: 1002 },<br /> { type:3, id: 1003 }<br /> ...<br /> ]<br /> &lt;/pre&gt;<br /> <br /> '''getUnselectedItems()'''<br /> <br /> Same as the previous one, but return unselected item instead of seleted ones.<br /> <br /> '''getAllItems()'''<br /> <br /> Get all items (same format than getSelectedItems and getUnselectedItems).<br /> <br /> '''setOverlap( horizontal_percent, vertical_percent )'''<br /> <br /> Make items on the stock control &quot;overlap&quot; on each other, to save space.<br /> <br /> By default, horizontal_overlap and vertical_overlap are 0.<br /> <br /> When horizontal_overlap=20, it means that a stock item must overlap on 20% of the width of the previous item. horizontal_overlap can't be over 100.<br /> <br /> vertical_overlap works differently: one items on two are shifted up.<br /> <br /> See &quot;Jaipur&quot; game to see an example to use of this function.<br /> <br /> '''onItemCreate'''<br /> <br /> Using onItemCreate, you can trigger a method each time a new item is added to the Stock, in order you can customize it.<br /> <br /> Complete example:<br /> &lt;pre&gt;<br /> // During &quot;setup&quot; phase, we associate our method &quot;setupNewCard&quot; with the creation of a new stock item:<br /> this.myStockItem.onItemCreate = dojo.hitch( this, 'setupNewCard' ); <br /> <br /> (...)<br /> <br /> // And here is our &quot;setupNewCard&quot;:<br /> setupNewCard: function( card_div, card_type_id, card_id )<br /> {<br /> // Add a special tooltip on the card:<br /> this.addTooltip( card_div.id, _(&quot;Some nice tooltip for this item&quot;), '' );<br /> <br /> // Note that &quot;card_type_id&quot; contains the type of the item, so you can do special actions depending on the item type<br /> <br /> // Add some custom HTML content INSIDE the Stock item:<br /> dojo.place( this.format_block( 'jstpl_my_card_content', {<br /> ....<br /> } ), card_div.id );<br /> }<br /> <br /> &lt;/pre&gt;<br /> <br /> == Tips when adding/removing items to/from Stock components ==<br /> <br /> The usual way is the following:<br /> <br /> '''Situation A''':<br /> <br /> When you add a card to a stock item, and this card is '''not''' coming from another stock: use &quot;addToStockWithId&quot; with a &quot;from&quot; argument set to the element of your interface where card should come from.<br /> <br /> '''Situation B''':<br /> <br /> When you add a card to a stock item, and this card is coming from another stock:<br /> * on the destination Stock, use &quot;addToStockWithId&quot; with a &quot;from&quot; equals to the HTML id of the corresponding item in the source Stock. For example, If the source stock id is &quot;myHand&quot;, then the HTML id of card 48 is &quot;myHand_item_48&quot;.<br /> * then, remove the source item with &quot;removeFromStockById&quot;.<br /> (note that it's important to do things in this order, because source item must still exists when you use it as the origin of the slide).<br /> <br /> '''Situation C''':<br /> <br /> When you move a card from a stock item to something that is not a stock item:<br /> * insert the card as a classic HTML template (dojo.place / this.format_block).<br /> * place it on the Stock item with &quot;this.placeOnObject&quot;, using Stock item HTML id (see above).<br /> * slide it to its new position with &quot;this.slideToObject&quot;<br /> * remove the card from the Stock item with &quot;removeFromStockById&quot;.<br /> <br /> Using the methods above, your cards should slide to, from and between your Stock controls smoothly</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Stock&diff=1081 2014-02-24T18:22:08Z

<p>Een: </p> <hr /> <div><br /> &quot;Stock&quot; is a javascript component that you can use on your game interface to display a set of elements of the same size that need to be arranged in one or several lines.<br /> <br /> Stock is very flexible and is the most used component in BGA games.<br /> <br /> Stock is used for example:<br /> * To display set of cards, typically hands (ex: in Hearts, Seasons, The Boss, Race for the Galaxy, ...).<br /> * To display items in player panels (ex: Takenoko, Amyitis, ...)<br /> * ... in many other situations. For example, black dice and cubes on cards in Troyes are displayed with stock components.<br /> <br /> Using stock:<br /> * Your items are arranged nicely and sorted by type.<br /> * When adding (or removing) items to the set. All items slide smoothly to their new position in the set to host the new one.<br /> * Select/unselect items is a built-in functionnality.<br /> * You don't have to care about inserting/removing HTML piece of code: the entire life of the stock is managed by the component.<br /> <br /> == Using stock: a simple example ==<br /> <br /> Let's have a look on how the stock is used in game &quot;Hearts&quot; to display a hand of standard cards.<br /> <br /> At first, don't forget to add &quot;ebg/stock&quot; as a dependency:<br /> &lt;pre&gt;<br /> define([<br /> &quot;dojo&quot;,&quot;dojo/_base/declare&quot;,<br /> &quot;ebg/core/gamegui&quot;,<br /> &quot;ebg/counter&quot;,<br /> &quot;ebg/stock&quot; /// &lt;==== HERE<br /> ],<br /> &lt;/pre&gt;<br /> <br /> The stock is initialized in Javascript &quot;setup&quot; method like this:<br /> &lt;pre&gt;<br /> // Player hand<br /> this.playerHand = new ebg.stock();<br /> this.playerHand.create( this, $('myhand'), this.cardwidth, this.cardheight );<br /> &lt;/pre&gt;<br /> <br /> Explanations:<br /> * We create a new stock object for the player hand.<br /> * As parameters of the &quot;create&quot; method, we provide the width/height of an item (=a card), and the container div &quot;myhand&quot; - which is a simple void &quot;div&quot; element defines in our HTML template (.tpl).<br /> <br /> Then, we must tell the stock what are the items it is going to display during its life: the 52 cards of a standard card game. Of course, we did not create 52 different images, but create a &quot;CSS sprite&quot; image named &quot;cards.jpg&quot; with all the cards arranged in 4 rows and 13 columns.<br /> <br /> Here's how we tell stock what are the items type to display:<br /> &lt;pre&gt;<br /> // Explain there are 13 images per row in the CSS sprite image<br /> this.playerHand.image_items_per_row = 13;<br /> <br /> // Create cards types:<br /> for( var color=1;color&lt;=4;color++ )<br /> {<br /> for( var value=2;value&lt;=14;value++ )<br /> {<br /> // Build card type id<br /> var card_type_id = this.getCardUniqueId( color, value );<br /> this.playerHand.addItemType( card_type_id, card_type_id, g_gamethemeurl+'img/cards.jpg', card_type_id );<br /> }<br /> }<br /> &lt;/pre&gt;<br /> <br /> Explanations:<br /> * At first, we tell the stock component that our CSS sprite contains 13 items per row. This way, it can find the correct image for each card type id.<br /> * Then for the 4x13 cards, we call &quot;addItemType&quot; method that create the type. The arguments are the type id, the weight of the card (for sorting purpose), the URL of our CSS sprite, and the position of our card image in the CSS sprite.<br /> <br /> Note: in this specific example we need to generate a unique ID for each type of card based on its color and value. This is the only purpose of &quot;getCardUniqueId&quot;.<br /> <br /> From now, if we need to add - for example - the 5 of Heart to player's hand, we can do this.<br /> this.playerHand.addToStock( this.getCardUniqueId( 2 /* 2=hearts */, 5 ) );<br /> <br /> In reality, cards have some IDs, which are useful to manipulate them. This is the reason we are using &quot;addToStockWithId&quot; instead:<br /> this.playerHand.addToStock( this.getCardUniqueId( 2 /* 2=hearts */, 5 ), my_card_id );<br /> <br /> If afterwards we want to remove this card from the stock:<br /> this.playerHand.removeFromStockById( my_card_id );<br /> <br /> == Complete stock component reference ==<br /> <br /> '''create( page, container_div, item_width, item_height ):'''<br /> <br /> With create, you create a new stock component.<br /> Parameters:<br /> * page: the container page. Usually: &quot;this&quot;.<br /> * container_div: the container &quot;&lt;div&gt;&quot; element (a void &lt;div&gt; element in your template, with an id).<br /> * a stock item width and height, in pixels.<br /> <br /> (See &quot;Hearts&quot; example above).<br /> <br /> <br /> '''count():'''<br /> <br /> Return the total number of items in the stock right now.<br /> <br /> '''addItemType( type, weight, image, image_position ):'''<br /> <br /> Define a new type of item to the stock.<br /> <br /> <br /> This is mandatory to define a new item type before adding it to the stock. Example: if you want to have a stock control that can contains cubes of 3 different colors, you must add 3 item types (one for each color).<br /> <br /> Parameters:<br /> * type: ID of the type to add. You can choose any positive integer. All item types must have distinct IDs.<br /> * weight: weight of items of this type. Weight value is used to sort items of the stock during the display. Note that you can specify the same weight for all items (in this case they are not sorted and their order might change randomly at any time).<br /> * image: URL of item image. Most of the time, you will use a CSS sprite for stock item, so you have to specify CSS sprite image here.<br /> <br /> Be careful: you must specify the image url as this:<br /> &lt;pre&gt;<br /> g_gamethemeurl+'img/yourimage.png'<br /> &lt;/pre&gt;<br /> * image_position: if &quot;image&quot; specify the URL of a CSS sprite, you must specify the position of the item image in this CSS sprite. For example, if you have a CSS sprite with 3 cubes with a size of 20x20 pixels each (so your CSS image has for example a size of 20x60 or 60x20), you specify &quot;0&quot; for the first cube image, 1 for the second, 2 for the third.<br /> Important: there are more than one line of items in your CSS sprite, you must specify how many items per line you have in your CSS sprite like this:<br /> &lt;pre&gt;<br /> // Specify that there is 10 image items per row in images used in &quot;myStockObject&quot; control.<br /> this.myStockObject.image_items_per_row = 10;<br /> &lt;/pre&gt;<br /> <br /> '''addToStock( type, from )'''<br /> <br /> Add an item to the stock, with the specified type.<br /> <br /> To make your life easy, in most of the case we suggest you to use &quot;addToStockWithId&quot; in order to give an ID to the item added. &quot;addToStock&quot; is perfect when you are using a stock controls with items that are generic game material that does not need to be addressed individually (ex: a bunch of money tokens).<br /> <br /> Parameters:<br /> * type: ID of the item type to use (as specified in &quot;addItemType&quot;)<br /> * from: OPTIONNAL: if you specify a HTML item here, the item will appear on this item and will be slided to its position on the stock item.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> // Add a money token to the &quot;player money&quot; stock.<br /> // The money token will appear on &quot;player_id&quot; player panel and will move to its position.<br /> this.playerMoney.addToStock( MONEY_TOKEN, 'overall_player_board_'+player_id );<br /> &lt;/pre&gt;<br /> <br /> Important: for a given stock control, you must use either addToStock or addToStockWithId, but NEVER BOTH OF THEM.<br /> <br /> '''addToStockWithId( type, id, from )'''<br /> <br /> This is exactly the same method than &quot;addToStock&quot;, except that you associate an ID to the newly created item.<br /> <br /> This is especially useful:<br /> * When you need to know which item(s) has been selected by the user (see &quot;getSelectedItems&quot;).<br /> * When you need to remove a specific item from the stock with &quot;removeFromStockById&quot;<br /> <br /> Important: for a given stock control, you must use either addToStock or addToStockWithId, but NEVER BOTH OF THEM.<br /> <br /> '''removeFromStock( type, to )'''<br /> <br /> Remove an item of the specific type from the stock.<br /> <br /> &quot;to&quot; is an optional parameter. If &quot;to&quot; contains the ID of an HTML element, the item removed from the stock is slided to this HTML element before it disappear.<br /> <br /> '''removeFromStockById( id, to )'''<br /> <br /> Remove an item with a specific ID from the stock.<br /> <br /> &quot;to&quot; is an optional parameter. If &quot;to&quot; contains the ID of an HTML element, the item removed from the stock is slided to this HTML element before it disappear.<br /> <br /> '''removeAll()'''<br /> <br /> Remove all items from the stock.<br /> <br /> '''getPresentTypeList()'''<br /> <br /> Return an array with all the types of items present in the stock right now.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.myStockControl.removeAll();<br /> this.myStockControl.addToStock( 65 );<br /> this.myStockControl.addToStock( 34 );<br /> this.myStockControl.addToStock( 89 );<br /> this.myStockControl.addToStock( 65 );<br /> <br /> // The following returns: { 34:1, 65:1, 89:1 }<br /> var item_types = this.myStockControl.getPresentTypeList();<br /> &lt;/pre&gt;<br /> <br /> '''resetItemsPosition()'''<br /> <br /> If you moved an item from the stock control manually (ex: after a drag'n'drop) and want to reset their position to their original ones, you can call this method.<br /> <br /> '''item_margin'''<br /> <br /> By default, there is a margin of 5px between the items of a stock. You can change the member variable &quot;item_margin&quot; to change this.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.myStockControl.item_margin=5;<br /> &lt;/pre&gt;<br /> <br /> '''changeItemsWeight( newWeights )'''<br /> <br /> With this method you can change dynamically the weight of the item types in a stock control.<br /> <br /> Items are immediately re-sorted with the new weight.<br /> <br /> Example: with a stock control that contains classic cards, you can order them by value or by color. Using changeItemsWeight you can switch from one sort method to another when a player request this.<br /> <br /> newWeights is an associative array: item type id =&gt; new weight.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> // Item type 1 gets a new weight of 10, 2 a new weight of 20, 3 a new weight of 30.<br /> this.myStockControl.changeItemsWeight( { 1: 10, 2: 20, 3: 30 } );<br /> &lt;/pre&gt;<br /> <br /> '''setSelectionMode( mode )'''<br /> <br /> For each stock control, you can specify a selection mode:<br /> * 0: no item can be selected by the player.<br /> * 1: a maximum of one item can be selected by the player at the same time.<br /> * 2: several items can be selected by the player at the same time.<br /> <br /> '''setSelectionAppeareance( type )'''<br /> <br /> For each stock control, you can specify a selection highlighting type:<br /> * 'border': there will be a red border around selected items (this is the default). The attribute 'apparenceBorderWidth' can be used to manage the width of the border (in pixels).<br /> * 'disappear': the selected item will fade out and disappear. This is useful when the selection has the effect of destroying the item.<br /> * 'class': there will be an extra 'stockitem_selecte' css class added to the element when it is selected (and removed when unselected). You can override this class in the css file for your game.<br /> <br /> By default this class definition is:<br /> &lt;pre&gt;<br /> .stockitem_selected {<br /> border: 2px solid red ! important;<br /> }<br /> &lt;/pre&gt;<br /> <br /> If you want to override it for example to change the border color add this in your &lt;game&gt;.css file:<br /> &lt;pre&gt;<br /> .stockitem_selected {<br /> border: 2px solid orange ! important;<br /> }<br /> &lt;/pre&gt;<br /> <br /> NB: the 'class' highlighting type has not yet been deployed on the studio - 24/02/2014. This warning will be removed after the next upgrade.<br /> <br /> <br /> '''isSelected( id )'''<br /> <br /> Return true/false wether the specified item id has been selected or not.<br /> <br /> '''selectItem( id )'''<br /> <br /> Select the specified item.<br /> <br /> '''unselectItem( id )'''<br /> <br /> Unselect the specified item.<br /> <br /> '''unselectAll()'''<br /> <br /> Unselect all items of the stock.<br /> <br /> '''onChangeSelection'''<br /> <br /> This callback method is called when the player select/unselect an item of the stock.<br /> <br /> You can connect this to one of your method like this:<br /> &lt;pre&gt;<br /> dojo.connect( this.myStockControl, 'onChangeSelection', this, 'onMyMethodToCall' );<br /> <br /> (...)<br /> <br /> onMyMethodToCall: function( control_name )<br /> {<br /> // This method is called when myStockControl selected items changed<br /> var items = this.myStockControl.getSelectedItems();<br /> <br /> // (do something)<br /> },<br /> &lt;/pre&gt;<br /> <br /> Note: The &quot;control_name&quot; argument is the ID (the &quot;DOM&quot; id) of the &lt;div&gt; container of your stock control. Using &quot;control_name&quot;, you can use the same callback method for different Stock control and see which one trigger the method.<br /> <br /> '''getSelectedItems()'''<br /> <br /> Return the list of selected items, as an array with the following format:<br /> &lt;pre&gt;<br /> [<br /> { type:1, id: 1001 },<br /> { type:1, id: 1002 },<br /> { type:3, id: 1003 }<br /> ...<br /> ]<br /> &lt;/pre&gt;<br /> <br /> '''getUnselectedItems()'''<br /> <br /> Same as the previous one, but return unselected item instead of seleted ones.<br /> <br /> '''getAllItems()'''<br /> <br /> Get all items (same format than getSelectedItems and getUnselectedItems).<br /> <br /> '''setOverlap( horizontal_percent, vertical_percent )'''<br /> <br /> Make items on the stock control &quot;overlap&quot; on each other, to save space.<br /> <br /> By default, horizontal_overlap and vertical_overlap are 0.<br /> <br /> When horizontal_overlap=20, it means that a stock item must overlap on 20% of the width of the previous item. horizontal_overlap can't be over 100.<br /> <br /> vertical_overlap works differently: one items on two are shifted up.<br /> <br /> See &quot;Jaipur&quot; game to see an example to use of this function.<br /> <br /> '''onItemCreate'''<br /> <br /> Using onItemCreate, you can trigger a method each time a new item is added to the Stock, in order you can customize it.<br /> <br /> Complete example:<br /> &lt;pre&gt;<br /> // During &quot;setup&quot; phase, we associate our method &quot;setupNewCard&quot; with the creation of a new stock item:<br /> this.myStockItem.onItemCreate = dojo.hitch( this, 'setupNewCard' ); <br /> <br /> (...)<br /> <br /> // And here is our &quot;setupNewCard&quot;:<br /> setupNewCard: function( card_div, card_type_id, card_id )<br /> {<br /> // Add a special tooltip on the card:<br /> this.addTooltip( card_div.id, _(&quot;Some nice tooltip for this item&quot;), '' );<br /> <br /> // Note that &quot;card_type_id&quot; contains the type of the item, so you can do special actions depending on the item type<br /> <br /> // Add some custom HTML content INSIDE the Stock item:<br /> dojo.place( this.format_block( 'jstpl_my_card_content', {<br /> ....<br /> } ), card_div.id );<br /> }<br /> <br /> &lt;/pre&gt;<br /> <br /> == Tips when adding/removing items to/from Stock components ==<br /> <br /> The usual way is the following:<br /> <br /> '''Situation A''':<br /> <br /> When you add a card to a stock item, and this card is '''not''' coming from another stock: use &quot;addToStockWithId&quot; with a &quot;from&quot; argument set to the element of your interface where card should come from.<br /> <br /> '''Situation B''':<br /> <br /> When you add a card to a stock item, and this card is coming from another stock:<br /> * on the destination Stock, use &quot;addToStockWithId&quot; with a &quot;from&quot; equals to the HTML id of the corresponding item in the source Stock. For example, If the source stock id is &quot;myHand&quot;, then the HTML id of card 48 is &quot;myHand_item_48&quot;.<br /> * then, remove the source item with &quot;removeFromStockById&quot;.<br /> (note that it's important to do things in this order, because source item must still exists when you use it as the origin of the slide).<br /> <br /> '''Situation C''':<br /> <br /> When you move a card from a stock item to something that is not a stock item:<br /> * insert the card as a classic HTML template (dojo.place / this.format_block).<br /> * place it on the Stock item with &quot;this.placeOnObject&quot;, using Stock item HTML id (see above).<br /> * slide it to its new position with &quot;this.slideToObject&quot;<br /> * remove the card from the Stock item with &quot;removeFromStockById&quot;.<br /> <br /> Using the methods above, your cards should slide to, from and between your Stock controls smoothly</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Stock&diff=1080 2014-02-24T18:05:47Z

<p>Een: </p> <hr /> <div><br /> &quot;Stock&quot; is a javascript component that you can use on your game interface to display a set of elements of the same size that need to be arranged in one or several lines.<br /> <br /> Stock is very flexible and is the most used component in BGA games.<br /> <br /> Stock is used for example:<br /> * To display set of cards, typically hands (ex: in Hearts, Seasons, The Boss, Race for the Galaxy, ...).<br /> * To display items in player panels (ex: Takenoko, Amyitis, ...)<br /> * ... in many other situations. For example, black dice and cubes on cards in Troyes are displayed with stock components.<br /> <br /> Using stock:<br /> * Your items are arranged nicely and sorted by type.<br /> * When adding (or removing) items to the set. All items slide smoothly to their new position in the set to host the new one.<br /> * Select/unselect items is a built-in functionnality.<br /> * You don't have to care about inserting/removing HTML piece of code: the entire life of the stock is managed by the component.<br /> <br /> == Using stock: a simple example ==<br /> <br /> Let's have a look on how the stock is used in game &quot;Hearts&quot; to display a hand of standard cards.<br /> <br /> At first, don't forget to add &quot;ebg/stock&quot; as a dependency:<br /> &lt;pre&gt;<br /> define([<br /> &quot;dojo&quot;,&quot;dojo/_base/declare&quot;,<br /> &quot;ebg/core/gamegui&quot;,<br /> &quot;ebg/counter&quot;,<br /> &quot;ebg/stock&quot; /// &lt;==== HERE<br /> ],<br /> &lt;/pre&gt;<br /> <br /> The stock is initialized in Javascript &quot;setup&quot; method like this:<br /> &lt;pre&gt;<br /> // Player hand<br /> this.playerHand = new ebg.stock();<br /> this.playerHand.create( this, $('myhand'), this.cardwidth, this.cardheight );<br /> &lt;/pre&gt;<br /> <br /> Explanations:<br /> * We create a new stock object for the player hand.<br /> * As parameters of the &quot;create&quot; method, we provide the width/height of an item (=a card), and the container div &quot;myhand&quot; - which is a simple void &quot;div&quot; element defines in our HTML template (.tpl).<br /> <br /> Then, we must tell the stock what are the items it is going to display during its life: the 52 cards of a standard card game. Of course, we did not create 52 different images, but create a &quot;CSS sprite&quot; image named &quot;cards.jpg&quot; with all the cards arranged in 4 rows and 13 columns.<br /> <br /> Here's how we tell stock what are the items type to display:<br /> &lt;pre&gt;<br /> // Explain there are 13 images per row in the CSS sprite image<br /> this.playerHand.image_items_per_row = 13;<br /> <br /> // Create cards types:<br /> for( var color=1;color&lt;=4;color++ )<br /> {<br /> for( var value=2;value&lt;=14;value++ )<br /> {<br /> // Build card type id<br /> var card_type_id = this.getCardUniqueId( color, value );<br /> this.playerHand.addItemType( card_type_id, card_type_id, g_gamethemeurl+'img/cards.jpg', card_type_id );<br /> }<br /> }<br /> &lt;/pre&gt;<br /> <br /> Explanations:<br /> * At first, we tell the stock component that our CSS sprite contains 13 items per row. This way, it can find the correct image for each card type id.<br /> * Then for the 4x13 cards, we call &quot;addItemType&quot; method that create the type. The arguments are the type id, the weight of the card (for sorting purpose), the URL of our CSS sprite, and the position of our card image in the CSS sprite.<br /> <br /> Note: in this specific example we need to generate a unique ID for each type of card based on its color and value. This is the only purpose of &quot;getCardUniqueId&quot;.<br /> <br /> From now, if we need to add - for example - the 5 of Heart to player's hand, we can do this.<br /> this.playerHand.addToStock( this.getCardUniqueId( 2 /* 2=hearts */, 5 ) );<br /> <br /> In reality, cards have some IDs, which are useful to manipulate them. This is the reason we are using &quot;addToStockWithId&quot; instead:<br /> this.playerHand.addToStock( this.getCardUniqueId( 2 /* 2=hearts */, 5 ), my_card_id );<br /> <br /> If afterwards we want to remove this card from the stock:<br /> this.playerHand.removeFromStockById( my_card_id );<br /> <br /> == Complete stock component reference ==<br /> <br /> '''create( page, container_div, item_width, item_height ):'''<br /> <br /> With create, you create a new stock component.<br /> Parameters:<br /> * page: the container page. Usually: &quot;this&quot;.<br /> * container_div: the container &quot;&lt;div&gt;&quot; element (a void &lt;div&gt; element in your template, with an id).<br /> * a stock item width and height, in pixels.<br /> <br /> (See &quot;Hearts&quot; example above).<br /> <br /> <br /> '''count():'''<br /> <br /> Return the total number of items in the stock right now.<br /> <br /> '''addItemType( type, weight, image, image_position ):'''<br /> <br /> Define a new type of item to the stock.<br /> <br /> <br /> This is mandatory to define a new item type before adding it to the stock. Example: if you want to have a stock control that can contains cubes of 3 different colors, you must add 3 item types (one for each color).<br /> <br /> Parameters:<br /> * type: ID of the type to add. You can choose any positive integer. All item types must have distinct IDs.<br /> * weight: weight of items of this type. Weight value is used to sort items of the stock during the display. Note that you can specify the same weight for all items (in this case they are not sorted and their order might change randomly at any time).<br /> * image: URL of item image. Most of the time, you will use a CSS sprite for stock item, so you have to specify CSS sprite image here.<br /> <br /> Be careful: you must specify the image url as this:<br /> &lt;pre&gt;<br /> g_gamethemeurl+'img/yourimage.png'<br /> &lt;/pre&gt;<br /> * image_position: if &quot;image&quot; specify the URL of a CSS sprite, you must specify the position of the item image in this CSS sprite. For example, if you have a CSS sprite with 3 cubes with a size of 20x20 pixels each (so your CSS image has for example a size of 20x60 or 60x20), you specify &quot;0&quot; for the first cube image, 1 for the second, 2 for the third.<br /> Important: there are more than one line of items in your CSS sprite, you must specify how many items per line you have in your CSS sprite like this:<br /> &lt;pre&gt;<br /> // Specify that there is 10 image items per row in images used in &quot;myStockObject&quot; control.<br /> this.myStockObject.image_items_per_row = 10;<br /> &lt;/pre&gt;<br /> <br /> '''addToStock( type, from )'''<br /> <br /> Add an item to the stock, with the specified type.<br /> <br /> To make your life easy, in most of the case we suggest you to use &quot;addToStockWithId&quot; in order to give an ID to the item added. &quot;addToStock&quot; is perfect when you are using a stock controls with items that are generic game material that does not need to be addressed individually (ex: a bunch of money tokens).<br /> <br /> Parameters:<br /> * type: ID of the item type to use (as specified in &quot;addItemType&quot;)<br /> * from: OPTIONNAL: if you specify a HTML item here, the item will appear on this item and will be slided to its position on the stock item.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> // Add a money token to the &quot;player money&quot; stock.<br /> // The money token will appear on &quot;player_id&quot; player panel and will move to its position.<br /> this.playerMoney.addToStock( MONEY_TOKEN, 'overall_player_board_'+player_id );<br /> &lt;/pre&gt;<br /> <br /> Important: for a given stock control, you must use either addToStock or addToStockWithId, but NEVER BOTH OF THEM.<br /> <br /> '''addToStockWithId( type, id, from )'''<br /> <br /> This is exactly the same method than &quot;addToStock&quot;, except that you associate an ID to the newly created item.<br /> <br /> This is especially useful:<br /> * When you need to know which item(s) has been selected by the user (see &quot;getSelectedItems&quot;).<br /> * When you need to remove a specific item from the stock with &quot;removeFromStockById&quot;<br /> <br /> Important: for a given stock control, you must use either addToStock or addToStockWithId, but NEVER BOTH OF THEM.<br /> <br /> '''removeFromStock( type, to )'''<br /> <br /> Remove an item of the specific type from the stock.<br /> <br /> &quot;to&quot; is an optional parameter. If &quot;to&quot; contains the ID of an HTML element, the item removed from the stock is slided to this HTML element before it disappear.<br /> <br /> '''removeFromStockById( id, to )'''<br /> <br /> Remove an item with a specific ID from the stock.<br /> <br /> &quot;to&quot; is an optional parameter. If &quot;to&quot; contains the ID of an HTML element, the item removed from the stock is slided to this HTML element before it disappear.<br /> <br /> '''removeAll()'''<br /> <br /> Remove all items from the stock.<br /> <br /> '''getPresentTypeList()'''<br /> <br /> Return an array with all the types of items present in the stock right now.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.myStockControl.removeAll();<br /> this.myStockControl.addToStock( 65 );<br /> this.myStockControl.addToStock( 34 );<br /> this.myStockControl.addToStock( 89 );<br /> this.myStockControl.addToStock( 65 );<br /> <br /> // The following returns: { 34:1, 65:1, 89:1 }<br /> var item_types = this.myStockControl.getPresentTypeList();<br /> &lt;/pre&gt;<br /> <br /> '''resetItemsPosition()'''<br /> <br /> If you moved an item from the stock control manually (ex: after a drag'n'drop) and want to reset their position to their original ones, you can call this method.<br /> <br /> '''item_margin'''<br /> <br /> By default, there is a margin of 5px between the items of a stock. You can change the member variable &quot;item_margin&quot; to change this.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.myStockControl.item_margin=5;<br /> &lt;/pre&gt;<br /> <br /> '''changeItemsWeight( newWeights )'''<br /> <br /> With this method you can change dynamically the weight of the item types in a stock control.<br /> <br /> Items are immediately re-sorted with the new weight.<br /> <br /> Example: with a stock control that contains classic cards, you can order them by value or by color. Using changeItemsWeight you can switch from one sort method to another when a player request this.<br /> <br /> newWeights is an associative array: item type id =&gt; new weight.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> // Item type 1 gets a new weight of 10, 2 a new weight of 20, 3 a new weight of 30.<br /> this.myStockControl.changeItemsWeight( { 1: 10, 2: 20, 3: 30 } );<br /> &lt;/pre&gt;<br /> <br /> '''setSelectionMode( mode )'''<br /> <br /> For each stock control, you can specify a selection mode:<br /> * 0: no item can be selected by the player.<br /> * 1: a maximum of one item can be selected by the player at the same time.<br /> * 2: several items can be selected by the player at the same time.<br /> <br /> '''isSelected( id )'''<br /> <br /> Return true/false wether the specified item id has been selected or not.<br /> <br /> '''selectItem( id )'''<br /> <br /> Select the specified item.<br /> <br /> '''unselectItem( id )'''<br /> <br /> Unselect the specified item.<br /> <br /> '''unselectAll()'''<br /> <br /> Unselect all items of the stock.<br /> <br /> '''onChangeSelection'''<br /> <br /> This callback method is called when the player select/unselect an item of the stock.<br /> <br /> You can connect this to one of your method like this:<br /> &lt;pre&gt;<br /> dojo.connect( this.myStockControl, 'onChangeSelection', this, 'onMyMethodToCall' );<br /> <br /> (...)<br /> <br /> onMyMethodToCall: function( control_name )<br /> {<br /> // This method is called when myStockControl selected items changed<br /> var items = this.myStockControl.getSelectedItems();<br /> <br /> // (do something)<br /> },<br /> &lt;/pre&gt;<br /> <br /> Note: The &quot;control_name&quot; argument is the ID (the &quot;DOM&quot; id) of the &lt;div&gt; container of your stock control. Using &quot;control_name&quot;, you can use the same callback method for different Stock control and see which one trigger the method.<br /> <br /> '''getSelectedItems()'''<br /> <br /> Return the list of selected items, as an array with the following format:<br /> &lt;pre&gt;<br /> [<br /> { type:1, id: 1001 },<br /> { type:1, id: 1002 },<br /> { type:3, id: 1003 }<br /> ...<br /> ]<br /> &lt;/pre&gt;<br /> <br /> '''getUnselectedItems()'''<br /> <br /> Same as the previous one, but return unselected item instead of seleted ones.<br /> <br /> '''getAllItems()'''<br /> <br /> Get all items (same format than getSelectedItems and getUnselectedItems).<br /> <br /> '''setOverlap( horizontal_percent, vertical_percent )'''<br /> <br /> Make items on the stock control &quot;overlap&quot; on each other, to save space.<br /> <br /> By default, horizontal_overlap and vertical_overlap are 0.<br /> <br /> When horizontal_overlap=20, it means that a stock item must overlap on 20% of the width of the previous item. horizontal_overlap can't be over 100.<br /> <br /> vertical_overlap works differently: one items on two are shifted up.<br /> <br /> See &quot;Jaipur&quot; game to see an example to use of this function.<br /> <br /> '''onItemCreate'''<br /> <br /> Using onItemCreate, you can trigger a method each time a new item is added to the Stock, in order you can customize it.<br /> <br /> Complete example:<br /> &lt;pre&gt;<br /> // During &quot;setup&quot; phase, we associate our method &quot;setupNewCard&quot; with the creation of a new stock item:<br /> this.myStockItem.onItemCreate = dojo.hitch( this, 'setupNewCard' ); <br /> <br /> (...)<br /> <br /> // And here is our &quot;setupNewCard&quot;:<br /> setupNewCard: function( card_div, card_type_id, card_id )<br /> {<br /> // Add a special tooltip on the card:<br /> this.addTooltip( card_div.id, _(&quot;Some nice tooltip for this item&quot;), '' );<br /> <br /> // Note that &quot;card_type_id&quot; contains the type of the item, so you can do special actions depending on the item type<br /> <br /> // Add some custom HTML content INSIDE the Stock item:<br /> dojo.place( this.format_block( 'jstpl_my_card_content', {<br /> ....<br /> } ), card_div.id );<br /> }<br /> <br /> &lt;/pre&gt;<br /> <br /> == Tips when adding/removing items to/from Stock components ==<br /> <br /> The usual way is the following:<br /> <br /> '''Situation A''':<br /> <br /> When you add a card to a stock item, and this card is '''not''' coming from another stock: use &quot;addToStockWithId&quot; with a &quot;from&quot; argument set to the element of your interface where card should come from.<br /> <br /> '''Situation B''':<br /> <br /> When you add a card to a stock item, and this card is coming from another stock:<br /> * on the destination Stock, use &quot;addToStockWithId&quot; with a &quot;from&quot; equals to the HTML id of the corresponding item in the source Stock. For example, If the source stock id is &quot;myHand&quot;, then the HTML id of card 48 is &quot;myHand_item_48&quot;.<br /> * then, remove the source item with &quot;removeFromStockById&quot;.<br /> (note that it's important to do things in this order, because source item must still exists when you use it as the origin of the slide).<br /> <br /> '''Situation C''':<br /> <br /> When you move a card from a stock item to something that is not a stock item:<br /> * insert the card as a classic HTML template (dojo.place / this.format_block).<br /> * place it on the Stock item with &quot;this.placeOnObject&quot;, using Stock item HTML id (see above).<br /> * slide it to its new position with &quot;this.slideToObject&quot;<br /> * remove the card from the Stock item with &quot;removeFromStockById&quot;.<br /> <br /> Using the methods above, your cards should slide to, from and between your Stock controls smoothly</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Game_interface_logic:_yourgamename.js&diff=1079 2014-02-24T17:49:33Z

<p>Een: /* Scoring dialogs */</p> <hr /> <div><br /> This is the main file for your game interface. Here you will define:<br /> <br /> * which actions on the page will generate calls to the server<br /> * what happens when you get a notification for change from the server and how it will show in the browser. <br /> <br /> == File structure ==<br /> <br /> The details on how the file is structured is described directly with comments on the code skeleton provided to you.<br /> <br /> Basically, here's this structure:<br /> * constructor: here you can define variable global to your whole interface.<br /> * setup: this method is called when the page is refreshed, in order you can setup the game interface.<br /> * onEnteringState: the method is called when entering in a new game state. This way you can customize the view for this game state.<br /> * onLeavingState: the method is called when leaving a game state.<br /> * onUpdateActionButtons: called when entering in a new state, in order you can add action buttons in status bar.<br /> * (utility methods): at this place you can define your utility methods<br /> * (player's actions): at this place you can write your handlers for player's action on the interface (ex: click on an item).<br /> * setupNotifications: in this method you associate notifications with notification handlers. This way, for each game notification, you trigger a javascript method to handle it and update the game interface.<br /> * (notification handlers): at this place you can define your notifications handlers.<br /> <br /> == General tips ==<br /> <br /> ; this.player_id<br /> : Id of the player on whose browser the code is running.<br /> <br /> ; this.isSpectator<br /> : Flag set to true if the user at the table is a spectator (not a player).<br /> : Note: if you want to hide some element for spectators, you'd better use [[Game_interface_stylesheet:_yourgamename.css#spectatorMode|CSS 'spectatorMode' class]].<br /> <br /> ; this.gamedatas<br /> : Contains your initial set of datas to init the game, created at game start or game refresh (F5)<br /> : You can update it as needed to keep an up to date reference of the game on the client side if you need it (most of the time you don't).<br /> <br /> ; isCurrentPlayerActive()<br /> : Returns true if the player on whose browser the code is running is currently active (it's his turn to play)<br /> <br /> ; this.getActivePlayerId()<br /> : Return the ID of active player, or null if we are not in a &quot;activeplayer&quot; type state.<br /> <br /> ; this.getActivePlayers()<br /> : Return an array with the IDs of players that are currently active (or an empty array if there is not).<br /> <br /> == Dojo framework ==<br /> <br /> BGA is using the [http://dojotoolkit.org/ Dojo Javascript framework].<br /> <br /> The Dojo framework allows us to do complex things easier, and the BGA framework is using Dojo framework a lot.<br /> <br /> To realize game although, you only need to use a few part of the Dojo framework. All the Dojo methods you need to use are describe on this page.<br /> <br /> == Access and manipulate the DOM ==<br /> <br /> '''$('some_html_element_id')'''<br /> <br /> The $() function is used to get some HTML element using its &quot;id&quot; attribute.<br /> <br /> Example 1: modify the content of a &quot;span&quot; element:<br /> &lt;pre&gt;<br /> In your HTML code:<br /> &lt;span id=&quot;a_value_in_the_game_interface&quot;&gt;1234&lt;/span&gt;<br /> <br /> In your Javascript code:<br /> $('a_value_in_the_game_interface').innerHTML = &quot;9999&quot;;<br /> &lt;/pre&gt;<br /> <br /> Note: $() is the standard method to access some HTML element with BGA Framework. You must not use &quot;getElementById&quot; function.<br /> <br /> <br /> '''dojo.style'''<br /> <br /> With dojo.style you can modify a CSS property of any HTML element of your interface.<br /> <br /> Examples:<br /> &lt;pre&gt;<br /> // Make an element disappear<br /> dojo.style( 'my_element', 'display', 'none' );<br /> <br /> // Give an element a 2px border<br /> dojo.style( 'my_element', 'borderWidth', '2px' );<br /> <br /> // Change the background position of an element<br /> // (very practical when you are using CSS sprite to transform an element to another)<br /> dojo.style( 'my_element', 'backgroundPosition', '-20px -50px' );<br /> &lt;/pre&gt;<br /> <br /> Note: you must always use dojo.style to modify CSS properties of HTML elements.<br /> <br /> Note²: if you have to modify several CSS properties of an element, or if you have some complex CSS transformation to do, you should consider using dojo.addClass/dojo.removeClass (see below).<br /> <br /> '''dojo CSS classes manipulation'''<br /> <br /> In many situation, a bunch of many small CSS property update can be replaced by a CSS class change (ie: you add a CSS class to your element instead of applying all modification manually).<br /> <br /> Advantages are:<br /> * All your CSS stuff remains in your CSS file.<br /> * You can add/remove a list of CSS modifications with a simple function and whithout error.<br /> * You can test if you applied the stuff to an element with &quot;dojo.hasClass&quot; method.<br /> <br /> Example from &quot;Reversi&quot;:<br /> &lt;pre&gt;<br /> // We add &quot;possibleMove&quot; to an element<br /> dojo.addClass( 'square_'+x+'_'+y, 'possibleMove' );<br /> <br /> // In our CSS file, the class is defined as:<br /> .possibleMove {<br /> background-color: white;<br /> opacity: 0.2;<br /> filter:alpha(opacity=20); /* For IE8 and earlier */ <br /> cursor: pointer; <br /> }<br /> <br /> // So we've applied 4 CSS property change in one line of code.<br /> <br /> // ... and when we need to check if a square is a possible move on client side:<br /> if( dojo.hasClass( 'square_'+x+'_'+y, 'possibleMove' ) )<br /> { ... }<br /> <br /> // ... and if we want to remove all possible moves in one line of code (see &quot;dojo.query&quot; method):<br /> dojo.query( '.possibleMove' ).removeClass( 'possibleMove' );<br /> &lt;/pre&gt;<br /> <br /> Conclusion: we encourage you to use dojo.addClass, dojo.removeClass and dojo.hasClass to make your life easier :)<br /> <br /> '''dojo.query'''<br /> <br /> With dojo.query, you can query a bunch of HTML elements with a single function, with a &quot;CSS selector&quot; style.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> // All elements with class &quot;possibleMove&quot;:<br /> var elements = dojo.query( '.possibleMove' );<br /> <br /> // Count number of tokens (ie: elements with class &quot;token&quot;) on the board (ie: element with id &quot;board&quot;):<br /> dojo.query( '#board .token' ).length;<br /> &lt;/pre&gt;<br /> <br /> But what is really cool with dojo.query is that you can combine it with almost all methods above.<br /> <br /> Examples:<br /> &lt;pre&gt;<br /> // Trigger a method when the mouse enter in any element with class &quot;meeple&quot;:<br /> dojo.query( '.meeple' ).connect( 'onmouseenter', this, 'myMethodToTrigger' );<br /> <br /> // Hide all meeples who are on the board<br /> dojo.query( '#board .meeple' ).style( 'display', 'none' );<br /> &lt;/pre&gt;<br /> <br /> '''dojo.place'''<br /> <br /> dojo.place is the best function to insert some HTML code somewhere in your game interface without breaking something. It is much better to use that &quot;innerHTML=''&quot; method as soon as you must insert HTML tags and not only values.<br /> <br /> &lt;pre&gt;<br /> // Insert your HTML code as a child of a container element<br /> dojo.place( &quot;&lt;your html code&gt;&quot;, &quot;your_container_element_id&quot; );<br /> <br /> // Replace the container element with your new html<br /> dojo.place( &quot;&lt;your html code&gt;&quot;, &quot;your_container_element_id&quot;, &quot;replace&quot; );<br /> <br /> &lt;/pre&gt;<br /> <br /> Note: the third parameter of dojo.place can take various interesting value: &quot;first&quot;, &quot;after&quot;, ... [http://dojotoolkit.org/reference-guide/1.7/dojo/place.html See full doc on dojo.place].<br /> <br /> Usually, when you want to insert some piece of HTML in your game interface, you should use &quot;[[Game_layout:_view_and_template:_yourgamename.view.php_and_yourgamename_yourgamename.tpl#Javascript_templates|Javascript templates]]&quot;.<br /> <br /> '''addStyleToClass: function( cssClassName, cssProperty, propertyValue )'''<br /> <br /> Same as dojo.style(), but for all the nodes set with the specified cssClassName<br /> <br /> === Animations ===<br /> <br /> '''Dojo Animations'''<br /> <br /> BGA animations is based on Dojo Animation ([http://dojotoolkit.org/documentation/tutorials/1.8/animation/ see tutorial here]).<br /> <br /> However, most of the time, you can just use methods below, which are built on top of Dojo Animation.<br /> <br /> Note: one interesting method from Dojo that could be useful from time to time is &quot;Dojo.Animation&quot;. It allows you to make any CSS property &quot;slide&quot; from one value to another.<br /> <br /> '''this.slideToObject( mobile_obj, target_obj, duration, delay )'''<br /> <br /> You can use slideToObject to &quot;slide&quot; an element to a target position.<br /> <br /> Sliding element on the game area is the recommended and the most used way to animate your game interface. Using slides allow players to figure out what is happening on the game, as if they were playing with the real boardgame.<br /> <br /> The parameters are:<br /> * mobile_obj: the ID of the object to move. This object must be &quot;relative&quot; or &quot;absolute&quot; positioned.<br /> * target_obj: the ID of the target object. This object must be &quot;relative&quot; or &quot;absolute&quot; positioned. Note that it is not mandatory that mobile_obj and target_obj have the same size. If their size are different, the system slides the center of mobile_obj to the center of target_obj.<br /> * duration: (optional) defines the duration in millisecond of the slide. The default is 500 milliseconds.<br /> * delay: (optional). If you defines a delay, the slide will start only after this delay. This is particularly useful when you want to slide several object from the same position to the same position: you can give a 0ms delay to the first object, a 100ms delay to the second one, a 200ms delay to the third one, ... this way they won't be superposed during the slide.<br /> <br /> BE CAREFUL: The method returns an dojo.fx animation, so you can combine it with other animation if you want to. It means that you have to call the &quot;play()&quot; method, otherwise the animation WON'T START.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.slideToObject( &quot;some_token&quot;, &quot;some_place_on_board&quot; ).play();<br /> &lt;/pre&gt;<br /> <br /> <br /> '''this.slideToObjectPos( mobile_obj, target_obj, target_x, target_y, duration, delay )'''<br /> <br /> This method does exactly the same than &quot;slideToObjectPos&quot;, except than you can specify some (x,y) coordinates. This way, &quot;mobile_obj&quot; will slide to the specified x,y position relatively to &quot;target_obj&quot;.<br /> <br /> Example: slide a token to some place on the board, 10 pixels to the bottom:<br /> &lt;pre&gt;<br /> this.slideToObjectPos( &quot;some_token&quot;, &quot;some_place_on_board&quot;, 0, 10 ).play();<br /> &lt;/pre&gt;<br /> <br /> '''this.slideTemporaryObject( mobile_obj_html, mobile_obj_parent, from, to, duration, delay )'''<br /> <br /> This method is useful when you want to slide a temporary HTML object from one place to another. As this object does not exists before the animation and won't remain after, it could be complex to create this object (with dojo.place), to place it at its origin (with placeOnObject) to slide it (with slideToObject) and to make it disappear at the end.<br /> <br /> slideTemporaryObject does all of this for you:<br /> * mobile_obj_html is a piece of HTML code that represent the object to slide.<br /> * mobile_obj_parent is the ID of an HTML element of your interface that will be the parent of this temporary HTML object.<br /> * from is the ID of the origin of the slide.<br /> * to is the ID of the target of the slide.<br /> * duration/delay works exactly like in &quot;slideToObject&quot;<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.slideTemporaryObject( '&lt;div class=&quot;token_icon&quot;&gt;&lt;/div&gt;', 'tokens', 'my_origin_div', 'my_target_div' );<br /> &lt;/pre&gt;<br /> <br /> '''this.slideToObjectAndDestroy: function( node, to, time, delay )'''<br /> <br /> This method is a handy shortcut to slide an existing HTML object to some place then destroy it upon arrival. It can be used for example to move a victory token or a card from the board to the player panel to show that the player earns it, then destroy it when we don't need to keep it visible on the player panel.<br /> <br /> It works the same as this.slideToObject and takes the same arguments. <br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.slideToObjectAndDestroy( &quot;some_token&quot;, &quot;some_place_on_board&quot;, 1000, 0 ).play();<br /> &lt;/pre&gt;<br /> <br /> '''this.fadeOutAndDestroy( node )'''<br /> <br /> This function fade out the target HTML node, then destroy it.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.fadeOutAndDestroy( &quot;a_card_that_must_disappear&quot; );<br /> &lt;/pre&gt;<br /> <br /> CAREFUL: the HTML node still exists until during few milliseconds, until the fadeOut has been completed.<br /> <br /> '''Rotating elements'''<br /> <br /> You can check here [http://jimfulton.info/demos/dojo-animated-rotate.html an example of use] of Dojo to make an element rotate.<br /> <br /> This example combines &quot;Dojo.Animation&quot; method and a CSS3 property that allow you to rotate the element.<br /> <br /> IMPORTANT: to asses browser compatibility, you must select the CSS property to use just like in the example (see sourcecode below):<br /> <br /> &lt;pre&gt;<br /> var transform;<br /> dojo.forEach(<br /> ['transform', 'WebkitTransform', 'msTransform',<br /> 'MozTransform', 'OTransform'],<br /> function (name) {<br /> if (typeof dojo.body().style[name] != 'undefined') {<br /> transform = name;<br /> }<br /> });<br /> // ... and then use &quot;transform&quot; as the name of your CSS property for rotation<br /> &lt;/pre&gt;<br /> <br /> === Moving elements ===<br /> <br /> '''this.placeOnObject( mobile_obj, target_obj )'''<br /> <br /> placeOnObject works exactly like &quot;slideToObject&quot;, except that the effect is immediate.<br /> <br /> This is not really an animation, but placeOnObject is frequently used before starting an animation.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> // (We just created an object &quot;my_new_token&quot;)<br /> <br /> // Place the new token on current player board<br /> this.placeOnObject( &quot;my_new_token&quot;, &quot;overall_player_board_&quot;+this.player_id );<br /> <br /> // Then slide it to its position on the board<br /> this.slideToObject( &quot;my_new_token&quot;, &quot;a_place_on_board&quot; ).play();<br /> &lt;/pre&gt;<br /> <br /> '''this.placeOnObjectPos( mobile_obj, target_obj, target_x, target_y )'''<br /> <br /> This method works exactly like placeOnObject, except than you can specify some (x,y) coordinates. This way, &quot;mobile_obj&quot; will be placed to the specified x,y position relatively to &quot;target_obj&quot;.<br /> <br /> '''this.attachToNewParent( mobile_obj, target_obj )'''<br /> <br /> With this method, you change the HTML parent of &quot;mobile_obj&quot; element. &quot;target_obj&quot; is the new parent of this element. The beauty of <br /> attachToNewParent is that the mobile_obj element DOES NOT MOVE during this process.<br /> <br /> Note: what happens is that the method calculate a relative position of mobile_obj to make sure it does not move after the HTML parent changes.<br /> <br /> Why using this method?<br /> <br /> Changing the HTML parent of an element can be useful for the following reasons:<br /> * When the HTML parent moves, all its child are moving with them. If some game elements is no more linked with a parent HTML object, you may want to attach it to another place.<br /> * The z_order (vertical order of display) depends on the position in the DOM, so you may need to change the parent of some game elements when they are moving in your game area.<br /> <br /> CAREFUL: when you attach an HTML element with a new parent, you break all references to this HTML element (ex: dojo.connect).<br /> <br /> == Players input ==<br /> <br /> '''dojo.connect'''<br /> <br /> Used to associate a player event with one of your notification method.<br /> <br /> Example: associate a click on an element (&quot;my_element&quot;) with one of our method (&quot;onClickOnMyElement&quot;):<br /> &lt;pre&gt;<br /> dojo.connect( $('my_element'), 'onclick', this, 'onClickOnMyElement' );<br /> &lt;/pre&gt;<br /> <br /> Note: this is the only possible correct way to associate a player input event to your code, and you must not use anything else.<br /> <br /> '''this.checkAction( &quot;my_action_name&quot; )'''<br /> <br /> Usage: checkAction: function( action, nomessage )<br /> <br /> Check if player can do the specified action by taking into account:<br /> * current game state<br /> * interface locking (a player can't do any action if an action is already in progress)<br /> <br /> return true if action is authorized (ie: the action is listed as a &quot;possibleaction&quot; in current game state).<br /> <br /> return false and display an error message if not (display no message if nomessage parameter is true). The displayed error message could be either &quot;This move is not allowed at this moment&quot; or &quot;An action is already in progress&quot;.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> function onClickOnGameElement( evt )<br /> {<br /> if( this.checkAction( &quot;my_action&quot; ) )<br /> {<br /> // Do the action<br /> }<br /> }<br /> &lt;/pre&gt;<br /> <br /> '''this.ajaxcall( url, parameters, obj_callback, callback, callback_error )'''<br /> <br /> This method must be used to send a player input to the game server.<br /> <br /> * url: the url of the action to perform. For a game, it must be: &quot;/&lt;mygame&gt;/&lt;mygame&gt;/myAction.html&quot;<br /> * parameters: an array of parameter to send to the game server. Note that &quot;lock:true&quot; must always be specified in this list of parameter in order the interface can be locked during the server call.<br /> * obj_callback: must be set to &quot;this&quot;.<br /> * callback: a function to trigger when the server returns and everything went fine.<br /> * callback_error: (optional and rarely used) a function to trigger when the server returns an error.<br /> <br /> Usage:<br /> &lt;pre&gt;<br /> this.ajaxcall( '/mygame/mygame/myaction.html', { lock: true, <br /> arg1: myarg1, <br /> arg2: myarg2, <br /> ...<br /> }, this, function( result ) {<br /> // Do some stuff after a successful call<br /> } );<br /> &lt;/pre&gt;<br /> <br /> Restricted arguments names (please don't use them):<br /> * &quot;action&quot;<br /> * &quot;module&quot;<br /> * &quot;class&quot;<br /> <br /> '''this.confirmationDialog()'''<br /> <br /> Display a confirmation dialog with a yes/no choice.<br /> <br /> We advice you to NOT use this function unless the player action is really critical and could ruins the game, because it slows down the game and upset players.<br /> <br /> Usage: this.confirmationDialog( &quot;Question to displayed&quot;, callback_function_if_click_on_yes );<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.confirmationDialog( _('Are you sure to use this bonus (points penalty at the end of the game) ?'),<br /> dojo.hitch( this, function() {<br /> this.ajaxcall( '/seasons/seasons/useBonus.html',<br /> { id:bonus_id, lock:true }, this, function( result ) {} );<br /> } ) ); <br /> &lt;/pre&gt;<br /> <br /> <br /> ; addEventToClass: function( cssClassName, eventName, functionName )<br /> : Same as dojo.connect(), but for all the nodes set with the specified cssClassName<br /> <br /> '''this.addActionButton( id, label, method, (opt)depreciated, (opt)bHighlight )'''<br /> <br /> You can use this method to add an action button in the main action status bar.<br /> <br /> Arguments:<br /> * id: a ID that should be unique in your HTML DOM document.<br /> * label: the text of the button. Should be translatable (use _() function).<br /> * method: the name of your method that must be triggered when the player clicks on this button.<br /> * depreciated (optional): do not use this. Please not specify this argument or use &quot;null&quot;.<br /> * bHighlight: if set to &quot;true&quot;, the button is going blink to catch player's attention. Please don't abuse of blinking button.<br /> <br /> You should only use this method in your &quot;onUpdateActionButtons&quot; method. Usually, you use it like this (from Hears example):<br /> <br /> &lt;pre&gt;<br /> onUpdateActionButtons: function( stateName, args )<br /> {<br /> console.log( 'onUpdateActionButtons: '+stateName );<br /> <br /> if( this.isCurrentPlayerActive() )<br /> { <br /> switch( stateName )<br /> {<br /> case 'giveCards':<br /> this.addActionButton( 'giveCards_button', _('Give selected cards'), 'onGiveCards' ); <br /> break;<br /> <br /> }<br /> }<br /> }, <br /> &lt;/pre&gt;<br /> <br /> In the example above, we are adding a &quot;Give selected cards&quot; button in the case we are on game state &quot;giveCards&quot;. When player clicks on this button, it triggers our &quot;onGiveCards&quot; method.<br /> <br /> == Translations ==<br /> <br /> See [[Translations]]<br /> <br /> == Notifications ==<br /> <br /> When something happens on the server side, your game interface Javascript logic received a notification.<br /> <br /> Here's how you can handle these notifications on the client side.<br /> <br /> === Subscribe to notifications ===<br /> <br /> Your Javascript &quot;setupNotifications&quot; method is the place where you can subscribe to notifications from your PHP code.<br /> <br /> Here's how you associate one of your Javascript method to a notification &quot;playDisc&quot; (from Reversi example):<br /> <br /> &lt;pre&gt;<br /> // In setupNotifications method:<br /> dojo.subscribe( 'playDisc', this, &quot;notif_playDisc&quot; );<br /> &lt;/pre&gt;<br /> <br /> Note: the &quot;playDisc&quot; corresponds to the name of the notification you define it in your PHP code, in your &quot;notifyAllPlayers&quot; or &quot;notifyPlayer&quot; method.<br /> <br /> Then, you have to define your &quot;notif_playDisc&quot; method:<br /> <br /> &lt;pre&gt;<br /> notif_playDisc: function( notif )<br /> {<br /> // Remove current possible moves (makes the board more clear)<br /> dojo.query( '.possibleMove' ).removeClass( 'possibleMove' ); <br /> <br /> this.addDiscOnBoard( notif.args.x, notif.args.y, notif.args.player_id );<br /> },<br /> &lt;/pre&gt;<br /> <br /> In a notification handler like our &quot;notif_playDisc&quot; method, you can access to all notifications arguments with &quot;notif.args&quot;.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> // If you did this on PHP side:<br /> self::notifyAllPlayers( &quot;myNotification&quot;, '', array( &quot;myArgument&quot; =&gt; 3 ) );<br /> <br /> // On Javascript side, you can access the &quot;myArgument&quot; like this:<br /> notif_myNotification: function( notif )<br /> {<br /> alert( &quot;myArgument = &quot; + notif.args.myArgument );<br /> }<br /> &lt;/pre&gt;<br /> <br /> === Synchronous notifications ===<br /> <br /> When several notifications are received by your game interface, these notifications are processed immediately, one after the other, in the same exact order they have been generated in your PHP game logic.<br /> <br /> However, sometimes, you need to give some time to the players to figure out what happened on the game before jumping to the next notification. Indeed, in many games, they are a lot of automatic actions, and the computer is going to resolve all these actions very fast if you don't tell it not to do so.<br /> <br /> As an example, for Reversi, when someone is playing a disc, we want to wait 500 milliseconds before doing anything else in order the opponent player can figure out what move has been played.<br /> <br /> Here's how we do this, right after our subscription:<br /> &lt;pre&gt;<br /> dojo.subscribe( 'playDisc', this, &quot;notif_playDisc&quot; );<br /> this.notifqueue.setSynchronous( 'playDisc', 500 ); // Wait 500 milliseconds after executing the playDisc handler<br /> &lt;/pre&gt;<br /> <br /> == Tooltips ==<br /> <br /> '''this.addTooltip( nodeId, _( helpString ), _( actionString ), delay )'''<br /> <br /> Add a simple text tooltip to the DOM node.<br /> <br /> Specify 'helpString' to display some information about &quot;what is this game element?&quot;.<br /> Specify 'actionString' to display some information about &quot;what happens when I click on this element?&quot;.<br /> <br /> You must specify both helpString and actionString. Most of the time, you use only one and specify a void string (&quot;&quot;) for the other one.<br /> <br /> Usually, _() must be used for the text to be marked for translation.<br /> <br /> &quot;Delay&quot; is an optional parameter. Usually, it is primarily used to specify a zero delay for some game element when the tooltip gives really important information for the game - but remember: no essential information must be placed in tooltips as they won't be displayed in some browser (see Guidelines).<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.addTooltip( 'cardcount', _('Number of cards in hand'), '' );<br /> &lt;/pre&gt;<br /> <br /> '''this.addTooltipHtml( nodeId, html, delay )'''<br /> <br /> Add an HTML tooltip to the DOM node (for more elaborate content such as presenting a bigger version of a card).<br /> <br /> '''this.addTooltipToClass( cssClass, _( helpString ), _( actionString ), delay )'''<br /> <br /> Add a simple text tooltip to all the DOM nodes set with this cssClass. <br /> <br /> IMPORTANT: all concerned nodes must have IDs to get tooltips.<br /> <br /> '''addTooltipHtmlToClass( cssClass, html, delay )'''<br /> <br /> Add an HTML tooltip to to all the DOM nodes set with this cssClass (for more elaborate content such as presenting a bigger version of a card).<br /> <br /> IMPORTANT: all concerned nodes must have IDs to get tooltips<br /> <br /> == Dialogs, warning messages, confirmation dialogs, ... ==<br /> <br /> === Warning messages ===<br /> <br /> Sometimes, there is something important that is happening on the game and you have to make sure all players get the message. Most of the time, the evolution of the game situation or the game log is enough, but sometimes you need something more visible.<br /> <br /> Ex: someone fulfill one of the end of the game condition, so this is the last turn.<br /> <br /> '''this.showMessage( msg, type )'''<br /> <br /> showMessage shows a message in a big rectangular area on the top of the screen of current player.<br /> <br /> * &quot;msg&quot; is the string to display. It should be translated.<br /> * &quot;type&quot; can be set to &quot;info&quot; or &quot;error&quot;. If set to &quot;info&quot;, the message will be an informative message on a white background. If set to &quot;error&quot;, the message will be an error message on a red background.<br /> <br /> Important: the normal way to inform players about the progression of the game is the game log. &quot;showMessage&quot; is intrusive and should not be used often.<br /> <br /> === Confirmation dialog ===<br /> <br /> When an important action with a lot of consequences is triggered by the player, you may want to propose a confirmation dialog.<br /> <br /> CAREFUL: the general guidelines of BGA is to AVOID the use of confirmation dialog. Confirmation dialogs slow down the game and bother players. The players knows that they have to pay attention about each move when they are playing online.<br /> <br /> The situation where you should use a confirmation dialog are the following:<br /> * It must not happen very often during a game.<br /> * It must be linked to an action that can really &quot;kill a game&quot; if the player do not pay attention.<br /> * It must be something that can be done by mistake (ex: a link on the action status bar).<br /> <br /> How to display a confirmation dialog:<br /> &lt;pre&gt;<br /> this.confirmationDialog( _('Are you sure you want to make this?'), dojo.hitch( this, function() {<br /> this.ajaxcall( '/mygame/mygame/makeThis.html', { lock:true }, this, function( result ) {} );<br /> } ) ); <br /> &lt;/pre&gt;<br /> <br /> === Dialogs ===<br /> <br /> At first, you shouldn't use dialogs windows.<br /> <br /> BGA guidelines specify that all game elements should be displayed on the main screen. Players can eventually scroll down to see game elements they don't need to see anytime, and you may eventually create anchors to move between game area section. Of course dialogs windows are very practical, but the thing is: all players know how to scroll down, and not all players know how to show up your dialog window. In addition, when the dialog shows up, players can't access the other game components.<br /> <br /> Sometimes although, you need to display a dialog window. Here is how you do this:<br /> <br /> &lt;pre&gt;<br /> <br /> // Create the new dialog. You should store the handler in a member variable to access it later<br /> this.myDlg = new dijit.Dialog({ title: _(&quot;my dialog title to translate&quot;) });<br /> <br /> // Create the HTML of my dialog. The best practice here is to use [[Game_layout:_view_and_template:_yourgamename.view.php_and_yourgamename_yourgamename.tpl#Javascript_templates|Javascript templates]]:<br /> var html = this.format_block( 'jstpl_myDialogTemplate', { <br /> arg1: myArg1,<br /> arg2: myArg2,<br /> ...<br /> } ); <br /> <br /> // Show the dialog<br /> this.myDlg.attr(&quot;content&quot;, html );<br /> this.myDlg.show(); <br /> <br /> // Now that the dialog has been displayed, you can connect your method to some dialog elements<br /> // Example, a &quot;close&quot; button:<br /> dojo.connect( $('closeDlg'), 'onclick', this, function(evt){<br /> evt.preventDefault();<br /> this.myDlg.hide();<br /> } ); <br /> <br /> &lt;/pre&gt;<br /> <br /> Tip: be careful with &quot;hide()&quot; method to close your dialog: the dialog and its content is not completely removed from the DOM. It can cause you problems if you try to display the same dialog several times. A good practice is to wrap all the content of your dialog in a &quot;&lt;div id='myDlgContent'&gt;&quot; div element, and to call &quot;dojo.destroy('myDlgContent')&quot; before displaying your dialog.<br /> <br /> === Scoring dialogs ===<br /> <br /> Sometimes at the end of a round you want to display a big table that details the points wins in each section of the game.<br /> <br /> Example: in Hearts game, we display at the end of each round the number of &quot;heart&quot; cards collected by each player, the player who collected the Queen of Spades, and the total number of points loose by each player.<br /> <br /> Scoring dialogs are managed entirely on '''PHP side''', but they are described here as their effects are visible only on client side.<br /> <br /> Displaying a scoring dialog is quite simple and is using a special notification type: &quot;tableWindow&quot;:<br /> &lt;pre&gt;<br /> // on PHP side:<br /> $this-&gt;notifyAllPlayers( &quot;tableWindow&quot;, '', array(<br /> &quot;id&quot; =&gt; 'finalScoring',<br /> &quot;title&quot; =&gt; clienttranslate(&quot;Title of the scoring dialog&quot;),<br /> &quot;table&quot; =&gt; $table<br /> ) ); <br /> &lt;/pre&gt;<br /> <br /> The &quot;table&quot; argument is a 2 dimensional PHP array that describe the table you want to display, line by line and column by column.<br /> <br /> Example: display an 3x3 array of strings<br /> &lt;pre&gt;<br /> $table = array(<br /> array( &quot;one&quot;, &quot;two&quot;, &quot;three&quot; ), // This is my first line<br /> array( &quot;four&quot;, &quot;five&quot;, &quot;six&quot; ), // This is my second line<br /> array( &quot;seven&quot;, &quot;height&quot;, &quot;nine&quot; ) // This is my third line<br /> );<br /> &lt;/pre&gt;<br /> <br /> As you can see above, in each &quot;cell&quot; of your array you can display a simple string value. But you can also display a complex value with a template and associated arguments like this:<br /> &lt;pre&gt;<br /> $table = array(<br /> array( &quot;one&quot;, &quot;two&quot;, array( &quot;str&quot; =&gt; &quot;a string with an ${argument}&quot;, &quot;args&quot; =&gt; array( 'argument' =&gt; 'argument_value' ) ) ),<br /> array( &quot;four&quot;, &quot;five&quot;, &quot;six&quot; ), <br /> array( &quot;seven&quot;, &quot;height&quot;, &quot;nine&quot; )<br /> );<br /> &lt;/pre&gt;<br /> <br /> This is especially useful when you want to display player names with colors. Example from &quot;Hearts&quot;:<br /> &lt;pre&gt;<br /> $firstRow = array( '' );<br /> foreach( $players as $player_id =&gt; $player )<br /> {<br /> $firstRow[] = array( 'str' =&gt; '${player_name}',<br /> 'args' =&gt; array( 'player_name' =&gt; $player['player_name'] ),<br /> 'type' =&gt; 'header'<br /> );<br /> }<br /> $table[] = $firstRow;<br /> &lt;/pre&gt;<br /> <br /> You can also use three extra attributes in the parameter array for the notification:<br /> <br /> &lt;pre&gt;<br /> $this-&gt;notifyAllPlayers( &quot;tableWindow&quot;, '', array(<br /> &quot;id&quot; =&gt; 'finalScoring',<br /> &quot;title&quot; =&gt; clienttranslate(&quot;Title of the scoring dialog&quot;),<br /> &quot;table&quot; =&gt; $table,<br /> &quot;header&quot; =&gt; '&lt;div&gt;Some header&lt;/div&gt;',<br /> &quot;footer&quot; =&gt; '&lt;div&gt;Some footer&lt;/div&gt;',<br /> &quot;closelabel&quot; =&gt; clienttranslate( &quot;Closing button label&quot; )<br /> ) ); <br /> &lt;/pre&gt;<br /> <br /> *'''header''': the content for this parameter will display before the table (also, the html will be parsed and player names will be colored according to the current game colors)<br /> *'''footer''': the content for this parameter will display after the table (no parsing for coloring the player names)<br /> *'''closelabel''': if this parameter is used, a button will be displayed with this label at the bottom of the popup and will allow players to close it (more easily than by clicking the top right 'cross' icon). NB: this last parameter is not yet - 24/02/2014 - deployed on the studio, but can be used already and will take effect immediately with the next update.<br /> <br /> == Update players score ==<br /> <br /> Increase a player score (with a positive or negative number):<br /> <br /> &lt;pre&gt;<br /> this.scoreCtrl[ player_id ].incValue( score_delta );<br /> &lt;/pre&gt;<br /> <br /> Set a player score to a specific value:<br /> <br /> &lt;pre&gt;<br /> this.scoreCtrl[ player_id ].setValue( new_score );<br /> &lt;/pre&gt;<br /> <br /> == Players panels ==<br /> <br /> === Adding stuff to player's panel ===<br /> <br /> At first, create a new &quot;JS template&quot; string in your template (tpl) file:<br /> <br /> (from Reversi example)<br /> &lt;pre&gt;<br /> var jstpl_player_board = '\&lt;div class=&quot;cp_board&quot;&gt;\<br /> &lt;div id=&quot;stoneicon_p${id}&quot; class=&quot;gmk_stoneicon gmk_stoneicon_${color}&quot;&gt;&lt;/div&gt;&lt;span id=&quot;stonecount_p${id}&quot;&gt;0&lt;/span&gt;\<br /> &lt;/div&gt;';<br /> &lt;/pre&gt;<br /> <br /> Then, you add this piece of code in your JS file to add this template to each player panel:<br /> <br /> &lt;pre&gt;<br /> // Setting up player boards<br /> for( var player_id in gamedatas.players )<br /> {<br /> var player = gamedatas.players[player_id];<br /> <br /> // Setting up players boards if needed<br /> var player_board_div = $('player_board_'+player_id);<br /> dojo.place( this.format_block('jstpl_player_board', player ), player_board_div );<br /> }<br /> &lt;/pre&gt;<br /> <br /> (Note: the code above is of course from your &quot;setup&quot; function in your Javascript).<br /> <br /> Very often, you have to distinguish current player and others players. In this case, you just have to create another JS template (ex: jstpl_otherplayer_board) and use it when &quot;player_id&quot; is different than &quot;this.player_id&quot;.<br /> <br /> === Player's panel disabling/enabling ===<br /> <br /> '''this.disablePlayerPanel( player_id )'''<br /> <br /> Disable given player panel (the panel background become gray).<br /> <br /> Usually, this is used to signal that this played passes, or will be inactive during a while.<br /> <br /> Note that the only effect of this is visual. There are no consequences on the behaviour of the panel itself.<br /> <br /> '''this.enablePlayerPanel( player_id )'''<br /> <br /> Enable a player panel that has been disabled before.<br /> <br /> '''this.enableAllPlayerPanels()'''<br /> <br /> Enable all player panels that has been disabled before.<br /> <br /> == Image loading ==<br /> <br /> See also [[Game_art:_img_directory]].<br /> <br /> '''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.<br /> <br /> '''dontPreloadImage( image_file_name )'''<br /> <br /> Using dontPreloadImage, you tell the interface to not preload a specific image in your img directory.<br /> <br /> Example of use:<br /> &lt;pre&gt;<br /> this.dontPreloadImage( 'cards.png' );<br /> &lt;/pre&gt;<br /> <br /> This is particularly useful if for example you have 2 different themes for a game. To accelerate the loading of the game, you can specify to not preload images corresponding to the other theme.<br /> <br /> Another example of use: in &quot;Gosu&quot; game with Kamakor extension, you play with 5 sets of cards among 10 available. Cards images are organized by sets, and we only preload the images corresponding to the 5 current sets.<br /> <br /> '''Note:''' You don't need to specify to not preload game box images (game_box.png, game_box75.png...) since they are not preloaded by default.<br /> <br /> == Other useful stuff ==<br /> <br /> <br /> '''dojo.hitch'''<br /> <br /> With dojo.hitch, you can create a callback function that will run with your game object context whatever happen.<br /> <br /> Typical example: display a BGA confirmation dialog with a callback function created with dojo.hitch:<br /> <br /> &lt;pre&gt;<br /> this.confirmationDialog( _('Are you sure you want to make this?'), dojo.hitch( this, function() {<br /> this.ajaxcall( '/mygame/mygame/makeThis.html', { lock:true }, this, function( result ) {} );<br /> } ) ); <br /> &lt;/pre&gt;<br /> <br /> In the example above, using dojo.hitch, we are sure that the &quot;this&quot; object will be set when the callback is called.<br /> <br /> <br /> ; updateCounters(counters)<br /> : Useful for updating game counters in the player panel (such as resources). <br /> : 'counters' arg is an associative array [counter_name_value =&gt; [ 'counter_name' =&gt; counter_name_value, 'counter_value' =&gt; counter_value_value], ... ]<br /> : All counters must be referenced in this.gamedatas.counters and will be updated.<br /> : DOM objects referenced by 'counter_name' will have their innerHTML updated with 'counter_value'.<br /> <br /> == BGA GUI components ==<br /> <br /> BGA framework provides some useful ready-to-use components for the game interface:<br /> <br /> [[Studio#BGA_Studio_game_components_reference]]<br /> <br /> Note that each time you are using an additional component, you must declare it at the top of your Javascript file in the list of modules used.<br /> <br /> Example if you are using &quot;ebg.stock&quot;:<br /> &lt;pre&gt;<br /> define([<br /> &quot;dojo&quot;,&quot;dojo/_base/declare&quot;,<br /> &quot;ebg/core/gamegui&quot;,<br /> &quot;ebg/counter&quot;,<br /> &quot;ebg/stock&quot; /// &lt;=== we are using ebg.stock module<br /> ],<br /> &lt;/pre&gt;</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Faq&diff=1078 2014-02-22T19:51:24Z

<p>Een: </p> <hr /> <div>[[Category:Help]]<br /> <br /> == General questions ==<br /> <br /> ===What is Board Game Arena?===<br /> <br /> Board Game Arena (BGA) is an online board game platform. With BGA, you can play online and in real time against players from the whole world. A selection of various board games and card games is available. In order to play, the only thing you need is your browser!<br /> <br /> <br /> ===What do you mean by &quot;real time play&quot;?===<br /> <br /> You can find many websites where you can play board games with a &quot;turn based&quot; approach: after each move, you have to wait for your opponents to connect to the website and play their own move. Most of the time, you have to wait a long time between each move, and games take a long time to finish (if they ever do).<br /> <br /> On Board Game Arena, your opponents are connected to the game platform all along the game, and they can see your moves and react to them immediately - as is the case in the real world.<br /> <br /> <br /> ===What do I need to play?===<br /> <br /> Your browser ... and that's it!<br /> <br /> Board Game Arena does not require anything else on your computer. Thus, you can play from any computer, anywhere, anytime!<br /> <br /> In order to make this thing possible, we are using the very latest technologies available for the web. This is the reason you should play with the most up to date web browsers to enjoy an optimal BGA experience (read more about our [[Browser_support|browser policy]]).<br /> <br /> <br /> ===How much does it cost to play on BGA?===<br /> <br /> Playing on BGA is free.<br /> <br /> You can also choose to help us by making a donation and becoming a [http://en.boardgamearena.com/#!club Board Game Arena club] member.<br /> <br /> <br /> ===What are the games available on BGA?===<br /> <br /> Board Game Arena proposes a various selection of board and card games, but is specialized in modern (&quot;European style&quot;) adult games.<br /> <br /> [http://en.boardgamearena.com/#!gamelist See available games].<br /> <br /> <br /> ===What can I do if I have an issue with the website?===<br /> <br /> Most of the issues one can encounter on this website should be solved with a simple web page refresh (or &quot;F5&quot;).<br /> <br /> If you experience persistent issues, you can browse the [http://forum.boardgamearena.com/viewforum.php?f=4 bug section in the forum], see if someone already reported the issue, and add a new bug report if that's not the case. Please take some time to describe the bug you are reporting in detail so that we can quickly reproduce and fix it.<br /> <br /> <br /> ===What is the legal status of this website?===<br /> <br /> All the games currently available on this site have been licensed or otherwise authorized by copyright holders. Please be aware that games available on BGA can be removed at the copyright holders demand (for example: if they publish their own adaptation of the game).<br /> <br /> Board Game Arena would like to thank all game publishers and game designers who allow us to have their games here, thus making it possible for this website to exist.<br /> <br /> <br /> ===I'm a game publisher: why would I like to have my game on Board Game Arena?===<br /> <br /> The main goal of Board Game Arena is to make it easy for people to discover and love new games. We think that there is only two kinds of players on Board Game Arena: those who already bought the games they are playing online, and those who dream to buy them soon!<br /> <br /> As the activity of this website contributes to increasing a game's popularity and thus generates game boxes sales in the &quot;real world&quot;, we think it is beneficial to the boardgame community: people from all over the world can play online, we can have fun developing this game platform to the best of our ability, and game publishers get money from the box sales and build a special relationship with their players community.<br /> <br /> <br /> <br /> == Meeting players and starting games ==<br /> <br /> ===I launched a new table but nobody is joining?===<br /> <br /> Although Board Game Arena has been enjoying a growing popularity, it is still a young website. For the most popular games, you can find players at any time of the day. For other games, we advise you to come back at peak hour (around 22:00 CEST) if you can't find opponents at the moment.<br /> <br /> Tip: check the number of online/available players for a game before launching the table.<br /> <br /> <br /> ===I joined a game. When does the game start?===<br /> <br /> Each table has an administrator, which is the table creator. It is the responsibility of the table administrator to start the game when he is satisfied with the number of players having joined the table.<br /> <br /> If you are the table administrator and can't launch the game, most of the time it's because there is not yet enough players joined the table.<br /> <br /> <br /> ===What is the meaning of the small color circle next to players names?===<br /> <br /> * http://fr.boardgamearena.com/theme/img/status/online_.png : this player is active. He completed an action very recently.<br /> * http://fr.boardgamearena.com/theme/img/status/inactive_.png : this player is inactive. He is connected to the website but did not perform any action recently.<br /> * http://fr.boardgamearena.com/theme/img/status/offline_.png : this player is offline.<br /> <br /> <br /> ===What does the '% hits' statistic mean?===<br /> % hits = number of victory points / number of games played<br /> <br /> Where number of victory points is the following:<br /> * When you win a 2 players game: 1 point.<br /> * When you win a 3 players game: 1.5 points.<br /> * When you win a 4 players game: 2 points.<br /> * etc.<br /> <br /> This way, &quot;50%&quot; means that you win 50% of 2 players game, or 33% of 3 players game, etc.<br /> <br /> <br /> <br /> == During the game ==<br /> <br /> ===What is the meaning of the icons next to players names?===<br /> <br /> * http://fr.boardgamearena.com/theme/img/layout/active_player.gif : this player must make a move now.<br /> * http://fr.boardgamearena.com/theme/img/layout/active_player_clockalert.gif : this player must make a move now, and he has spent his reflexion time. Can someone wake him up? ;)<br /> * http://fr.boardgamearena.com/theme/img/layout/active_player_nonack.gif : this player must make a move now, but is probably not aware of the fact. If the situation does not evolve, it might be that this player has some connection issue.<br /> * http://fr.boardgamearena.com/theme/img/common/zombie.png : this player is a &quot;zombie&quot; (he left the game or has been fired from the game). The game goes on without this player.<br /> <br /> When the &quot;normal&quot; avatar of a player is displayed, it means that this player is waiting for his turn to play.<br /> <br /> <br /> ===A player has to make a move but he/she doesn't. What can I do?===<br /> <br /> * First, please remember that this player has the right to think as long as he needs to about is next move... well as long as he still has some time left on the game clock, that is.<br /> * Then you can ask this player to confirm that he is still thinking about how to play.<br /> * If this player seems to be away, we advise you to wait a few minutes: this player may be experiencing some network problems or have left his computer temporarily.<br /> * If the player is not coming back, you can expel him from the game as soon as he is running out of time on the game clock for the current move (red bar) or if he goes over his alloted time to think by more than 3/4/5 minutes (depending on game speed). See Clock section for details. Important: in this case, no ELO points will be won by anybody for this game.<br /> <br /> <br /> ===What is the current progression of the game I'm playing?===<br /> <br /> A percentage of progression is displayed on the top of the web page.<br /> There is also a progress bar at the bottom of the web page shows you the current progression of the game.<br /> <br /> <br /> ===What is forbidden on Board Game Arena?===<br /> <br /> * Leaving a game in progress on purpose.<br /> * Taking an unnecessary and unreasonable amount of time at the end of game in an obvious losing situation.<br /> * Kingmaking: enabling another player to win on purpose while there is a better move to make for yourself.<br /> * Running out of time on the game clock.<br /> * Giving some piece of information about the current game situation that corrupts the normal game flow.<br /> * Communicating with another player about the game privately (ex: with MSN).<br /> * Provocation / triumphalism / defeatism ... anything which is not fair play.<br /> * Having a shocking avatar (no advertisement, no politics, ...)<br /> <br /> Going against these rules will affect your reputation.<br /> <br /> <br /> ===What is absolutely forbidden in Board Game Arena?===<br /> <br /> * Creating multiple accounts and playing against oneself.<br /> * Insulting other players in any manner.<br /> <br /> Going against these rules can lead to the removal of your account and/or to the blacklisting of your IP.<br /> <br /> <br /> ===What if some player does something wrong?===<br /> <br /> The Board Game Arena platform has been designed to encourage players to maintain good behavior. The reputation system allows you to distinguish between good and bad players. Then, it is up to you to decide whether to start a game with them or not.<br /> <br /> If you think some player has had bad behavior during a game, you can give him a at the end of the game.<br /> <br /> If you think some player committed some serious wrongdoing during a game (ex: insult), please report this player to us (&quot;report this player&quot; link from his profile or game result page) so that we can take appropriate measures.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Contact_us&diff=1021 2013-12-18T21:14:23Z

<p>Een: Reverted edits by Januszk0 (talk) to last revision by Sourisdudesert</p> <hr /> <div>'''Board Game Arena''' is located in France.<br /> <br /> == Contact e-mail ==<br /> <br /> contact(at)boardgamearena.com<br /> <br /> We receive '''a lot''' of e-mails. Please do not send us an e-mail in any of these two cases:<br /> <br /> * If you want to report a bug, please do it in the [http://boardgamearena.com/#!bugs bug reporting system]<br /> * If you want to report a player for violation of BGA policy, use the &quot;report this player&quot; button on his/her profile.<br /> <br /> == Postal address ==<br /> <br /> G. Isabelli<br /> <br /> 19 bd république<br /> <br /> 92 260 Fontenay-aux-Roses<br /> <br /> FRANCE<br /> <br /> +33 6 17 25 80 34</div>

Een https://ms.doc.boardgamearena.com/index.php?title=BGA_Game_licences&diff=973 2013-10-01T20:56:18Z

<p>Een: moved BGA Game licences to BGA Game licenses: typo</p> <hr /> <div>#REDIRECT [[BGA Game licenses]]</div>

Een https://ms.doc.boardgamearena.com/index.php?title=BGA_Game_licenses&diff=972 2013-10-01T20:56:18Z

<p>Een: moved BGA Game licences to BGA Game licenses: typo</p> <hr /> <div><br /> == What is a &quot;license&quot; exactly? ==<br /> <br /> Almost all games on the Board Game Arena platform are adaptations of existing commercial &quot;real&quot; board games. In order to host an adaptation of one of these board games on a website, the copyright owners must first grant a license/authorisation to this website.<br /> <br /> == Are all games on BGA licensed by their respective copyright owners? ==<br /> <br /> Yes, for all games that are not in the public domain, BGA has been granted an authorisation to create and host an online version.<br /> <br /> == Where can I find a list of games for which a license has already been granted? ==<br /> <br /> [http://en.studio.boardgamearena.com/#!page/availablelicences Check the list of available licenses]<br /> <br /> (NB: this page is restricted to developers registered in BGA studio. You'll need to enter your BGA studio credentials to access it)<br /> <br /> == What if I start developing a game that is not on the &quot;Available licences&quot; list? ==<br /> <br /> We allow developers to start any project in the Studio. But when you submit your project to go live on BGA, it will be rejected during the review process if BGA doesn't hold a proper license for the game.<br /> <br /> Exception: games in the public domain are of course not concerned.<br /> <br /> == Wow, I WANT to develop a game on this list! ==<br /> <br /> Great! :)<br /> <br /> But before creating a new project, please takes some seconds to check that someone is not already developing this game. If it is the case, maybe you can propose to join the project?<br /> <br /> [http://en.studio.boardgamearena.com/#!projects Check the list of current projects]<br /> <br /> == What needs to be done to add a game on this list? ==<br /> <br /> The copyright owners have to give an license/authorisation to BGA.<br /> <br /> Publishers do not have to pay anything to BGA for this, they just need to give their &quot;go&quot;. Most of the time, publishers want to have a formal agreement and we sign a contract with them.<br /> <br /> '''Important''': you CAN'T take the initiative to ask a license authorization on behalf of BGA, because the authorisation has to be granted to BGA (read more below).<br /> <br /> == Why aren't all the best-selling games that I love on that list? ==<br /> <br /> As you can imagine, the more popular a game is, the most difficult it can be to get an agreement to host this game on BGA.<br /> <br /> So if you are thinking about a very popular game that is not on this list, the reason is most likely &quot;we asked but it was not possible&quot; and not &quot;we didn't think of it&quot;.<br /> <br /> We are really happy to have been able to build a very nice platform that managed to convince some of the most prestigious publishers to host their games here, but of course we can't convince -everyone-.<br /> <br /> == I want to make my prototype/unpublished game available on BGA ==<br /> <br /> This is possible, BUT most of the time, we consider this is a bad idea for the following reasons:<br /> * if your game has not been published yet, there is certainly a good reason - most of the time there is still some more work to do on the game itself. Publishing a game on BGA that is not 100% finalized won't help you to finalize it.<br /> * as a rule of thumb, popular board games on BGA are games that are popular in the real world. As a consequence prototypes most likely won't get a big audience on BGA.<br /> * we also advise you against developing your own game: games adaptation are better when there is a designer whose focus is on the gameplay and a developer whose focus is on the implementation.<br /> <br /> So you definitely can develop your prototype/unpublished game on BGA, but we encourage you to think twice about it and do it only if you are in one/several of the situations below:<br /> * the game is going to be published in the near future<br /> * the game design process is really 100% done: the game is ready to be published in its current shape (ex: self-publishing game, game in a crowdfunding process...)<br /> * you want to test your game with a big number of players to fine-tune some minor things (&quot;balance&quot; of the game).<br /> <br /> == What if I really want to develop a particular game that is NOT on the list below? ==<br /> <br /> This is the most frequently asked question, so for a detailed answer please follow the white rabbit down these numbered instructions:<br /> <br /> === 0: ===<br /> <br /> In any case: please, do not contact publishers without asking us before. Just put yourself in the shoes of a game publisher who just published a popular game: what would you think if you received 40 emails from 40 developers speaking about some &quot;BGA platform&quot; and wanting to build an adaptation on it?<br /> <br /> Proceed to 1.<br /> <br /> === 1: ===<br /> <br /> First, you should determine who is the owner of the digital rights of the game. Most of the time, this is the original publisher of the game. The original publisher is not always easy to find, because very often board games are translated and published in different countries by a local publisher.<br /> <br /> To find the original publisher:<br /> * check in which country the game has been published first (ex: If it's in Poland, the original publisher is probably Polish).<br /> * check the copyright notice at the end of the rules, where the original publisher is mentioned almost every time.<br /> * very often, if two publishers are mentioned on a gamebox, the well-known publisher is the local publisher from your country and the other one is the original publisher.<br /> <br /> Special case: if the game is themed with a prestigious licence (Star Wars, Lord of the Rings, some TV show, some well known novel...), you can stop here immediately: contracts between game publishers and prestigious licenses owners are very restrictive, and there is 99% chance that an online adaptation on BGA would be impossible to manage.<br /> <br /> Continue to 2.<br /> <br /> === 2: ===<br /> <br /> Read the list of publishers from the &quot;available licenses&quot; page to check if BGA is already working with this publisher.<br /> <br /> If YES, proceed to 3.<br /> If NO, jump to 4.<br /> <br /> However, if the publisher is listed as &quot;not working with BGA&quot;, you can stop here immediately. It happens that some publishers are not convinced or interested by online boardgaming and it is their right to think so. The BGA team regularly meets new publishers during board games events to show them the platform, so we're working on this but -again- we cannot convince everyone.<br /> <br /> === 3: ===<br /> <br /> Is there already in the list a game licensed by this publisher that is available to be developed or under development?<br /> <br /> If YES: as a rule of thumb, we do not ask more than one game to a publisher at a time. When we ask a license for a game, the publisher naturally expects that this game will be developed and published online. So we develop and publish a game before asking for another.<br /> If you really want to develop another game from this particular publisher, the best option for you is to help develop the game that is currently licensed and then ask us to request the game you'd like to develop.<br /> <br /> If NO: just ask us which game you want to develop and we will be happy to ask the publisher for his authorisation.<br /> <br /> === 4: ===<br /> <br /> We have never worked with this publisher before.<br /> <br /> If you have already developed a game on BGA, we will be happy to contact the publisher to ask for an authorisation :)<br /> <br /> If this is your first game on BGA, we advise you to start with a game already on the list. Why? Because unfortunately, some developers ask us to request a license, and then don't finish the development. When we ask for a license, we are more comfortable if you have already shown your ability to realise an adaptation.<br /> <br /> Special case: if you know the publisher PERSONALLY, or have some contact there, please tell us so we can help you setup a contract allowing us to host a game adaptation on BGA.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=BGA_Game_licenses&diff=971 2013-10-01T20:54:58Z

<p>Een: </p> <hr /> <div><br /> == What is a &quot;license&quot; exactly? ==<br /> <br /> Almost all games on the Board Game Arena platform are adaptations of existing commercial &quot;real&quot; board games. In order to host an adaptation of one of these board games on a website, the copyright owners must first grant a license/authorisation to this website.<br /> <br /> == Are all games on BGA licensed by their respective copyright owners? ==<br /> <br /> Yes, for all games that are not in the public domain, BGA has been granted an authorisation to create and host an online version.<br /> <br /> == Where can I find a list of games for which a license has already been granted? ==<br /> <br /> [http://en.studio.boardgamearena.com/#!page/availablelicences Check the list of available licenses]<br /> <br /> (NB: this page is restricted to developers registered in BGA studio. You'll need to enter your BGA studio credentials to access it)<br /> <br /> == What if I start developing a game that is not on the &quot;Available licences&quot; list? ==<br /> <br /> We allow developers to start any project in the Studio. But when you submit your project to go live on BGA, it will be rejected during the review process if BGA doesn't hold a proper license for the game.<br /> <br /> Exception: games in the public domain are of course not concerned.<br /> <br /> == Wow, I WANT to develop a game on this list! ==<br /> <br /> Great! :)<br /> <br /> But before creating a new project, please takes some seconds to check that someone is not already developing this game. If it is the case, maybe you can propose to join the project?<br /> <br /> [http://en.studio.boardgamearena.com/#!projects Check the list of current projects]<br /> <br /> == What needs to be done to add a game on this list? ==<br /> <br /> The copyright owners have to give an license/authorisation to BGA.<br /> <br /> Publishers do not have to pay anything to BGA for this, they just need to give their &quot;go&quot;. Most of the time, publishers want to have a formal agreement and we sign a contract with them.<br /> <br /> '''Important''': you CAN'T take the initiative to ask a license authorization on behalf of BGA, because the authorisation has to be granted to BGA (read more below).<br /> <br /> == Why aren't all the best-selling games that I love on that list? ==<br /> <br /> As you can imagine, the more popular a game is, the most difficult it can be to get an agreement to host this game on BGA.<br /> <br /> So if you are thinking about a very popular game that is not on this list, the reason is most likely &quot;we asked but it was not possible&quot; and not &quot;we didn't think of it&quot;.<br /> <br /> We are really happy to have been able to build a very nice platform that managed to convince some of the most prestigious publishers to host their games here, but of course we can't convince -everyone-.<br /> <br /> == I want to make my prototype/unpublished game available on BGA ==<br /> <br /> This is possible, BUT most of the time, we consider this is a bad idea for the following reasons:<br /> * if your game has not been published yet, there is certainly a good reason - most of the time there is still some more work to do on the game itself. Publishing a game on BGA that is not 100% finalized won't help you to finalize it.<br /> * as a rule of thumb, popular board games on BGA are games that are popular in the real world. As a consequence prototypes most likely won't get a big audience on BGA.<br /> * we also advise you against developing your own game: games adaptation are better when there is a designer whose focus is on the gameplay and a developer whose focus is on the implementation.<br /> <br /> So you definitely can develop your prototype/unpublished game on BGA, but we encourage you to think twice about it and do it only if you are in one/several of the situations below:<br /> * the game is going to be published in the near future<br /> * the game design process is really 100% done: the game is ready to be published in its current shape (ex: self-publishing game, game in a crowdfunding process...)<br /> * you want to test your game with a big number of players to fine-tune some minor things (&quot;balance&quot; of the game).<br /> <br /> == What if I really want to develop a particular game that is NOT on the list below? ==<br /> <br /> This is the most frequently asked question, so for a detailed answer please follow the white rabbit down these numbered instructions:<br /> <br /> === 0: ===<br /> <br /> In any case: please, do not contact publishers without asking us before. Just put yourself in the shoes of a game publisher who just published a popular game: what would you think if you received 40 emails from 40 developers speaking about some &quot;BGA platform&quot; and wanting to build an adaptation on it?<br /> <br /> Proceed to 1.<br /> <br /> === 1: ===<br /> <br /> First, you should determine who is the owner of the digital rights of the game. Most of the time, this is the original publisher of the game. The original publisher is not always easy to find, because very often board games are translated and published in different countries by a local publisher.<br /> <br /> To find the original publisher:<br /> * check in which country the game has been published first (ex: If it's in Poland, the original publisher is probably Polish).<br /> * check the copyright notice at the end of the rules, where the original publisher is mentioned almost every time.<br /> * very often, if two publishers are mentioned on a gamebox, the well-known publisher is the local publisher from your country and the other one is the original publisher.<br /> <br /> Special case: if the game is themed with a prestigious licence (Star Wars, Lord of the Rings, some TV show, some well known novel...), you can stop here immediately: contracts between game publishers and prestigious licenses owners are very restrictive, and there is 99% chance that an online adaptation on BGA would be impossible to manage.<br /> <br /> Continue to 2.<br /> <br /> === 2: ===<br /> <br /> Read the list of publishers from the &quot;available licenses&quot; page to check if BGA is already working with this publisher.<br /> <br /> If YES, proceed to 3.<br /> If NO, jump to 4.<br /> <br /> However, if the publisher is listed as &quot;not working with BGA&quot;, you can stop here immediately. It happens that some publishers are not convinced or interested by online boardgaming and it is their right to think so. The BGA team regularly meets new publishers during board games events to show them the platform, so we're working on this but -again- we cannot convince everyone.<br /> <br /> === 3: ===<br /> <br /> Is there already in the list a game licensed by this publisher that is available to be developed or under development?<br /> <br /> If YES: as a rule of thumb, we do not ask more than one game to a publisher at a time. When we ask a license for a game, the publisher naturally expects that this game will be developed and published online. So we develop and publish a game before asking for another.<br /> If you really want to develop another game from this particular publisher, the best option for you is to help develop the game that is currently licensed and then ask us to request the game you'd like to develop.<br /> <br /> If NO: just ask us which game you want to develop and we will be happy to ask the publisher for his authorisation.<br /> <br /> === 4: ===<br /> <br /> We have never worked with this publisher before.<br /> <br /> If you have already developed a game on BGA, we will be happy to contact the publisher to ask for an authorisation :)<br /> <br /> If this is your first game on BGA, we advise you to start with a game already on the list. Why? Because unfortunately, some developers ask us to request a license, and then don't finish the development. When we ask for a license, we are more comfortable if you have already shown your ability to realise an adaptation.<br /> <br /> Special case: if you know the publisher PERSONALLY, or have some contact there, please tell us so we can help you setup a contract allowing us to host a game adaptation on BGA.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=BGA_Game_licenses&diff=970 2013-10-01T20:52:40Z

<p>Een: </p> <hr /> <div><br /> == What's a &quot;license&quot; ==<br /> <br /> Almost all games on the Board Game Arena platform are adaptations of existing commercial &quot;real&quot; board games. In order to host an adaptation of one of these board games on a website, the copyright owners must first grant a license/authorisation to this website.<br /> <br /> == Are all games on BGA licensed by their respective copyright owners? ==<br /> <br /> Yes, for all games that are not in the public domain, BGA has been granted an authorisation to create and host an online version.<br /> <br /> == Where can I find a list of games for which a license has already been granted? ==<br /> <br /> [http://en.studio.boardgamearena.com/#!page/availablelicences Check the list of available licenses]<br /> <br /> (NB: this page is restricted to developers registered in BGA studio. You'll need to enter your BGA studio credentials to access it)<br /> <br /> == What if I start developing a game that is not on the &quot;Available licences&quot; list? ==<br /> <br /> We allow developers to start any project in the Studio. But when you submit your project to go live on BGA, it will be rejected during the review process if BGA doesn't hold a proper license for the game.<br /> <br /> Exception: games in the public domain are of course not concerned.<br /> <br /> == Wow, I WANT to develop a game on this list! ==<br /> <br /> Great! :)<br /> <br /> But before creating a new project, please takes some seconds to check that someone is not already developing this game. If it is the case, maybe you can propose to join the project?<br /> <br /> [http://en.studio.boardgamearena.com/#!projects Check the list of current projects]<br /> <br /> == What needs to be done to add a game on this list? ==<br /> <br /> The copyright owners have to give an license/authorisation to BGA.<br /> <br /> Publishers do not have to pay anything to BGA for this, they just need to give their &quot;go&quot;. Most of the time, publishers want to have a formal agreement and we sign a contract with them.<br /> <br /> '''Important''': you CAN'T take the initiative to ask a license authorization on behalf of BGA, because the authorisation has to be granted to BGA (read more below).<br /> <br /> == Why aren't all the best-selling games that I love on that list? ==<br /> <br /> As you can imagine, the more popular a game is, the most difficult it can be to get an agreement to host this game on BGA.<br /> <br /> So if you are thinking about a very popular game that is not on this list, the reason is most likely &quot;we asked but it was not possible&quot; and not &quot;we didn't think of it&quot;.<br /> <br /> We are really happy to have been able to build a very nice platform that managed to convince some of the most prestigious publishers to host their games here, but of course we can't convince -everyone-.<br /> <br /> == I want to make my prototype/unpublished game available on BGA ==<br /> <br /> This is possible, BUT most of the time, we consider this is a bad idea for the following reasons:<br /> * if your game has not been published yet, there is certainly a good reason - most of the time there is still some more work to do on the game itself. Publishing a game on BGA that is not 100% finalized won't help you to finalize it.<br /> * as a rule of thumb, popular board games on BGA are games that are popular in the real world. As a consequence prototypes most likely won't get a big audience on BGA.<br /> * we also advise you against developing your own game: games adaptation are better when there is a designer whose focus is on the gameplay and a developer whose focus is on the implementation.<br /> <br /> So you definitely can develop your prototype/unpublished game on BGA, but we encourage you to think twice about it and do it only if you are in one/several of the situations below:<br /> * the game is going to be published in the near future<br /> * the game design process is really 100% done: the game is ready to be published in its current shape (ex: self-publishing game, game in a crowdfunding process...)<br /> * you want to test your game with a big number of players to fine-tune some minor things (&quot;balance&quot; of the game).<br /> <br /> == What if I really want to develop a particular game that is NOT on the list below? ==<br /> <br /> This is the most frequently asked question, so for a detailed answer please follow the white rabbit down these numbered instructions:<br /> <br /> === 0: ===<br /> <br /> In any case: please, do not contact publishers without asking us before. Just put yourself in the shoes of a game publisher who just published a popular game: what would you think if you received 40 emails from 40 developers speaking about some &quot;BGA platform&quot; and wanting to build an adaptation on it?<br /> <br /> Proceed to 1.<br /> <br /> === 1: ===<br /> <br /> First, you should determine who is the owner of the digital rights of the game. Most of the time, this is the original publisher of the game. The original publisher is not always easy to find, because very often board games are translated and published in different countries by a local publisher.<br /> <br /> To find the original publisher:<br /> * check in which country the game has been published first (ex: If it's in Poland, the original publisher is probably Polish).<br /> * check the copyright notice at the end of the rules, where the original publisher is mentioned almost every time.<br /> * very often, if two publishers are mentioned on a gamebox, the well-known publisher is the local publisher from your country and the other one is the original publisher.<br /> <br /> Special case: if the game is themed with a prestigious licence (Star Wars, Lord of the Rings, some TV show, some well known novel...), you can stop here immediately: contracts between game publishers and prestigious licenses owners are very restrictive, and there is 99% chance that an online adaptation on BGA would be impossible to manage.<br /> <br /> Continue to 2.<br /> <br /> === 2: ===<br /> <br /> Read the list of publishers from the &quot;available licenses&quot; page to check if BGA is already working with this publisher.<br /> <br /> If YES, proceed to 3.<br /> If NO, jump to 4.<br /> <br /> However, if the publisher is listed as &quot;not working with BGA&quot;, you can stop here immediately. It happens that some publishers are not convinced or interested by online boardgaming and it is their right to think so. The BGA team regularly meets new publishers during board games events to show them the platform, so we're working on this but -again- we cannot convince everyone.<br /> <br /> === 3: ===<br /> <br /> Is there already in the list a game licensed by this publisher that is available to be developed or under development?<br /> <br /> If YES: as a rule of thumb, we do not ask more than one game to a publisher at a time. When we ask a license for a game, the publisher naturally expects that this game will be developed and published online. So we develop and publish a game before asking for another.<br /> If you really want to develop another game from this particular publisher, the best option for you is to help develop the game that is currently licensed and then ask us to request the game you'd like to develop.<br /> <br /> If NO: just ask us which game you want to develop and we will be happy to ask the publisher for his authorisation.<br /> <br /> === 4: ===<br /> <br /> We have never worked with this publisher before.<br /> <br /> If you have already developed a game on BGA, we will be happy to contact the publisher to ask for an authorisation :)<br /> <br /> If this is your first game on BGA, we advise you to start with a game already on the list. Why? Because unfortunately, some developers ask us to request a license, and then don't finish the development. When we ask for a license, we are more comfortable if you have already shown your ability to realise an adaptation.<br /> <br /> Special case: if you know the publisher PERSONALLY, or have some contact there, please tell us so we can help you setup a contract allowing us to host a game adaptation on BGA.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Browser_support&diff=969 2013-10-01T19:11:36Z

<p>Een: </p> <hr /> <div><br /> &lt;h3&gt;For the best experience, we recommend:&lt;/h3&gt;<br /> * '''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]<br /> * '''Mozilla Firefox 4+''' [http://www.mozilla.org/products/firefox/ Windows] [http://www.mozilla.org/products/firefox/ Mac] [http://www.mozilla.org/products/firefox/ Linux]<br /> <br /> 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. <br /> 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. <br /> <br /> 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:<br /> <br /> * Google Chrome 4+<br /> * Mozilla Firefox 3.5+<br /> * Internet Explorer 9+<br /> * Safari 4+<br /> <br /> (Note: We do NOT support playing on iPads or similar tablets.)<br /> <br /> [[Category:Help]]</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Faq&diff=968 2013-10-01T19:06:03Z

<p>Een: /* What do I need to play? */</p> <hr /> <div>[[Category:Help]]<br /> <br /> == General questions ==<br /> <br /> ===What is Board Game Arena?===<br /> <br /> Board Game Arena (BGA) is an online board game platform. With BGA, you can play online and in real time against players from the whole world. A selection of various board games and card games is available. In order to play, the only thing you need is your browser!<br /> <br /> ===What do you mean by &quot;real time play&quot;?===<br /> <br /> You can find many websites where you can play board games with a &quot;turn based&quot; approach: after each move, you have to wait for your opponents to connect to the website and play their own move. Most of the time, you have to wait a long time between each move, and games take a long time to finish (if they ever do).<br /> <br /> On Board Game Arena, your opponents are connected to the game platform all along the game, and they can see your moves and react to them immediately - as is the case in the real world.<br /> <br /> ===What do I need to play?===<br /> <br /> Your browser ... and that's it!<br /> <br /> Board Game Arena does not require anything else on your computer. Thus, you can play from any computer, anywhere, anytime!<br /> <br /> In order to make this thing possible, we are using the very latest technologies available for the web. This is the reason you should play with the most up to date web browsers to enjoy an optimal BGA experience (read more about our [[Browser_support|browser policy]]).<br /> <br /> ===How much does it cost to play on BGA?===<br /> <br /> Playing on BGA is free.<br /> <br /> You can also choose to help us by making a donation and becoming a [http://en.boardgamearena.com/#!club Board Game Arena club] member.<br /> <br /> ===What are the games available on BGA?===<br /> <br /> Board Game Arena proposes a various selection of board and card games, but is specialized in modern (&quot;European style&quot;) adult games.<br /> <br /> [http://en.boardgamearena.com/#!gamelist See available games].<br /> <br /> ===What can I do if I have an issue with the website?===<br /> <br /> Most of the issues one can encounter on this website should be solved with a simple web page refresh (or &quot;F5&quot;).<br /> <br /> If you experience persistent issues, you can browse the [http://forum.boardgamearena.com/viewforum.php?f=4 bug section in the forum], see if someone already reported the issue, and add a new bug report if that's not the case. Please take some time to describe the bug you are reporting in detail so that we can quickly reproduce and fix it.<br /> <br /> ===What is the legal status of this website?===<br /> <br /> All the games currently available on this site have been licensed or otherwise authorized by copyright holders. Please be aware that games available on BGA can be removed at the copyright holders demand (for example: if they publish their own adaptation of the game).<br /> <br /> Board Game Arena would like to thank all game publishers and game designers who allow us to have their games here, thus making it possible for this website to exist.<br /> <br /> ===I'm a game publisher: why would I like to have my game on Board Game Arena?===<br /> <br /> The main goal of Board Game Arena is to make it easy for people to discover and love new games. We think that there is only two kinds of players on Board Game Arena: those who already bought the games they are playing online, and those who dream to buy them soon!<br /> <br /> As the activity of this website contributes to increasing a game's popularity and thus generates game boxes sales in the &quot;real world&quot;, we think it is beneficial to the boardgame community: people from all over the world can play online, we can have fun developing this game platform to the best of our ability, and game publishers get money from the box sales and build a special relationship with their players community.<br /> <br /> == Meeting players and starting games ==<br /> <br /> ===I launched a new table but nobody is joining?===<br /> <br /> Although Board Game Arena has been enjoying a growing popularity, it is still a young website. For the most popular games, you can find players at any time of the day. For other games, we advise you to come back at peak hour (around 22:00 CEST) if you can't find opponents at the moment.<br /> <br /> Tip: check the number of online/available players for a game before launching the table.<br /> <br /> ===I joined a game. When does the game start?===<br /> <br /> Each table has an administrator, which is the table creator. It is the responsibility of the table administrator to start the game when he is satisfied with the number of players having joined the table.<br /> <br /> If you are the table administrator and can't launch the game, most of the time it's because there is not yet enough players joined the table.<br /> <br /> ===What is the meaning of the small color circle next to players names?===<br /> <br /> * http://fr.boardgamearena.com/theme/img/status/online_.png : this player is active. He completed an action very recently.<br /> * http://fr.boardgamearena.com/theme/img/status/inactive_.png : this player is inactive. He is connected to the website but did not perform any action recently.<br /> * http://fr.boardgamearena.com/theme/img/status/offline_.png : this player is offline.<br /> <br /> ===What does the '% hits' statistic mean?===<br /> % hits = number of victory points / number of games played<br /> <br /> Where number of victory points is the following:<br /> * When you win a 2 players game: 1 point.<br /> * When you win a 3 players game: 1.5 points.<br /> * When you win a 4 players game: 2 points.<br /> * etc.<br /> <br /> This way, &quot;50%&quot; means that you win 50% of 2 players game, or 33% of 3 players game, etc.<br /> <br /> == During the game ==<br /> <br /> ===What is the meaning of the icons next to players names?===<br /> <br /> * http://fr.boardgamearena.com/theme/img/layout/active_player.gif : this player must make a move now.<br /> * http://fr.boardgamearena.com/theme/img/layout/active_player_clockalert.gif : this player must make a move now, and he has spent his reflexion time. Can someone wake him up? ;)<br /> * http://fr.boardgamearena.com/theme/img/layout/active_player_nonack.gif : this player must make a move now, but is probably not aware of the fact. If the situation does not evolve, it might be that this player has some connection issue.<br /> * http://fr.boardgamearena.com/theme/img/common/zombie.png : this player is a &quot;zombie&quot; (he left the game or has been fired from the game). The game goes on without this player.<br /> <br /> When the &quot;normal&quot; avatar of a player is displayed, it means that this player is waiting for his turn to play.<br /> <br /> ===A player has to make a move but he/she doesn't. What can I do?===<br /> <br /> * First, please remember that this player has the right to think as long as he needs to about is next move... well as long as he still has some time left on the game clock, that is.<br /> * Then you can ask this player to confirm that he is still thinking about how to play.<br /> * If this player seems to be away, we advise you to wait a few minutes: this player may be experiencing some network problems or have left his computer temporarily.<br /> * If the player is not coming back, you can expel him from the game as soon as he is running out of time on the game clock for the current move (red bar) or if he goes over his alloted time to think by more than 3/4/5 minutes (depending on game speed). See Clock section for details. Important: in this case, no ELO points will be won by anybody for this game.<br /> <br /> ===What is the current progression of the game I'm playing?===<br /> <br /> A percentage of progression is displayed on the top of the web page.<br /> There is also a progress bar at the bottom of the web page shows you the current progression of the game.<br /> <br /> ===What is forbidden on Board Game Arena?===<br /> <br /> * Leaving a game in progress on purpose.<br /> * Thinking an unnecessary and unreasonable amount of time at the end of game in an obvious losing situation.<br /> * Kingmaking: enabling another player to win on purpose while there is a better move to make for yourself.<br /> * Running out of time on the game clock.<br /> * Giving some piece of information about the current game situation that corrupts the normal game flow.<br /> * Communicating with another player about the game privately (ex: with MSN).<br /> * Provocation / triumphalism / defeatism ... anything which is not fair play.<br /> * Having a shocking avatar (no advertisement, no politics, ...)<br /> <br /> Going against these rules will affect your reputation.<br /> <br /> ===What is absolutely forbidden in Board Game Arena?===<br /> <br /> * Creating multiple account and playing against oneself.<br /> * Insulting other players in any manner.<br /> <br /> Going against these rules can lead to the removal of your account and/or to the blacklisting of your IP.<br /> <br /> ===What if some player does something wrong?===<br /> <br /> Board Game Arena platform has been designed to encourage players to maintain a good behaviour. The reputation system allows you to distinguish between good and bad players. Then, it is up to you to decide whether to start a game with them or not.<br /> <br /> If you think some player has had a bad behavior during a game, you can give him a at the end of the game.<br /> <br /> If you think some player committed some serious wrongdoing during a game (ex: insult), please report this player to us (&quot;report this player&quot; link from his profile or game result page) so that we can take appropriate measures.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Privacy&diff=905 2013-07-09T06:22:06Z

<p>Een: Created page with &quot;To create an account, you need to provide an email, user name and password. You can also complete your player profile with some other data. We store this data. Yep. It would ...&quot;</p> <hr /> <div>To create an account, you need to provide an email, user name and password.<br /> You can also complete your player profile with some other data.<br /> <br /> We store this data. Yep. It would be pretty annoying for you to enter it each time you visit ;)<br /> <br /> If you are 'internet paranoid' and you never provide any website with accurate personal information, congratulations! You can skip this section.<br /> <br /> If you are not, congratulations! You can also skip this section which is intended only for 'internet paranoid' people anyway... It has been written for compliance with some social network authentication policy (take your bet, there is only two - oh, wait, if you are reading this you probably know). Well, to be fair, I could have left it empty too, the only check made by said social network being that the page exists. But, what would have been the fun in that?<br /> <br /> If you are still interested to read on some stuff instead of going straight to playing:<br /> * Your password is stored encrypted, but the usual precautionary measures apply. You should use a strong password and not use the same one that for sensitive websites. Some people would say never to use the same password, but this looks like excessive blunt force to the head, except for websites with very sensitive information. Shouldn't be the case on a gaming website, but hey, do as you please.<br /> * We don't share your email with third parties without your consent. Your consent may be implicit in some obvious cases (such as if you take part in a contest with prizes from a publisher, as it will be needed for the publisher to contact you to redeem the prize).<br /> * Your profile information is visible to other players, as well as your gaming history on the website. So, since anyone can create an account on the site, it should be considered public information. But if you use a pseudonym for your username, it shouldn't be easy to link it to your real identity (in case you would be worried about that).<br /> <br /> Hope this all sounds reasonable to you, and that you can now enjoy Board Game Arena without second thoughts!<br /> <br /> Cheers and doughnuts,<br /> <br /> The admins.</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Game_interface_logic:_yourgamename.js&diff=902 2013-06-30T13:35:10Z

<p>Een: /* Animations */</p> <hr /> <div><br /> This is the main file for your game interface. Here you will define:<br /> <br /> * which actions on the page will generate calls to the server<br /> * what happens when you get a notification for change from the server and how it will show in the browser. <br /> <br /> == File structure ==<br /> <br /> The details on how the file is structured is described directly with comments on the code skeleton provided to you.<br /> <br /> Basically, here's this structure:<br /> * constructor: here you can define variable global to your whole interface.<br /> * setup: this method is called when the page is refreshed, in order you can setup the game interface.<br /> * onEnteringState: the method is called when entering in a new game state. This way you can customize the view for this game state.<br /> * onLeavingState: the method is called when leaving a game state.<br /> * onUpdateActionButtons: called when entering in a new state, in order you can add action buttons in status bar.<br /> * (utility methods): at this place you can define your utility methods<br /> * (player's actions): at this place you can write your handlers for player's action on the interface (ex: click on an item).<br /> * setupNotifications: in this method you associate notifications with notification handlers. This way, for each game notification, you trigger a javascript method to handle it and update the game interface.<br /> * (notification handlers): at this place you can define your notifications handlers.<br /> <br /> == General tips ==<br /> <br /> ; this.player_id<br /> : Id of the player on whose browser the code is running.<br /> <br /> ; this.isSpectator<br /> : Flag set to true if the user at the table is a spectator (not a player).<br /> : Note: if you want to hide some element for spectators, you'd better use [[Game_interface_stylesheet:_yourgamename.css#spectatorMode|CSS 'spectatorMode' class]].<br /> <br /> ; this.gamedatas<br /> : Contains your initial set of datas to init the game, created at game start or game refresh (F5)<br /> : You can update it as needed to keep an up to date reference of the game on the client side if you need it (most of the time you don't).<br /> <br /> ; isCurrentPlayerActive()<br /> : Returns true if the player on whose browser the code is running is currently active (it's his turn to play)<br /> <br /> ; this.getActivePlayerId()<br /> : Return the ID of active player, or null if we are not in a &quot;activeplayer&quot; type state.<br /> <br /> ; this.getActivePlayers()<br /> : Return an array with the IDs of players that are currently active (or an empty array if there is not).<br /> <br /> == Dojo framework ==<br /> <br /> BGA is using the [http://dojotoolkit.org/ Dojo Javascript framework].<br /> <br /> The Dojo framework allows us to do complex things easier, and the BGA framework is using Dojo framework a lot.<br /> <br /> To realize game although, you only need to use a few part of the Dojo framework. All the Dojo methods you need to use are describe on this page.<br /> <br /> == Access and manipulate the DOM ==<br /> <br /> '''$('some_html_element_id')'''<br /> <br /> The $() function is used to get some HTML element using its &quot;id&quot; attribute.<br /> <br /> Example 1: modify the content of a &quot;span&quot; element:<br /> &lt;pre&gt;<br /> In your HTML code:<br /> &lt;span id=&quot;a_value_in_the_game_interface&quot;&gt;1234&lt;/span&gt;<br /> <br /> In your Javascript code:<br /> $('a_value_in_the_game_interface').innerHTML = &quot;9999&quot;;<br /> &lt;/pre&gt;<br /> <br /> Note: $() is the standard method to access some HTML element with BGA Framework. You must not use &quot;getElementById&quot; function.<br /> <br /> <br /> '''dojo.style'''<br /> <br /> With dojo.style you can modify a CSS property of any HTML element of your interface.<br /> <br /> Examples:<br /> &lt;pre&gt;<br /> // Make an element disappear<br /> dojo.style( 'my_element', 'display', 'none' );<br /> <br /> // Give an element a 2px border<br /> dojo.style( 'my_element', 'borderWidth', '2px' );<br /> <br /> // Change the background position of an element<br /> // (very practical when you are using CSS sprite to transform an element to another)<br /> dojo.style( 'my_element', 'backgroundPosition', '-20px -50px' );<br /> &lt;/pre&gt;<br /> <br /> Note: you must always use dojo.style to modify CSS properties of HTML elements.<br /> <br /> Note²: if you have to modify several CSS properties of an element, or if you have some complex CSS transformation to do, you should consider using dojo.addClass/dojo.removeClass (see below).<br /> <br /> '''dojo CSS classes manipulation'''<br /> <br /> In many situation, a bunch of many small CSS property update can be replaced by a CSS class change (ie: you add a CSS class to your element instead of applying all modification manually).<br /> <br /> Advantages are:<br /> * All your CSS stuff remains in your CSS file.<br /> * You can add/remove a list of CSS modifications with a simple function and whithout error.<br /> * You can test if you applied the stuff to an element with &quot;dojo.hasClass&quot; method.<br /> <br /> Example from &quot;Reversi&quot;:<br /> &lt;pre&gt;<br /> // We add &quot;possibleMove&quot; to an element<br /> dojo.addClass( 'square_'+x+'_'+y, 'possibleMove' );<br /> <br /> // In our CSS file, the class is defined as:<br /> .possibleMove {<br /> background-color: white;<br /> opacity: 0.2;<br /> filter:alpha(opacity=20); /* For IE8 and earlier */ <br /> cursor: pointer; <br /> }<br /> <br /> // So we've applied 4 CSS property change in one line of code.<br /> <br /> // ... and when we need to check if a square is a possible move on client side:<br /> if( dojo.hasClass( 'square_'+x+'_'+y, 'possibleMove' ) )<br /> { ... }<br /> <br /> // ... and if we want to remove all possible moves in one line of code (see &quot;dojo.query&quot; method):<br /> dojo.query( '.possibleMove' ).removeClass( 'possibleMove' );<br /> &lt;/pre&gt;<br /> <br /> Conclusion: we encourage you to use dojo.addClass, dojo.removeClass and dojo.hasClass to make your life easier :)<br /> <br /> '''dojo.query'''<br /> <br /> With dojo.query, you can query a bunch of HTML elements with a single function, with a &quot;CSS selector&quot; style.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> // All elements with class &quot;possibleMove&quot;:<br /> var elements = dojo.query( '.possibleMove' );<br /> <br /> // Count number of tokens (ie: elements with class &quot;token&quot;) on the board (ie: element with id &quot;board&quot;):<br /> dojo.query( '#board .token' ).length;<br /> &lt;/pre&gt;<br /> <br /> But what is really cool with dojo.query is that you can combine it with almost all methods above.<br /> <br /> Examples:<br /> &lt;pre&gt;<br /> // Trigger a method when the mouse enter in any element with class &quot;meeple&quot;:<br /> dojo.query( '.meeple' ).connect( 'onmouseenter', this, 'myMethodToTrigger' );<br /> <br /> // Hide all meeples who are on the board<br /> dojo.query( '#board .meeple' ).style( 'display', 'none' );<br /> &lt;/pre&gt;<br /> <br /> '''dojo.place'''<br /> <br /> dojo.place is the best function to insert some HTML code somewhere in your game interface without breaking something. It is much better to use that &quot;innerHTML=''&quot; method as soon as you must insert HTML tags and not only values.<br /> <br /> &lt;pre&gt;<br /> // Insert your HTML code as a child of a container element<br /> dojo.place( &quot;&lt;your html code&gt;&quot;, &quot;your_container_element_id&quot; );<br /> <br /> // Replace the container element with your new html<br /> dojo.place( &quot;&lt;your html code&gt;&quot;, &quot;your_container_element_id&quot;, &quot;replace&quot; );<br /> <br /> &lt;/pre&gt;<br /> <br /> Note: the third parameter of dojo.place can take various interesting value: &quot;first&quot;, &quot;after&quot;, ... [http://dojotoolkit.org/reference-guide/1.7/dojo/place.html See full doc on dojo.place].<br /> <br /> Usually, when you want to insert some piece of HTML in your game interface, you should use &quot;[[Game_layout:_view_and_template:_yourgamename.view.php_and_yourgamename_yourgamename.tpl#Javascript_templates|Javascript templates]]&quot;.<br /> <br /> '''addStyleToClass: function( cssClassName, cssProperty, propertyValue )'''<br /> <br /> Same as dojo.style(), but for all the nodes set with the specified cssClassName<br /> <br /> === Animations ===<br /> <br /> '''Dojo Animations'''<br /> <br /> BGA animations is based on Dojo Animation ([http://dojotoolkit.org/documentation/tutorials/1.8/animation/ see tutorial here]).<br /> <br /> However, most of the time, you can just use methods below, which are built on top of Dojo Animation.<br /> <br /> Note: one interesting method from Dojo that could be useful from time to time is &quot;Dojo.Animation&quot;. It allows you to make any CSS property &quot;slide&quot; from one value to another.<br /> <br /> '''this.slideToObject( mobile_obj, target_obj, duration, delay )'''<br /> <br /> You can use slideToObject to &quot;slide&quot; an element to a target position.<br /> <br /> Sliding element on the game area is the recommended and the most used way to animate your game interface. Using slides allow players to figure out what is happening on the game, as if they were playing with the real boardgame.<br /> <br /> The parameters are:<br /> * mobile_obj: the ID of the object to move. This object must be &quot;relative&quot; or &quot;absolute&quot; positioned.<br /> * target_obj: the ID of the target object. This object must be &quot;relative&quot; or &quot;absolute&quot; positioned. Note that it is not mandatory that mobile_obj and target_obj have the same size. If their size are different, the system slides the center of mobile_obj to the center of target_obj.<br /> * duration: (optional) defines the duration in millisecond of the slide. The default is 500 milliseconds.<br /> * delay: (optional). If you defines a delay, the slide will start only after this delay. This is particularly useful when you want to slide several object from the same position to the same position: you can give a 0ms delay to the first object, a 100ms delay to the second one, a 200ms delay to the third one, ... this way they won't be superposed during the slide.<br /> <br /> BE CAREFUL: The method returns an dojo.fx animation, so you can combine it with other animation if you want to. It means that you have to call the &quot;play()&quot; method, otherwise the animation WON'T START.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.slideToObject( &quot;some_token&quot;, &quot;some_place_on_board&quot; ).play();<br /> &lt;/pre&gt;<br /> <br /> <br /> '''this.slideToObjectPos( mobile_obj, target_obj, target_x, target_y, duration, delay )'''<br /> <br /> This method does exactly the same than &quot;slideToObjectPos&quot;, except than you can specify some (x,y) coordinates. This way, &quot;mobile_obj&quot; will slide to the specified x,y position relatively to &quot;target_obj&quot;.<br /> <br /> Example: slide a token to some place on the board, 10 pixels to the bottom:<br /> &lt;pre&gt;<br /> this.slideToObjectPos( &quot;some_token&quot;, &quot;some_place_on_board&quot;, 0, 10 ).play();<br /> &lt;/pre&gt;<br /> <br /> '''this.slideTemporaryObject( mobile_obj_html, mobile_obj_parent, from, to, duration, delay )'''<br /> <br /> This method is useful when you want to slide a temporary HTML object from one place to another. As this object does not exists before the animation and won't remain after, it could be complex to create this object (with dojo.place), to place it at its origin (with placeOnObject) to slide it (with slideToObject) and to make it disappear at the end.<br /> <br /> slideTemporaryObject does all of this for you:<br /> * mobile_obj_html is a piece of HTML code that represent the object to slide.<br /> * mobile_obj_parent is the ID of an HTML element of your interface that will be the parent of this temporary HTML object.<br /> * from is the ID of the origin of the slide.<br /> * to is the ID of the target of the slide.<br /> * duration/delay works exactly like in &quot;slideToObject&quot;<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.slideTemporaryObject( '&lt;div class=&quot;token_icon&quot;&gt;&lt;/div&gt;', 'tokens', 'my_origin_div', 'my_target_div' );<br /> &lt;/pre&gt;<br /> <br /> '''this.slideToObjectAndDestroy: function( node, to, time, delay )'''<br /> <br /> This method is a handy shortcut to slide an existing HTML object to some place then destroy it upon arrival. It can be used for example to move a victory token or a card from the board to the player panel to show that the player earns it, then destroy it when we don't need to keep it visible on the player panel.<br /> <br /> It works the same as this.slideToObject and takes the same arguments. <br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.slideToObjectAndDestroy( &quot;some_token&quot;, &quot;some_place_on_board&quot;, 1000, 0 ).play();<br /> &lt;/pre&gt;<br /> <br /> '''this.fadeOutAndDestroy( node )'''<br /> <br /> This function fade out the target HTML node, then destroy it.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.fadeOutAndDestroy( &quot;a_card_that_must_disappear&quot; );<br /> &lt;/pre&gt;<br /> <br /> CAREFUL: the HTML node still exists until during few milliseconds, until the fadeOut has been completed.<br /> <br /> '''Rotating elements'''<br /> <br /> You can check here [http://jimfulton.info/demos/dojo-animated-rotate.html an example of use] of Dojo to make an element rotate.<br /> <br /> This example combines &quot;Dojo.Animation&quot; method and a CSS3 property that allow you to rotate the element.<br /> <br /> IMPORTANT: to asses browser compatibility, you must select the CSS property to use just like in the example (see sourcecode below):<br /> <br /> &lt;pre&gt;<br /> var transform;<br /> dojo.forEach(<br /> ['transform', 'WebkitTransform', 'msTransform',<br /> 'MozTransform', 'OTransform'],<br /> function (name) {<br /> if (typeof dojo.body().style[name] != 'undefined') {<br /> transform = name;<br /> }<br /> });<br /> // ... and then use &quot;transform&quot; as the name of your CSS property for rotation<br /> &lt;/pre&gt;<br /> <br /> === Moving elements ===<br /> <br /> '''this.placeOnObject( mobile_obj, target_obj )'''<br /> <br /> placeOnObject works exactly like &quot;slideToObject&quot;, except that the effect is immediate.<br /> <br /> This is not really an animation, but placeOnObject is frequently used before starting an animation.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> // (We just created an object &quot;my_new_token&quot;)<br /> <br /> // Place the new token on current player board<br /> this.placeOnObject( &quot;my_new_token&quot;, &quot;overall_player_board_&quot;+this.player_id );<br /> <br /> // Then slide it to its position on the board<br /> this.slideToObject( &quot;my_new_token&quot;, &quot;a_place_on_board&quot; ).play();<br /> &lt;/pre&gt;<br /> <br /> '''this.placeOnObjectPos( mobile_obj, target_obj, target_x, target_y )'''<br /> <br /> This method works exactly like placeOnObject, except than you can specify some (x,y) coordinates. This way, &quot;mobile_obj&quot; will be placed to the specified x,y position relatively to &quot;target_obj&quot;.<br /> <br /> '''this.attachToNewParent( mobile_obj, target_obj )'''<br /> <br /> With this method, you change the HTML parent of &quot;mobile_obj&quot; element. &quot;target_obj&quot; is the new parent of this element. The beauty of <br /> attachToNewParent is that the mobile_obj element DOES NOT MOVE during this process.<br /> <br /> Note: what happens is that the method calculate a relative position of mobile_obj to make sure it does not move after the HTML parent changes.<br /> <br /> Why using this method?<br /> <br /> Changing the HTML parent of an element can be useful for the following reasons:<br /> * When the HTML parent moves, all its child are moving with them. If some game elements is no more linked with a parent HTML object, you may want to attach it to another place.<br /> * The z_order (vertical order of display) depends on the position in the DOM, so you may need to change the parent of some game elements when they are moving in your game area.<br /> <br /> CAREFUL: when you attach an HTML element with a new parent, you break all references to this HTML element (ex: dojo.connect).<br /> <br /> == Players input ==<br /> <br /> '''dojo.connect'''<br /> <br /> Used to associate a player event with one of your notification method.<br /> <br /> Example: associate a click on an element (&quot;my_element&quot;) with one of our method (&quot;onClickOnMyElement&quot;):<br /> &lt;pre&gt;<br /> dojo.connect( $('my_element'), 'onClick', this, 'onClickOnMyElement' );<br /> &lt;/pre&gt;<br /> <br /> Note: this is the only possible correct way to associate a player input event to your code, and you must not use anything else.<br /> <br /> '''this.checkAction( &quot;my_action_name&quot; )'''<br /> <br /> Usage: checkAction: function( action, nomessage )<br /> <br /> Check if player can do the specified action by taking into account:<br /> * current game state<br /> * interface locking (a player can't do any action if an action is already in progress)<br /> <br /> return true if action is authorized (ie: the action is listed as a &quot;possibleaction&quot; in current game state).<br /> <br /> return false and display an error message if not (display no message if nomessage parameter is true). The displayed error message could be either &quot;This move is not allowed at this moment&quot; or &quot;An action is already in progress&quot;.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> function onClickOnGameElement( evt )<br /> {<br /> if( this.checkAction( &quot;my_action&quot; ) )<br /> {<br /> // Do the action<br /> }<br /> }<br /> &lt;/pre&gt;<br /> <br /> '''this.ajaxcall( url, parameters, obj_callback, callback, callback_error )'''<br /> <br /> This method must be used to send a player input to the game server.<br /> <br /> * url: the url of the action to perform. For a game, it must be: &quot;/&lt;mygame&gt;/&lt;mygame&gt;/myAction.html&quot;<br /> * parameters: an array of parameter to send to the game server. Note that &quot;lock:true&quot; must always be specified in this list of parameter in order the interface can be locked during the server call.<br /> * obj_callback: must be set to &quot;this&quot;.<br /> * callback: a function to trigger when the server returns and everything went fine.<br /> * callback_error: (optional and rarely used) a function to trigger when the server returns an error.<br /> <br /> Usage:<br /> &lt;pre&gt;<br /> this.ajaxcall( '/mygame/mygame/myaction.html', { lock: true, <br /> arg1: myarg1, <br /> arg2: myarg2, <br /> ...<br /> }, this, function( result ) {<br /> // Do some stuff after a successful call<br /> } );<br /> &lt;/pre&gt;<br /> <br /> Restricted arguments names (please don't use them):<br /> * &quot;action&quot;<br /> * &quot;module&quot;<br /> * &quot;class&quot;<br /> <br /> '''this.confirmationDialog()'''<br /> <br /> Display a confirmation dialog with a yes/no choice.<br /> <br /> We advice you to NOT use this function unless the player action is really critical and could ruins the game, because it slows down the game and upset players.<br /> <br /> Usage: this.confirmationDialog( &quot;Question to displayed&quot;, callback_function_if_click_on_yes );<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.confirmationDialog( _('Are you sure to use this bonus (points penalty at the end of the game) ?'),<br /> dojo.hitch( this, function() {<br /> this.ajaxcall( '/seasons/seasons/useBonus.html',<br /> { id:bonus_id, lock:true }, this, function( result ) {} );<br /> } ) ); <br /> &lt;/pre&gt;<br /> <br /> <br /> ; addEventToClass: function( cssClassName, eventName, functionName )<br /> : Same as dojo.connect(), but for all the nodes set with the specified cssClassName<br /> <br /> '''this.addActionButton( id, label, method, (opt)depreciated, (opt)bHighlight )'''<br /> <br /> You can use this method to add an action button in the main action status bar.<br /> <br /> Arguments:<br /> * id: a ID that should be unique in your HTML DOM document.<br /> * label: the text of the button. Should be translatable (use _() function).<br /> * method: the name of your method that must be triggered when the player clicks on this button.<br /> * depreciated (optional): do not use this. Please not specify this argument or use &quot;null&quot;.<br /> * bHighlight: if set to &quot;true&quot;, the button is going blink to catch player's attention. Please don't abuse of blinking button.<br /> <br /> You should only use this method in your &quot;onUpdateActionButtons&quot; method. Usually, you use it like this (from Hears example):<br /> <br /> &lt;pre&gt;<br /> onUpdateActionButtons: function( stateName, args )<br /> {<br /> console.log( 'onUpdateActionButtons: '+stateName );<br /> <br /> if( this.isCurrentPlayerActive() )<br /> { <br /> switch( stateName )<br /> {<br /> case 'giveCards':<br /> this.addActionButton( 'giveCards_button', _('Give selected cards'), 'onGiveCards' ); <br /> break;<br /> <br /> }<br /> }<br /> }, <br /> &lt;/pre&gt;<br /> <br /> In the example above, we are adding a &quot;Give selected cards&quot; button in the case we are on game state &quot;giveCards&quot;. When player clicks on this button, it triggers our &quot;onGiveCards&quot; method.<br /> <br /> == Translations ==<br /> <br /> See [[Translations]]<br /> <br /> == Notifications ==<br /> <br /> When something happens on the server side, your game interface Javascript logic received a notification.<br /> <br /> Here's how you can handle these notifications on the client side.<br /> <br /> === Subscribe to notifications ===<br /> <br /> Your Javascript &quot;setupNotifications&quot; method is the place where you can subscribe to notifications from your PHP code.<br /> <br /> Here's how you associate one of your Javascript method to a notification &quot;playDisc&quot; (from Reversi example):<br /> <br /> &lt;pre&gt;<br /> // In setupNotifications method:<br /> dojo.subscribe( 'playDisc', this, &quot;notif_playDisc&quot; );<br /> &lt;/pre&gt;<br /> <br /> Note: the &quot;playDisc&quot; corresponds to the name of the notification you define it in your PHP code, in your &quot;notifyAllPlayers&quot; or &quot;notifyPlayer&quot; method.<br /> <br /> Then, you have to define your &quot;notif_playDisc&quot; method:<br /> <br /> &lt;pre&gt;<br /> notif_playDisc: function( notif )<br /> {<br /> // Remove current possible moves (makes the board more clear)<br /> dojo.query( '.possibleMove' ).removeClass( 'possibleMove' ); <br /> <br /> this.addDiscOnBoard( notif.args.x, notif.args.y, notif.args.player_id );<br /> },<br /> &lt;/pre&gt;<br /> <br /> In a notification handler like our &quot;notif_playDisc&quot; method, you can access to all notifications arguments with &quot;notif.args&quot;.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> // If you did this on PHP side:<br /> self::notifyAllPlayers( &quot;myNotification&quot;, '', array( &quot;myArgument&quot; =&gt; 3 ) );<br /> <br /> // On Javascript side, you can access the &quot;myArgument&quot; like this:<br /> notif_myNotification: function( notif )<br /> {<br /> alert( &quot;myArgument = &quot; + notif.args.myArgument );<br /> }<br /> &lt;/pre&gt;<br /> <br /> === Synchronous notifications ===<br /> <br /> When several notifications are received by your game interface, these notifications are processed immediately, one after the other, in the same exact order they have been generated in your PHP game logic.<br /> <br /> However, sometimes, you need to give some time to the players to figure out what happened on the game before jumping to the next notification. Indeed, in many games, they are a lot of automatic actions, and the computer is going to resolve all these actions very fast if you don't tell it not to do so.<br /> <br /> As an example, for Reversi, when someone is playing a disc, we want to wait 500 milliseconds before doing anything else in order the opponent player can figure out what move has been played.<br /> <br /> Here's how we do this, right after our subscription:<br /> &lt;pre&gt;<br /> dojo.subscribe( 'playDisc', this, &quot;notif_playDisc&quot; );<br /> this.notifqueue.setSynchronous( 'playDisc', 500 ); // Wait 500 milliseconds after executing the playDisc handler<br /> &lt;/pre&gt;<br /> <br /> == Tooltips ==<br /> <br /> '''this.addTooltip( nodeId, _( helpString ), _( actionString ), delay )'''<br /> <br /> Add a simple text tooltip to the DOM node.<br /> <br /> Specify 'helpString' to display some information about &quot;what is this game element?&quot;.<br /> Specify 'actionString' to display some information about &quot;what happens when I click on this element?&quot;.<br /> <br /> You must specify both helpString and actionString. Most of the time, you use only one and specify a void string (&quot;&quot;) for the other one.<br /> <br /> Usually, _() must be used for the text to be marked for translation.<br /> <br /> &quot;Delay&quot; is an optional parameter. Usually, it is primarily used to specify a zero delay for some game element when the tooltip gives really important information for the game - but remember: no essential information must be placed in tooltips as they won't be displayed in some browser (see Guidelines).<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.addTooltip( 'cardcount', _('Number of cards in hand'), '' );<br /> &lt;/pre&gt;<br /> <br /> '''this.addTooltipHtml( nodeId, html, delay )'''<br /> <br /> Add an HTML tooltip to the DOM node (for more elaborate content such as presenting a bigger version of a card).<br /> <br /> '''this.addTooltipToClass( cssClass, _( helpString ), _( actionString ), delay )'''<br /> <br /> Add a simple text tooltip to all the DOM nodes set with this cssClass. <br /> <br /> IMPORTANT: all concerned nodes must have IDs to get tooltips.<br /> <br /> '''addTooltipHtmlToClass( cssClass, html, delay )'''<br /> <br /> Add an HTML tooltip to to all the DOM nodes set with this cssClass (for more elaborate content such as presenting a bigger version of a card).<br /> <br /> IMPORTANT: all concerned nodes must have IDs to get tooltips<br /> <br /> == Dialogs, warning messages, confirmation dialogs, ... ==<br /> <br /> === Warning messages ===<br /> <br /> Sometimes, there is something important that is happening on the game and you have to make sure all players get the message. Most of the time, the evolution of the game situation or the game log is enough, but sometimes you need something more visible.<br /> <br /> Ex: someone fulfill one of the end of the game condition, so this is the last turn.<br /> <br /> '''this.showMessage( msg, type )'''<br /> <br /> showMessage shows a message in a big rectangular area on the top of the screen of current player.<br /> <br /> * &quot;msg&quot; is the string to display. It should be translated.<br /> * &quot;type&quot; can be set to &quot;info&quot; or &quot;error&quot;. If set to &quot;info&quot;, the message will be an informative message on a white background. If set to &quot;error&quot;, the message will be an error message on a red background.<br /> <br /> Important: the normal way to inform players about the progression of the game is the game log. &quot;showMessage&quot; is intrusive and should not be used often.<br /> <br /> === Confirmation dialog ===<br /> <br /> When an important action with a lot of consequences is triggered by the player, you may want to propose a confirmation dialog.<br /> <br /> CAREFUL: the general guidelines of BGA is to AVOID the use of confirmation dialog. Confirmation dialogs slow down the game and bother players. The players knows that they have to pay attention about each move when they are playing online.<br /> <br /> The situation where you should use a confirmation dialog are the following:<br /> * It must not happen very often during a game.<br /> * It must be linked to an action that can really &quot;kill a game&quot; if the player do not pay attention.<br /> * It must be something that can be done by mistake (ex: a link on the action status bar).<br /> <br /> How to display a confirmation dialog:<br /> &lt;pre&gt;<br /> this.confirmationDialog( _('Are you sure you want to make this?'), dojo.hitch( this, function() {<br /> this.ajaxcall( '/mygame/mygame/makeThis.html', { lock:true }, this, function( result ) {} );<br /> } ) ); <br /> &lt;/pre&gt;<br /> <br /> === Dialogs ===<br /> <br /> At first, you shouldn't use dialogs windows.<br /> <br /> BGA guidelines specify that all game elements should be displayed on the main screen. Players can eventually scroll down to see game elements they don't need to see anytime, and you may eventually create anchors to move between game area section. Of course dialogs windows are very practical, but the thing is: all players know how to scroll down, and not all players know how to show up your dialog window. In addition, when the dialog shows up, players can't access the other game components.<br /> <br /> Sometimes although, you need to display a dialog window. Here is how you do this:<br /> <br /> &lt;pre&gt;<br /> <br /> // Create the new dialog. You should store the handler in a member variable to access it later<br /> this.myDlg = new dijit.Dialog({ title: _(&quot;my dialog title to translate&quot;) });<br /> <br /> // Create the HTML of my dialog. The best practice here is to use [[Game_layout:_view_and_template:_yourgamename.view.php_and_yourgamename_yourgamename.tpl#Javascript_templates|Javascript templates]]:<br /> var html = this.format_block( 'jstpl_myDialogTemplate', { <br /> arg1: myArg1,<br /> arg2: myArg2,<br /> ...<br /> } ); <br /> <br /> // Show the dialog<br /> this.myDlg.attr(&quot;content&quot;, html );<br /> this.myDlg.show(); <br /> <br /> // Now that the dialog has been displayed, you can connect your method to some dialog elements<br /> // Example, a &quot;close&quot; button:<br /> dojo.connect( $('closeDlg'), 'onclick', this, function(evt){<br /> evt.preventDefault();<br /> this.myDlg.hide();<br /> } ); <br /> <br /> &lt;/pre&gt;<br /> <br /> Tip: be careful with &quot;hide()&quot; method to close your dialog: the dialog and its content is not completely removed from the DOM. It can cause you problems if you try to display the same dialog several times. A good practice is to wrap all the content of your dialog in a &quot;&lt;div id='myDlgContent'&gt;&quot; div element, and to call &quot;dojo.destroy('myDlgContent')&quot; before displaying your dialog.<br /> <br /> === Scoring dialogs ===<br /> <br /> Sometimes at the end of a round you want to display a big table that details the points wins in each section of the game.<br /> <br /> Example: in Hearts game, we display at the end of each round the number of &quot;heart&quot; cards collected by each player, the player who collected the Queen of Spades, and the total number of points loose by each player.<br /> <br /> Scoring dialogs are managed entirely on '''PHP side''', but they are described here as their effects are visible only on client side.<br /> <br /> Displaying a scoring dialog is quite simple and is using a special notification type: &quot;tableWindow&quot;:<br /> &lt;pre&gt;<br /> // on PHP side:<br /> $this-&gt;notifyAllPlayers( &quot;tableWindow&quot;, '', array(<br /> &quot;id&quot; =&gt; 'finalScoring',<br /> &quot;title&quot; =&gt; clienttranslate(&quot;Title of the scoring dialog&quot;),<br /> &quot;table&quot; =&gt; $table<br /> ) ); <br /> &lt;/pre&gt;<br /> <br /> The &quot;table&quot; argument is a 2 dimensional PHP array that describe the table you want to display, line by line and column by column.<br /> <br /> Example: display an 3x3 array of strings<br /> &lt;pre&gt;<br /> $table = array(<br /> array( &quot;one&quot;, &quot;two&quot;, &quot;three&quot; ), // This is my first line<br /> array( &quot;four&quot;, &quot;five&quot;, &quot;six&quot; ), // This is my second line<br /> array( &quot;seven&quot;, &quot;height&quot;, &quot;nine&quot; ) // This is my third line<br /> );<br /> &lt;/pre&gt;<br /> <br /> As you can see above, in each &quot;cell&quot; of your array you can display a simple string value. But you can also display a complex value with a template and associated arguments like this:<br /> &lt;pre&gt;<br /> $table = array(<br /> array( &quot;one&quot;, &quot;two&quot;, array( &quot;str&quot; =&gt; &quot;a string with an ${argument}&quot;, &quot;args&quot; =&gt; array( 'argument' =&gt; 'argument_value' ) ) ),<br /> array( &quot;four&quot;, &quot;five&quot;, &quot;six&quot; ), <br /> array( &quot;seven&quot;, &quot;height&quot;, &quot;nine&quot; )<br /> );<br /> &lt;/pre&gt;<br /> <br /> This is especially useful when you want to display player names with colors. Example from &quot;Hearts&quot;:<br /> &lt;pre&gt;<br /> $firstRow = array( '' );<br /> foreach( $players as $player_id =&gt; $player )<br /> {<br /> $firstRow[] = array( 'str' =&gt; '${player_name}',<br /> 'args' =&gt; array( 'player_name' =&gt; $player['player_name'] ),<br /> 'type' =&gt; 'header'<br /> );<br /> }<br /> $table[] = $firstRow;<br /> &lt;/pre&gt;<br /> <br /> == Update players score ==<br /> <br /> Increase a player score (with a positive or negative number):<br /> <br /> &lt;pre&gt;<br /> this.scoreCtrl[ player_id ].incValue( score_delta );<br /> &lt;/pre&gt;<br /> <br /> Set a player score to a specific value:<br /> <br /> &lt;pre&gt;<br /> this.scoreCtrl[ player_id ].setValue( new_score );<br /> &lt;/pre&gt;<br /> <br /> == Players panels ==<br /> <br /> === Adding stuff to player's panel ===<br /> <br /> At first, create a new &quot;JS template&quot; string in your template (tpl) file:<br /> <br /> (from Reversi example)<br /> &lt;pre&gt;<br /> var jstpl_player_board = '\&lt;div class=&quot;cp_board&quot;&gt;\<br /> &lt;div id=&quot;stoneicon_p${id}&quot; class=&quot;gmk_stoneicon gmk_stoneicon_${color}&quot;&gt;&lt;/div&gt;&lt;span id=&quot;stonecount_p${id}&quot;&gt;0&lt;/span&gt;\<br /> &lt;/div&gt;';<br /> &lt;/pre&gt;<br /> <br /> Then, you add this piece of code in your JS file to add this template to each player panel:<br /> <br /> &lt;pre&gt;<br /> // Setting up player boards<br /> for( var player_id in gamedatas.players )<br /> {<br /> var player = gamedatas.players[player_id];<br /> <br /> // Setting up players boards if needed<br /> var player_board_div = $('player_board_'+player_id);<br /> dojo.place( this.format_block('jstpl_player_board', player ), player_board_div );<br /> }<br /> &lt;/pre&gt;<br /> <br /> (Note: the code above is of course from your &quot;setup&quot; function in your Javascript).<br /> <br /> Very often, you have to distinguish current player and others players. In this case, you just have to create another JS template (ex: jstpl_otherplayer_board) and use it when &quot;player_id&quot; is different than &quot;this.player_id&quot;.<br /> <br /> === Player's panel disabling/enabling ===<br /> <br /> '''this.disablePlayerPanel( player_id )'''<br /> <br /> Disable given player panel (the panel background become gray).<br /> <br /> Usually, this is used to signal that this played passes, or will be inactive during a while.<br /> <br /> Note that the only effect of this is visual. There are no consequences on the behaviour of the panel itself.<br /> <br /> '''this.enablePlayerPanel( player_id )'''<br /> <br /> Enable a player panel that has been disabled before.<br /> <br /> '''this.enableAllPlayerPanels()'''<br /> <br /> Enable all player panels that has been disabled before.<br /> <br /> == Image loading ==<br /> <br /> See also [[Game_art:_img_directory]].<br /> <br /> '''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.<br /> <br /> '''dontPreloadImage( image_file_name )'''<br /> <br /> Using dontPreloadImage, you tell the interface to not preload a specific image in your img directory.<br /> <br /> Example of use:<br /> &lt;pre&gt;<br /> this.dontPreloadImage( 'cards.png' );<br /> &lt;/pre&gt;<br /> <br /> This is particularly useful if for example you have 2 different themes for a game. To accelerate the loading of the game, you can specify to not preload images corresponding to the other theme.<br /> <br /> Another example of use: in &quot;Gosu&quot; game with Kamakor extension, you play with 5 sets of cards among 10 available. Cards images are organized by sets, and we only preload the images corresponding to the 5 current sets.<br /> <br /> == Other useful stuff ==<br /> <br /> <br /> '''dojo.hitch'''<br /> <br /> With dojo.hitch, you can create a callback function that will run with your game object context whatever happen.<br /> <br /> Typical example: display a BGA confirmation dialog with a callback function created with dojo.hitch:<br /> <br /> &lt;pre&gt;<br /> this.confirmationDialog( _('Are you sure you want to make this?'), dojo.hitch( this, function() {<br /> this.ajaxcall( '/mygame/mygame/makeThis.html', { lock:true }, this, function( result ) {} );<br /> } ) ); <br /> &lt;/pre&gt;<br /> <br /> In the example above, using dojo.hitch, we are sure that the &quot;this&quot; object will be set when the callback is called.<br /> <br /> <br /> ; updateCounters(counters)<br /> : Useful for updating game counters in the player panel (such as resources). <br /> : 'counters' arg is an associative array [counter_name_value =&gt; [ 'counter_name' =&gt; counter_name_value, 'counter_value' =&gt; counter_value_value], ... ]<br /> : All counters must be referenced in this.gamedatas.counters and will be updated.<br /> : DOM objects referenced by 'counter_name' will have their innerHTML updated with 'counter_value'.<br /> <br /> == BGA GUI components ==<br /> <br /> BGA framework provides some useful ready-to-use components for the game interface:<br /> <br /> [[Studio#BGA_Studio_game_components_reference]]<br /> <br /> Note that each time you are using an additional component, you must declare it at the top of your Javascript file in the list of modules used.<br /> <br /> Example if you are using &quot;ebg.stock&quot;:<br /> &lt;pre&gt;<br /> define([<br /> &quot;dojo&quot;,&quot;dojo/_base/declare&quot;,<br /> &quot;ebg/core/gamegui&quot;,<br /> &quot;ebg/counter&quot;,<br /> &quot;ebg/stock&quot; /// &lt;=== we are using ebg.stock module<br /> ],<br /> &lt;/pre&gt;</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Game_interface_logic:_yourgamename.js&diff=901 2013-06-30T13:34:16Z

<p>Een: /* Animations */</p> <hr /> <div><br /> This is the main file for your game interface. Here you will define:<br /> <br /> * which actions on the page will generate calls to the server<br /> * what happens when you get a notification for change from the server and how it will show in the browser. <br /> <br /> == File structure ==<br /> <br /> The details on how the file is structured is described directly with comments on the code skeleton provided to you.<br /> <br /> Basically, here's this structure:<br /> * constructor: here you can define variable global to your whole interface.<br /> * setup: this method is called when the page is refreshed, in order you can setup the game interface.<br /> * onEnteringState: the method is called when entering in a new game state. This way you can customize the view for this game state.<br /> * onLeavingState: the method is called when leaving a game state.<br /> * onUpdateActionButtons: called when entering in a new state, in order you can add action buttons in status bar.<br /> * (utility methods): at this place you can define your utility methods<br /> * (player's actions): at this place you can write your handlers for player's action on the interface (ex: click on an item).<br /> * setupNotifications: in this method you associate notifications with notification handlers. This way, for each game notification, you trigger a javascript method to handle it and update the game interface.<br /> * (notification handlers): at this place you can define your notifications handlers.<br /> <br /> == General tips ==<br /> <br /> ; this.player_id<br /> : Id of the player on whose browser the code is running.<br /> <br /> ; this.isSpectator<br /> : Flag set to true if the user at the table is a spectator (not a player).<br /> : Note: if you want to hide some element for spectators, you'd better use [[Game_interface_stylesheet:_yourgamename.css#spectatorMode|CSS 'spectatorMode' class]].<br /> <br /> ; this.gamedatas<br /> : Contains your initial set of datas to init the game, created at game start or game refresh (F5)<br /> : You can update it as needed to keep an up to date reference of the game on the client side if you need it (most of the time you don't).<br /> <br /> ; isCurrentPlayerActive()<br /> : Returns true if the player on whose browser the code is running is currently active (it's his turn to play)<br /> <br /> ; this.getActivePlayerId()<br /> : Return the ID of active player, or null if we are not in a &quot;activeplayer&quot; type state.<br /> <br /> ; this.getActivePlayers()<br /> : Return an array with the IDs of players that are currently active (or an empty array if there is not).<br /> <br /> == Dojo framework ==<br /> <br /> BGA is using the [http://dojotoolkit.org/ Dojo Javascript framework].<br /> <br /> The Dojo framework allows us to do complex things easier, and the BGA framework is using Dojo framework a lot.<br /> <br /> To realize game although, you only need to use a few part of the Dojo framework. All the Dojo methods you need to use are describe on this page.<br /> <br /> == Access and manipulate the DOM ==<br /> <br /> '''$('some_html_element_id')'''<br /> <br /> The $() function is used to get some HTML element using its &quot;id&quot; attribute.<br /> <br /> Example 1: modify the content of a &quot;span&quot; element:<br /> &lt;pre&gt;<br /> In your HTML code:<br /> &lt;span id=&quot;a_value_in_the_game_interface&quot;&gt;1234&lt;/span&gt;<br /> <br /> In your Javascript code:<br /> $('a_value_in_the_game_interface').innerHTML = &quot;9999&quot;;<br /> &lt;/pre&gt;<br /> <br /> Note: $() is the standard method to access some HTML element with BGA Framework. You must not use &quot;getElementById&quot; function.<br /> <br /> <br /> '''dojo.style'''<br /> <br /> With dojo.style you can modify a CSS property of any HTML element of your interface.<br /> <br /> Examples:<br /> &lt;pre&gt;<br /> // Make an element disappear<br /> dojo.style( 'my_element', 'display', 'none' );<br /> <br /> // Give an element a 2px border<br /> dojo.style( 'my_element', 'borderWidth', '2px' );<br /> <br /> // Change the background position of an element<br /> // (very practical when you are using CSS sprite to transform an element to another)<br /> dojo.style( 'my_element', 'backgroundPosition', '-20px -50px' );<br /> &lt;/pre&gt;<br /> <br /> Note: you must always use dojo.style to modify CSS properties of HTML elements.<br /> <br /> Note²: if you have to modify several CSS properties of an element, or if you have some complex CSS transformation to do, you should consider using dojo.addClass/dojo.removeClass (see below).<br /> <br /> '''dojo CSS classes manipulation'''<br /> <br /> In many situation, a bunch of many small CSS property update can be replaced by a CSS class change (ie: you add a CSS class to your element instead of applying all modification manually).<br /> <br /> Advantages are:<br /> * All your CSS stuff remains in your CSS file.<br /> * You can add/remove a list of CSS modifications with a simple function and whithout error.<br /> * You can test if you applied the stuff to an element with &quot;dojo.hasClass&quot; method.<br /> <br /> Example from &quot;Reversi&quot;:<br /> &lt;pre&gt;<br /> // We add &quot;possibleMove&quot; to an element<br /> dojo.addClass( 'square_'+x+'_'+y, 'possibleMove' );<br /> <br /> // In our CSS file, the class is defined as:<br /> .possibleMove {<br /> background-color: white;<br /> opacity: 0.2;<br /> filter:alpha(opacity=20); /* For IE8 and earlier */ <br /> cursor: pointer; <br /> }<br /> <br /> // So we've applied 4 CSS property change in one line of code.<br /> <br /> // ... and when we need to check if a square is a possible move on client side:<br /> if( dojo.hasClass( 'square_'+x+'_'+y, 'possibleMove' ) )<br /> { ... }<br /> <br /> // ... and if we want to remove all possible moves in one line of code (see &quot;dojo.query&quot; method):<br /> dojo.query( '.possibleMove' ).removeClass( 'possibleMove' );<br /> &lt;/pre&gt;<br /> <br /> Conclusion: we encourage you to use dojo.addClass, dojo.removeClass and dojo.hasClass to make your life easier :)<br /> <br /> '''dojo.query'''<br /> <br /> With dojo.query, you can query a bunch of HTML elements with a single function, with a &quot;CSS selector&quot; style.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> // All elements with class &quot;possibleMove&quot;:<br /> var elements = dojo.query( '.possibleMove' );<br /> <br /> // Count number of tokens (ie: elements with class &quot;token&quot;) on the board (ie: element with id &quot;board&quot;):<br /> dojo.query( '#board .token' ).length;<br /> &lt;/pre&gt;<br /> <br /> But what is really cool with dojo.query is that you can combine it with almost all methods above.<br /> <br /> Examples:<br /> &lt;pre&gt;<br /> // Trigger a method when the mouse enter in any element with class &quot;meeple&quot;:<br /> dojo.query( '.meeple' ).connect( 'onmouseenter', this, 'myMethodToTrigger' );<br /> <br /> // Hide all meeples who are on the board<br /> dojo.query( '#board .meeple' ).style( 'display', 'none' );<br /> &lt;/pre&gt;<br /> <br /> '''dojo.place'''<br /> <br /> dojo.place is the best function to insert some HTML code somewhere in your game interface without breaking something. It is much better to use that &quot;innerHTML=''&quot; method as soon as you must insert HTML tags and not only values.<br /> <br /> &lt;pre&gt;<br /> // Insert your HTML code as a child of a container element<br /> dojo.place( &quot;&lt;your html code&gt;&quot;, &quot;your_container_element_id&quot; );<br /> <br /> // Replace the container element with your new html<br /> dojo.place( &quot;&lt;your html code&gt;&quot;, &quot;your_container_element_id&quot;, &quot;replace&quot; );<br /> <br /> &lt;/pre&gt;<br /> <br /> Note: the third parameter of dojo.place can take various interesting value: &quot;first&quot;, &quot;after&quot;, ... [http://dojotoolkit.org/reference-guide/1.7/dojo/place.html See full doc on dojo.place].<br /> <br /> Usually, when you want to insert some piece of HTML in your game interface, you should use &quot;[[Game_layout:_view_and_template:_yourgamename.view.php_and_yourgamename_yourgamename.tpl#Javascript_templates|Javascript templates]]&quot;.<br /> <br /> '''addStyleToClass: function( cssClassName, cssProperty, propertyValue )'''<br /> <br /> Same as dojo.style(), but for all the nodes set with the specified cssClassName<br /> <br /> === Animations ===<br /> <br /> '''Dojo Animations'''<br /> <br /> BGA animations is based on Dojo Animation ([http://dojotoolkit.org/documentation/tutorials/1.8/animation/ see tutorial here]).<br /> <br /> However, most of the time, you can just use methods below, which are built on top of Dojo Animation.<br /> <br /> Note: one interesting method from Dojo that could be useful from time to time is &quot;Dojo.Animation&quot;. It allows you to make any CSS property &quot;slide&quot; from one value to another.<br /> <br /> '''this.slideToObject( mobile_obj, target_obj, duration, delay )'''<br /> <br /> You can use slideToObject to &quot;slide&quot; an element to a target position.<br /> <br /> Sliding element on the game area is the recommended and the most used way to animate your game interface. Using slides allow players to figure out what is happening on the game, as if they were playing with the real boardgame.<br /> <br /> The parameters are:<br /> * mobile_obj: the ID of the object to move. This object must be &quot;relative&quot; or &quot;absolute&quot; positioned.<br /> * target_obj: the ID of the target object. This object must be &quot;relative&quot; or &quot;absolute&quot; positioned. Note that it is not mandatory that mobile_obj and target_obj have the same size. If their size are different, the system slides the center of mobile_obj to the center of target_obj.<br /> * duration: (optional) defines the duration in millisecond of the slide. The default is 500 milliseconds.<br /> * delay: (optional). If you defines a delay, the slide will start only after this delay. This is particularly useful when you want to slide several object from the same position to the same position: you can give a 0ms delay to the first object, a 100ms delay to the second one, a 200ms delay to the third one, ... this way they won't be superposed during the slide.<br /> <br /> BE CAREFUL: The method returns an dojo.fx animation, so you can combine it with other animation if you want to. It means that you have to call the &quot;play()&quot; method, otherwise the animation WON'T START.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.slideToObject( &quot;some_token&quot;, &quot;some_place_on_board&quot; ).play();<br /> &lt;/pre&gt;<br /> <br /> <br /> '''this.slideToObjectPos( mobile_obj, target_obj, target_x, target_y, duration, delay )'''<br /> <br /> This method does exactly the same than &quot;slideToObjectPos&quot;, except than you can specify some (x,y) coordinates. This way, &quot;mobile_obj&quot; will slide to the specified x,y position relatively to &quot;target_obj&quot;.<br /> <br /> Example: slide a token to some place on the board, 10 pixels to the bottom:<br /> &lt;pre&gt;<br /> this.slideToObjectPos( &quot;some_token&quot;, &quot;some_place_on_board&quot;, 0, 10 ).play();<br /> &lt;/pre&gt;<br /> <br /> '''this.slideTemporaryObject( mobile_obj_html, mobile_obj_parent, from, to, duration, delay )'''<br /> <br /> This method is useful when you want to slide a temporary HTML object from one place to another. As this object does not exists before the animation and won't remain after, it could be complex to create this object (with dojo.place), to place it at its origin (with placeOnObject) to slide it (with slideToObject) and to make it disappear at the end.<br /> <br /> slideTemporaryObject does all of this for you:<br /> * mobile_obj_html is a piece of HTML code that represent the object to slide.<br /> * mobile_obj_parent is the ID of an HTML element of your interface that will be the parent of this temporary HTML object.<br /> * from is the ID of the origin of the slide.<br /> * to is the ID of the target of the slide.<br /> * duration/delay works exactly like in &quot;slideToObject&quot;<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.slideTemporaryObject( '&lt;div class=&quot;token_icon&quot;&gt;&lt;/div&gt;', 'tokens', 'my_origin_div', 'my_target_div' );<br /> &lt;/pre&gt;<br /> <br /> '''this.slideToObjectAndDestroy: function( node, to, time, delay )'''<br /> <br /> This method is a handy shortcut to slide an existing HTML object to some place then destroy it upon arrival. It can be used for example to move a victory token or a card from the board to the player panel to show that the player earns it, then destroy it when we don't need to keep it visible on the player panel.<br /> <br /> It works the same as this.slideToObject and takes the same arguments. <br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.slideToObjectAndDestroy( &quot;some_token&quot;, &quot;some_place_on_board&quot; ).play();<br /> &lt;/pre&gt;<br /> <br /> '''this.fadeOutAndDestroy( node )'''<br /> <br /> This function fade out the target HTML node, then destroy it.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.fadeOutAndDestroy( &quot;a_card_that_must_disappear&quot; );<br /> &lt;/pre&gt;<br /> <br /> CAREFUL: the HTML node still exists until during few milliseconds, until the fadeOut has been completed.<br /> <br /> '''Rotating elements'''<br /> <br /> You can check here [http://jimfulton.info/demos/dojo-animated-rotate.html an example of use] of Dojo to make an element rotate.<br /> <br /> This example combines &quot;Dojo.Animation&quot; method and a CSS3 property that allow you to rotate the element.<br /> <br /> IMPORTANT: to asses browser compatibility, you must select the CSS property to use just like in the example (see sourcecode below):<br /> <br /> &lt;pre&gt;<br /> var transform;<br /> dojo.forEach(<br /> ['transform', 'WebkitTransform', 'msTransform',<br /> 'MozTransform', 'OTransform'],<br /> function (name) {<br /> if (typeof dojo.body().style[name] != 'undefined') {<br /> transform = name;<br /> }<br /> });<br /> // ... and then use &quot;transform&quot; as the name of your CSS property for rotation<br /> &lt;/pre&gt;<br /> <br /> === Moving elements ===<br /> <br /> '''this.placeOnObject( mobile_obj, target_obj )'''<br /> <br /> placeOnObject works exactly like &quot;slideToObject&quot;, except that the effect is immediate.<br /> <br /> This is not really an animation, but placeOnObject is frequently used before starting an animation.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> // (We just created an object &quot;my_new_token&quot;)<br /> <br /> // Place the new token on current player board<br /> this.placeOnObject( &quot;my_new_token&quot;, &quot;overall_player_board_&quot;+this.player_id );<br /> <br /> // Then slide it to its position on the board<br /> this.slideToObject( &quot;my_new_token&quot;, &quot;a_place_on_board&quot; ).play();<br /> &lt;/pre&gt;<br /> <br /> '''this.placeOnObjectPos( mobile_obj, target_obj, target_x, target_y )'''<br /> <br /> This method works exactly like placeOnObject, except than you can specify some (x,y) coordinates. This way, &quot;mobile_obj&quot; will be placed to the specified x,y position relatively to &quot;target_obj&quot;.<br /> <br /> '''this.attachToNewParent( mobile_obj, target_obj )'''<br /> <br /> With this method, you change the HTML parent of &quot;mobile_obj&quot; element. &quot;target_obj&quot; is the new parent of this element. The beauty of <br /> attachToNewParent is that the mobile_obj element DOES NOT MOVE during this process.<br /> <br /> Note: what happens is that the method calculate a relative position of mobile_obj to make sure it does not move after the HTML parent changes.<br /> <br /> Why using this method?<br /> <br /> Changing the HTML parent of an element can be useful for the following reasons:<br /> * When the HTML parent moves, all its child are moving with them. If some game elements is no more linked with a parent HTML object, you may want to attach it to another place.<br /> * The z_order (vertical order of display) depends on the position in the DOM, so you may need to change the parent of some game elements when they are moving in your game area.<br /> <br /> CAREFUL: when you attach an HTML element with a new parent, you break all references to this HTML element (ex: dojo.connect).<br /> <br /> == Players input ==<br /> <br /> '''dojo.connect'''<br /> <br /> Used to associate a player event with one of your notification method.<br /> <br /> Example: associate a click on an element (&quot;my_element&quot;) with one of our method (&quot;onClickOnMyElement&quot;):<br /> &lt;pre&gt;<br /> dojo.connect( $('my_element'), 'onClick', this, 'onClickOnMyElement' );<br /> &lt;/pre&gt;<br /> <br /> Note: this is the only possible correct way to associate a player input event to your code, and you must not use anything else.<br /> <br /> '''this.checkAction( &quot;my_action_name&quot; )'''<br /> <br /> Usage: checkAction: function( action, nomessage )<br /> <br /> Check if player can do the specified action by taking into account:<br /> * current game state<br /> * interface locking (a player can't do any action if an action is already in progress)<br /> <br /> return true if action is authorized (ie: the action is listed as a &quot;possibleaction&quot; in current game state).<br /> <br /> return false and display an error message if not (display no message if nomessage parameter is true). The displayed error message could be either &quot;This move is not allowed at this moment&quot; or &quot;An action is already in progress&quot;.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> function onClickOnGameElement( evt )<br /> {<br /> if( this.checkAction( &quot;my_action&quot; ) )<br /> {<br /> // Do the action<br /> }<br /> }<br /> &lt;/pre&gt;<br /> <br /> '''this.ajaxcall( url, parameters, obj_callback, callback, callback_error )'''<br /> <br /> This method must be used to send a player input to the game server.<br /> <br /> * url: the url of the action to perform. For a game, it must be: &quot;/&lt;mygame&gt;/&lt;mygame&gt;/myAction.html&quot;<br /> * parameters: an array of parameter to send to the game server. Note that &quot;lock:true&quot; must always be specified in this list of parameter in order the interface can be locked during the server call.<br /> * obj_callback: must be set to &quot;this&quot;.<br /> * callback: a function to trigger when the server returns and everything went fine.<br /> * callback_error: (optional and rarely used) a function to trigger when the server returns an error.<br /> <br /> Usage:<br /> &lt;pre&gt;<br /> this.ajaxcall( '/mygame/mygame/myaction.html', { lock: true, <br /> arg1: myarg1, <br /> arg2: myarg2, <br /> ...<br /> }, this, function( result ) {<br /> // Do some stuff after a successful call<br /> } );<br /> &lt;/pre&gt;<br /> <br /> Restricted arguments names (please don't use them):<br /> * &quot;action&quot;<br /> * &quot;module&quot;<br /> * &quot;class&quot;<br /> <br /> '''this.confirmationDialog()'''<br /> <br /> Display a confirmation dialog with a yes/no choice.<br /> <br /> We advice you to NOT use this function unless the player action is really critical and could ruins the game, because it slows down the game and upset players.<br /> <br /> Usage: this.confirmationDialog( &quot;Question to displayed&quot;, callback_function_if_click_on_yes );<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.confirmationDialog( _('Are you sure to use this bonus (points penalty at the end of the game) ?'),<br /> dojo.hitch( this, function() {<br /> this.ajaxcall( '/seasons/seasons/useBonus.html',<br /> { id:bonus_id, lock:true }, this, function( result ) {} );<br /> } ) ); <br /> &lt;/pre&gt;<br /> <br /> <br /> ; addEventToClass: function( cssClassName, eventName, functionName )<br /> : Same as dojo.connect(), but for all the nodes set with the specified cssClassName<br /> <br /> '''this.addActionButton( id, label, method, (opt)depreciated, (opt)bHighlight )'''<br /> <br /> You can use this method to add an action button in the main action status bar.<br /> <br /> Arguments:<br /> * id: a ID that should be unique in your HTML DOM document.<br /> * label: the text of the button. Should be translatable (use _() function).<br /> * method: the name of your method that must be triggered when the player clicks on this button.<br /> * depreciated (optional): do not use this. Please not specify this argument or use &quot;null&quot;.<br /> * bHighlight: if set to &quot;true&quot;, the button is going blink to catch player's attention. Please don't abuse of blinking button.<br /> <br /> You should only use this method in your &quot;onUpdateActionButtons&quot; method. Usually, you use it like this (from Hears example):<br /> <br /> &lt;pre&gt;<br /> onUpdateActionButtons: function( stateName, args )<br /> {<br /> console.log( 'onUpdateActionButtons: '+stateName );<br /> <br /> if( this.isCurrentPlayerActive() )<br /> { <br /> switch( stateName )<br /> {<br /> case 'giveCards':<br /> this.addActionButton( 'giveCards_button', _('Give selected cards'), 'onGiveCards' ); <br /> break;<br /> <br /> }<br /> }<br /> }, <br /> &lt;/pre&gt;<br /> <br /> In the example above, we are adding a &quot;Give selected cards&quot; button in the case we are on game state &quot;giveCards&quot;. When player clicks on this button, it triggers our &quot;onGiveCards&quot; method.<br /> <br /> == Translations ==<br /> <br /> See [[Translations]]<br /> <br /> == Notifications ==<br /> <br /> When something happens on the server side, your game interface Javascript logic received a notification.<br /> <br /> Here's how you can handle these notifications on the client side.<br /> <br /> === Subscribe to notifications ===<br /> <br /> Your Javascript &quot;setupNotifications&quot; method is the place where you can subscribe to notifications from your PHP code.<br /> <br /> Here's how you associate one of your Javascript method to a notification &quot;playDisc&quot; (from Reversi example):<br /> <br /> &lt;pre&gt;<br /> // In setupNotifications method:<br /> dojo.subscribe( 'playDisc', this, &quot;notif_playDisc&quot; );<br /> &lt;/pre&gt;<br /> <br /> Note: the &quot;playDisc&quot; corresponds to the name of the notification you define it in your PHP code, in your &quot;notifyAllPlayers&quot; or &quot;notifyPlayer&quot; method.<br /> <br /> Then, you have to define your &quot;notif_playDisc&quot; method:<br /> <br /> &lt;pre&gt;<br /> notif_playDisc: function( notif )<br /> {<br /> // Remove current possible moves (makes the board more clear)<br /> dojo.query( '.possibleMove' ).removeClass( 'possibleMove' ); <br /> <br /> this.addDiscOnBoard( notif.args.x, notif.args.y, notif.args.player_id );<br /> },<br /> &lt;/pre&gt;<br /> <br /> In a notification handler like our &quot;notif_playDisc&quot; method, you can access to all notifications arguments with &quot;notif.args&quot;.<br /> <br /> Example:<br /> &lt;pre&gt;<br /> // If you did this on PHP side:<br /> self::notifyAllPlayers( &quot;myNotification&quot;, '', array( &quot;myArgument&quot; =&gt; 3 ) );<br /> <br /> // On Javascript side, you can access the &quot;myArgument&quot; like this:<br /> notif_myNotification: function( notif )<br /> {<br /> alert( &quot;myArgument = &quot; + notif.args.myArgument );<br /> }<br /> &lt;/pre&gt;<br /> <br /> === Synchronous notifications ===<br /> <br /> When several notifications are received by your game interface, these notifications are processed immediately, one after the other, in the same exact order they have been generated in your PHP game logic.<br /> <br /> However, sometimes, you need to give some time to the players to figure out what happened on the game before jumping to the next notification. Indeed, in many games, they are a lot of automatic actions, and the computer is going to resolve all these actions very fast if you don't tell it not to do so.<br /> <br /> As an example, for Reversi, when someone is playing a disc, we want to wait 500 milliseconds before doing anything else in order the opponent player can figure out what move has been played.<br /> <br /> Here's how we do this, right after our subscription:<br /> &lt;pre&gt;<br /> dojo.subscribe( 'playDisc', this, &quot;notif_playDisc&quot; );<br /> this.notifqueue.setSynchronous( 'playDisc', 500 ); // Wait 500 milliseconds after executing the playDisc handler<br /> &lt;/pre&gt;<br /> <br /> == Tooltips ==<br /> <br /> '''this.addTooltip( nodeId, _( helpString ), _( actionString ), delay )'''<br /> <br /> Add a simple text tooltip to the DOM node.<br /> <br /> Specify 'helpString' to display some information about &quot;what is this game element?&quot;.<br /> Specify 'actionString' to display some information about &quot;what happens when I click on this element?&quot;.<br /> <br /> You must specify both helpString and actionString. Most of the time, you use only one and specify a void string (&quot;&quot;) for the other one.<br /> <br /> Usually, _() must be used for the text to be marked for translation.<br /> <br /> &quot;Delay&quot; is an optional parameter. Usually, it is primarily used to specify a zero delay for some game element when the tooltip gives really important information for the game - but remember: no essential information must be placed in tooltips as they won't be displayed in some browser (see Guidelines).<br /> <br /> Example:<br /> &lt;pre&gt;<br /> this.addTooltip( 'cardcount', _('Number of cards in hand'), '' );<br /> &lt;/pre&gt;<br /> <br /> '''this.addTooltipHtml( nodeId, html, delay )'''<br /> <br /> Add an HTML tooltip to the DOM node (for more elaborate content such as presenting a bigger version of a card).<br /> <br /> '''this.addTooltipToClass( cssClass, _( helpString ), _( actionString ), delay )'''<br /> <br /> Add a simple text tooltip to all the DOM nodes set with this cssClass. <br /> <br /> IMPORTANT: all concerned nodes must have IDs to get tooltips.<br /> <br /> '''addTooltipHtmlToClass( cssClass, html, delay )'''<br /> <br /> Add an HTML tooltip to to all the DOM nodes set with this cssClass (for more elaborate content such as presenting a bigger version of a card).<br /> <br /> IMPORTANT: all concerned nodes must have IDs to get tooltips<br /> <br /> == Dialogs, warning messages, confirmation dialogs, ... ==<br /> <br /> === Warning messages ===<br /> <br /> Sometimes, there is something important that is happening on the game and you have to make sure all players get the message. Most of the time, the evolution of the game situation or the game log is enough, but sometimes you need something more visible.<br /> <br /> Ex: someone fulfill one of the end of the game condition, so this is the last turn.<br /> <br /> '''this.showMessage( msg, type )'''<br /> <br /> showMessage shows a message in a big rectangular area on the top of the screen of current player.<br /> <br /> * &quot;msg&quot; is the string to display. It should be translated.<br /> * &quot;type&quot; can be set to &quot;info&quot; or &quot;error&quot;. If set to &quot;info&quot;, the message will be an informative message on a white background. If set to &quot;error&quot;, the message will be an error message on a red background.<br /> <br /> Important: the normal way to inform players about the progression of the game is the game log. &quot;showMessage&quot; is intrusive and should not be used often.<br /> <br /> === Confirmation dialog ===<br /> <br /> When an important action with a lot of consequences is triggered by the player, you may want to propose a confirmation dialog.<br /> <br /> CAREFUL: the general guidelines of BGA is to AVOID the use of confirmation dialog. Confirmation dialogs slow down the game and bother players. The players knows that they have to pay attention about each move when they are playing online.<br /> <br /> The situation where you should use a confirmation dialog are the following:<br /> * It must not happen very often during a game.<br /> * It must be linked to an action that can really &quot;kill a game&quot; if the player do not pay attention.<br /> * It must be something that can be done by mistake (ex: a link on the action status bar).<br /> <br /> How to display a confirmation dialog:<br /> &lt;pre&gt;<br /> this.confirmationDialog( _('Are you sure you want to make this?'), dojo.hitch( this, function() {<br /> this.ajaxcall( '/mygame/mygame/makeThis.html', { lock:true }, this, function( result ) {} );<br /> } ) ); <br /> &lt;/pre&gt;<br /> <br /> === Dialogs ===<br /> <br /> At first, you shouldn't use dialogs windows.<br /> <br /> BGA guidelines specify that all game elements should be displayed on the main screen. Players can eventually scroll down to see game elements they don't need to see anytime, and you may eventually create anchors to move between game area section. Of course dialogs windows are very practical, but the thing is: all players know how to scroll down, and not all players know how to show up your dialog window. In addition, when the dialog shows up, players can't access the other game components.<br /> <br /> Sometimes although, you need to display a dialog window. Here is how you do this:<br /> <br /> &lt;pre&gt;<br /> <br /> // Create the new dialog. You should store the handler in a member variable to access it later<br /> this.myDlg = new dijit.Dialog({ title: _(&quot;my dialog title to translate&quot;) });<br /> <br /> // Create the HTML of my dialog. The best practice here is to use [[Game_layout:_view_and_template:_yourgamename.view.php_and_yourgamename_yourgamename.tpl#Javascript_templates|Javascript templates]]:<br /> var html = this.format_block( 'jstpl_myDialogTemplate', { <br /> arg1: myArg1,<br /> arg2: myArg2,<br /> ...<br /> } ); <br /> <br /> // Show the dialog<br /> this.myDlg.attr(&quot;content&quot;, html );<br /> this.myDlg.show(); <br /> <br /> // Now that the dialog has been displayed, you can connect your method to some dialog elements<br /> // Example, a &quot;close&quot; button:<br /> dojo.connect( $('closeDlg'), 'onclick', this, function(evt){<br /> evt.preventDefault();<br /> this.myDlg.hide();<br /> } ); <br /> <br /> &lt;/pre&gt;<br /> <br /> Tip: be careful with &quot;hide()&quot; method to close your dialog: the dialog and its content is not completely removed from the DOM. It can cause you problems if you try to display the same dialog several times. A good practice is to wrap all the content of your dialog in a &quot;&lt;div id='myDlgContent'&gt;&quot; div element, and to call &quot;dojo.destroy('myDlgContent')&quot; before displaying your dialog.<br /> <br /> === Scoring dialogs ===<br /> <br /> Sometimes at the end of a round you want to display a big table that details the points wins in each section of the game.<br /> <br /> Example: in Hearts game, we display at the end of each round the number of &quot;heart&quot; cards collected by each player, the player who collected the Queen of Spades, and the total number of points loose by each player.<br /> <br /> Scoring dialogs are managed entirely on '''PHP side''', but they are described here as their effects are visible only on client side.<br /> <br /> Displaying a scoring dialog is quite simple and is using a special notification type: &quot;tableWindow&quot;:<br /> &lt;pre&gt;<br /> // on PHP side:<br /> $this-&gt;notifyAllPlayers( &quot;tableWindow&quot;, '', array(<br /> &quot;id&quot; =&gt; 'finalScoring',<br /> &quot;title&quot; =&gt; clienttranslate(&quot;Title of the scoring dialog&quot;),<br /> &quot;table&quot; =&gt; $table<br /> ) ); <br /> &lt;/pre&gt;<br /> <br /> The &quot;table&quot; argument is a 2 dimensional PHP array that describe the table you want to display, line by line and column by column.<br /> <br /> Example: display an 3x3 array of strings<br /> &lt;pre&gt;<br /> $table = array(<br /> array( &quot;one&quot;, &quot;two&quot;, &quot;three&quot; ), // This is my first line<br /> array( &quot;four&quot;, &quot;five&quot;, &quot;six&quot; ), // This is my second line<br /> array( &quot;seven&quot;, &quot;height&quot;, &quot;nine&quot; ) // This is my third line<br /> );<br /> &lt;/pre&gt;<br /> <br /> As you can see above, in each &quot;cell&quot; of your array you can display a simple string value. But you can also display a complex value with a template and associated arguments like this:<br /> &lt;pre&gt;<br /> $table = array(<br /> array( &quot;one&quot;, &quot;two&quot;, array( &quot;str&quot; =&gt; &quot;a string with an ${argument}&quot;, &quot;args&quot; =&gt; array( 'argument' =&gt; 'argument_value' ) ) ),<br /> array( &quot;four&quot;, &quot;five&quot;, &quot;six&quot; ), <br /> array( &quot;seven&quot;, &quot;height&quot;, &quot;nine&quot; )<br /> );<br /> &lt;/pre&gt;<br /> <br /> This is especially useful when you want to display player names with colors. Example from &quot;Hearts&quot;:<br /> &lt;pre&gt;<br /> $firstRow = array( '' );<br /> foreach( $players as $player_id =&gt; $player )<br /> {<br /> $firstRow[] = array( 'str' =&gt; '${player_name}',<br /> 'args' =&gt; array( 'player_name' =&gt; $player['player_name'] ),<br /> 'type' =&gt; 'header'<br /> );<br /> }<br /> $table[] = $firstRow;<br /> &lt;/pre&gt;<br /> <br /> == Update players score ==<br /> <br /> Increase a player score (with a positive or negative number):<br /> <br /> &lt;pre&gt;<br /> this.scoreCtrl[ player_id ].incValue( score_delta );<br /> &lt;/pre&gt;<br /> <br /> Set a player score to a specific value:<br /> <br /> &lt;pre&gt;<br /> this.scoreCtrl[ player_id ].setValue( new_score );<br /> &lt;/pre&gt;<br /> <br /> == Players panels ==<br /> <br /> === Adding stuff to player's panel ===<br /> <br /> At first, create a new &quot;JS template&quot; string in your template (tpl) file:<br /> <br /> (from Reversi example)<br /> &lt;pre&gt;<br /> var jstpl_player_board = '\&lt;div class=&quot;cp_board&quot;&gt;\<br /> &lt;div id=&quot;stoneicon_p${id}&quot; class=&quot;gmk_stoneicon gmk_stoneicon_${color}&quot;&gt;&lt;/div&gt;&lt;span id=&quot;stonecount_p${id}&quot;&gt;0&lt;/span&gt;\<br /> &lt;/div&gt;';<br /> &lt;/pre&gt;<br /> <br /> Then, you add this piece of code in your JS file to add this template to each player panel:<br /> <br /> &lt;pre&gt;<br /> // Setting up player boards<br /> for( var player_id in gamedatas.players )<br /> {<br /> var player = gamedatas.players[player_id];<br /> <br /> // Setting up players boards if needed<br /> var player_board_div = $('player_board_'+player_id);<br /> dojo.place( this.format_block('jstpl_player_board', player ), player_board_div );<br /> }<br /> &lt;/pre&gt;<br /> <br /> (Note: the code above is of course from your &quot;setup&quot; function in your Javascript).<br /> <br /> Very often, you have to distinguish current player and others players. In this case, you just have to create another JS template (ex: jstpl_otherplayer_board) and use it when &quot;player_id&quot; is different than &quot;this.player_id&quot;.<br /> <br /> === Player's panel disabling/enabling ===<br /> <br /> '''this.disablePlayerPanel( player_id )'''<br /> <br /> Disable given player panel (the panel background become gray).<br /> <br /> Usually, this is used to signal that this played passes, or will be inactive during a while.<br /> <br /> Note that the only effect of this is visual. There are no consequences on the behaviour of the panel itself.<br /> <br /> '''this.enablePlayerPanel( player_id )'''<br /> <br /> Enable a player panel that has been disabled before.<br /> <br /> '''this.enableAllPlayerPanels()'''<br /> <br /> Enable all player panels that has been disabled before.<br /> <br /> == Image loading ==<br /> <br /> See also [[Game_art:_img_directory]].<br /> <br /> '''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.<br /> <br /> '''dontPreloadImage( image_file_name )'''<br /> <br /> Using dontPreloadImage, you tell the interface to not preload a specific image in your img directory.<br /> <br /> Example of use:<br /> &lt;pre&gt;<br /> this.dontPreloadImage( 'cards.png' );<br /> &lt;/pre&gt;<br /> <br /> This is particularly useful if for example you have 2 different themes for a game. To accelerate the loading of the game, you can specify to not preload images corresponding to the other theme.<br /> <br /> Another example of use: in &quot;Gosu&quot; game with Kamakor extension, you play with 5 sets of cards among 10 available. Cards images are organized by sets, and we only preload the images corresponding to the 5 current sets.<br /> <br /> == Other useful stuff ==<br /> <br /> <br /> '''dojo.hitch'''<br /> <br /> With dojo.hitch, you can create a callback function that will run with your game object context whatever happen.<br /> <br /> Typical example: display a BGA confirmation dialog with a callback function created with dojo.hitch:<br /> <br /> &lt;pre&gt;<br /> this.confirmationDialog( _('Are you sure you want to make this?'), dojo.hitch( this, function() {<br /> this.ajaxcall( '/mygame/mygame/makeThis.html', { lock:true }, this, function( result ) {} );<br /> } ) ); <br /> &lt;/pre&gt;<br /> <br /> In the example above, using dojo.hitch, we are sure that the &quot;this&quot; object will be set when the callback is called.<br /> <br /> <br /> ; updateCounters(counters)<br /> : Useful for updating game counters in the player panel (such as resources). <br /> : 'counters' arg is an associative array [counter_name_value =&gt; [ 'counter_name' =&gt; counter_name_value, 'counter_value' =&gt; counter_value_value], ... ]<br /> : All counters must be referenced in this.gamedatas.counters and will be updated.<br /> : DOM objects referenced by 'counter_name' will have their innerHTML updated with 'counter_value'.<br /> <br /> == BGA GUI components ==<br /> <br /> BGA framework provides some useful ready-to-use components for the game interface:<br /> <br /> [[Studio#BGA_Studio_game_components_reference]]<br /> <br /> Note that each time you are using an additional component, you must declare it at the top of your Javascript file in the list of modules used.<br /> <br /> Example if you are using &quot;ebg.stock&quot;:<br /> &lt;pre&gt;<br /> define([<br /> &quot;dojo&quot;,&quot;dojo/_base/declare&quot;,<br /> &quot;ebg/core/gamegui&quot;,<br /> &quot;ebg/counter&quot;,<br /> &quot;ebg/stock&quot; /// &lt;=== we are using ebg.stock module<br /> ],<br /> &lt;/pre&gt;</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelpelfenland&diff=888 2013-06-16T13:00:56Z

<p>Een: /* Goal of the game */</p> <hr /> <div>== Goal of the game ==<br /> <br /> Visiting as many cities as possible in Elfenland over 4 rounds.<br /> <br /> At the end of the 4th round, the player who collected the most Town Pieces wins.<br /> <br /> We advise you to play with at least 3 players to best enjoy the game (4 or 5 is even better). A lot of the fun comes from using the Transportation Counters set by other players to optimise one's travels, so the more the merrier!<br /> <br /> == Round overview ==<br /> <br /> A round is split into phases:<br /> <br /> # Each player fills his hand up to 8 cards and gets a secret Transportation Counter.<br /> # One after another, each player chooses a Transportation Counter from the 5 visible or drawn from the facedown stack, until each player took 3.<br /> # One after another, each player chooses must plan a travel road by laying a Transportation Counter matching the terrain of the chosen road. This phase goes on until each player has passed consecutively. Each player also owns an Obstacle that he can lay down on a Transportation Counter to up the cost of traveling on this road from 1 card.<br /> # One after another, each player is going to travel from town to town. The current position of a player is shown by the Elf Boot of his color, initially set on the biggest town, Elvenhold.<br /> <br /> At the end of the round, a player can keep a maximum of 4 cards in hand, and keeps only 1 Transportation counter.<br /> <br /> == Travel rules ==<br /> <br /> Players can travel :<br /> * on the roads on which a Transportation Counter has been set<br /> * on the rivers<br /> * on the lakes.<br /> <br /> To travel on a road, a river or a lake, the player needs to pay with the cards in hands the cost matching the terrain of the road and the means of transport used.<br /> <br /> For example, if the Transportation Counter 'Magic Cloud' has been set on a mountain road, one can travel with just one 'Magic Cloud' card. But if it has been set on a forest or plain road, one needs to pay 2 'Magic Cloud' cards to pass (NB: the 'Magic Cloud' Transportation Counter cannot be used to travel in the desert, as it's too hot for a Cloud over there).<br /> <br /> Also :<br /> * To travel a river, you need only 1 'Raft' card to go downriver, but you need 2 to go upriver (look for the small arrows).<br /> * To cross a lake, you need to pay two 'Raft' cards.<br /> * If an Obstacle has been set on a road, you need to pay 1 more card of the appropriate type.<br /> * If you don't have the appropriate cards to travel on a road, you can still pass using a 'Caravan', by paying 3 cards of any type (4 cards if there is an Obstacle on the road).<br /> <br /> == Variant ==<br /> <br /> In the 'Hometown' variant, each player gets a secret town card at the beginning of the game, telling him which town he has to reach at the end of the 4th round.<br /> <br /> If he doesn't manage to get there, he'll lose as many points as the remaining distance he has to travel to get there.<br /> <br /> This variant gives more tactic depth to the game, as you have to plan each round to the best to get the most Town Pieces while making sure to be able to get to your hometown at the end of the game.<br /> <br /> <br /> '''Have a good game!'''</div>

Een https://ms.doc.boardgamearena.com/index.php?title=Gamehelpelfenland&diff=887 2013-06-16T12:57:28Z

<p>Een: /* Goal of the game */</p> <hr /> <div>== Goal of the game ==<br /> <br /> Visiting as many cities as possible in Elfenland over 4 rounds.<br /> <br /> At the end of the 4th round, the player who collected the most Town Pieces wins.<br /> <br /> We advise you to play with at least 3 players to best enjoy the game (4 or 5 is even better). A lot of the fun comes from using the counters from other players to optimise one's travels, so the more the merrier!<br /> <br /> == Round overview ==<br /> <br /> A round is split into phases:<br /> <br /> # Each player fills his hand up to 8 cards and gets a secret Transportation Counter.<br /> # One after another, each player chooses a Transportation Counter from the 5 visible or drawn from the facedown stack, until each player took 3.<br /> # One after another, each player chooses must plan a travel road by laying a Transportation Counter matching the terrain of the chosen road. This phase goes on until each player has passed consecutively. Each player also owns an Obstacle that he can lay down on a Transportation Counter to up the cost of traveling on this road from 1 card.<br /> # One after another, each player is going to travel from town to town. The current position of a player is shown by the Elf Boot of his color, initially set on the biggest town, Elvenhold.<br /> <br /> At the end of the round, a player can keep a maximum of 4 cards in hand, and keeps only 1 Transportation counter.<br /> <br /> == Travel rules ==<br /> <br /> Players can travel :<br /> * on the roads on which a Transportation Counter has been set<br /> * on the rivers<br /> * on the lakes.<br /> <br /> To travel on a road, a river or a lake, the player needs to pay with the cards in hands the cost matching the terrain of the road and the means of transport used.<br /> <br /> For example, if the Transportation Counter 'Magic Cloud' has been set on a mountain road, one can travel with just one 'Magic Cloud' card. But if it has been set on a forest or plain road, one needs to pay 2 'Magic Cloud' cards to pass (NB: the 'Magic Cloud' Transportation Counter cannot be used to travel in the desert, as it's too hot for a Cloud over there).<br /> <br /> Also :<br /> * To travel a river, you need only 1 'Raft' card to go downriver, but you need 2 to go upriver (look for the small arrows).<br /> * To cross a lake, you need to pay two 'Raft' cards.<br /> * If an Obstacle has been set on a road, you need to pay 1 more card of the appropriate type.<br /> * If you don't have the appropriate cards to travel on a road, you can still pass using a 'Caravan', by paying 3 cards of any type (4 cards if there is an Obstacle on the road).<br /> <br /> == Variant ==<br /> <br /> In the 'Hometown' variant, each player gets a secret town card at the beginning of the game, telling him which town he has to reach at the end of the 4th round.<br /> <br /> If he doesn't manage to get there, he'll lose as many points as the remaining distance he has to travel to get there.<br /> <br /> This variant gives more tactic depth to the game, as you have to plan each round to the best to get the most Town Pieces while making sure to be able to get to your hometown at the end of the game.<br /> <br /> <br /> '''Have a good game!'''</div>

Een