Board Game Arena - User contributions [en]

Tips martianchess

2026-04-17T08:38:55Z

RicardoRix: Created page with "== STRATEGY TIPS == === BEWARE THE DOUBLE WHAMMY === Whenever you capture a piece, make sure the piece you moved isn’t in a position where it can immediately capture one of your own remaining pieces (unless you’re happy enough making an exchange...). === EYES ON THE PRIZE === Keep in mind that the goal is points, not position. This is particularly vital in a four-player game, when two people can use the Double Whammy on each other to quickly trade pieces for po..."

== STRATEGY TIPS ==

=== BEWARE THE DOUBLE WHAMMY ===

Whenever you capture a piece, make sure the
piece you moved isn’t in a position where it can
immediately capture one of your own remaining
pieces (unless you’re happy enough making an
exchange...).

=== EYES ON THE PRIZE ===

Keep in mind that the goal is points, not position.
This is particularly vital in a four-player game,
when two people can use the Double Whammy
on each other to quickly trade pieces for
points.

=== RUN FOR THE BORDER ===

If you’re ahead on points and low on pieces, try
to end the game quickly by pushing your last few
pieces across a canal.

Gamehelpworldwarfive

2026-04-07T10:15:25Z

RicardoRix: Created page with "=== OVERVIEW: === World War 5 is a world-conquest board game. We can’t tell you what happened during World Wars 3 or 4, but at this point the earth is neatly divided into six nation states, each filling up their continent, with everyone perfectly connected to every other nation-state in equal and completely balanced ways. So the international stage is set for a world conquest board game that is both fast and fair. === GOAL: === Conquer another continent while maintai..."

=== OVERVIEW: ===
World War 5 is a world-conquest board game. We can’t tell you what happened during World Wars 3 or 4, but at this point the earth is neatly divided into six nation
states, each filling up their continent, with everyone perfectly connected to every other nation-state in equal and completely balanced ways. So the international stage
is set for a world conquest board game that is both fast and fair.

=== GOAL: ===
Conquer another continent while maintaining a base in
your own. You are eliminated from the game if there are
zero pieces of your color on your continent.

=== SETUP: ===
Each player chooses a home continent and receives the pyramids of the color most similar to the colors of their continent. Each player then places three of their pyramids, one of each size, onto the three territories of their continent. (Only one piece may ever occupy a territory.) The starting pieces are placed in turn order, with all players taking turns placing their smalls, then adding their mediums, and finally their large pyramids.

=== ACTIONS (HOW TO PLAY): ===
Perform one of these actions during each turn:

==== GROW: ====
Increase the size of one of your pyramids by
replacing it with the next larger size, if one is available.
You can only grow a piece on your own continent.
==== BUILD: ====
Place a small piece of your color (if available)
into an empty territory on your own continent.
==== MOVE: ====
Transfer one of your units to an empty territory
that it is connected to.
==== INVADE: ====
Attempt to enter a connected enemy-held
territory by using combat.

=== COMBAT RULES ===
A territory can never contain more than one piece. To
move into an occupied territory, you must push the
enemy out. (You cannot push your own pieces.) Attacks
are resolved as follows:

• Begin by placing the piece you are attacking with on its
side, pointing at the territory you seek to move into.
• Battles are resolved with the two players rolling dice.
The number of dice you roll is the same as the number
of pips on your piece. (If your piece is Large, you roll
three dice, if it’s Medium, you roll two, and if you only
have a Small, you only roll one die.)

• If the attacker fails to get a better total dice roll than the
defender, the battle ends and no pieces are moved. Ties
go to the defender.

• If the attacker wins, the loser must retreat into an
empty, adjoining territory of their choice, while the
winner's piece is moved into the disputed zone.

• You cannot retreat into the space the attacker is
coming from.

• If (and only if) there is no available territory for the
loser to retreat to, then their piece is reduced in size
by one

• If a piece must shrink but there's no piece available of
the size needed, the piece shrinks to the next smallest
size. Smalls are removed from the board, allowing the
attacker to move in.

• If a player is eliminated because they have no pieces
left in their home territory, all pieces of that color are
immediately removed from the board.

• After resolving combat, stand your piece up.

• The defender chooses where they retreat to.

=== HOW TO WIN ===
You win if all three territories in another colored continent are occupied by pieces of your color — provided you also have at least one piece of your color in your home
continent. If two players happen to meet the victory condition at the same time, then the active player wins.
You also win if all other players are eliminated.

Gamehelpproteus

2026-03-04T18:25:35Z

RicardoRix: pieces to pawns

***Background*** In ancient Greek mythology there was a sea god named Proteus. His most notable characteristic was that he could change his shape at will, from a man to a fish, a whale, a bird, or anything else. This most useful skill against opponents gave rise to the expression of being in a "Protean struggle." The Proteus game set is so named because the game can change its form — not its physical form, but rather the game rules themselves.

How to play PROTEUS®

Players: Two.
Object: Attain the Goal in effect at the end of the turn.
Equipment: The Proteus board; 3 pawns per player; 9 engraved tiles.

The rule tiles:

The 9 tiles have markings on their face only. The backs are blank. There are 3 tiles in each of three colors. During the game, only one tile of each color may be face up (active) at a time. Here's what the inscriptions mean:

MOVE (maroon tiles)
Proteus pawns move like certain chess figures, with these exceptions: — a pawn, except when moving as a king, may leap over another pawn if there is an empty space on the other side of the pawn being jumped over; there is no capturing. Active MOVE rules apply equally to all pawns. Only one pawn allowed per space.

KING — moves like a chess king, one space in any direction.
ROOK — moves like a chess rook, any distance in the same row or column (horizontal or vertical).
BISHOP/KNIGHT — moves to any empty space not in the same row or column.

TRADE (turquoise tiles)
Two tiles may exchange places. Their relative positions don’t matter, nor whether they are face-up or face-down. Pawns, if any occupy them, stay put to await the new tile. Only one tile allowed per space. There are 27 different tile pair combinations for each of these:

POLARITY — both tiles to be traded must contain pawns, and the pawns must belong to opposing players. The symbols on the pawns don't matter.
COLOR — both tiles to be traded must be the same color. The color doesn't matter, and they need not be occupied.
SHAPE — both tiles to be traded must be the same shape. The shape doesn't matter, and they need not be occupied.

GOAL (gold tiles)
These tiles represent the three different ways a game can be won. The first method is just like Tic-Tac-Toe. The other two methods require that a player's 3 pawns occupy similar tiles, regardless of their relative positions on the board.

3-IN-LINE — The winning player's three pawns must be in a straight line, horizontally, vertically, or diagonally.
COLOR — the player's three pawns must occupy tiles of a single color; symbols on pawns need not match the tiles.
SHAPE — the player's three pawns must occupy tiles of the same shape.

Placement Phase

The board begins empty, with the 9 tiles spread around for easy selection in a common pool. Black places first.

Players take turns placing any of the tiles from the pool face-down onto any empty space of the board, or placing one of their own pawns onto any space already occupied by a vacant tile (never onto an empty space). Once placed, no pawn or tile can be moved during this phase of the game.

When a pawn and a tile of the same shape come together, that tile is turned face-up and becomes active. Its rule will stay in effect until another tile of the same color is activated.

During the 15 turns of the placement phase, one and only one tile of each color must be activated. They may be activated in any order and by either player. Once a tile is activated, no other tile of the same color can accept a pawn of matching shape until after all tiles and pawns have been placed.

Plan ahead: it may happen that only one player can activate a tile and therefore must do so. For example, if two of the three tiles of a color are already occupied by non-matching pawns, only the third tile is still open for activation. If only one player has a pawn of the requisite shape to activate that tile, that is a mandatory placement for that player.

Movement Phase

The movement phase begins when all the pawns and tiles are on the board and three tiles of different colors are active (provided the game was not already won during the placement phase).

Players take turns moving any one of their own pawns to a vacant tile (according to the active Move rule), or exchanging two tiles (according to the active Trade rule).

When, through a move or trade, a pawn and tile of the same shape are brought together, that tile becomes activated. It is turned face-up, and the previously active tile of the same color is turned face-down. The new rule is now in effect for both players. If a trade of two inactive tiles of the same color produces two matches, they cancel each other and the previously active tile stays in effect.

The first player to satisfy the Goal active at the end of that turn is the winner. If both players simultaneously meet the goal, neither wins and the game continues until there is a clear winner.

Gamehelpgaiaproject

2026-01-15T18:19:36Z

RicardoRix: /* Rules to Remember */

== Factions ==
{| class="wikitable"
|- style="font-weight:bold; vertical-align:bottom;"
! '''Faction'''
! '''Planet Type'''
! '''Ability'''
! '''Planetary Institute'''
! '''Starting Research'''
! '''Basic Income'''
|-
| style="vertical-align:bottom;" | Terrans
| style="vertical-align:bottom;" | Terra
| style="background-color:rgba(255, 255, 255, 0.85);" | During the Gaia phase, move the power tokens in your Gaia area to area II of your power cycle instead of to area I.
| style="background-color:rgba(255, 255, 255, 0.85);" | During the Gaia phase, when you move power tokens from your Gaia area to area II of your power cycle, you may gain resources as if you were spending that much power to take free actions.
| style="vertical-align:bottom;" | Gaia Project
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Lantids
| style="vertical-align:bottom;" | Terra
| style="background-color:rgba(255, 255, 255, 0.85);" | When you take the “Build a Mine” action, you may build a mine on a planet colonized by an opponent (including the Lost Planet). Place your mine next to the opponent’s structure. You do not have to pay for terraforming, but you must still pay the mine’s cost. This mine counts as a normal mine in all ways except the following: this mine cannot be upgraded, and it does not count for any effects that relate to how many planet types or Gaia planets you have colonized.
| style="background-color:rgba(255, 255, 255, 0.85);" | Each time you build a mine on a planet colonized by an opponent, gain two knowledge.
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Xenos
| style="vertical-align:bottom;" | Desert
| style="background-color:rgba(255, 255, 255, 0.85);" | You place a third starting mine after all other starting mines have been placed.
| style="background-color:rgba(255, 255, 255, 0.85);" | You can form federations with a total power value of six instead of seven. You gain one Q.I.C. as income instead of one power token.
| style="vertical-align:bottom;" | Artificial Intelligence
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Gleens
| style="vertical-align:bottom;" | Desert
| style="background-color:rgba(255, 255, 255, 0.85);" | If you would ever gain Q.I.C., gain that much ore instead; once you have upgraded to the indicated academy, this effect no longer applies. To make a Gaia Planet habitable, pay one ore instead of one Q.I.C. Each time you build a mine on a Gaia Planet, gain two additional VP.
| style="background-color:rgba(255, 255, 255, 0.85);" | When you upgrade to the planetary institute, immediately gain the Gleens’ federation token (gaining the resources shown as normal). Gaining this tile counts as forming a federation. The planetary institute itself can still be part of a federation on the board.
| style="vertical-align:bottom;" | Navigation
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Taklons
| style="vertical-align:bottom;" | Swamp
| style="background-color:rgba(255, 255, 255, 0.85);" | The Brainstone counts as one power token (when starting a Gaia Project, building satellites, etc.), but you can spend it as if it were three power.
| style="background-color:rgba(255, 255, 255, 0.85);" | Each time you would charge power from “Passive Action: Charge Power,” you gain one power token. You can choose to gain the power before or after charging.
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Ambas
| style="vertical-align:bottom;" | Swamp
| style="vertical-align:bottom;" | NA
| style="background-color:rgba(255, 255, 255, 0.85);" | Once per round, as an action, you can swap your planetary institute with one of your mines on the game board (this can help you form a new federation). This has no impact on existing federations, even if their power value becomes less than seven. The swap does not count as a build or upgrade action; no VP or power can be gained from it.
| style="vertical-align:bottom;" | Navigation
| style="vertical-align:bottom;" | 1 Knowledge, 2 Ore
|-
| style="vertical-align:bottom;" | Hadsch Hallas
| style="vertical-align:bottom;" | Oxide
| style="vertical-align:bottom;" | NA
| style="background-color:rgba(255, 255, 255, 0.85);" | You can spend credits instead of power to take free actions that allow you to gain resources. Example: You can spend 3 credits to take the free action that allows you to gain one ore.
| style="vertical-align:bottom;" | Economy
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore, 3 Credits
|-
| style="vertical-align:bottom;" | Ivits
| style="vertical-align:bottom;" | Oxide
| style="background-color:rgba(255, 255, 255, 0.85);" | During setup, do not place mines. Instead, after all other players have placed mines (including the Xenos’ third mine), place your planetary institute on any red planet. You can only have one federation, but each time the power value of your federation becomes a multiple of 7, you may take the "Form A Federation" action again. You must discard Q.I.C. instead of power tokens to make satellites.
| style="background-color:rgba(255, 255, 255, 0.85);" | As a special action, place a space station on an accessible space that does not contain a planet or another space station. The accessibility of a space follows the same rules as the “Build a Mine” action.
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore, 1 QIC
|-
| style="vertical-align:bottom;" | Geodens
| style="vertical-align:bottom;" | Volcanic
| style="vertical-align:bottom;" | NA
| style="background-color:rgba(255, 255, 255, 0.85);" | The first time you build a mine on each planet type, gain 3 knowledge. (You do not gain knowledge for planet types you colonized before upgrading to your planetary institute.)
| style="vertical-align:bottom;" | Terraforming
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Bal T'aks
| style="vertical-align:bottom;" | Volcanic
| style="background-color:rgba(255, 255, 255, 0.85);" | You cannot advance in the “Navigation” research area, even if you take the tech tile below the “Navigation” research area. If you do take that tech tile, no advancement occurs. As a free action, you can move a Gaiaformer from a Gaiaformer space on your faction board to your Gaia area to gain one Q.I.C. Gaiaformers in your Gaia area are not available until the next Gaia phase. In the next Gaia phase, move any Gaiaformer in your Gaia area back to its Gaiaformer space.
| style="background-color:rgba(255, 255, 255, 0.85);" | You can now advance in the “Navigation” research area.
| style="vertical-align:bottom;" | Gaia Project
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Firaks
| style="vertical-align:bottom;" | Titanium
| style="vertical-align:bottom;" | NA
| style="background-color:rgba(255, 255, 255, 0.85);" | As an action, you can “downgrade” a research lab into a trading station and immediately advance one level in a research area of your choice. Advancing in a research area is explained on page 15. This counts as an “Upgrade to a Trading Station” action. You can later upgrade the trading station back into a research lab using the normal rules (including gaining a new tech tile).
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 2 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Bescods
| style="vertical-align:bottom;" | Titanium
| style="background-color:rgba(255, 255, 255, 0.85);" | The positions of your planetary institute and academies are swapped on your faction board, as is the income you gain for trading stations and research labs. As with the other factions, upgrading to an academy or a research lab allows you to gain a tech tile. Once per round, as an action, you can advance your lowest-level token in a research area (without paying knowledge). If multiple of your tokens are tied for the lowest level, choose which of the tied tokens to advance. To advance to level 5 this way, you must still flip a federation token as normal. Remember, only one player can reach level 5 of each research area.
| style="background-color:rgba(255, 255, 255, 0.85);" | The power value of your structures on gray planets (your home type) is increased by one (in addition to any other effects that increase their power value).
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Ore
|-
| style="vertical-align:bottom;" | Nevlas
| style="vertical-align:bottom;" | Ice
| style="background-color:rgba(255, 255, 255, 0.85);" | As a free action, you can move one power token from area III of your power cycle to your Gaia area to gain one knowledge (these power tokens follow the normal Gaia phase rules). This does not count as spending power.
| style="background-color:rgba(255, 255, 255, 0.85);" | You can spend power tokens in area III of your power cycle as if they were each two power. Otherwise, they count as one power token (when starting a Gaia Project, building satellites, etc.). When paying for a power action with an odd power cost (1, 3, 5, etc.), the unspent power is lost.
| style="vertical-align:bottom;" | Science
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Itars
| style="vertical-align:bottom;" | Ice
| style="background-color:rgba(255, 255, 255, 0.85);" | Each time you discard a power token from area II of your power cycle to move another power token to area III, place the discarded power token in your Gaia area instead of returning it to the supply.
| style="background-color:rgba(255, 255, 255, 0.85);" | During the Gaia phase, you can discard 4 power tokens from your Gaia area to immediately gain a tech tile (standard or advanced).
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore, 1 Power in Bowl I
|}

== Rules to Remember ==
* Starting Resources (before receiving income at the beginning of Round 1) - Credits: 15, Ore: 4, Knowledge: 3
* Resource Storage Limits - Credits: 30, Ore: 15, Knowledge: 15
* Round phase order: 1.Income, 2.Gaia (move any gaia tokens to area/bowl 1), 3.Actions.

==Actions==
# '''Build a Mine''' - This places a mine on the board, which usually give you ore as income. These mines must be at most a distance away from another building of yours equal to your navigation (the second track from the left). You must pay the cost of the mine. If it's a Gaia planet (green planets without gaiaformers on them), you must also pay one QIC. If it's some other planet type, you must pay additional ore - the exact cost is determined by your terraforming ability (the first track from the left) and the number of terraforming steps required to make the destination planet habitable for your faction.
# '''Start a Gaia Project''' - This allows you to transform Transdim planets (purple) into a Gaia planet. You can only do this if you have at least one available gaiaformer, which you can get as a result of the Gaia Project track (the fourth track from the left). To do this, move power tokens into the gaia section of your board. These tokens are not lost - you'll get them back as the last step of the income phase. At the start of the next round, these planets are now Gaia planets and you can build mines on them normally (without spending a QIC like you normally would to build on a Gaia Planet). The gaiaformer is removed (and sent to your faction board) only after you decide to build on these planets (they are "reserved" for you until then).
# '''Upgrade Existing Structure''' - Mines can be upgraded to Trading Stations, which usually produce credits - note that this has a cheaper cost if it's at most two units away from an opponent's structure. Trade Centers can be upgraded to either a Planetary Institute (which produces power and unlocks an ability specific to your faction) or Research Labs, which produce knowledge and allows you to immediately take a technology tile and advance on one of the tracks (if able, depending on your current position in the track). Research Labs can be upgraded to Academies, which also let you gain more technologies and produce either knowledge or QIC (or other resources depending on the faction).
# '''Form a Federation''' - This allows you to combine structures to gain more points. To do this, you need any cluster of structures whose total power level is 7 or more. This can include empty space as well, but for each empty space included this way, pay 1 power token from any bowl to create a satellite. For doing this, you gain a federation token, which gives you immediate points, some other resource bonus, and can later be spent to advance to the top position of a research track or gain advanced technology tiles.
# '''Research Progress''' - Spend 4 knowledge to advance on any track. The tracks are
##Terraforming, which improves your ability to terraform planets
##Navigation, which increases the range at which you can build structures
##Artificial Intelligence, which gives you more QIC
##Gaia Project, which allows you to start Gaia Projects on Transdim planets
##Economy, which increase your ore, credits, power charge income
##Science, which increases your knowledge income.
# '''Power and Q.I.C. Actions''' - Spend power or QICs to take any of the actions at the bottom of the research board. Each of these can be taken only once per round.
# '''Special Actions''' - Use any actions printed on booster tiles or your faction board. These can be taken only once per round.
# '''Pass''' - Select a new booster tile. Wait until all other players have passed too.
# '''Free Actions''' - Resource Conversions (or burn power to move power from Bowl 2 to Bowl 3).
[[Image:Gaia_Project_Free_Actions.JPG]]
# '''Passive Action''' - Charging power. Spend VP as necessary depending on the amount of power being charged. This is optional.

== Auctions for Drafting Factions ==

Each player submits the maximum amount he is willing to bid for each faction that has been drafted. Once all bids are submitted, a round-robin auction is automatically conducted in turn order until each player has the top bid on one faction. During the round-robin portion, each player automatically bids '''on the faction with the greatest difference between the faction's current bid and that player's maximum possible bid.'''

A typical '''automatic''' auction might look like this behind the scenes.

1) The first player bids zero VP on the faction that has his highest maximum bid (i.e. the faction they wanted most)

2) If the second player submitted the same top bid for two different factions, he'll automatically bid zero on the faction no one has picked yet. If he had placed a higher bid on the same faction as player 1, he would have increased that bid to one VP instead.

3) The third player looks at the current bids and compares those to his maximum bid. He'll automatically bid one higher on the faction with the greatest difference between his maximum bid and the current bid of that faction.

This is all resolved quickly and automatically behind the scenes. It's not uncommon for players to get factions for free if no one outbids them.

After the auction, all players are given VP so that the player that paid the most still starts with 10 VP to use during the game.

'''Here is a game log auction example for a 3 player game:'''

<u>In summary</u>:

PLAYER_A wins IVITS for 11, their maximum bid was 27 for IVITS,

PLAYER_B wins AMBAS for 6, their maximum bid was 10 for IVITS, 8 for AMBAS.

PLAYER_C wins TERRANS for 0, their maximum bid was16 for IVITS, 12 for AMBAS, 6 for TERRANS.

<u>some notable example lines from the log are:</u>

''**PLAYER_B switches from [IVITS] to [AMBAS] when the bid reaches 3 on IVITS, because 9>7 : AMBAS:8--1= '''9''' > IVITS:10-3='''7'''.''

<small><code>explanation: AMBAS: 8(PlayerB max bid for Ambas) - -1(current bid for Ambas) = 9 > IVITS: 10(PlayerB max bid for Ivits) - 3 (current bid for Ivits) =11</code></small>

''++PLAYER_C switches from [IVITS] to [AMBAS] when the bid reaches 5 on IVITS, because 12>11 : AMBAS:12-0='''12''' > IVITS:16-5='''11'''.''

<code><small>explanation: AMBAS: 12(PlayerC max bid for Ambas) - 0(current bid for Ambas) = 12 > IVITS: 16(PlayerC max bid for Ivits) - 5 (current bid for Ivits) =11</small></code>

<u>Actual Log:</u>

Players will automatically bid on the faction with the greatest gap between its current bid and the player's maximum bid

PLAYER_A bids 0 on [IVITS] (and is willing to bid up to 27 if needed)

PLAYER_B bids 1 on [IVITS], outbidding PLAYER_A. (The bid was 10 away from PLAYER_B's max bid of 10.)

PLAYER_C bids 2 on [IVITS], outbidding PLAYER_B. (The bid was 15 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 3 on [IVITS], outbidding PLAYER_C. (The bid was 25 away from PLAYER_A's max bid of 27.)

<nowiki>**</nowiki>PLAYER_B bids 0 on [AMBAS] (and is willing to bid up to 8 if needed)

PLAYER_C bids 4 on [IVITS], outbidding PLAYER_A. (The bid was 13 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 5 on [IVITS], outbidding PLAYER_C. (The bid was 23 away from PLAYER_A's max bid of 27.)

++PLAYER_C bids 1 on [AMBAS], outbidding PLAYER_B. (The bid was 12 away from PLAYER_C's max bid of 12.)

PLAYER_B bids 2 on [AMBAS], outbidding PLAYER_C. (The bid was 7 away from PLAYER_B's max bid of 8.)

PLAYER_C bids 6 on [IVITS], outbidding PLAYER_A. (The bid was 11 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 7 on [IVITS], outbidding PLAYER_C. (The bid was 21 away from PLAYER_A's max bid of 27.)

PLAYER_C bids 3 on [AMBAS], outbidding PLAYER_B. (The bid was 10 away from PLAYER_C's max bid of 12.)

PLAYER_B bids 4 on [AMBAS], outbidding PLAYER_C. (The bid was 5 away from PLAYER_B's max bid of 8.)

PLAYER_C bids 8 on [IVITS], outbidding PLAYER_A. (The bid was 9 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 9 on [IVITS], outbidding PLAYER_C. (The bid was 19 away from PLAYER_A's max bid of 27.)

PLAYER_C bids 5 on [AMBAS], outbidding PLAYER_B. (The bid was 8 away from PLAYER_C's max bid of 12.)

PLAYER_B bids 6 on [AMBAS], outbidding PLAYER_C. (The bid was 3 away from PLAYER_B's max bid of 8.)

PLAYER_C bids 10 on [IVITS], outbidding PLAYER_A. (The bid was 7 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 11 on [IVITS], outbidding PLAYER_C. (The bid was 17 away from PLAYER_A's max bid of 27.)

PLAYER_C bids 0 on [TERRANS] (and is willing to bid up to 6 if needed)

PLAYER_A wins the auction for [IVITS], spending [VP11]

PLAYER_C wins the auction for [TERRANS], spending [VP0]

PLAYER_B wins the auction for [AMBAS], spending [VP6]

All players receive [VP11] to ensure every player starts with at least 10 VP

== FAQ: General ==
Q: The booster tile is covering the conversions pane!

A: Check the preferences for other options for the booster tile.

Q: On iOS/Mac, the game is unresponsive.

A: The rendering engine on Apple devices deals very poorly with shadows. You'll get much better performance by setting the "Structure outlines" user preference to "No outlines." This is true regardless of which browser you're using.

Q: The game isn't allowing me to gain an advanced tech!

Q: The game isn't allowing me to advance to level 5 in a research track!

A: Both of these require a green federation tile. If you want to do both in a single action, you need two federation tiles.

Q: Why can't I upgrade?

A: This is usually because you lack the resources required to perform any available upgrades. Occasionally, it's because you lack the structures (because they are already on the board).

Q: Is there an option to undo my entire turn?

A: The game asks you to confirm or cancel after selecting a planet for a build/upgrade action, selecting planets for a federation, selecting a research track, passing, and so on. However, the developers have decided not to add an option to [https://boardgamearena.com/doc/BGA_Undo_policy undo your entire turn].

== FAQ: Conversions/Power ==
Q: Why do I only get one credit when I convert the Brainstone to credits?

A: If you want to get more than one credit, click on that button more than one time. The game does not do this automatically in order to allow you to allocate the spent power as desired.

Q: Why don't I get a chance to convert resources at the end of my turn?

Q: I should get the option to charge before or after gaining power!

A: There are options in the pull-down menu to the right to enable this under various conditions. By default, options are selected that improve the speed of the game.

Q: I have enough power to perform a power action, but it doesn't show up as available!

A: There are two possible reasons:
- You're lacking something else that would be required to perform that action. For example, if you don't have a mine and enough resources to build a mine, the terraforming actions won't show as available.
- Someone else has taken that action this round.

== FAQ: Federations ==

Q: Why can't I form this federation?

A: The federation rules are surprisingly intricate given the amount of space they occupy in the rulebook. See boardgamegeek.com/thread/2120375/official-federation-faq for more details.

Xenos: note that 7 power is required if you have not built your PI.

Bescods: note that power is only increased on titanium planets, and only after you have built your PI.

Ivits: Your existing federation starts out pre-selected. Your second federation must connect to your existing federation. Don't forget that Ivits spend QICs for satellites!

IMPORTANT: All bug reports regarding federations require the move number of the action and a screenshot showing which hexes are selected. Without these, it's nearly impossible to piece together exactly what's happening and when.

== FAQ: Faction-specific ==

Q: As Hadsch Hallas, how do I use my PI ability?

A: Once you've built your PI, the new conversion options will be available under the Convert menu.

Q: My faction's ability isn't working!

A: Make sure you're not confusing your passive ability with the ability granted by your Planetary Institute. If it's the PI ability, you'll need to have built your PI.

Q: As Nevlas, what happens to the remaining half a power when I convert?

A: Any "half power" not used is lost. Make sure you select all desired conversions before clicking confirm.

Q: How do I form a second federation as Ivits?

A: Your existing federation starts out pre-selected. Your second federation must connect to your existing federation. Don't forget that Ivits spend QICs for satellites!

Gamehelpfiftyfirststate

2025-12-14T13:41:40Z

RicardoRix: /* Develop a location */

===Overview===

Play cards to your area in order to earn points. When a player has 25 victory points (VPs), the current round finishes and then whoever has the most VPs (including end game scoring) wins!

===Round===

The round is split into five phases, each of which is completed by every player before moving to the next, the phases are:

# 1. Lookout phase
# 2. Production phase
# 3. Action phase
# 4. Check for game end
# 5. Cleanup phase

===1. Lookout Phase===

First, reveal n+1 cards, where n is the number of players (e.g. 4 cards in a 3-player game). Then:

* • Players take turns taking a new card in clockwise order.
* • After each player has taken 1 card, discard remaining cards.

Then draw n+1 cards again, and:
* • Starting with the last player and proceeding counter-clockwise, each player takes a card.
* • After each player has taken 1 card again, discard the remaining cards.

===2. Production Phase===

# First, gain resources according to your faction board. Usually this includes 3 workers {{meeple|black|3}}, 1 resource ⚙️/💳/🔫/⛽, 1 connection token {{blackCylinder|>}}, and 1 card {{cardBack}}.
# Second, each deal provides the good depicted on the card.
# Third, each production location produces goods (including open production cards).

===3. Action Phase===

In clockwise order, '''each player takes a single action or passes''' until all players pass.

If you pass then:
* • you cannot take additional actions
* • your locations cannot be razed or interacted with in any other way, e.g., use open production locations.

The actions are:

==== Construct a location ====
Build a location by spending the number of grey connection tokens {{greyCylinder|>}} equal to the card's Distance value. Earn any building bonuses and if building a production location (including open production locations), take the goods from the supply.

==== Develop a location ====
Build a location on top of an existing location by spending a brick and removing the old location. You earn 1 VP after developing. The new location must have at least 1 matching symbol with the old location. Ruins (and cards without icons like Radioactive Colony) can be built over with any type. Earn any building bonuses and if building a production location (including open production locations), take the goods from the supply. Any resources or tokens that were on the old card (if they were in "storage") are kept.

==== Make a deal ====
Spend the number of blue connection tokens {{blueCylinder|>}} equal to the card's Distance value, and then turn the card upside down to show its Deal value.

==== Raze location from your hand ====
Discard a card and spend the number of red connection tokens {{redCylinder|>}} equal to the card's Distance value. Take the goods shown in the spoils field.

==== Raze opponent's location ====
Spend the number of red connection tokens {{redCylinder|>}} equal to the location's Defense value (3 for Production, 4 for Feature, 5 for Action). Take the goods shown in the spoils field. The location's owner takes the good in the Deal field and turns the location upside down to indicate that the location is now a Ruin.

==== Use an action from a location ====
Spend the goods to perform the card action and keep the goods on the card to remember you used it this round, as each action can only be used once per round.

==== Use an action from your faction board ====
Spend the goods to perform the faction action and keep the goods on the faction board to remember you used it this round, as each action can only be used once per round.

==== Use another player's open production location ====
Spend a worker to earn the good on the opponent's open production location. The opponent takes a worker from the supply. You cannot send a worker to your own open production location. Each open production location can only be used once per round.

==== Take a connection card ====
Spend 2 workers to take a face-up connection card.

==== Play a connection card ====
Play a connection card and earn the goods on it.

==== Place a shield token on a location (free action) ====
Place a shield token on a location to increase its defense value by 1. Each location can only have 1 shield token.

==== Pass ====
Pass for the round and do not take any more actions.

===4. Check for Game End===

If one player has 25 VPs or more, do not go to the Cleanup Phase, and instead calculate the final score for each player.

===5. Cleanup Phase===

* • You can use the storage ability on any locations to save goods. All other goods (resources, workers, contact tokens, shields) in your personal supply and on your cards are returned to the general supply.
* • Beside stored goods, you can only keep cards in between rounds.
* • Discard all face-up connection cards.
* • Pass the first player token to the left and start a new round.

===End Game Scoring===

Each player adds 1 VP per location (but 0 VP per Ruin) to their current score.

In the case of a tie, use the following tie breakers in order:
*• The player with the most total goods
*• The player with the most locations
*• If still tied, share the victory

Gamehelpharmonies

2025-11-27T22:08:00Z

RicardoRix: /* Landscape */

== Overview ==

Your goal is to earn the most points by building landscapes and habitats for Animals. Which landscapes and habitats are built using colored tokens in certain arrangements. The more arrangements you have, the more points you can earn.

Tokens can be one of five colors. There are 23 blue tokens (representing water), 23 grey tokens (representing mountains), 21 brown tokens (representing woody trees), 19 green tokens (representing foliage or treetops), 19 yellow tokens (representing fields) and 15 red tokens (representing buildings).

Animals are represented by Animal cards. Each Animal card indicates the habitat pattern you must form within your landscape.

Nature's Spirit Cards can be added to the game and provide additional scoring conditions. When integrated into the game, choose between 2 randomly dealt spirit cards before taking your first turn. Refer to the rule indicated on the card to determine its value in points.

== Turns ==

There are 3 possible actions to take. One is mandatory, two are optional. They can be done in any order.

'''Mandatory action - Take and place tokens:''' Choose one set of 3 tokens (out of 5 sets). Place each of the 3 tokens on your board according to the following requirements:

- The token cannot be placed underneath another token.

- The token cannot be placed on top of a spirit cube.

- The token must be either on an empty space or on top of 1-2 previously placed tokens (see diagram).

[[File:Harmonies.png]]

'''Optional action - Take an Animal card:''' The card will be placed in one of 4 available slots. You can only take 1 card per turn.

Each card displays the pattern/arrangement to make to score points, the spirit cubes to earn for making the pattern, and the number of points you can earn for each spirit cube. When all the cubes are used, the card is discarded and you can take a new one.

'''Optional action - Place an Animal cube'''. If you have placed a valid pattern on your board, you can place a spirit cube where indicated on its Animal card.

At the end of a turn, the central board of tokens is refilled and the Animal cards are replaced so there are 5.

== End of Game ==

The game ends when either A) there are no tokens left to refill the central board or B) a player has 2 or fewer empty spaces on their board. At that point, the round ends so that all players have completed the same number of turns.

=== Scoring ===

==== Animal Cards ====
Each player scores points according to the number of points indicated in the topmost space without an Animal cube. A card with all its cubes scores 0.

==== Landscape ====
Each player scores points according to the standard patterns for certain landscape features (colors).
{|class="wikitable" style="max-width:50rem;text-align:center;" border="2"
!Token
!Formation
!Scoring
|-
! style="background:#6e790f;color:#fff" | Tree
|1 green token placed on top of 0/1/2 brown tokens
|The scores corresponding are 1/3/7 pts.
|-
! style="background:#858983;color:#fff" | Mountain
|A stack made of 1/2/3 gray tokens
|Only mountains adjacent to other mountains score: each mountain scores 1/3/7 pts
|-
! style="background:#deae09;color:#fff" | Field
|2+ yellow tokens
|Each 2+ contiguous yellow tokens group you get 5 pts.
|-
! style="background:#b82521;color:#fff" | Building
|1 red token on top of a red, brown, or gray token
|Each Building scores 5 pts if surrounded by at least 3 tokens of different colors (only consider the top of each adjacent place).
|-
! style="background:#197984;color:#fff" | Water ''(Side A)''
|Blue tokens
|Score for your longest continuous chain of blue tokens. Choose any two blue tokens and count how many blue tokens connect them by the '''shortest''' path (inclusive of the two selected tokens at both ends of the chain). Score 2/5/8/11/15 pts for a chain of 2/3/4/5/6 blue tokens + 4 pts for every additional token in the chain.
Making '''loops''' is not recommended since according to this shortest rule your river length will be only half of its tokens +1.
|-
! style="background:#197984;color:#fff" | Water ''(Side B)''
|Areas divided by blue tokens
|Each island that is separated from each other by blue tokens gives you 5 pts.
|}

== Spirit Cards ==
If playing with Spirit cards, the following changes to the game are made.

Each player chooses 1 of 2 Spirit cards. This card counts toward your 4-card limit and is given a Nature's Spirit cube. These follow the same rules as Animal cards, but have different requirements, such as points for the number of landscapes or groups of connected landscapes of a certain pattern.

At the end of the game, points are scored for Spirit cards just like Animal cards.

BGA Studio Migration Guide

2025-11-14T09:24:11Z

RicardoRix: /* Deprecated APP_* Classes */

This page is only for people who started long time ago and now need to re-write older projects into more modern versions.
Also if you trying to fix older game you may have to look here.

==Overview==
See announcement here https://studio.boardgamearena.com/forum/viewtopic.php?f=12&t=45248

📌 This symbol: direct information about migration
== Structural changes==

'''''gameoptions.inc.php''''' => gameoptions.json, gamepreferences.json

Previously, options and preferences were specified in a single gameoptions.inc.php file.

Now options and preferences are 2 json files, follow Migration steps on this page https://en.doc.boardgamearena.com/Options_and_preferences:_gameoptions.json,_gamepreferences.json#Migration

See [[#User preferences]] and [[#Game options]] for API changes.

When building the game with this file you will see deprecation warning: The file gameoptions.inc.php is deprecated. click "Reload game options configuration" to generate the JSON content you can then put on a gameoptions.json and gamepreferences.json file. Then you can safely delete the gameoptions.inc.php file.

'''''<gamename>.game.php''''' => modules/php/Game.php

Move and refactor, see section [[BGA Studio Migration Guide#Namespaced game class|Namespaced game class]]

'''<gamename>.action.php => remove'''

See section [[BGA Studio Migration Guide#Autowire game actions|Autowire game actions]]

'''''<gamename>.view.php, <gamename>_<gamename>.tpl''''' => remove

See section [[BGA Studio Migration Guide#Removal of view and template|Removal of view and template]]

'''gameinfos.inc.php'''

File still there. Deprecated keys '''designer''', '''artist''', '''year''', '''presentation''', '''tags''', '''complexity''', '''strategy''', '''luck''', '''diplomacy''', '''is_beta''' are no longer in use. Please remove these keys and use the Game Metadata Manager instead.

'''''material.inc.php''''' => optional

See section [[#Material]]

'''''states.inc.php''''' => modules/php/States

See section [[#States]]

'''stats.inc.php''' => stats.json

Deprecation warning: The file stats.inc.php is deprecated. click "Reload statistics configuration" to generate the JSON content you can then put on a stats.json file. Then you can safely delete the stats.inc.php file.

'''<gamename>.js'''

File still there but massive API changes, see bottom sections

==IDE Support==
A new _ide_helper.php file is now provided in every project dir, allowing IDE to provide syntax error highlighting for the framework functions. This file is regularly updated to match the latest framework updates.

Same with bga-framework.d.ts for those using TypeScript.

📌 Sync the files from the FTP dir to your local copy to benefit from it. Most of the IDE like Visual Studio Code should handle _ide_helper.php if you already followed https://en.doc.boardgamearena.com/Setting_up_BGA_Development_environment_using_VSCode

==Game configuration ==

===User preferences===

Access to user preferences and listener: https://en.doc.boardgamearena.com/Game_interface_logic:_yourgamename.js#User_preferences

📌
*If you had a custom function called <code>setupPreferences()</code> reading the <select> values, you can now use <code>onGameUserPreferenceChanged</code> instead.
*If you had a copy of the user preferences on a DB table, it's not needed anymore. Remove all support of writing to this table. Replace access to this table with
$pref = $this->userPreferences->get($playerId, $prefCode) ?? $defaultValue;
*If you used $this->player_preferences - replace the use with use of proper API

====Instant cssPref on user preferences====
A reload is not needed anymore to apply cssPref on a user preference change.

📌 Remove forceReload: true if it was only set to update the cssPref. The player will appreciate to not reload the whole page!

===Game options===

New functions to access the table options (game options) without hassle

https://en.doc.boardgamearena.com/Options_and_preferences:_gameoptions.json,_gamepreferences.json#Game_Options

📌
*Remove declaration of game options from "<code>initGameStateLabels</code>"
* Instead of using <code>$this->getGameStateValue</code> or <code>$this->gamestate->table_globals</code> use
$this->tableOptions->get(int $optionId)

This new object can also return the Real-time/Turn-based setting: https://en.doc.boardgamearena.com/Main_game_logic:_Game.php#Reflexion_time

==Server parts (php, sql, etc)==

===PHP migration===

Oct 2025: The migration was made from PHP7.4 to PHP8.4 new syntax and functions.

New projects are generated using the strict mode

📌

*Replace all <code>self::</code> to <code>$this-></code> - The new project template has been updated to remove this bad practice (that may be unsupported in a future PHP version)

*Add <code>declare(strict_types=1);</code> to all .php files and fix compiler warnings (if you use IDE it will detect it before upload).

===Namespaced game class===
Game class from '''''<gamename>.game.php''''' are now namespaced (and moved to modules/php/Game.php) and can autoload other classes of the same namespace

[[Main game logic: Game.php#Creating other classes]]

📌 The class file should be moved to modules/php/Game.php and adopted

(In examples below YourGameName is NOT verbatim its your game name)

* Move YourGameName.game.php to modules/php (create this dir if does not exists)
* Rename to Game.php
* Find the place below the copyright and add

declare(strict_types=1);
namespace Bga\Games\YourGameName;

* Remove
require_once APP_GAMEMODULE_PATH . "module/table/table.game.php";

* Find you class declaration change YouGameName to Game (verbatim) and change extends

class Game extends \Bga\GameFramework\Table

* All references to non-namespaced classes in this file should be defined on top of the file with "use", for example "use \BgaUserException;" as it is this non-namespaced exception is used in the zombieTurn function.

* All includes with relative path will need to be updated too.

* The material.inc.php to have be moved and included directly (see below)

Multiple functions of "Table" base class are now deprecated, see how to migrate in corresponding section

* notifyAllPlayers
*notifyPlayer
* mysql_fetch_assoc
** Deprecation warning: mysql_fetch_assoc function detected. It is deprecated, and may be removed someday. Please replace it by standard framework DB functions!
*Table (class access without namespace)
*isMutiactiveState (misspelled version)
*...

===Material===
Material file '''material.inc.php''' is now optional. You can define all your material directly in php class. If you still like to keep it, and using namespaced Game.php you have to move it to subfolder and include directly [[Game material description: material.inc.php#Move it to modules/php]]

=== Autowire game actions===
Simplify the action calls by removing '''<gamename>.action.php''' file

https://en.doc.boardgamearena.com/Main_game_logic:_Game.php#Actions_%28autowired%29

📌 Autowired actions needs to start with "act", so it's risky to change them (if you change all actions names in the states.php, game, action and JS file, Real-time players will call the old name until they refresh. So, it needs to be done in two steps with duplicates on back side, or to be deployed when there is no Realt-time table running.

When migration is done, the action.php file can be deleted.

Deprecation warning: Actions detected on .action.php file. You can now use [[Main game logic: Game.php#Actions (autowired)|Auto-wired actions]] to avoid pass-through functions in .action.php file. If you transform your project to use only auto-wired actions, you can then delete the .action.php file.

=== Notifications===
Functions notifyAllPlayers and notifyPlayer from main game.php are deprecated

📌 Replace <code>$this->notifyAllPlayers</code> with <code>$this->notify->all</code>
and Replace <code>$this->notifyPlayer</code> with <code>$this->notify->player</code>

====Notification Decorators====
New notify function that handles decorators, reducing the duplicate code on notification args.

https://en.doc.boardgamearena.com/Main_game_logic:_Game.php#Notification_decorators

====Notification args consistency====
Previously, when you sent an arg that was transformed by format_string_recursive or bgaFormatText, the args object was mutated and you got the transformed value in the notif_ handler.

The solution was to send the values in 2 different names like this:

[
'roundNumber' => $roundNumber, // number, to update the round counter
'round_number' => $roundNumber, // number that will be transformed to string by bgaFormatText, when shown in bold in the logs
]
📌 Do not duplicate the value, as the notif_ handler will now get unmutated args

===Deprecated getGameName===
The getGameName() function is now useless in the Game PHP file and can be deleted

📌 Delete the getGameName function in the Game PHP file.

Deprecation warning: getGameName function detected. It is deprecated. You can delete it, it is not used anymore

=== Deprecated APP_* Classes ===
Deprecation warning:

Reference to old APP_* class detected.

We recommend you to use composition instead of extend:

Pass `private Game $game` in the constructor of your object that need to access Table functions

If it's too complicated, at least replace APP_Object/APP_GameClass by APP_DbObject as APP_Object/APP_GameClass may be removed soon and don't contain anything more than APP_DbObject.

Don't hesitate to ask for help in the Dev Discord or in the Dev forum if you don't know how to do it!
class Tokens extends APP_GameClass {
becomes:
class Tokens extends \APP_DbObject {

=== Deprecated translation functions ===

On php side translation story is simplified

* totranslate function is not longer needed and can be replaced with clienttranslate
* $this->_() - can also be replaced with clienttranslate when use for non parameterized exceptions strings like

throw new \BgaUserException(clienttranslate('You must choose 3 cards'));

See [[Translations]]

=== Deprecated getNew ===
Function getNew that was only used to create new deck object is now deprecated, use $this->deckFactory->createDeck('') instead

=== Stats ===

The stats function such as initStat, setStat and getStat are also deprecated in favor of access via the objects <code>$this->tableStats and $this->playerStats</code>
See https://en.doc.boardgamearena.com/index.php?title=Main_game_logic:_Game.php#Game_statistics

===Legacy===
New object to access the legacy functions, removing the need to manually decode the JSON result when getting the values.

[[Main game logic: Game.php#Legacy games API|https://en.doc.boardgamearena.com/Main_game_logic:_Game.php#Legacy_games_API]]

📌 Use $this->legacy->actionname instead of $this->actionnameLegacy and remove JSON decoding on getters

===Any Globals===
New database table and API to handle any type variables instead of numerical values only

https://en.doc.boardgamearena.com/Main_game_logic:_Game.php#Use_globals

📌 If you had custom tables just for that you can drop them and use standard table

=== Server Counters ===
2 new counter classes have been added to easily handle the various counters your game might have. You also have 2 prebuilt counters: playerScore and playerScoreAux, to handle the scoring values, so you don't need to update manually the DB when setting the scores.

https://en.doc.boardgamearena.com/PlayerCounter_and_TableCounter

📌 Replace setting player_score/player_score_aux using db queries with use of $this->playerScore and $this->playerScoreAux. Remove the notifications, or part of notifications, updating the scoreCtrl counter (if you had some custom notification you may still need them).
===Updated Zombie Mode documentation and recommendations===
We now recommend making the zombie player playing randomly, instead of passing as a default. A new "Zombie Mode level" field has been added to the Game Metadata Manager, to indicated the Zombie Mode you implemented in your game.

https://en.doc.boardgamearena.com/Zombie_Mode

===View and template files: deprecated===
'''''<gamename>.view.php, <gamename>_<gamename>.tpl''''' are now optional and are not generated anymore on a new project. The new project templates demonstrate how to work without them.

📌 The DOM should be built on the JS side to remove the view/template files, so it can be complicated for old projects using them intensively. It would look like this:
this.getGameAreaElement().insertAdjacentHTML('beforeend', `
<nowiki><span>${_('My translated text')}</span></nowiki><nowiki><div id="player-tables"></div></nowiki>
`);

See more in [[#Access template elements]]

====Forbid access to global BGA variables and direct DB access on action/view files====
If you did not remove action and view files, you cannot longer use some stuff in them, such $g_user global and db access functions.

A new getCurrentPlayerId() function has been added to those action/view classes for easier migration

📌 Replace $g_user->get_id() by $this-> getCurrentPlayerId()

Replace DB calls by $this->game->DbQuery() (and such...)

===States===
There is now a way to describe each game state in a State class, that will handle all logic and description of the state. It helps splitting the code into multiple files, instead of one big Game.php file.

https://en.doc.boardgamearena.com/State_classes:_State_directory

📌 Create a State class for each state of the game (except 1 and 99 if they are still described in states.inc.php), move the state definition in it, and adapt the "st", "arg", "actXXX" and "zombie" functions in the class. When all classes are migrated, you can remove the states.inc.php file in the FTP folder.

==== If still using states.php====
The new class GameStateBuilder helps you build the state machine, allowing auto-completion, and avoid typo errors on state types. Complete example: 📌 https://en.doc.boardgamearena.com/Your_game_state_machine:_states.inc.php

States 1 and 99, that must not be changed, are now optional.

📌 Replace the array definition by GameStateBuilder use. You can remove the declaration of states 1 and 99.

Note: it's only useful if you don't migrate to State classes described above

==Client parts (js, html, css) ==

===Deprecated ajaxcall ===
Introduced function bgaPerformAction to replace ajaxcall and checkAction combination, with a simpler syntax:

https://en.doc.boardgamearena.com/Game_interface_logic:_yourgamename.js#Actions

Deprecation warning: The <code>ajaxcall</code> function is deprecated, check [[/en.doc.boardgamearena.com/Game interface logic: yourgamename.js#Actions|the]] <code>bgaPerformAction</code> [[/en.doc.boardgamearena.com/Game interface logic: yourgamename.js#Actions|function]].

📌 Replace combination of checkAction/ajaxcall by bgaPerformAction. Beware of the options (3rd param) if it was an ajaxcall without checkAction.
===Access to DOM elements ===
New functions getPlayerPanelElement(player_id) and this.getGameAreaElement()

https://en.doc.boardgamearena.com/Game_interface_logic:_yourgamename.js#Adding_stuff_to_player%27s_panel

📌 Code like dojo.place(html, player_board_${player.id}); would be replaced by this.getGameAreaElement().insertAdjacentHTML('beforeend', html);
===Notification setup===
Notifications can now be automatically scanned and called without needing to register them one by one. They'll handle Promises, so they end synchronously when the Promise resolves.

https://en.doc.boardgamearena.com/Game_interface_logic:_yourgamename.js#Notifications

A wait function has been added to return a Promise when a delay is passed (compatible with fast-replay mode)

A new utility function has been added to support Promises for old Dojo animations

https://en.doc.boardgamearena.com/Game_interface_logic:_yourgamename.js#Animation_Callbacks

📌 Dojo.subscribe calls in setupNotifications must be removed if bgaSetupPromiseNotifications is used. Notif_ function should be async and return a Promise, make sure they wait for the expected amount of time if the sync setup was using a numerical duration

If you used Dojo animation, make them Promise compatible with "await this.bgaPlayDojoAnimation(dojoAnim);"

===Status bar manipulation===
Function to change the title from the JS
https://en.doc.boardgamearena.com/Game_interface_logic:_yourgamename.js#Title_bar

📌 Replace direct title div manipulation with this.statusBar.setTitle(title: string, args?: object), and benefit from replacement of ${actplayer}/${you}/... (see example in the link above).

This also includes a new function to create action buttons, that are more screen-reader compatible than the previous version. The new button parameters also allow you to set a confirm popin or an autoclick for confirmation buttons

📌 Replace this.addActionButton by this.statusBar.addActionButton. Notice the parameters have changed, so they need to be adapted too! Remove manual setActionTimer or manual confirm with the new parameters.

===Dojo usage===
Dojo usage has been reduced to minimum in the new project template and the doc, as native JS is now able to do almost the same things, with better performance and more knowledge for newcomers of the native (vanilla) JS.

📌 Replace dojo by vanilla JS where possible
{| class="wikitable"
! colspan="undefined" |Dojo API
! colspan="undefined" |Category
! colspan="undefined" |Description
! colspan="undefined" |Vanilla JS Replacement
|-
| colspan="undefined" |<code>dojo.byId("id")</code>
| colspan="undefined" |DOM Selection
| colspan="undefined" |Selects a single DOM element by its ID.
| colspan="undefined" |<code>document.getElementById("id")</code>
|-
| colspan="undefined" |<code>dojo.query("selector")</code>
| colspan="undefined" |DOM Selection
| colspan="undefined" |Selects a collection of DOM elements using CSS selectors.
| colspan="undefined" |<code>document.querySelectorAll("selector")</code> or <code>document.querySelector("selector")</code>
|-
| colspan="undefined" |<code>dojo.connect(node, "onclick", fn)</code>
| colspan="undefined" |Event Handling
| colspan="undefined" |Connects an event handler to a DOM element.
| colspan="undefined" |<code>node.addEventListener("click", fn)</code>
|-
| colspan="undefined" |<code>dojo.disconnect(handle)</code>
| colspan="undefined" |Event Handling
| colspan="undefined" |Removes an event handler created with <code>dojo.connect</code>.
| colspan="undefined" |<code>handle.remove()</code> for event listeners, or <code>node.removeEventListener("click", fn)</code>
|-
| colspan="undefined" |<code>dojo.place(node, parent, "last")</code>
| colspan="undefined" |DOM Manipulation
| colspan="undefined" |Places a DOM node inside a parent node at a specific position.
| colspan="undefined" |<code>parent.appendChild(node)</code>
|-
| colspan="undefined" |<code>dojo.create("tag", props, parent)</code>
| colspan="undefined" |DOM Manipulation
| colspan="undefined" |Creates a new DOM element with optional properties.
| colspan="undefined" |<code>document.createElement("tag")</code>, then set properties and use <code>parent.appendChild()</code>
|-
| colspan="undefined" |<code>dojo.style(node, "color", "red")</code>
| colspan="undefined" |Styling
| colspan="undefined" |Sets an inline CSS property on a DOM node.
| colspan="undefined" |<code>node.style.color = "red"</code>
|-
| colspan="undefined" |<code>dojo.hasClass(node, "className")</code>
| colspan="undefined" |Styling
| colspan="undefined" |Checks if a DOM node has a specific CSS class.
| colspan="undefined" |<code>node.classList.contains("className")</code>
|-
| colspan="undefined" |<code>dojo.addClass(node, "className")</code>
| colspan="undefined" |Styling
| colspan="undefined" |Adds a CSS class to a DOM node.
| colspan="undefined" |<code>node.classList.add("className")</code>
|-
| colspan="undefined" |<code>dojo.removeClass(node, "className")</code>
| colspan="undefined" |Styling
| colspan="undefined" |Removes a CSS class from a DOM node.
| colspan="undefined" |<code>node.classList.remove("className")</code>
|-
| colspan="undefined" |<code>dojo.forEach(array, fn)</code>
| colspan="undefined" |Array Utilities
| colspan="undefined" |Iterates over an array.
| colspan="undefined" |<code>array.forEach(fn)</code>
|-
| colspan="undefined" |<code>dojo.map(array, fn)</code>
| colspan="undefined" |Array Utilities
| colspan="undefined" |Transforms an array by applying a function to each element.
| colspan="undefined" |<code>array.map(fn)</code>
|}

===Sound loading===
New functions load/play have been added for the sounds:

https://en.doc.boardgamearena.com/Game_interface_logic:_yourgamename.js#Sounds

📌 Replace template loading of sounds and global function playSound

===Formatting of log message using bgaFormatText===
This function, if defined, will allow you to insert HTML in the logs without overriding format_string_recursive. Example: 📌https://en.doc.boardgamearena.com/BGA_Studio_Cookbook#Define_this.bgaFormatText%28%29_method

📌 Replace the override of format_string_recursive by bgaFormatText (the last line will change)

===Future support of dark mode===
BGA doesn't support dark mode yet. To have some games compatible when we do, we added a theme data tag you can use as described here:

https://en.doc.boardgamearena.com/Game_interface_stylesheet:_yourgamename.css#Support_of_the_Dark_mode

===Automata player panel===
A new framework function to add a player panel for your game automas https://en.doc.boardgamearena.com/Game_interface_logic:_yourgamename.js#Adding_a_player_panel_for_an_automata

📌 Replace manually created automata player panel with this new function

===New JS libraries===
New JS libraries are created to help you design your games, especially for components that you will find on numerous games. See [[Studio#BGA Studio game components reference]]

📌 Replace manually created animation, stocks, etc with components (check the list above, don't want to duplicate it here)

Gamehelptwilightimperium

2025-07-28T17:46:24Z

RicardoRix:

===== ACTION PHASE =====
The action phase is the main phase of the game, during which
players produce units, move ships, enact strategies, and interact
with other players.
During the action phase, players take turns in initiative order.
While a player is taking a turn, he is the active player, and
he can perform one action. After each player has taken a turn,
player turns begin again in initiative order. Initiative order
may repeat in this manner several times within a single action
phase. The action phase does not end until each player has
passed (see below).
There are three types of actions: tactical actions, strategic
actions, and component actions. They are described in
detail later.
If a player does not wish to perform an action during his turn,
he may pass. After a player passes, his turn is skipped for the
remainder of the action phase. A player cannot pass until he
has performed his strategic action, which is explained later.
After each player has passed, the game round continues to
the status phase.

====== TACTICAL ACTION ======
A tactical action allows a player to move ships, initiate combat,
invade planets, produce units, and otherwise interact with the
game board. To understand a tactical action, players need to understand many
other game concepts, such as movement and combat. For this
reason, the steps of a tactical action are summarized below, but
are not described in detail until later.

1. ACTIVATION: The active player must activate a system by
taking a command token from his tactic pool and placing it in
that system.

2. MOVEMENT: The active player may move ships into a
system from any number of other systems. Ships can also
transport ground forces from one system to another.

3. SPACE COMBAT: If multiple players have ships in the active
system, they resolve a space combat.

4. INVASION: The active player may commit ground forces
to land on planets in the active system. If another player
has units on those planets, the players resolve a ground
combat.

5. PRODUCTION: If the active player has a space dock in the
active system, he can produce units by spending resources.
A player might not resolve all of the above steps during every
tactical action. For example, a player may choose not to move
units during the “Movement” step but may still produce units
during the “Production” step.

====== STRATEGIC ACTION ======
Each strategy card has both a primary ability and a
secondary ability.
When a player performs a strategic action, he resolves the
primary ability of his strategy card. After resolving this ability,
each other player may resolve the secondary ability of that
strategy card. The active player cannot resolve the secondary
ability of his own strategy card.
After each player has had an opportunity to resolve a strategy
card’s secondary ability, the active player exhausts that strategy
card by flipping it facedown. Players cannot resolve abilities on
exhausted strategy cards, but the exhausted cards’ numbers are
still used to determine initiative order.
A player cannot pass during the action phase unless his strategy
card is exhausted. This means that each player must perform a
strategic action at some point during the action phase, which
guarantees that each other player has an opportunity to resolve
the secondary ability of that strategy card. A player who has
passed during the action phase can still resolve the secondary
ability of other players’ strategy cards.

====== COMPONENT ACTIONS ======
A component action is an action that is printed on a game
component. Many action cards, faction sheets, and even some
technology cards have component actions. Each of these effects
is preceded by the word “Action.”

Gamehelptwilightimperium

2025-07-28T11:43:42Z

RicardoRix: Created page with "ACTION PHASE The action phase is the main phase of the game, during which players produce units, move ships, enact strategies, and interact with other players. During the action phase, players take turns in initiative order. While a player is taking a turn, he is the active player, and he can perform one action. After each player has taken a turn, player turns begin again in initiative order. Initiative order may repeat in this manner several times within a single action..."

ACTION PHASE
The action phase is the main phase of the game, during which
players produce units, move ships, enact strategies, and interact
with other players.
During the action phase, players take turns in initiative order.
While a player is taking a turn, he is the active player, and
he can perform one action. After each player has taken a turn,
player turns begin again in initiative order. Initiative order
may repeat in this manner several times within a single action
phase. The action phase does not end until each player has
passed (see below).
There are three types of actions: tactical actions, strategic
actions, and component actions. They are described in
detail later.
If a player does not wish to perform an action during his turn,
he may pass. After a player passes, his turn is skipped for the
remainder of the action phase. A player cannot pass until he
has performed his strategic action, which is explained later.
After each player has passed, the game round continues to
the status phase.

TACTICAL ACTION
A tactical action allows a player to move ships, initiate combat,
invade planets, produce units, and otherwise interact with the
game board. To understand a tactical action, players need to understand many
other game concepts, such as movement and combat. For this
reason, the steps of a tactical action are summarized below, but
are not described in detail until later.
1. ACTIVATION: The active player must activate a system by
taking a command token from his tactic pool and placing it in
that system.
2. MOVEMENT: The active player may move ships into a
system from any number of other systems. Ships can also
transport ground forces from one system to another.
3. SPACE COMBAT: If multiple players have ships in the active
system, they resolve a space combat.
4. INVASION: The active player may commit ground forces
to land on planets in the active system. If another player
has units on those planets, the players resolve a ground
combat.
5. PRODUCTION: If the active player has a space dock in the
active system, he can produce units by spending resources.
A player might not resolve all of the above steps during every
tactical action. For example, a player may choose not to move
units during the “Movement” step but may still produce units
during the “Production” step.

STRATEGIC ACTION
Each strategy card has both a primary ability and a
secondary ability.
When a player performs a strategic action, he resolves the
primary ability of his strategy card. After resolving this ability,
each other player may resolve the secondary ability of that
strategy card. The active player cannot resolve the secondary
ability of his own strategy card.
After each player has had an opportunity to resolve a strategy
card’s secondary ability, the active player exhausts that strategy
card by flipping it facedown. Players cannot resolve abilities on
exhausted strategy cards, but the exhausted cards’ numbers are
still used to determine initiative order.
A player cannot pass during the action phase unless his strategy
card is exhausted. This means that each player must perform a
strategic action at some point during the action phase, which
guarantees that each other player has an opportunity to resolve
the secondary ability of that strategy card. A player who has
passed during the action phase can still resolve the secondary
ability of other players’ strategy cards.

COMPONENT ACTIONS
A component action is an action that is printed on a game
component. Many action cards, faction sheets, and even some
technology cards have component actions. Each of these effects
is preceded by the word “Action.”

Gamehelpsuperfantasybrawl

2025-03-14T14:10:41Z

RicardoRix: /* Keywords */

=== WINNING THE GAME ===
The first Player to reach 5 VP immediately wins
the game.

=== BASIC CONCEPTS ===
==== The First Rule ====
If the effect of a card directly conflicts with one or
more rules in this document, the text on the card
takes precedence.
==== Enemies and Allies ====
Miniatures represent great warriors from Fabulosa’s
turbulent history, and are referred to as Champions.
Champions under your opponent’s control are
referred to as Enemies. Your own Champions are
called Allies. Note that when a Champion’s card
effect refers to Allies or an Ally, it does not include
the Champion to whom the card belongs.
==== Objective of the Game ====
Victory Points (VPs) represent the favour of the
crowd, that will decide the victor in the Brawl. The
first player to score 5 VPs wins immediately. This is
done by taking Enemy Champions out of action, and
by completing challenges on the Challenge Track.
==== The Three Cores of Magic ====
All magic, and indeed all energy in Fabulosa, is
intrinsically tied to one of the three Cores of Magic:
Destruction (red), Creation (yellow), or Manipulation
(blue). Whenever a player uses any type of Action,
they exhaust (flip over) their connection to one of
these Cores, and must wait until the end of their turn
until they are ready to be used again.

==== Towards and Away ====
When an effect instructs a Champion to move
towards a game element, the moving Champion
must end its move with fewer hexes between it and
the game element it is moving towards than it did
before starting the move, if possible. If this is not
possible, the Champion will not move.
When an effect instructs a Champion to move away
from a game element, the moving Champion must end
its move with more hexes between it and the game
element it is moving away from than they were before
starting the move. If this is not possible, the Champion
will not move.
==== Strength and Damage ====
Some cards and effects will deal damage, whilst others will state the strength of the attack. Strength is always reduced by the defence of the target,
whilst damage is applied directly to the target, ignoring any defence.

==== Resolving a card ====
When resolving a card, if a card cannot be fully
resolved, forfeit the part that cannot be resolved.

==== Targeting ====
Unless a card says otherwise, Champions can only
target Enemy Champions. Area of Effect (AoE) attacks that include an Enemy Champion in the AoE
fulfil this condition, even if an Ally is also in the AoE.
Open and Hidden Information
Each player’s hand is hidden information, and should
not be shared with another player unless a game
effect instructs a player to do so. When a card effect
asks a player to show something, all players may
see the revealed information.
Each player’s discard pile is open information.
Players can ask to see their opponent’s discard pile
at any time. Both sides of any Champion cards are
also open information, and a player can ask to see
either side of a Champion card at any time. When a
card effect asks a player to look at something, only
that player may see the revealed information.
==== Drawing Cards ====
If a player is instructed to draw cards from an empty
deck, they shuffle their discard pile to form a new
draw deck.
=== GAME ROUND ===
Each round consists of three steps: First player’s turn,
Second player’s turn, and Advance Challenge Track.
ON A TURN, PLAYERS CARRY OUT THE FOLLOWING
PHASES IN ORDER:
==== Scoreboard Phase ====
The active player checks to see
if they meet the conditions of any active Challenge
cards. If they do, they gain the appropriate number
of VPs, and discard that Challenge. Skip this Phase
on the first round.
==== Activation Phase ====
Players exhaust Cores to play Action
cards from their hand and activate their Champions.
Upkeep Phase. The active player readies each of their
Cores, discards their hand and draws a new hand of
5 cards.

'''Upkeep Phase'''

Players ready each of their Cores, discard their hand and draw a new hand of 5 cards.

=== PRE-ATTACK AND POST-ATTACK ===
Pre-attack and post-attack abilities
are effects that take place when an attack
card with either symbol is played. Both abilities
are mandatory. If a card instructs a player to
resolve a or ability, then it must be
fully resolved before moving on to the next
step of the attack.
The key difference between the two is that a
player may play a card with a ability, and
then choose not to attack, whereas a
ability is only ever resolved after an attack
is made. Note that these abilities can be part
of a reaction card.
Note that many keywords have numerical
values, so can be legally resolved by choosing
0, effectively cancelling the effect.
Every Action card with the attack icon
in the upper left corner of the card is an
attack card. To resolve an attack, follow
these steps:
# Use as much of the card’s movement as you choose.
# Resolve any abilities.
# Choose if you will use the attack. If you choose not to make the attack, the activation ends immediately. Otherwise, continue to step 4.
# Declare target(s).
# Opponent chooses whether to play Reactions.
# The target’s defence value is subtracted from the current strength value of the attack.
# Resolve attack damage.
# Resolve abilities from Reactions.
# Resolve abilities from the attack card.
# Declare target(s)
Check the range and targeting icons to determine
which targeting rules apply for the attack. Some
attacks have a minimum range, and any Enemy
closer than that range is not an eligible target.

=== ACTION CARD ANATOMY ===

The dark grey hex in the targeting box marks the
relative position of the attacking Champion to the
targeted hex(es), marked on the card in yellow.
Melee Attack
A melee attack targets a single adjacent
Enemy.
==== Indirect Shot ====
An indirect shot targets a single Enemy.
The targeting value shows the maximum range of the Action. When one
figure is specified the targeting value shows the
maximum range of the Action. When two figures are
indicated, the first specifies the minimum and the
second the maximum range of the Action. To define
range, count the smallest possible number of hexes
to the target, including the target’s hex but not the
activating Champion’s hex. Indirect shots can target
Champions through Statues and other Champions.
==== Direct Shot ====
A direct shot works like an indirect
shot with some extra restrictions.
Direct shots may only target Enemies
on hexes in the same row of hexes as the attacking
Champion. Additionally, direct shots cannot target
Champions if there are any Statues, or other Champions (Enemy or Ally) in that hex row between the
activating Champion and target.
==== Area of Effect (AoE) ====
An AoE attack affects all Champions in the
yellow marked hexes shown in the targeting
icon of the Action card (including Allies).
The player playing the Action chooses the exact
orientation of the AoE.
==== Reactions are played ====
After targets are declared, the controller of an Enemy
target Champion may play one Reaction card on any
of their Champions targeted. The Core of the Reaction
card must be exhausted as normal. Only one Reaction
may be played per attack (see Reactions, page 11).
The target’s defence value is subtracted from
the current strength value
All Champions have a defence value. Even if a
Champion’s printed defence value is 0, it can still be
modified by card effects.
During this step, the current defence value of the
defender is subtracted from the current strength
value of the attack. Remember to include any
modifiers to strength and defence values in this
step. Defence values are always applied to every
attack made against the Champion, unless reduced
or bypassed by a card effect. The end sum of this is
the attack damage.
==== Resolve attack damage ====
The attack damage is dealt to all targets of the attack.
Place on the Champion card damage tokens equal
to the damage the Champion is dealt. Keywords that
affect damage such as Poison, Double, and Lifesteal
are resolved in this step (see page 15).
=== Standard Actions ===
In addition to using their hand of Action cards,
players may also activate Champions using the
Standard Actions shown on the player dashboard.
These Actions are intentionally weaker than Action
cards, but they offer some options when a player
does not draw the Cores and/or cards of Champions
they need.
Each Standard Action may only be used once per
Activation Phase.
# Spend the Manipulation (blue) Core to Move 1 and Plan 1 (see Plan, page 16).
# Spend the Creation (yellow) Core to Move 1 and Heal 1 (see Heal, page 15).
# Spend the Destruction (red) Core to Move 1 and Deal 1 damage to an adjacent Enemy. This damage ignores defence.
# Spend 1 Core, Manipulation or Creation or Destruction, to Move 2.
==== Reactions ====
During an opponent’s turn, players can
react to their opponent’s attacks by playing
Reaction cards. Reactions may only be
played during the opponent’s turn and
only when at least one of that player’s Champions is
targeted by an opponent’s attack action.
=== ADVANCE CHALLENGE TRACK ===
At the end of each game round (after all players have
taken a turn), all Challenge cards move one space to
the right, and a new Challenge card is drawn. This is
placed in the Cannot Be Scored space. Challenges
moving right from the rightmost space are discarded
(move them to the Challenge discard pile). If at any
point your Challenge card deck empties, shuffle the
discard pile to form a new Challenge deck.
=== OUT OF ACTION ===
A Champion is taken out of action as soon as they
suffer an amount of damage equal to or greater than
their hitpoint value (as printed on their Champion
card). If during their activation a Champion takes
an Enemy out of action, the attacking Champion’s
player gains 1 VP, and the attacking Champion
Levels Up. The out of action Champion is teleported
by the wizards out of harm’s way and is healed. All
damage is removed from the Champion, and if they
had Levelled Up, flip their Champion card back over
to the basic side. The out of action Champion is then
placed on their team’s Gate until they are activated
again.
Whilst Champions are on the Gate, they cannot be
affected by card effects, can never be targeted by
Actions or attacks, and cannot target Champions on
the hex grid.
To activate an out of action Champion, the player
must use an Action with to move that Champion
back into the arena. The first hex of movement must
be spent moving the Champion onto one of their
team’s deployment area hexes.
Out of action Champions may not be activated using
Action cards without . Once in the arena, they
may use any remaining movement to move further,
and complete the Action.
If during their activation a Champion takes themselves
or an Ally out of action, their opponent gains 1 VP.
If a card takes a Champion from each team out of
action simultaneously, both players gain 1VP and
Level Up the appropriate Champions. If this would
end the game in a draw (due to both players now
being tied with 5 or more VPs), the player who didn’t
play the card wins.
=== LEVELING UP ===
When an Enemy is taken out of action, the Champion
currently being activated will Level Up after the
Action is fully resolved. Flip that Champion card, and
move any damage tokens to the Levelled Up side.
The Champion uses the stats and effects of the
Levelled Up side until they are taken out of action.
If the Champion was already Levelled Up before the
knock out, then nothing happens. Please note that
Level Up effects are always active.
=== TRAPS ===
Some hexes contain trap tokens. Traps
are always placed face down. A trap will
trigger as soon as a Champion enters the
hex in which it is placed. It doesn’t matter
if the Champion deliberately moved
there or was pushed, pulled, or otherwise displaced
onto that hex. The player controlling the Champion
that activated the trap flips the trap token and applies
the effect to the Champion. The Champion may then
complete any remaining movement they have
available, unless prevented from doing so by the trap
effect.
There should always be 4 trap tokens on the map.
As soon as a trap is triggered and its effects applied,
the player whose Champion triggered the trap takes
a new trap token from the supply. Without looking at
it, the player places it face down on a different empty
trap hex, then shuffles the old trap back into the trap
supply. If all trap hexes are blocked by Champions
and/or traps, the trap token may be placed anywhere
adjacent to a trap hex that is not blocked by a
Champion or Statue. In addition to the trap hexes on
the board, any hex that currently contains a trap is
considered a trap hex.
If the trap was triggered because of a card effect
(for example when a Champion uses an attack
that pushes the defender into a trap), the damage
is considered to be caused by the source of that
effect. This may result in Levelling Up Champions as
normal.
==== Trap Effects ====
The Champion suffers the amount of damage
indicated on the trap token. Remember, this
damage ignores the defence value.
The Champion
suffers Root.
The Champion
suffers Stun.

=== DISPLACEMENT AND ROOT ===
Fear, Force, Pull, and Push are all considered displacement effects. Effects that negate displacement effects will negate any damage those effects would cause.
It is important to note that while Root means a Champion cannot be moved, it does not negate movement. As the target cannot move, any Push or Pull distance will cause as normal. Fear and Force cannot move a Champion suffering root, but do not cause, as neither keyword usually causes damage for failing to complete the movement.

=== HEXES & HEX ROWS ===
The arena board is made up of a series of hexes. A continuous line of hexes is called a hex row.
<pre>Example:
Gold’arr makes a Dash 2. He can move along any of the hex rows shown, but cannot move out of the hex row due as the Dash keyword states he must remain in the same hex row.</pre>

== Keywords ==
'''Bloodied:''' A champion is considered Bloodied if it has taken at-least 3 damage.

<s>A Champion is considered Bloodied when they have half of their hitpoints or fewer remaining (rounding up). For example, a 7 hitpoint Champion would be bloodied when reduced to 4 hitpoints.</s>

'''Control:''' A player is considered to control an area when they have more Champions in that area than their opponent.

'''Dash X:''' A dash is a straight-line movement where the dashing Champion must stay in the same hex row of the hex grid.

'''Double:''' After completing the resolve attack damage step of this attack, resolve this step a second time.

'''Fear X:''' If an action or reaction applies fear, the Champion who suffered the fear effect must dash X in a direction of their choice, as long as it is away from the source of the fear. When a Champion is affected by fear, the Champion must move the maximum dashvalue they possibly can.

'''Force X:''' The player who played the card with the force effect may move the target up to X hexes in any direction.

'''Jump X:''' Jump is a type of movement that allows the Champion to move up to X hexes, and move through hexes containing Enemy Champions, statues, and traps without activating them. If the Champion ends the movement on a trap token, the trap is activated.

'''Lifesteal:''' During the resolve attack damage step of this attack, the attacking Champion is healed for an amount equal to the attack damage.

'''Poison X:''' During the resolve attack damage step of this attack, if damage was dealt, deal X to the target.

'''Place:''' When a Champion or game element would be placed, it is removed from its original location, and put in a new location, as described by the effect causing the place.

'''Plan X:''' The controlling player may put up to X cards from their hand onto the top of their deck.

'''Pull X:''' Target Champions are pulled directly towards the Champion causing the pull in a straight line. They must stay in the same row of hexes. The activating Champion must pull the target the full distance. The target will stop before entering a hex with a Champion (Ally or Enemy), a statue, or the edge of the arena, and will activate traps if they are pulled over or onto them. If a Champion cannot be pulled the full distance for any reason, they suffer damage equal to the remaining distance. If the target is not in the same hex row as the attacking Champion when the pull is resolved, the pull is ignored.

'''Push:''' Target Champions are pushed directly away from the Champion causing the push in a straight line. They must stay in the same row of hexes. The activating Champion must push the target the full distance. The target will stop before entering a hex with a Champion (Ally or Enemy), a statue, or the edge of the arena, and will activate traps if they are pushed over or onto them. If a Champion cannot be pushed the full distance for any reason, they suffer damage equal to the remaining distance. If the target is not in the same hex row as the attacking Champion when the push is resolved, the push is ignored.

'''Root:''' A rooted Champion instantly loses any remaining movement points of the current action, and may not move, dash, swoop, or jump again during this turn. The Champion may attack and use skills normally. A Champion suffering root cannot be moved for the duration of the turn, but can be placed.

'''Stun:''' When a Champion suffers stun, its controller must choose and discard a card of that Champion from their hand, or reveal a hand showing no cards of that Champion.

'''Swoop X:''' A swoop is a straight-line movement where the swooping Champion must stay in the same hex row. A swooping Champion may move through Enemies, statues, and traps without activating them. Traps do still activate if the Champion ends the swoop on a trap token.

Gamehelpsaddle

2025-03-13T12:12:15Z

RicardoRix: Created page with "OBJECTIVE Saddle is a two player card game, the objective of which is to get rid of all of your cards or be the last to take a turn. THE DECK A standard 52-card deck, ranked from ace (1) to King. SETUP Each player starts with 12 cards dealt face down. Two cards are placed separately face up to begin two discard piles. The remainder of the cards become the draw pile. PLAY Players take turns matching a card from their hand by rank or suit with the top card in one of the..."

OBJECTIVE
Saddle is a two player card game, the objective of which is to get rid of all of your cards or be the last to take a turn.

THE DECK
A standard 52-card deck, ranked from ace (1) to King.

SETUP
Each player starts with 12 cards dealt face down. Two cards are placed separately face up to begin two discard piles. The remainder of the cards become the draw pile.

PLAY
Players take turns matching a card from their hand by rank or suit with the top card in one of the discard piles, but not both. The card placed is called the saddle.
Based upon it, one or more additional cards can be added before the turn ends. The added cards must either be of the same rank as the saddle, or a sequence up or down from it. The added cards may be of different suits.
At no time do players pick up any new cards. A player wins if he gets rid of all his cards or his opponent is unable to take a turn.

SCORING
After each game the winning player gets one point for each card remaining in his opponents hand, and when one player reaches 13 points he wins the match.

Gamehelppaxpamir

2025-03-05T11:34:56Z

RicardoRix: /* Card Actions */

===Overview===

In Pax Pamir, each player assumes the role of a nineteenth-century Afghan leader attempting to forge a new state after the collapse of the Durrani Empire. Western histories often call this period “The Great Game” because of the role played by the Europeans who attempted to use Central Asia as a theater for their own rivalries

To win the game, have the most victory points after the final Dominance Check is resolved, or have a lead of at least 4 points after any Dominance Check is resolved.

If players are tied for victory points after the final Dominance Check, the player with the most red stars in their court among the tied players wins. If there is still a tie, the player with the most rupees among the tied players wins. If there is still a tie, whoever can cook the best chopan kebab wins.

===Starting Loyalty===

During setup, starting with a random player, each player chooses their starting loyalty. (See "Loyalty and Influence" below.)

After the last player has chosen their starting loyalty, that player will take the first turn. The game is now ready to play.

===Turn===

On your turn, you may take 0-2 actions (plus any free bonus actions) then perform Cleanup.

The three action types are: Purchase, Play, and Card Action:

{|class="wikitable" style="width:auto;" border="2"
|-
! Purchase
| Purchasing cards from the market is done via a skip penalty cost, i.e. the first card is free, if you wish to buy card 2, pay 1 rupee to card 1, if you wish to buy card 3, pay 1 rupee to card 1 and 1 rupee to card 2, and so on. If the card you purchased had rupees from before, you gain these rupees. (If when paying a skip cost, one or more spaces to pay the penalty to is empty, place the payment on the card on the opposite row first.)

If you purchase an event card, this is resolved then discarded, all other cards purchased go into your hand.
|-
! Play
| To play a card, check the region it is associated with. If you are the ruler, or there is no ruler, the card is free to play. If another player is the ruler, they may require you to pay them rupees equal to the number of tribes they have in that region in order to play the card. You may offer any number of rupees up to their number of tribes, including 0. The ruler will then accept or reject the offer. If the full cost is paid, it is automatically accepted. (Depending on the game state, players may wish to help each other out by waiving some or all of the bribe.)

If the criteria to play is met, you must play the card to either the far left or far right of your current Court row.

If the card is a '''Patriot''' which doesn't match your '''Loyalty''', you must change loyalty. See "Loyalty and Influence" below.

Finally, resolve all '''Impact Symbols'''.
|-
! Card Action
| After a card is in your Court, you can take one of the actions it provides. Some cards just provide a single action. However, if a card shows multiple icons, you must only pick one to use each turn.

Some actions are free, only taking an action point, whilst others have additional costs such as rupees.

When a card has spies on it, the owner must pay a bribe of rupees to the player with the most spies on the card to use that card's action(s). (i.e. if player 2 has 1 spy on card A, and player 3 has 2 spies on Card A, player 1 has to pay player 3 2 Rupees to use an action.)
|}

===Impact Symbols===

A Camel has you place a road coalition block on a border of the card's region

A Jezail has you place an army coalition block on the card's region

A Weighing Scales gives you 2 Rupees and reminds you that the card is Leveraged (see "Cards")

A Cylinder on Card has you place a Spy Cylinder on a matching region card in any player's court

A Crown has you place a Tribe Cylinder on the card's region

All the Suits have you to change the Favoured Suit

===Card Actions===

There are 6 main action types cards may provide

{|class="wikitable" style="width:auto;" border="2"
|-
! Tax
| Take Rupees equal to the card's rank from a player you share a region with (Economic Stars can counter this). If you can't tax another player, you can tax the market.
|-
! Gift
| Place a cylinder on a gift space at increasing cost of 2 then 4 then 6 Rupees
|-
! Build
| In regions you rule, place up to three armies or roads or combination of, at a cost of 2 rupees each.
|-
! Move
| Based on the card's rank, gain that many movement points. A movement point moves either an army or spy. If moving a spy, it can move clockwise or counterclockwise from its current position, along the same player's court and even jumping to the next player's court. To move an army, there must be a loyal road on the border to move it from one region to the adjacent region.
|-
! Betray
| For 2 Rupees, discard a card from your or an opponent's court where you have a spy planted. After which, you may accept the discarded card as a Prize or let it be discarded (see "Loyalty and Influence"). This may also trigger the Leverage icon for the original owner.
|-
! Battle
| Pick either a card or a region. Remove tokens at that site equal to the rank of the battle card. Tribes, Spies, Roads, and Armies are all eligible for removal and, if allowed to remove more than one, they can be different. There are a few restrictions to this. You may not remove more than you have Armies or Spies at that site, i.e. a rank 2 battle card with 1 army/spy at the site can still only remove 1 token. Armies and Roads and Tribes of your loyalty are immune to removal (This prevents you weakening your current loyalty before switching loyalties).
|}

===Cleanup===

Check you aren't over Hand or Court Limit

If there are any Event cards in the left-most spot in the Market, discard them and resolve their Impact Event for all Players

If there were any rupees on these cards, they stay lingering in the empty spaces

Move all Market cards to the left, which allows cards to scoop up rupees in empty spaces even if they already had rupees of their own

Draw new Market cards into the now-empty rightmost spots in the Market

If one of the new cards was a Dominance, check to see if it's the only Dominance

If there is another Dominance, complete a Dominance Check, discard all Dominance cards, and draw new cards to fill the spaces

===Dominance Check===

To be successful, a single coalition must have the most blocks in play and four more than any other coalition.

If unsuccessful, the player with the most cylinders in play scores 3 points and the player with second most scores 1 point.

If successful, players in the winning coalition each score points based on how much influence they have. The player with the most scores 5, then 3, then 1. After which, remove all coalition blocks.

The fourth and final dominance check awards double points for every player involved.

In the case of a tie, tied players add up the victory points for the tied places and then divide that number by the number of tied players (rounding down). For example, in a dominance check where there is a winning coalition, if two players both have the second most amount of loyalty, they would each get 2 points (3 + 1 divided by 2).

===Court & Hand Limits===

During your turn, your court can contain any number of cards

However, at end of turn, your court can only have 3 + purple stars quantity of cards, any excess must be discarded

Likewise, your hand can contain any number of cards during the turn

However, at end of turn, your hand can only have 2 + blue stars quantity of cards, any excess must be discarded

===Stars===

<b style="color:#f91">★ Economic Stars</b> reduce taxation

<b style="color:#c23">★ Military Stars</b> provide a tie-breaker for end game

<b style="color:#929">★ Political Stars</b> increase size of Court

<b style="color:#07b">★ Intelligence Stars</b> increase size of Hand

===Loyalty and Influence===

Each player is always loyal to one of the three coalitions: {{pill|British|#423|#e8a9cc}}, {{pill|Russian|#440|#f5f079}} or {{pill|Afghan|#153|#56c1a5}}. This affects which cards you may want to play into your court. Consider carefully if and when you want to change loyalty, to take advantage of the game state and earn the most victory points.

Your loyalty is important in gaining victory points from Dominance Checks. If you are loyal to the Dominant Coalition when a Dominance Check is resolved, you are eligible to score victory points depending on your amount of influence compared to other players of the same loyalty. (You'll want to be loyal to the right coalition at the right time, which may require changing loyalties during the game.)

You change loyalty whenever you play a Patriot, or gain a prize, of a '''different''' loyalty. The loyalty of a Patriot is determined by the colour and symbol on the banner containing the card's name, or at the bottom of the card when gaining it as a prize. You may reject a prize in order to maintain your current loyalty. When you change loyalty, you lose all patriots, gifts, and prizes you currently have, before gaining the new patriot or prize which caused you to change.

Your influence to your coalition is calculated as 1, plus the number of patriots, prizes, and gifts you have. If you have the most influence in the Dominant Coalition when a Dominance Check is resolved, you will score the most points. (See "Dominance Check" above.)

===Ruling a Region===

To rule a region, you must have one tribe there and more ruling pieces than any other

Once a ruler, you have the following bonuses

• You may take the Build action

• You have Tax Privilege

• You can Extract Bribes

=== Overthrow Rule ===
If you lose your last tribe in a region, all ''Political'' cards you own from that region must be immediately discarded

Likewise, if you lose your last ''Political'' card from a region, you must immediately remove all of your tribes from that region

===Cards===

Cards may have multiple actions on them, but only one of these actions may be taken per turn

If you need to discard a card with a spy, this is returned to its owner

If you need to discard a card with the Leveraged icon, either two rupees or 1 card per rupee owed must be discarded too

If you lose the last tribe in a region, all political cards associated with that region are also discarded

If you lose the last political card associated with a region, all tribes in that region are also discarded

===Suits===

There are four suits in the game, and one suit is always shown as favoured, starting with {{pill|Political|#fff|#929}} but this will change throughout the game

{|class="wikitable" style="width:auto;" border="2"
|-
! style="background-color:#f91; color:#000" | Economic<br/><small>(gold)</small>
| Protect against taxation, manipulate rupees and piece movement
|-
! style="background-color:#c23; color:#000" | Military<br/><small>(red)</small>
| Manage armies and form coalitions
|-
! style="background-color:#929; color:#fff" | Political<br/><small>(purple)</small>
| Consolidate power and determine card playability
|-
! style="background-color:#07b; color:#fff" | Intelligence<br/><small>(blue)</small>
| Manage diplomacy and compromise enemies
|}

Actions on a card of the currently Favoured suit may be used as free actions, while still following the one action from each card per turn rule.

If {{pill|Military|#000|#c23}} is Favoured, purchasing cost of cards is doubled whilst Favoured

===Game End===

After a Dominance Check, if a player is at least 4 points ahead of everyone else, that player immediately wins

After the fourth Dominance Check card is resolved, the player with the most points wins

If there's a tie, the tie-breakers are: first, most Military stars, second most rupees, third cook a Chopan Kebab and the players vote on who cooked the best meal

Gamehelppaxpamir

2025-03-05T11:32:31Z

RicardoRix: /* Card Actions */

===Overview===

In Pax Pamir, each player assumes the role of a nineteenth-century Afghan leader attempting to forge a new state after the collapse of the Durrani Empire. Western histories often call this period “The Great Game” because of the role played by the Europeans who attempted to use Central Asia as a theater for their own rivalries

To win the game, have the most victory points after the final Dominance Check is resolved, or have a lead of at least 4 points after any Dominance Check is resolved.

If players are tied for victory points after the final Dominance Check, the player with the most red stars in their court among the tied players wins. If there is still a tie, the player with the most rupees among the tied players wins. If there is still a tie, whoever can cook the best chopan kebab wins.

===Starting Loyalty===

During setup, starting with a random player, each player chooses their starting loyalty. (See "Loyalty and Influence" below.)

After the last player has chosen their starting loyalty, that player will take the first turn. The game is now ready to play.

===Turn===

On your turn, you may take 0-2 actions (plus any free bonus actions) then perform Cleanup.

The three action types are: Purchase, Play, and Card Action:

{|class="wikitable" style="width:auto;" border="2"
|-
! Purchase
| Purchasing cards from the market is done via a skip penalty cost, i.e. the first card is free, if you wish to buy card 2, pay 1 rupee to card 1, if you wish to buy card 3, pay 1 rupee to card 1 and 1 rupee to card 2, and so on. If the card you purchased had rupees from before, you gain these rupees. (If when paying a skip cost, one or more spaces to pay the penalty to is empty, place the payment on the card on the opposite row first.)

If you purchase an event card, this is resolved then discarded, all other cards purchased go into your hand.
|-
! Play
| To play a card, check the region it is associated with. If you are the ruler, or there is no ruler, the card is free to play. If another player is the ruler, they may require you to pay them rupees equal to the number of tribes they have in that region in order to play the card. You may offer any number of rupees up to their number of tribes, including 0. The ruler will then accept or reject the offer. If the full cost is paid, it is automatically accepted. (Depending on the game state, players may wish to help each other out by waiving some or all of the bribe.)

If the criteria to play is met, you must play the card to either the far left or far right of your current Court row.

If the card is a '''Patriot''' which doesn't match your '''Loyalty''', you must change loyalty. See "Loyalty and Influence" below.

Finally, resolve all '''Impact Symbols'''.
|-
! Card Action
| After a card is in your Court, you can take one of the actions it provides. Some cards just provide a single action. However, if a card shows multiple icons, you must only pick one to use each turn.

Some actions are free, only taking an action point, whilst others have additional costs such as rupees.

When a card has spies on it, the owner must pay a bribe of rupees to the player with the most spies on the card to use that card's action(s). (i.e. if player 2 has 1 spy on card A, and player 3 has 2 spies on Card A, player 1 has to pay player 3 2 Rupees to use an action.)
|}

===Impact Symbols===

A Camel has you place a road coalition block on a border of the card's region

A Jezail has you place an army coalition block on the card's region

A Weighing Scales gives you 2 Rupees and reminds you that the card is Leveraged (see "Cards")

A Cylinder on Card has you place a Spy Cylinder on a matching region card in any player's court

A Crown has you place a Tribe Cylinder on the card's region

All the Suits have you to change the Favoured Suit

===Card Actions===

There are 6 main action types cards may provide

{|class="wikitable" style="width:auto;" border="2"
|-
! Tax
| Take Rupees equal to the card's rank from a player you share a region with (Economic Stars can counter this). If you can't tax another player, you can tax the market.
|-
! Gift
| Place a cylinder on a gift space at increasing cost of 2 then 4 then 6 Rupees
|-
! Build
| In regions you control, place up to three armies or roads or combination of, at a cost of 2 rupees each.
|-
! Move
| Based on the card's rank, gain that many movement points. A movement point moves either an army or spy. If moving a spy, it can move clockwise or counterclockwise from its current position, along the same player's court and even jumping to the next player's court. To move an army, there must be a loyal road on the border to move it from one region to the adjacent region.
|-
! Betray
| For 2 Rupees, discard a card from your or an opponent's court where you have a spy planted. After which, you may accept the discarded card as a Prize or let it be discarded (see "Loyalty and Influence"). This may also trigger the Leverage icon for the original owner.
|-
! Battle
| Pick either a card or a region. Remove tokens at that site equal to the rank of the battle card. Tribes, Spies, Roads, and Armies are all eligible for removal and, if allowed to remove more than one, they can be different. There are a few restrictions to this. You may not remove more than you have Armies or Spies at that site, i.e. a rank 2 battle card with 1 army/spy at the site can still only remove 1 token. Armies and Roads and Tribes of your loyalty are immune to removal (This prevents you weakening your current loyalty before switching loyalties).
|}

===Cleanup===

Check you aren't over Hand or Court Limit

If there are any Event cards in the left-most spot in the Market, discard them and resolve their Impact Event for all Players

If there were any rupees on these cards, they stay lingering in the empty spaces

Move all Market cards to the left, which allows cards to scoop up rupees in empty spaces even if they already had rupees of their own

Draw new Market cards into the now-empty rightmost spots in the Market

If one of the new cards was a Dominance, check to see if it's the only Dominance

If there is another Dominance, complete a Dominance Check, discard all Dominance cards, and draw new cards to fill the spaces

===Dominance Check===

To be successful, a single coalition must have the most blocks in play and four more than any other coalition.

If unsuccessful, the player with the most cylinders in play scores 3 points and the player with second most scores 1 point.

If successful, players in the winning coalition each score points based on how much influence they have. The player with the most scores 5, then 3, then 1. After which, remove all coalition blocks.

The fourth and final dominance check awards double points for every player involved.

In the case of a tie, tied players add up the victory points for the tied places and then divide that number by the number of tied players (rounding down). For example, in a dominance check where there is a winning coalition, if two players both have the second most amount of loyalty, they would each get 2 points (3 + 1 divided by 2).

===Court & Hand Limits===

During your turn, your court can contain any number of cards

However, at end of turn, your court can only have 3 + purple stars quantity of cards, any excess must be discarded

Likewise, your hand can contain any number of cards during the turn

However, at end of turn, your hand can only have 2 + blue stars quantity of cards, any excess must be discarded

===Stars===

<b style="color:#f91">★ Economic Stars</b> reduce taxation

<b style="color:#c23">★ Military Stars</b> provide a tie-breaker for end game

<b style="color:#929">★ Political Stars</b> increase size of Court

<b style="color:#07b">★ Intelligence Stars</b> increase size of Hand

===Loyalty and Influence===

Each player is always loyal to one of the three coalitions: {{pill|British|#423|#e8a9cc}}, {{pill|Russian|#440|#f5f079}} or {{pill|Afghan|#153|#56c1a5}}. This affects which cards you may want to play into your court. Consider carefully if and when you want to change loyalty, to take advantage of the game state and earn the most victory points.

Your loyalty is important in gaining victory points from Dominance Checks. If you are loyal to the Dominant Coalition when a Dominance Check is resolved, you are eligible to score victory points depending on your amount of influence compared to other players of the same loyalty. (You'll want to be loyal to the right coalition at the right time, which may require changing loyalties during the game.)

You change loyalty whenever you play a Patriot, or gain a prize, of a '''different''' loyalty. The loyalty of a Patriot is determined by the colour and symbol on the banner containing the card's name, or at the bottom of the card when gaining it as a prize. You may reject a prize in order to maintain your current loyalty. When you change loyalty, you lose all patriots, gifts, and prizes you currently have, before gaining the new patriot or prize which caused you to change.

Your influence to your coalition is calculated as 1, plus the number of patriots, prizes, and gifts you have. If you have the most influence in the Dominant Coalition when a Dominance Check is resolved, you will score the most points. (See "Dominance Check" above.)

===Ruling a Region===

To rule a region, you must have one tribe there and more ruling pieces than any other

Once a ruler, you have the following bonuses

• You may take the Build action

• You have Tax Privilege

• You can Extract Bribes

=== Overthrow Rule ===
If you lose your last tribe in a region, all ''Political'' cards you own from that region must be immediately discarded

Likewise, if you lose your last ''Political'' card from a region, you must immediately remove all of your tribes from that region

===Cards===

Cards may have multiple actions on them, but only one of these actions may be taken per turn

If you need to discard a card with a spy, this is returned to its owner

If you need to discard a card with the Leveraged icon, either two rupees or 1 card per rupee owed must be discarded too

If you lose the last tribe in a region, all political cards associated with that region are also discarded

If you lose the last political card associated with a region, all tribes in that region are also discarded

===Suits===

There are four suits in the game, and one suit is always shown as favoured, starting with {{pill|Political|#fff|#929}} but this will change throughout the game

{|class="wikitable" style="width:auto;" border="2"
|-
! style="background-color:#f91; color:#000" | Economic<br/><small>(gold)</small>
| Protect against taxation, manipulate rupees and piece movement
|-
! style="background-color:#c23; color:#000" | Military<br/><small>(red)</small>
| Manage armies and form coalitions
|-
! style="background-color:#929; color:#fff" | Political<br/><small>(purple)</small>
| Consolidate power and determine card playability
|-
! style="background-color:#07b; color:#fff" | Intelligence<br/><small>(blue)</small>
| Manage diplomacy and compromise enemies
|}

Actions on a card of the currently Favoured suit may be used as free actions, while still following the one action from each card per turn rule.

If {{pill|Military|#000|#c23}} is Favoured, purchasing cost of cards is doubled whilst Favoured

===Game End===

After a Dominance Check, if a player is at least 4 points ahead of everyone else, that player immediately wins

After the fourth Dominance Check card is resolved, the player with the most points wins

If there's a tie, the tie-breakers are: first, most Military stars, second most rupees, third cook a Chopan Kebab and the players vote on who cooked the best meal

Gamehelppaxpamir

2025-03-05T11:31:55Z

RicardoRix: /* Card Actions */

===Overview===

In Pax Pamir, each player assumes the role of a nineteenth-century Afghan leader attempting to forge a new state after the collapse of the Durrani Empire. Western histories often call this period “The Great Game” because of the role played by the Europeans who attempted to use Central Asia as a theater for their own rivalries

To win the game, have the most victory points after the final Dominance Check is resolved, or have a lead of at least 4 points after any Dominance Check is resolved.

If players are tied for victory points after the final Dominance Check, the player with the most red stars in their court among the tied players wins. If there is still a tie, the player with the most rupees among the tied players wins. If there is still a tie, whoever can cook the best chopan kebab wins.

===Starting Loyalty===

During setup, starting with a random player, each player chooses their starting loyalty. (See "Loyalty and Influence" below.)

After the last player has chosen their starting loyalty, that player will take the first turn. The game is now ready to play.

===Turn===

On your turn, you may take 0-2 actions (plus any free bonus actions) then perform Cleanup.

The three action types are: Purchase, Play, and Card Action:

{|class="wikitable" style="width:auto;" border="2"
|-
! Purchase
| Purchasing cards from the market is done via a skip penalty cost, i.e. the first card is free, if you wish to buy card 2, pay 1 rupee to card 1, if you wish to buy card 3, pay 1 rupee to card 1 and 1 rupee to card 2, and so on. If the card you purchased had rupees from before, you gain these rupees. (If when paying a skip cost, one or more spaces to pay the penalty to is empty, place the payment on the card on the opposite row first.)

If you purchase an event card, this is resolved then discarded, all other cards purchased go into your hand.
|-
! Play
| To play a card, check the region it is associated with. If you are the ruler, or there is no ruler, the card is free to play. If another player is the ruler, they may require you to pay them rupees equal to the number of tribes they have in that region in order to play the card. You may offer any number of rupees up to their number of tribes, including 0. The ruler will then accept or reject the offer. If the full cost is paid, it is automatically accepted. (Depending on the game state, players may wish to help each other out by waiving some or all of the bribe.)

If the criteria to play is met, you must play the card to either the far left or far right of your current Court row.

If the card is a '''Patriot''' which doesn't match your '''Loyalty''', you must change loyalty. See "Loyalty and Influence" below.

Finally, resolve all '''Impact Symbols'''.
|-
! Card Action
| After a card is in your Court, you can take one of the actions it provides. Some cards just provide a single action. However, if a card shows multiple icons, you must only pick one to use each turn.

Some actions are free, only taking an action point, whilst others have additional costs such as rupees.

When a card has spies on it, the owner must pay a bribe of rupees to the player with the most spies on the card to use that card's action(s). (i.e. if player 2 has 1 spy on card A, and player 3 has 2 spies on Card A, player 1 has to pay player 3 2 Rupees to use an action.)
|}

===Impact Symbols===

A Camel has you place a road coalition block on a border of the card's region

A Jezail has you place an army coalition block on the card's region

A Weighing Scales gives you 2 Rupees and reminds you that the card is Leveraged (see "Cards")

A Cylinder on Card has you place a Spy Cylinder on a matching region card in any player's court

A Crown has you place a Tribe Cylinder on the card's region

All the Suits have you to change the Favoured Suit

===Card Actions===

There are 6 main action types cards may provide

{|class="wikitable" style="width:auto;" border="2"
|-
! Tax
| Take Rupees equal to the card's rank from a player you share a region with (Economic Stars can counter this). If you can't tax another player, you can tax the market.
|-
! Gift
| Place a cylinder on a gift space at increasing cost of 2 then 4 then 6 Rupees
|-
! Build
| In a region you control, place up to three armies or roads or combination of, at a cost of 2 rupees each.
|-
! Move
| Based on the card's rank, gain that many movement points. A movement point moves either an army or spy. If moving a spy, it can move clockwise or counterclockwise from its current position, along the same player's court and even jumping to the next player's court. To move an army, there must be a loyal road on the border to move it from one region to the adjacent region.
|-
! Betray
| For 2 Rupees, discard a card from your or an opponent's court where you have a spy planted. After which, you may accept the discarded card as a Prize or let it be discarded (see "Loyalty and Influence"). This may also trigger the Leverage icon for the original owner.
|-
! Battle
| Pick either a card or a region. Remove tokens at that site equal to the rank of the battle card. Tribes, Spies, Roads, and Armies are all eligible for removal and, if allowed to remove more than one, they can be different. There are a few restrictions to this. You may not remove more than you have Armies or Spies at that site, i.e. a rank 2 battle card with 1 army/spy at the site can still only remove 1 token. Armies and Roads and Tribes of your loyalty are immune to removal (This prevents you weakening your current loyalty before switching loyalties).
|}

===Cleanup===

Check you aren't over Hand or Court Limit

If there are any Event cards in the left-most spot in the Market, discard them and resolve their Impact Event for all Players

If there were any rupees on these cards, they stay lingering in the empty spaces

Move all Market cards to the left, which allows cards to scoop up rupees in empty spaces even if they already had rupees of their own

Draw new Market cards into the now-empty rightmost spots in the Market

If one of the new cards was a Dominance, check to see if it's the only Dominance

If there is another Dominance, complete a Dominance Check, discard all Dominance cards, and draw new cards to fill the spaces

===Dominance Check===

To be successful, a single coalition must have the most blocks in play and four more than any other coalition.

If unsuccessful, the player with the most cylinders in play scores 3 points and the player with second most scores 1 point.

If successful, players in the winning coalition each score points based on how much influence they have. The player with the most scores 5, then 3, then 1. After which, remove all coalition blocks.

The fourth and final dominance check awards double points for every player involved.

In the case of a tie, tied players add up the victory points for the tied places and then divide that number by the number of tied players (rounding down). For example, in a dominance check where there is a winning coalition, if two players both have the second most amount of loyalty, they would each get 2 points (3 + 1 divided by 2).

===Court & Hand Limits===

During your turn, your court can contain any number of cards

However, at end of turn, your court can only have 3 + purple stars quantity of cards, any excess must be discarded

Likewise, your hand can contain any number of cards during the turn

However, at end of turn, your hand can only have 2 + blue stars quantity of cards, any excess must be discarded

===Stars===

<b style="color:#f91">★ Economic Stars</b> reduce taxation

<b style="color:#c23">★ Military Stars</b> provide a tie-breaker for end game

<b style="color:#929">★ Political Stars</b> increase size of Court

<b style="color:#07b">★ Intelligence Stars</b> increase size of Hand

===Loyalty and Influence===

Each player is always loyal to one of the three coalitions: {{pill|British|#423|#e8a9cc}}, {{pill|Russian|#440|#f5f079}} or {{pill|Afghan|#153|#56c1a5}}. This affects which cards you may want to play into your court. Consider carefully if and when you want to change loyalty, to take advantage of the game state and earn the most victory points.

Your loyalty is important in gaining victory points from Dominance Checks. If you are loyal to the Dominant Coalition when a Dominance Check is resolved, you are eligible to score victory points depending on your amount of influence compared to other players of the same loyalty. (You'll want to be loyal to the right coalition at the right time, which may require changing loyalties during the game.)

You change loyalty whenever you play a Patriot, or gain a prize, of a '''different''' loyalty. The loyalty of a Patriot is determined by the colour and symbol on the banner containing the card's name, or at the bottom of the card when gaining it as a prize. You may reject a prize in order to maintain your current loyalty. When you change loyalty, you lose all patriots, gifts, and prizes you currently have, before gaining the new patriot or prize which caused you to change.

Your influence to your coalition is calculated as 1, plus the number of patriots, prizes, and gifts you have. If you have the most influence in the Dominant Coalition when a Dominance Check is resolved, you will score the most points. (See "Dominance Check" above.)

===Ruling a Region===

To rule a region, you must have one tribe there and more ruling pieces than any other

Once a ruler, you have the following bonuses

• You may take the Build action

• You have Tax Privilege

• You can Extract Bribes

=== Overthrow Rule ===
If you lose your last tribe in a region, all ''Political'' cards you own from that region must be immediately discarded

Likewise, if you lose your last ''Political'' card from a region, you must immediately remove all of your tribes from that region

===Cards===

Cards may have multiple actions on them, but only one of these actions may be taken per turn

If you need to discard a card with a spy, this is returned to its owner

If you need to discard a card with the Leveraged icon, either two rupees or 1 card per rupee owed must be discarded too

If you lose the last tribe in a region, all political cards associated with that region are also discarded

If you lose the last political card associated with a region, all tribes in that region are also discarded

===Suits===

There are four suits in the game, and one suit is always shown as favoured, starting with {{pill|Political|#fff|#929}} but this will change throughout the game

{|class="wikitable" style="width:auto;" border="2"
|-
! style="background-color:#f91; color:#000" | Economic<br/><small>(gold)</small>
| Protect against taxation, manipulate rupees and piece movement
|-
! style="background-color:#c23; color:#000" | Military<br/><small>(red)</small>
| Manage armies and form coalitions
|-
! style="background-color:#929; color:#fff" | Political<br/><small>(purple)</small>
| Consolidate power and determine card playability
|-
! style="background-color:#07b; color:#fff" | Intelligence<br/><small>(blue)</small>
| Manage diplomacy and compromise enemies
|}

Actions on a card of the currently Favoured suit may be used as free actions, while still following the one action from each card per turn rule.

If {{pill|Military|#000|#c23}} is Favoured, purchasing cost of cards is doubled whilst Favoured

===Game End===

After a Dominance Check, if a player is at least 4 points ahead of everyone else, that player immediately wins

After the fourth Dominance Check card is resolved, the player with the most points wins

If there's a tie, the tie-breakers are: first, most Military stars, second most rupees, third cook a Chopan Kebab and the players vote on who cooked the best meal

Gamehelporionduel

2025-02-12T22:51:07Z

RicardoRix: /* 4 paths to victory: */

ORION Duel is an abstract board game for two players where the goal is to control cosmic space by connecting key elements.

=== Here's how it's played: ===
On their turn, players place one of their tiles on the board. You can place a tile on a galaxy or a black hole if the color of that tile connects to others of the same color already on the board.

=== 4 paths to victory: ===

* Connect opposite edges of the same color with a continuous flow of your color.
* Connect 4 galaxies with a continuous flow of your color.
* Connect 3 black holes with a continuous flow of your opponent's color. Strategic placement and clever connections are essential to win this cosmic battle.
* Opponent cannot place any tile
The game ends immediately when a player reaches one or more of the victory conditions. In case both players reach one or more of the victory conditions in the same time, the winner is the one who reached more winning conditions or the game continues if tied.

If no victory condition majority occurs, the game ends when all tiles have been placed. In this case the player with the largest value coming from: count of all the galaxy tokens minus the black hole tokens of each corresponding player. If the values are the same the game ends in a tie.

ORION Duel is a dynamic and engaging game that combines abstract strategy with a quest for victory. It's easy to learn, but mastering it requires skill and cunning.

In the case of a tie victory conditions, where play continues:

4 additional galaxies or 3 additional black holes (on same group or on a separated group) give an additional condition of victory/defeat.

Tips auntiemildred

2024-10-19T09:48:22Z

RicardoRix: Created page with "Beginner mistakes: - TASK cards: These are like upgrade tracks and can be extremely useful. Immediately after you place dice there like 1,2,3,4 you can use one of their effects (like modify 2 dice on CLEAN). Next round you leave just 1 dice there, you get back 1,2,3 but you can still use the 4 effect for every round. - INDULGENCY (Green cards): Your opponent can beat your dice and stop you scoring on 1-Pair, Full House, ect. - The pip value of the dice on PRANK\DODGE..."

Beginner mistakes:

- TASK cards: These are like upgrade tracks and can be extremely useful. Immediately after you place dice there like 1,2,3,4 you can use one of their effects (like modify 2 dice on CLEAN). Next round you leave just 1 dice there, you get back 1,2,3 but you can still use the 4 effect for every round.

- INDULGENCY (Green cards): Your opponent can beat your dice and stop you scoring on 1-Pair, Full House, ect.

- The pip value of the dice on PRANK\DODGE do not matter just the amount of dice.

- You do not need to DODGE unless your opponent has PRANK dice.

Gamehelpauntiemildred

2024-10-19T09:47:18Z

RicardoRix: TLDR rules

<big>'''TLDR rules''':</big>

<big>''Beginner mistakes'':</big>

- TASK cards: These are like upgrade tracks and can be extremely useful. Immediately after you place dice there like 1,2,3,4 you can use one of their effects (like modify 2 dice on CLEAN). Next round you leave just 1 dice there, you get back 1,2,3 but you can still use the 4 effect for every round.

- INDULGENCY (Green cards): Your opponent can beat your dice and stop you scoring on 1-Pair, Full House, ect.

- The pip value of the dice on PRANK\DODGE do not matter just the amount of dice.

- You do not need to DODGE unless your opponent has PRANK dice.

<h3>Overview</h3>
<p>
This is a competitive 1-versus-1, dice placement game for 2 players.
<br />
The aim of the game is to score 3 Victory Dice before your opponent.
<br />
Players take turns performing actions with their dice trying to score points and improve their position by gaining special abilities on the task cards.<br />
</p>

<h3>Mechanism: Cookie Points Scoring, Victory Dice and Winning.</h3>
<p>There are a few different ways you may score cookies. When doing so, you should increase the value of the black cookie die as much as possible but not beyond 6.
If the cookie die reaches 6 you score a Victory Die, the player must take any one of their dice (usually a die that has just been used to score) and place the die into a victory die space. Afterwards
reset the black cookie die to 1. If a player places their 3rd die into a victory point space then they win the game immediately.<br />
<i>Clarification:</i><br />
Excess points scored that take the cookie die beyond 6 are lost.<br />
Some card abilities allow a player to directly score a victory point dice, if so the black cookie die remains untouched.<br />
</p>

<h3>Mechanism: Dice spots and scallywags</h3>
<p>All cards have square spots to place your dice. These are worker placement spots and always have a border of the player colour to match the colour of your dice.
The Indulgency cards require multiple dice. The player ability cards have multiple spots but maybe used
one-at-a-time.<br />
You may place a die onto a set of task cards, and later activate this scallywag die by sliding the die to the grey square 'spot' which is rotated 45 degrees. You gain the associated reward as printed on the card.<br />
</p>

<h3>Mechanism: Tasks: Always, Wakeup and Reward effects</h3>
<p>
If you have a die on a task card then you can use the effect during your turn.<br />
ALWAYS: This type of effect occurs when appropriate, the die does not need to be activated (put into the used position) <br />
WAKEUP: Activate this die during the WAKEUP phase to use this ability. e.g. use LAUNDRY#4 and place all LAUNDRY dice into the used position.<br />
REWARD. Activate this ability during the ACTION phase. Place all the dice into the used position for this chore. e.g. use DIY#3 and place all DIY dice into the used position.<br />
</p>



<h3>How to Play</h3>
<p>
To decide which player goes first, each player shakes their dice, the player with the lowest total value starts on their first Player Round at Phase3:ACTION.
For the player starting last on their first turn only, they may choose to keep these dice values or shake for their Phase2:SHAKE.<br />
One player will be the active player for a complete Player Round, performing all of the phases detailed below.<br />
Once the player has completed all the phases their opponent then starts a new Player Round and becomes the active player.<br />
A player wins immediately when they score their 3rd Victory Dice.<br />
</p>

<h3>Player Round</h3>
<h4>Phase1: WAKEUP</h4>
<p>Perform all the steps below in any order, if required you may also repeat any step more than once. This is to stop a player being penalised for forgetting a particular step or playing them in the wrong order.<br />
Whenever you remove dice, then place them into your dice pool ready to be later rolled and used in the action phase.<br />
Each step is optional, unless stated as mandatory.
</p>
<ol type="A">

<li>MANDATORY: Remove all your dodge dice.</li>

<li>
Resolve Combat by evaluating the number slot on your PRANK card versus the number slot on your opponent's DODGE card.<br />
If the PRANK is higher, then the opponent must lose 1 point on their black cookie die. Note, it's not possible to go below 1. <br />
If the player has a die on a LAUNDRY task card, then the opponent must defend in this situation due to the ALWAYS effect and having only 1 point on their black cookie die. Failure to lose a cookie point, means they lose a victory point die instead. Failure to do that, you automatically win the game.<br />
If instead the active player has the same prank or lower then nothing happens. The opponent successfully dodges.<br />
Afterwards simply remove the PRANK dice and place them in your used dice pool.<br />
This action is optional, you may leave your prank dice alone, ready for the next round.<br />
</li>

<li>Score Indulgency dice: You remove dice from an Indulgency card and place the dice into your used dice pool. You may only score cookies if your dice are greater in value than any dice your opponent may have on the same card, otherwise you do not score any cookies.<br />
To clarify for the full house card, first compare the value of the row of 3, followed by the row of 2. e.g. 44422 beats 33366. The same is true for the 2 rows of 3 indulgency.<br />
With LAUNDRY#1 ALWAYS effect you may also score when you have exactly tied values with your opponent.<br />
You may repeat this action for other dice you may have on Indulgency cards.<br />
</li>

<li>
Remove all your task card scallywag dice, if each set is on or beyond the 'GOAL LINE', you gain 2 Victory dice.<br />
</li>

<li>You may only perform this step once per turn:<br />
Straighten all your scallywag dice on Task cards. Place them back onto your player colour spots.<br />
Afterwards you may perform any WAKEUP abilities, REWARD actions require the player to place the die back into the used position.<br />
The WAKEUP ALWAYS ability on COOK#1 does not require the die to become used.
</li>

<li>Collect as many of your dice as you wish from around the table and place them into your dice pool. You may only have 1 scallywag die left on a particular set of Task cards. For example,
on a previous turn you may have placed 4 dice, a 1,2,3 and 4 onto the DIY tasks, you must now collect the 1,2,3 dice and place them into your dice pool. This is mandatory.<br />
For all the other dice you have, it's NOT mandatory you take back the dice into your dice pool, but it's almost always beneficial to do so.
For example, the player may wish to block an indulgency card by not scoring and leaving the dice there, or if the player cannot score they may want to try and wait until the next round to do so.
</li>

</ol>

<h4>Phase2: SHAKE</h4>
<p>Shake all of your dice in the dice pool. You may now use them 1 at a time or as part of a group in the following action phase.
</p>

<h4>Phase3: ACTION</h4>
<p>Each die or group of dice may perform an action, a player may also activate their scallywag dice on task cards to gain rewards. The player is not limited to the order in which they can take the following actions.<br />
The player may take these actions for as many times as they have available dice and action spots before they end their turn and pass to the opponent.
</p>

<h5>ACTION: Player Abilities.</h5>
<p>
There are 2 modify spots on your dice pool card. Place a die into a free spot, and change a different die value in your pool by plus or minus 1. You may change a 1 value into a 6 or a 6 into a 1.
</p>

<h5>ACTION: Prank / Dodge.</h5>
<p>
You may place <b>ANY</b> valued die into these spots. Place the first die into the 1 slot, the 2nd die into the 2 slot, etc. <i>You do not place a 4 straight into the slot 4 postion.</i><br />
Other abilities may add dice, this is only possible if you already have at least 1 actual die here. Simply move the die into the next appropriate available slot.<br />
E.G. Task LAUNDRY#3 allows the player to add 1 prank die. The player moves a previously placed die in the 1 slot and moves it into the 2 slot.<br />
For visual clarity, you may change the value of the die to match its slot position.
</p>

<h5>ACTION: Indulgency Cards.</h5>
<p>
Place a group of dice on an Indulgency card that match the requirements. <br />E.G. The 'Full House' requires 5 dice comprising of 3 dice of the same value and a further 2 dice of a different value.
</p>

<h5>ACTION: Scallywagging, doing new tasks.</h5>
<p>
Place a die onto one of the task cards. You must match the value with level of the card. The first die to be placed must have a value of 1, and subsequent dice must be a value 1 higher than previously played.<br />
If this is the first scallywag die with a value of 1 on a set of task cards then place it in the straightened position.<br/>
These dice are referred to as scallywag dice.<br />
E.G. A player already has a 3 die value placed on the Clean#3 task card. They repeat this action twice and the player places a 4 value die onto the Clean#4 and a 5 value die onto the Clean#5 task card.<br />
When placing a die of value 2 or higher, place the new die in the same orientation as the die 1 lower, either straightened or used.
</p>

<h5>ACTION: Doing a task and getting a reward.</h5>
<p>
A player will normally only be able to perform one task from each set.<br />
A Player may move a previously placed scallywag die on a task card, and move it from the straightened position to the used position, repeat this for all other dice on task cards of this set.<br />
Afterwards take the reward from that set on a task card of equal or lesser value.
<br />
E.G. A player takes the 5 valued scallywag die on the Cook#5, rotates the die 45 degrees and slides it over to the grey box on the card into the used position. They also have a die that were previously placed on Cook#4 which also now becomes rotated.<br />
As a reward, they select the Cook#3 reward and re-roll 2 of their other dice that are yet to be used.
</p>

<h5>ACTION: Pass.</h5>
<p>
When you choose to pass, restart the Player Round with your opponent now being the active player.
</p>
<br />
<br />

Gamehelprolledwest

2024-09-23T08:56:08Z

RicardoRix:

Resources are first spent from the rolled resources then the banked resources.

The dice are 12 sided with 4 copper, 3 wood, 3 silver, and 2 gold.

=== AREAS: ===
Boomtown - (Top Left) - 3x3 grid of special bonus. Use only once per turn.

Shipping - (Top Right) - Bonus for the 3rd and final 5th spot. The higher (top) bonus is available only to the player that first reaches this place. The lower bonus goes to all other players reaching this point.

Contracts - (Middle Row) - Spend various copper, silver, gold. 5 Gold for 15 points being the highest. All contracts are unique so only can be claimed by 1 player in the whole game.

Claims - (Bottom) - Spend 1-2 wood to make camp/settlement. After you choose the terrain. 1 wood (camp), 2 wood (settlement). The far right of this track show bonus for coming 1st (top) and 2nd (bottom). Numbers on the track denote an immediate score.

=== TURN: ===
Roll 4 dice.

Choose Terrain: Select 1 dice as the terrain for a possible advancement on the 'Claims' track using additional wood. 1 Extra wood (camp), 2 Extra wood (settlement).

Main Phase where you can use your dice and any previously banked resources.

-- You may bank at most 1 dice in this phase to add to your banked resources.

=== OPPONENTS TURN: ===
- You get to bank 1 of the dice to add to your banked resources. Either copy a dice from the player to your left, or from your right, but just 1 dice total per round. There is an automated UI feature for this, if you prefer to automatically make this decision.

Gamehelpcommanderchess

2024-06-30T22:09:59Z

RicardoRix: /* Pieces and movement */

== Description ==
Commander Chess, or Cờ tư lệnh (literally "Chess Command") is a xiangqi variant created by Hải Quý Nguyễn.

Cờ tư lệnh is played with 38 pieces (19 per player) on a board that is 11 lines wide and 12 lines long. It is played on the vertices of the grid. The board is divided into two land territories by a river in the middle of the board. The three files on one side of the board form the sea.

== Object of the game ==
To win you must capture the opponent's Commander, or all units of a single division of the opponent's army:
*Sea - Both Navy ships. 2 pieces total.
*Land - Artillery, Tanks, Infantry. 6 pieces total.
*Air - Both Planes. 2 pieces total.
*Commander - 1 piece total.

== Pieces and movement ==

* All pieces have a range of movement. For example if a piece has a range of 3, then it may move 1, 2 or 3 spaces.
* All pieces move orthogonally (like a castle in standard chess), and some also move diagonally (like a bishop in standard chess).
* Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.
* Normally pieces block other pieces from moving but some pieces can Jump over other pieces.
* Some pieces can carry other pieces, a piece will embark onto the carrier and share the same location. Either piece can move to the other piece. See 'Stack moves'.
* Anti-Aircraft pieces provide a Ring-of-fire range. See 'Airspace' for more details.

{| class="wikitable" style="text-align:center;"
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Commander
| <div style="transform-origin:top left;transform:scale(0.125);width:50px;height:50px;">[[File:commander.png|Commander]]</div>
| C
| Land
| 10
| -
| -
| T,N,Af,HQ
| -
| -
| -
| If captured you lose.
Cannot goes past opponents C line-of-sight, and if you open a direct line-of-sight then you immediately lose.
If opponents pieces place the commander in check they gain 'hero' status.
The commander has protection inside the HQ from pieces[In,M,Aa,Ms].
|-

| Infantry
| <div style="transform-origin:top left;transform:scale(0.125);width:50px;height:50px;">[[File:infantry.png|Infantry]]</div>
| I
| Land
| 1
| -
| -
| T,N,Af
| -
| -
| -
| -

|-
| Tank
| <div style="transform-origin:top left;transform:scale(0.125);width:50px;height:50px;">[[File:tank.png|Tank]]</div>
| T
| Land
| 2
| -
| C,In,M
| N,Af
| -
| -
| -
| Only 1 tank maybe carried by a Navy on Plane.
May only carry 1 Infantry.

|-
| Militia
| <div style="transform-origin:top left;transform:scale(0.125);width:50px;height:50px;">[[File:militia.png|Militia]]</div>
| M
| Land
| 1
| yes
| -
| T,N,Af
| -
| -
| -
| -

|-
| Engineer
| <div style="transform-origin:top left;transform:scale(0.125);width:50px;height:50px;">[[File:engineer.png|Engineer]]</div>
| E
| Land
| 1
| -
| A, Aa, Ms
| -
| -
| -
| -
| May carry all pieces, but only the single space across the river.

|-
| Artillery
| <div style="transform-origin:top left;transform:scale(0.125);width:50px;height:50px;">[[File:artillery.png|Artillery]]</div>
| A
| Land
| 3
| yes
| -
| E
| to capture
| restriction
| -
| May jump over other pieces to capture.
May only cross the river at 2 BANK positions, but can capture and move across the sea.
May cross the sea if being carried.

|-
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Anti-Aircraft
| <div style="transform-origin:top left;transform:scale(0.125);width:50px;height:50px;">[[File:aa.png|Anti-Aircraft]]</div>
| Aa
| Land
| 1
| -
| -
| E
| -
| restriction
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Missile
| <div style="transform-origin:top left;transform:scale(0.125);width:50px;height:50px;">[[File:missile.png|Missile]]</div>
| Ms
| Land
| 2
| -
| -
| E
| -
| restriction
| 2
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Headquarters
| <div style="transform-origin:top left;transform:scale(0.25);width:50px;height:50px;">[[File:hq.png|Headquarters]]</div>
| HQ
| Land
| 0
| -
| C
| -
| -
| -
| -
| Does not move. Protects commander against [In,M,Aa,Ms]

|-
| Airforce
| <div style="transform-origin:top left;transform:scale(0.125);width:50px;height:50px;">[[File:plane.png|Airforce]]</div>
| Af
| Air
| 4
| yes
| T,In,M
| N
| yes
| -
| shot down
| May perform 'bombing' on an opponents land and sea pieces (not Af) and return to original position. See 'Airspace' for more details about being shot-down.

|-
| Navy
| <div style="transform-origin:top left;transform:scale(0.125);width:50px;height:50px;">[[File:navy.png|Navy]]</div>
| N
| Sea
| 4 (3)
| yes
| Af,T,In,M
| -
| yes
| -
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
Cannot diagonally move across land, but can fire gun (range 3) onto land pieces. If it can legally move to capture a piece, it does.
May move into the river but may not move onto or passed the bank.

|}

==Airspace==
When moving Planes '''[Af]''' may be shot down by the opponents anti-aircraft pieces.

Anti-Aircraft Pieces (range): '''[Ms]''' Missile(2), '''[Aa]''' Anti-Aircraft(1), '''[N]''' Navy(1).
''''Note'''': this range a circular radius.

A plane can commit kamikaze (capture the opponents piece) while staying in opponents anti-aircraft range; But if the plane leaves the ROF before reaching its target then it will be shot down, and will be unsuccessful in performing kamikaze. Please see image for cases of 2 Aa pieces.

[[File:4planes.png]]

The last '''[Af]''' plane committing kamikaze against the opponents last '''[N]''' Navy will win the game, even though the plane gets shot down.

A plane can get shot down during its own turn due to anti-aircraft pieces, when this happens a player cannot undo their turn.

==General rules==
Pieces capture as they move, and never jump, unless noted.

Pieces can cross the river but not occupy sea points unless noted.

'''[N]''' Navy piece may not cut across land when moving diagonally.

Pieces which check the opposing Commander are promoted, gaining 'hero' status and gain special abilities.

Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]''' Planes become stealth planes and are immune to ALL anti-aircraft.

When a land piece captures a '''[N]''' Navy at sea (not the coast), it must stay where it is.
When a '''[N]''' Navy captures a land piece in-land (not the coast), it must stay where it is.
If navy/land piece capture is at coast position, then the captured piece is replaced as usual.

== Stack: Pieces that can carry other pieces ==

'''Stacks''' are a group of pieces all at the same location. They may form groups of 2 or 3 pieces.

A stack of pieces can all move in a single turn. The stack may move as a single group or any piece from the stack may instead disembark and move elsewhere. Multiple captures are possible. See the user interface section for specific instructions on moving with the stack.

The following list are pieces that can be carriers followed by the pieces and restrictions of what they can carry:

'''Stacks''' maximum group of '''3 pieces''' (1 carrier and 2 other pieces)
* '''[N]''' Navy. May carry any combination of '''[C]''' Commander, '''[In]''' Infantry, '''[M]''' Militia, '''[T]''' Tank, '''[Af]''' Plane.
* '''[Af]''' Plane. May carry any combination of '''[C]''' Commander, '''[In]''' Infantry, '''[M]''' Militia, '''[T]''' Tank. '''but not 2 tanks'''.
* '''[T]''' Tank. May carry 1 '''[In]''' Infantry and 1 other piece. '''[C]''' Commander, '''[In]''' Infantry, '''[M]''' Militia.

'''Stacks''' maximum group of '''2 pieces''' (1 carrier and 1 other piece):
* '''[HQ]''' Headquarters, may hold '''[C]''' Commander. '''HQ does not move'''
* '''[E]''' Engineer, may carry heavy weapons '''[A]''' Artillery, '''[Aa]''' Anti-aircraft, '''[Ms]''' Missile '''Also specifically must be carried across the river from one side to the other.'''

== Examples of unusual play ==
Both navy and land pieces may be placed on the coast. A '''[N]''' Navy has a gun and may capture a land piece, if it does then it will only capture and move if this land piece is on the coast, otherwise the '''[N]''' Navy piece will remain still and capture.

'''[E]''' Engineers may only carry pieces from the limited number of river bank spaces, and move just the 1 space across the river. All other carried stack movements with the engineer are not allowed.

'''[A]''' Artillery can only jump over pieces when capturing another piece. Otherwise, they cannot jump over pieces.

On the Sea/Land border (coast) land pieces do not block the movement of a Navy piece and vice versa. So these pieces are not being jumped over. One is on land, the other is in the sea, but both are on the coast.

A commander that exposes himself to the opponents commander will immediately lose. (Line-of-sight).

Pieces that can jump and are not blocked by ANY piece. '''[Af]''' Plane, '''[N]''' Navy and the Navy gun. '''[A]''' Artillery(but only when capturing),

Without Enforce Check, it is possible to move into check, if you do this with your commander, then the opponents piece will become heroic.

== User Interface ==
* Some pieces stack on top of each other. It is recommended to use the squares to the right of the board from top to bottom. It automatically selects the stack to be moved as 1 group, if you would like to split up the pieces then user must select the pieces individually.
By selecting a box you will see the colour of the box change and the text.

GREEN means this is the selected piece and the piece you are currently moving.

RED means this piece is being carried and will not move separately.

GREY means this piece will move later after you have moved the current GREEN (selected) piece.

'Stay' will mean that the carried piece will disembark and stay in its current position.

* When playing with 'Enforce check' option a player needs to RESIGN if there are no playable moves.

* There are various 'confirm' options available from the context menu (3 lines, burger menu).

* You can play with (0,0) always at the bottom, available from the context menu (3 lines, burger menu).

Gamehelpauntiemildred

2024-02-23T00:08:51Z

RicardoRix:

<h3>Overview</h3>
<p>
This is a competitive 1-versus-1, dice placement game for 2 players.
<br />
The aim of the game is to score 3 Victory Dice before your opponent.
<br />
Players take turns performing actions with their dice trying to score points and improve their position by gaining special abilities on the task cards.<br />
</p>

<h3>Mechanism: Cookie Points Scoring, Victory Dice and Winning.</h3>
<p>There are a few different ways you may score cookies. When doing so, you should increase the value of the black cookie die as much as possible but not beyond 6.
If the cookie die reaches 6 you score a Victory Die, the player must take any one of their dice (usually a die that has just been used to score) and place the die into a victory die space. Afterwards
reset the black cookie die to 1. If a player places their 3rd die into a victory point space then they win the game immediately.<br />
<i>Clarification:</i><br />
Excess points scored that take the cookie die beyond 6 are lost.<br />
Some card abilities allow a player to directly score a victory point dice, if so the black cookie die remains untouched.<br />
</p>

<h3>Mechanism: Dice spots and scallywags</h3>
<p>All cards have square spots to place your dice. These are worker placement spots and always have a border of the player colour to match the colour of your dice.
The Indulgency cards require multiple dice. The player ability cards have multiple spots but maybe used
one-at-a-time.<br />
You may place a die onto a set of task cards, and later activate this scallywag die by sliding the die to the grey square 'spot' which is rotated 45 degrees. You gain the associated reward as printed on the card.<br />
</p>

<h3>Mechanism: Tasks: Always, Wakeup and Reward effects</h3>
<p>
If you have a die on a task card then you can use the effect during your turn.<br />
ALWAYS: This type of effect occurs when appropriate, the die does not need to be activated (put into the used position) <br />
WAKEUP: Activate this die during the WAKEUP phase to use this ability. e.g. use LAUNDRY#4 and place all LAUNDRY dice into the used position.<br />
REWARD. Activate this ability during the ACTION phase. Place all the dice into the used position for this chore. e.g. use DIY#3 and place all DIY dice into the used position.<br />
</p>



<h3>How to Play</h3>
<p>
To decide which player goes first, each player shakes their dice, the player with the lowest total value starts on their first Player Round at Phase3:ACTION.
For the player starting last on their first turn only, they may choose to keep these dice values or shake for their Phase2:SHAKE.<br />
One player will be the active player for a complete Player Round, performing all of the phases detailed below.<br />
Once the player has completed all the phases their opponent then starts a new Player Round and becomes the active player.<br />
A player wins immediately when they score their 3rd Victory Dice.<br />
</p>

<h3>Player Round</h3>
<h4>Phase1: WAKEUP</h4>
<p>Perform all the steps below in any order, if required you may also repeat any step more than once. This is to stop a player being penalised for forgetting a particular step or playing them in the wrong order.<br />
Whenever you remove dice, then place them into your dice pool ready to be later rolled and used in the action phase.<br />
Each step is optional, unless stated as mandatory.
</p>
<ol type="A">

<li>MANDATORY: Remove all your dodge dice.</li>

<li>
Resolve Combat by evaluating the number slot on your PRANK card versus the number slot on your opponent's DODGE card.<br />
If the PRANK is higher, then the opponent must lose 1 point on their black cookie die. Note, it's not possible to go below 1. <br />
If the player has a die on a LAUNDRY task card, then the opponent must defend in this situation due to the ALWAYS effect and having only 1 point on their black cookie die. Failure to lose a cookie point, means they lose a victory point die instead. Failure to do that, you automatically win the game.<br />
If instead the active player has the same prank or lower then nothing happens. The opponent successfully dodges.<br />
Afterwards simply remove the PRANK dice and place them in your used dice pool.<br />
This action is optional, you may leave your prank dice alone, ready for the next round.<br />
</li>

<li>Score Indulgency dice: You remove dice from an Indulgency card and place the dice into your used dice pool. You may only score cookies if your dice are greater in value than any dice your opponent may have on the same card, otherwise you do not score any cookies.<br />
To clarify for the full house card, first compare the value of the row of 3, followed by the row of 2. e.g. 44422 beats 33366. The same is true for the 2 rows of 3 indulgency.<br />
With LAUNDRY#1 ALWAYS effect you may also score when you have exactly tied values with your opponent.<br />
You may repeat this action for other dice you may have on Indulgency cards.<br />
</li>

<li>
Remove all your task card scallywag dice, if each set is on or beyond the 'GOAL LINE', you gain 2 Victory dice.<br />
</li>

<li>You may only perform this step once per turn:<br />
Straighten all your scallywag dice on Task cards. Place them back onto your player colour spots.<br />
Afterwards you may perform any WAKEUP abilities, REWARD actions require the player to place the die back into the used position.<br />
The WAKEUP ALWAYS ability on COOK#1 does not require the die to become used.
</li>

<li>Collect as many of your dice as you wish from around the table and place them into your dice pool. You may only have 1 scallywag die left on a particular set of Task cards. For example,
on a previous turn you may have placed 4 dice, a 1,2,3 and 4 onto the DIY tasks, you must now collect the 1,2,3 dice and place them into your dice pool. This is mandatory.<br />
For all the other dice you have, it's NOT mandatory you take back the dice into your dice pool, but it's almost always beneficial to do so.
For example, the player may wish to block an indulgency card by not scoring and leaving the dice there, or if the player cannot score they may want to try and wait until the next round to do so.
</li>

</ol>

<h4>Phase2: SHAKE</h4>
<p>Shake all of your dice in the dice pool. You may now use them 1 at a time or as part of a group in the following action phase.
</p>

<h4>Phase3: ACTION</h4>
<p>Each die or group of dice may perform an action, a player may also activate their scallywag dice on task cards to gain rewards. The player is not limited to the order in which they can take the following actions.<br />
The player may take these actions for as many times as they have available dice and action spots before they end their turn and pass to the opponent.
</p>

<h5>ACTION: Player Abilities.</h5>
<p>
There are 2 modify spots on your dice pool card. Place a die into a free spot, and change a different die value in your pool by plus or minus 1. You may change a 1 value into a 6 or a 6 into a 1.
</p>

<h5>ACTION: Prank / Dodge.</h5>
<p>
You may place <b>ANY</b> valued die into these spots. Place the first die into the 1 slot, the 2nd die into the 2 slot, etc. <i>You do not place a 4 straight into the slot 4 postion.</i><br />
Other abilities may add dice, this is only possible if you already have at least 1 actual die here. Simply move the die into the next appropriate available slot.<br />
E.G. Task LAUNDRY#3 allows the player to add 1 prank die. The player moves a previously placed die in the 1 slot and moves it into the 2 slot.<br />
For visual clarity, you may change the value of the die to match its slot position.
</p>

<h5>ACTION: Indulgency Cards.</h5>
<p>
Place a group of dice on an Indulgency card that match the requirements. <br />E.G. The 'Full House' requires 5 dice comprising of 3 dice of the same value and a further 2 dice of a different value.
</p>

<h5>ACTION: Scallywagging, doing new tasks.</h5>
<p>
Place a die onto one of the task cards. You must match the value with level of the card. The first die to be placed must have a value of 1, and subsequent dice must be a value 1 higher than previously played.<br />
If this is the first scallywag die with a value of 1 on a set of task cards then place it in the straightened position.<br/>
These dice are referred to as scallywag dice.<br />
E.G. A player already has a 3 die value placed on the Clean#3 task card. They repeat this action twice and the player places a 4 value die onto the Clean#4 and a 5 value die onto the Clean#5 task card.<br />
When placing a die of value 2 or higher, place the new die in the same orientation as the die 1 lower, either straightened or used.
</p>

<h5>ACTION: Doing a task and getting a reward.</h5>
<p>
A player will normally only be able to perform one task from each set.<br />
A Player may move a previously placed scallywag die on a task card, and move it from the straightened position to the used position, repeat this for all other dice on task cards of this set.<br />
Afterwards take the reward from that set on a task card of equal or lesser value.
<br />
E.G. A player takes the 5 valued scallywag die on the Cook#5, rotates the die 45 degrees and slides it over to the grey box on the card into the used position. They also have a die that were previously placed on Cook#4 which also now becomes rotated.<br />
As a reward, they select the Cook#3 reward and re-roll 2 of their other dice that are yet to be used.
</p>

<h5>ACTION: Pass.</h5>
<p>
When you choose to pass, restart the Player Round with your opponent now being the active player.
</p>
<br />
<br />
</div>

Gamehelpauntiemildred

2024-02-21T22:51:12Z

RicardoRix: Created page with "<h3>Overview</h3> <p> This is a competitive 1-versus-1, dice placement game for 2 players. <br /> The aim of the game is to score 3 Victory Dice before your opponent. <br /> Players take turns performing actions with their dice trying to score points and improve their position by gaining special abilities on the task cards.<br /> </p> <h3>Introduction</h3> <p>Your mad as a box of frogs Auntie Mildred has just passed away. This is devastating news as she made the best..."

<h3>Overview</h3>
<p>
This is a competitive 1-versus-1, dice placement game for 2 players.
<br />
The aim of the game is to score 3 Victory Dice before your opponent.
<br />
Players take turns performing actions with their dice trying to score points and improve their position by gaining special abilities on the task cards.<br />
</p>

<h3>Introduction</h3>
<p>Your mad as a box of frogs Auntie Mildred has just passed away. This is devastating news as she made the best cookies this side of Shrewsbury.
Her inheritance includes a long list of random tasks.
You need to perform these tasks to get your grubby little hands on her ingredients, recipe and instructions for the oven.
Put it all together and you can bake the best batch of cookies in the galaxy to win over Beatrice - the girl of your dreams, secure the job of a lifetime and save your soul from eternal damnation.
<br />
This may sound stupid, because all board game themes are stupid. This is no dragons and wizards fighting over which train to take gold to the land of victory points. No, heavenly cookies and hugs from grandma are infinitely more important. And it's time you found out.
</p>

<h3>Mechanism: Cookie Points Scoring, Victory Dice and Winning.</h3>
<p>There are a few different ways you may score cookies. When doing so, you should increase the value of the black cookie die as much as possible but not beyond 6.
If the cookie die reaches 6 you score a Victory Die, the player must take any one of their dice (usually a die that has just been used to score) and place the die into a victory die space. Afterwards
reset the black cookie die to 1. If a player places their 3rd die into a victory points space then they win the game immediately.<br />
<i>Clarification:</i><br />
Excess points scored that take the cookie die beyond 6 are lost.<br />
Some card abilities allow a player to directly score a victory point dice, if so the black cookie die remains untouched.<br />
</p>

<h3>Mechanism: Dice spots and scallywags</h3>
<p>All cards have square spots to place your dice. These are worker placement spots and always have a border of the player colour to match the colour of your dice.
The Indulgency cards require multiple dice. The player ability cards have multilple spots but maybe used
one-at-a-time.<br />
You may place a die onto a set of task cards, and later activate this scallywag die by sliding the die to the grey square 'spot' which is rotated 45 degrees. You gain the associated reward as printed on the card.<br />
</p>

<h3>Mechanism: Tasks: Always, Wakeup and Reward effects</h3>
<p>
If you have a die on a task card then you can use the effect during your turn.<br />
ALWAYS: This type of effect occurs when approripate, the die does not need to be activated (put into the used position) <br />
WAKEUP: Actiavte this die during the WAKEUP phase to use this ability. e.g. use LAUNDRY#4 and place all LAUNDRY dice into the used position.<br />
REWARD. Actiavte this ability during the ACTION phase. Place all the dice into the used poistion for this chore. e.g. use DIY#3 and place all DIY dice into the used position.<br />
</p>



<h3>How to Play</h3>
<p>
To decide which player goes first, each player shakes their dice, the player with the lowest total value starts on their first Player Round at Phase3:ACTION.
For the player starting last on their first turn only, they may choose to keep these dice values or shake for their Phase2:SHAKE.<br />
One player will be the active player for a complete Player Round, performing all of the phases detailed below.<br />
Once the player has completed all the phases their opponent then starts a new Player Round and becomes the active player.<br />
A player wins immediately when they score their 3rd Victory Dice.<br />
</p>

<h3>Player Round</h3>
<h4>Phase1: WAKEUP</h4>
<p>Perform all the steps below in any order, if required you may also repeat any step more than once. This is to stop a player being penalised for forgetting a particular step or playing them in the wrong order.<br />
</p>
<ol type="A">

<li>
Resolve Combat by evaluating the number of dice on your PRANK card versus the number of dice on your opponent's DODGE card.<br />
If the PRANK has higher slot position than the oppoents DODGE, then the opponent must lose 1 point on their black cookie die. Note, it's not possible to go below 1. <br />
If the player has a die on a LAUNDRY task card, then the opponent must defend in this situation due to the ALWAYS effect and having only 1 point on their black cookie die. Failure to lose a cookie point, means they lose a victory point die instead. Failure to do that, you automatically win the game.<br />
If the active player has the same or fewer dice then nothing happens.<br />
Afterwards simply remove the PRANK dice and place them in your used dice pool.<br />
This action is optional, you may leave your prank dice alone, ready for the next round.<br />
</li>

<li>Score Indulgency dice. You MAY remove dice from an Indulgency card and place the dice into your used dice pool. You may only score cookies if your dice are greater in value than any dice your opponent may have on the same card.<br />
With LAUNDRY#1 always effect you may also score when you have tied values with your opponent.<br />
You may repeat this action for other dice you many have on Indulgency cards.
</li>

<li>
Remove all you task card scallywag dice, if each set is on or beyond the 'GOAL LINE', you gain 2 Victory dice.<br />
</li>

<li>Straighten all your scallywag dice on Task cards. Place them back onto your player colour spots. Perform any WAKEUP abilities, these require the player to place the die into the used position and some of the abilities may require the dice to be removed.
(You may only perform this step once per turn).
</li>

<li>Collect as many of your dice as you wish from around the table and place them into your dice pool. You may only have 1 scallywag die left on a particular set of Task cards. For example,
on a previous turn you may have placed 4 dice, a 1,2,3 and 4 onto the DIY tasks, you must now collect the 1,2,3 dice and place them into your dice pool.<br />
For all the other dice you have, it's NOT mandatory you take back the dice into your dice pool, but it's almost always beneficial to do so.
For example, the player may wish to block an indulgency card by not scoring and leaving the dice there, or if the player cannot score they may want to try and wait until the next round to do so.
</li>

</ol>

<h4>Phase2: SHAKE</h4>
<p>Shake all of your dice in the dice pool. You may now use them 1 at a time or as part of a group in the following action phase.
</p>

<h4>Phase3: ACTION</h4>
<p>Each die or group of dice may perform an action, a player may also activate their scallywag dice on task cards to gain rewards. The player is not limited to the order in which they can take the following actions.<br />
The player may take these actions for as many times as they have available dice and action spots before they end their turn and pass to the opponent.
</p>

<h5>ACTION: Player Abilities.</h5>
<p>
There are 2 modify spots on your dice pool card. Place a die into a free spot, and change a different die value in your pool by plus or minus 1. You may change a 1 value into a 6 or a 6 into a 1.
</p>

<h5>ACTION: Prank / Dodge.</h5>
<p>
You may place <b>ANY</b> valued die into these spots. Place the first die into the 1 slot, the 2nd die into the 2 slot, etc. <i>You do not place a 4 straight into the slot 4 postion.</i><br />
Other abilities may add dice, this is only possible if you already have at least 1 actual die here. Simply move the die into the next appropriate available slot.<br />
E.G. Task LAUNDRY#3 allows the player to add 1 prank die. The player moves a previously placed die in the 1 slot and moves it into the 2 slot.<br />
For visual calirity, you may change the value of the die to match it's slot position.
</p>

<h5>ACTION: Indulgency Cards.</h5>
<p>
Place a group of dice on an Indulgency card that match the requirements. <br />E.G. The 'Full House' requires 5 dice comprising of 3 dice of the same value and a further 2 dice of a different value.
</p>

<h5>ACTION: Scallywagging, doing new tasks.</h5>
<p>
Place a die onto one of the task cards. You must match the value with level of the card. The first die to be placed must have a value of 1, and subsequent dice must be a value 1 higher than previously played.<br />
If this is the first scallywag die with a value of 1 on a set of taks cards then place it in the straightened position.<br/>
These dice are referred to as scallywag dice.<br />
E.G. A player already has a 3 die value placed on the Clean#3 task card. They repeat this action twice and the player places a 4 value die onto the Clean#4 and a 5 value die onto the Clean#5 task card.<br />
When placing a die of value 2 or higher, place the new die in the same orientation as the die 1 lower, either straighetned or used.
</p>

<h5>ACTION: Doing a task and getting a reward.</h5>
<p>
A player will normally only be able to perform one task from each set.<br />
A Player may move a previously placed scallywag die on a task card, and move it from the straightened position to the used position, repeat this for all other dice on task cards of this set.<br />
Afterwards take the reward from that set on a task card of equal or lesser value.
<br />
E.G. A player takes the 5 valued scallywag die on the Cook#5, rotates the die 45 degrees and slides it over to the grey box on the card into the used position. They also have a die that were previously placed on Cook#4 which also now becomes rotated.<br />
As a reward, they select the Cook#3 reward and re-roll 2 of their other dice that are yet to be used.
</p>

<h5>ACTION: Pass.</h5>
<p>
When you choose to pass, restart the Player Round with your opponent now being the active player.
</p>

Gamehelprolledwest

2023-09-12T15:39:39Z

RicardoRix: /* AREAS: */

Resources are first spent from the rolled resources then the banked resources.

The dice are 12 sided with 4 copper, 3 wood, 3 silver, and 2 gold.

=== AREAS: ===
Boomtown - (Top Left) - 3x3 grid of special bonus. Use only once per turn.

Shipping - (Top Right) - Bonus for the 3rd and final 5th spot. The higher (top) bonus is available only to the player that first reaches this place. The lower bonus goes to all other players reaching this point.

Contracts - (Middle Row) - Spend various copper, silver, gold. 5 Gold for 15 points being the highest. All contracts are unique so only can be claimed by 1 player in the whole game.

Claims - (Bottom) - Spend wood to make camp/settlement. 1 Extra wood (camp), 2 Extra wood (settlement). The far right of this track show bonus for coming 1st (top) and 2nd (bottom). Numbers on the track denote an immediate score.

=== TURN: ===
Roll 4 dice.

Choose Terrain: Select 1 dice as the terrain for a possible advancement on the 'Claims' track using additional wood. 1 Extra wood (camp), 2 Extra wood (settlement).

Main Phase where you can use your dice and any previously banked resources.

-- You may bank at most 1 dice in this phase to add to your banked resources.

=== OPPONENTS TURN: ===
- You get to bank 1 of the dice to add to your banked resources. Either copy a dice from the player to your left, or from your right, but just 1 dice total per round. There is an automated UI feature for this, if you prefer to automatically make this decision.

Gamehelprolledwest

2023-09-09T20:25:51Z

RicardoRix:

Resources are first spent from the rolled resources then the banked resources.

The dice are 12 sided with 4 copper, 3 wood, 3 silver, and 2 gold.

=== AREAS: ===
Boomtown - (Top Left) - 3x3 grid of special bonus.

Shipping - (Top Right) - Bonus for the 3rd and final 5th spot. The higher (top) bonus is available only to the player that first reaches this place. The lower bonus goes to all other players reaching this point.

Contracts - (Middle Row) - Spend various copper, silver, gold. 5 Gold for 15 points being the highest. All contracts are unique so only can be claimed by 1 player in the whole game.

Claims - (Bottom) - Spend wood to make camp/settlement. 1 Extra wood (camp), 2 Extra wood (settlement). The far right of this track show bonus for coming 1st (top) and 2nd (bottom). Numbers on the track denote an immediate score.

=== TURN: ===
Roll 4 dice.

Choose Terrain: Select 1 dice as the terrain for a possible advancement on the 'Claims' track using additional wood. 1 Extra wood (camp), 2 Extra wood (settlement).

Main Phase where you can use your dice and any previously banked resources.

-- You may bank at most 1 dice in this phase to add to your banked resources.

=== OPPONENTS TURN: ===
- You get to bank 1 of the dice to add to your banked resources. Either copy a dice from the player to your left, or from your right, but just 1 dice total per round. There is an automated UI feature for this, if you prefer to automatically make this decision.

Gamehelprolledwest

2023-09-04T10:09:34Z

RicardoRix:

Resources are first spent from the rolled resources then the banked resources.

The dice are 12 sided with 4 copper, 3 wood, 3 silver, and 2 gold.

=== AREAS: ===
Boomtown - (Top Left) - 3x3 grid of special bonus.

Shipping - (Top Right) - Bonus for the 3rd and final 5th spot. The higher (top) bonus is available only to the player that first reaches this place. The lower bonus goes to all other players reaching this point.

Contracts - (Middle Row) - Spend various copper, silver, gold. 5 Gold for 15 points being the highest. All contracts are unique so only can be claimed by 1 player in the whole game.

Claims - (Bottom) - Spend wood to make camp/settlement. 1 Extra wood (camp), 2 Extra wood (settlement). The far right of this track show bonus for coming 1st (top) and 2nd (bottom). Numbers on the track denote an immediate score.

=== TURN: ===
- Roll 4 dice.

- Choose Terrain: Select 1 dice as the terrain for a possible advancement on the 'Claims' track using additional wood. 1 Extra wood (camp), 2 Extra wood (settlement).

- Main Phase where you can use your dice and any previously banked resources.

-- You may bank at most 1 dice in this phase to add to your banked resources.

=== OPPONENTS TURN: ===
- You get to bank 1 of the dice to add to your banked resources. There is an automated UI feature for this, if you prefer to automatically make this decision.

Gamehelprolledwest

2023-09-04T10:09:10Z

RicardoRix: AREAS and TURN description.

Resources are first spent from the rolled resources then the banked resources.

The dice are 12 sided with 4 copper, 3 wood, 3 silver, and 2 gold.

=== AREAS: ===
Boomtown - (Top Left) - 3x3 grid of special bonus.

Shipping - (Top Right) - Bonus for the 3rd and final 5th spot. The higher (top) bonus is available only to the player that first reaches this place. The lower bonus goes to all other players reaching this point.

Contracts - (Middle Row) - Spend various copper, silver, gold. 5 Gold for 15 points being the highest. All contracts are unique so only can be claimed by 1 player in the whole game.

Claims - (Bottom) - Spend wood to make camp/settlement. 1 Extra wood (camp), 2 Extra wood (settlement). The far right of this track show bonus for coming 1st (top) and 2nd (bottom). Numbers on the track denote an immediate score.

=== TURN: ===
- Roll 4 dice.

- Choose Terrain: Select 1 dice as the terrain for a possible advancement on the 'Claims' track using additional wood. 1 Extra wood (camp), 2 Extra wood (settlement).

- Main Phase where you can use your dice and any previously banked resources.

-- You may bank at most 1 dice in this phase to add to your banked resources.

OPPONENTS TURN:

- You get to bank 1 of the dice to add to your banked resources. There is an automated UI feature for this, if you prefer to automatically make this decision.

Gamehelprolledwest

2023-09-04T09:19:57Z

RicardoRix:

Resources are first spent from the rolled resources then the banked resources.

The dice are 12 sided with 4 copper, 3 wood, 3 silver, and 2 gold.

AREAS:

Boomtown - (Top Left) - 3x3 grid of special bonus.

Shipping - (Top Right) - Bonus for the 3rd and final 5th spot.

Contracts - (Middle Row) - Spend various copper,silver, gold. 5 Gold for 15 points being the highest.

Claims - (Bottom) - Spend wood to make camp/settlement.

Gamehelpgaiaproject

2023-08-02T21:06:32Z

RicardoRix: /* Auctions for Drafting Factions */

== Factions ==
{| class="wikitable"
|- style="font-weight:bold; vertical-align:bottom;"
! '''Faction'''
! '''Planet Type'''
! '''Ability'''
! '''Planetary Institute'''
! '''Starting Research'''
! '''Basic Income'''
|-
| style="vertical-align:bottom;" | Terrans
| style="vertical-align:bottom;" | Terra
| style="background-color:rgba(255, 255, 255, 0.85);" | During the Gaia phase, move the power tokens in your Gaia area to area II of your power cycle instead of to area I.
| style="background-color:rgba(255, 255, 255, 0.85);" | During the Gaia phase, when you move power tokens from your Gaia area to area II of your power cycle, you may gain resources as if you were spending that much power to take free actions.
| style="vertical-align:bottom;" | Gaia Project
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Lantids
| style="vertical-align:bottom;" | Terra
| style="background-color:rgba(255, 255, 255, 0.85);" | When you take the “Build a Mine” action, you may build a mine on a planet colonized by an opponent (including the Lost Planet). Place your mine next to the opponent’s structure. You do not have to pay for terraforming, but you must still pay the mine’s cost. This mine counts as a normal mine in all ways except the following: this mine cannot be upgraded, and it does not count for any effects that relate to how many planet types or Gaia planets you have colonized.
| style="background-color:rgba(255, 255, 255, 0.85);" | Each time you build a mine on a planet colonized by an opponent, gain two knowledge.
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Xenos
| style="vertical-align:bottom;" | Desert
| style="background-color:rgba(255, 255, 255, 0.85);" | You place a third starting mine after all other starting mines have been placed.
| style="background-color:rgba(255, 255, 255, 0.85);" | You can form federations with a total power value of six instead of seven. You gain one Q.I.C. as income instead of one power token.
| style="vertical-align:bottom;" | Artificial Intelligence
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Gleens
| style="vertical-align:bottom;" | Desert
| style="background-color:rgba(255, 255, 255, 0.85);" | If you would ever gain Q.I.C., gain that much ore instead; once you have upgraded to the indicated academy, this effect no longer applies. To make a Gaia Planet habitable, pay one ore instead of one Q.I.C. Each time you build a mine on a Gaia Planet, gain two additional VP.
| style="background-color:rgba(255, 255, 255, 0.85);" | When you upgrade to the planetary institute, immediately gain the Gleens’ federation token (gaining the resources shown as normal). Gaining this tile counts as forming a federation. The planetary institute itself can still be part of a federation on the board.
| style="vertical-align:bottom;" | Navigation
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Taklons
| style="vertical-align:bottom;" | Swamp
| style="background-color:rgba(255, 255, 255, 0.85);" | The Brainstone counts as one power token (when starting a Gaia Project, building satellites, etc.), but you can spend it as if it were three power.
| style="background-color:rgba(255, 255, 255, 0.85);" | Each time you would charge power from “Passive Action: Charge Power,” you gain one power token. You can choose to gain the power before or after charging.
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Ambas
| style="vertical-align:bottom;" | Swamp
| style="vertical-align:bottom;" | NA
| style="background-color:rgba(255, 255, 255, 0.85);" | Once per round, as an action, you can swap your planetary institute with one of your mines on the game board (this can help you form a new federation). This has no impact on existing federations, even if their power value becomes less than seven. The swap does not count as a build or upgrade action; no VP or power can be gained from it.
| style="vertical-align:bottom;" | Navigation
| style="vertical-align:bottom;" | 1 Knowledge, 2 Ore
|-
| style="vertical-align:bottom;" | Hadsch Hallas
| style="vertical-align:bottom;" | Oxide
| style="vertical-align:bottom;" | NA
| style="background-color:rgba(255, 255, 255, 0.85);" | You can spend credits instead of power to take free actions that allow you to gain resources. Example: You can spend 3 credits to take the free action that allows you to gain one ore.
| style="vertical-align:bottom;" | Economy
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore, 3 Credits
|-
| style="vertical-align:bottom;" | Ivits
| style="vertical-align:bottom;" | Oxide
| style="background-color:rgba(255, 255, 255, 0.85);" | During setup, do not place mines. Instead, after all other players have placed mines (including the Xenos’ third mine), place your planetary institute on any red planet. You can only have one federation, but each time the power value of your federation becomes a multiple of 7, you may take the "Form A Federation" action again. You must discard Q.I.C. instead of power tokens to make satellites.
| style="background-color:rgba(255, 255, 255, 0.85);" | As a special action, place a space station on an accessible space that does not contain a planet or another space station. The accessibility of a space follows the same rules as the “Build a Mine” action.
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore, 1 QIC
|-
| style="vertical-align:bottom;" | Geodens
| style="vertical-align:bottom;" | Volcanic
| style="vertical-align:bottom;" | NA
| style="background-color:rgba(255, 255, 255, 0.85);" | The first time you build a mine on each planet type, gain 3 knowledge. (You do not gain knowledge for planet types you colonized before upgrading to your planetary institute.)
| style="vertical-align:bottom;" | Terraforming
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Bal T'aks
| style="vertical-align:bottom;" | Volcanic
| style="background-color:rgba(255, 255, 255, 0.85);" | You cannot advance in the “Navigation” research area, even if you take the tech tile below the “Navigation” research area. If you do take that tech tile, no advancement occurs. As a free action, you can move a Gaiaformer from a Gaiaformer space on your faction board to your Gaia area to gain one Q.I.C. Gaiaformers in your Gaia area are not available until the next Gaia phase. In the next Gaia phase, move any Gaiaformer in your Gaia area back to its Gaiaformer space.
| style="background-color:rgba(255, 255, 255, 0.85);" | You can now advance in the “Navigation” research area.
| style="vertical-align:bottom;" | Gaia Project
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Firaks
| style="vertical-align:bottom;" | Titanium
| style="vertical-align:bottom;" | NA
| style="background-color:rgba(255, 255, 255, 0.85);" | As an action, you can “downgrade” a research lab into a trading station and immediately advance one level in a research area of your choice. Advancing in a research area is explained on page 15. This counts as an “Upgrade to a Trading Station” action. You can later upgrade the trading station back into a research lab using the normal rules (including gaining a new tech tile).
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 2 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Bescods
| style="vertical-align:bottom;" | Titanium
| style="background-color:rgba(255, 255, 255, 0.85);" | The positions of your planetary institute and academies are swapped on your faction board, as is the income you gain for trading stations and research labs. As with the other factions, upgrading to an academy or a research lab allows you to gain a tech tile. Once per round, as an action, you can advance your lowest-level token in a research area (without paying knowledge). If multiple of your tokens are tied for the lowest level, choose which of the tied tokens to advance. To advance to level 5 this way, you must still flip a federation token as normal. Remember, only one player can reach level 5 of each research area.
| style="background-color:rgba(255, 255, 255, 0.85);" | The power value of your structures on gray planets (your home type) is increased by one (in addition to any other effects that increase their power value).
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Ore
|-
| style="vertical-align:bottom;" | Nevlas
| style="vertical-align:bottom;" | Ice
| style="background-color:rgba(255, 255, 255, 0.85);" | As a free action, you can move one power token from area III of your power cycle to your Gaia area to gain one knowledge (these power tokens follow the normal Gaia phase rules). This does not count as spending power.
| style="background-color:rgba(255, 255, 255, 0.85);" | You can spend power tokens in area III of your power cycle as if they were each two power. Otherwise, they count as one power token (when starting a Gaia Project, building satellites, etc.). When paying for a power action with an odd power cost (1, 3, 5, etc.), the unspent power is lost.
| style="vertical-align:bottom;" | Science
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Itars
| style="vertical-align:bottom;" | Ice
| style="background-color:rgba(255, 255, 255, 0.85);" | Each time you discard a power token from area II of your power cycle to move another power token to area III, place the discarded power token in your Gaia area instead of returning it to the supply.
| style="background-color:rgba(255, 255, 255, 0.85);" | During the Gaia phase, you can discard 4 power tokens from your Gaia area to immediately gain a tech tile (standard or advanced).
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore, 1 Power in Bowl I
|}

== Rules to Remember ==
* Starting Resources (before receiving income at the beginning of Round 1) - Credits: 15, Ore: 4, Knowledge: 3
* Resource Storage Limits - Credits: 30, Ore: 15, Knowledge: 15

==Actions==
# '''Build a Mine''' - This places a mine on the board, which usually give you ore as income. These mines must be at most a distance away from another building of yours equal to your navigation (the second track from the left). You must pay the cost of the mine. If it's a Gaia planet (green planets without gaiaformers on them), you must also pay one QIC. If it's some other planet type, you must pay additional ore - the exact cost is determined by your terraforming ability (the first track from the left) and the number of terraforming steps required to make the destination planet habitable for your faction.
# '''Start a Gaia Project''' - This allows you to transform Transdim planets (purple) into a Gaia planet. You can only do this if you have at least one available gaiaformer, which you can get as a result of the Gaia Project track (the fourth track from the left). To do this, move power tokens into the gaia section of your board. These tokens are not lost - you'll get them back as the last step of the income phase. At the start of the next round, these planets are now Gaia planets and you can build mines on them normally (without spending a QIC like you normally would to build on a Gaia Planet). The gaiaformer is removed (and sent to your faction board) only after you decide to build on these planets (they are "reserved" for you until then).
# '''Upgrade Existing Structure''' - Mines can be upgraded to Trading Stations, which usually produce credits - note that this has a cheaper cost if it's at most two units away from an opponent's structure. Trade Centers can be upgraded to either a Planetary Institute (which produces power and unlocks an ability specific to your faction) or Research Labs, which produce knowledge and allows you to immediately take a technology tile and advance on one of the tracks (if able, depending on your current position in the track). Research Labs can be upgraded to Academies, which also let you gain more technologies and produce either knowledge or QIC (or other resources depending on the faction).
# '''Form a Federation''' - This allows you to combine structures to gain more points. To do this, you need any cluster of structures whose total power level is 7 or more. This can include empty space as well, but for each empty space included this way, pay 1 power token from any bowl to create a satellite. For doing this, you gain a federation token, which gives you immediate points, some other resource bonus, and can later be spent to advance to the top position of a research track or gain advanced technology tiles.
# '''Research Progress''' - Spend 4 knowledge to advance on any track. The tracks are
##Terraforming, which improves your ability to terraform planets
##Navigation, which increases the range at which you can build structures
##Artificial Intelligence, which gives you more QIC
##Gaia Project, which allows you to start Gaia Projects on Transdim planets
##Economy, which increase your ore, credits, power charge income
##Science, which increases your knowledge income.
# '''Power and Q.I.C. Actions''' - Spend power or QICs to take any of the actions at the bottom of the research board. Each of these can be taken only once per round.
# '''Special Actions''' - Use any actions printed on booster tiles or your faction board. These can be taken only once per round.
# '''Pass''' - Select a new booster tile. Wait until all other players have passed too.
# '''Free Actions''' - Resource Conversions (or burn power to move power from Bowl 2 to Bowl 3).
[[Image:Gaia_Project_Free_Actions.JPG]]
# '''Passive Action''' - Charging power. Spend VP as necessary depending on the amount of power being charged. This is optional.

== Auctions for Drafting Factions ==

Each player submits the maximum amount they are willing to bid for each faction that has been drafted. Once all bids are submitted, a round-robin auction is automatically conducted in turn order until each player has the top bid on one faction. During the round-robin portion, each player automatically bids '''on the faction with the greatest difference between the faction's current bid and that player's maximum possible bid.'''

A typical '''automatic''' auction might look like this behind the scenes.

1) The first player bids zero VP on the faction that has their highest maximum bid (i.e. the faction they wanted most)

2) If the second player submitted the same top bid for two different factions, they'll automatically bid zero on the faction no one has picked yet. If they had placed a higher bid on the same faction as player 1, they would have increased that bid to one VP instead.

3) The third player looks at the current bids and compares those to their maximum bid. They'll automatically bid one higher on the faction with the greatest difference between their maximum bid and the current bid of that faction.

This is all resolved quickly and automatically behind the scenes. It's not uncommon for players to get factions for free if no one outbids them.

After the auction, all players are given VP so that the player that paid the most still starts with 10 VP to use during the game.

'''Here is a game log auction example for a 3 player game:'''

<u>In summary</u>:

PLAYER_A wins IVITS for 11, their maximum bid was 27 for IVITS,

PLAYER_B wins AMBAS for 0, their maximum bid was 10 for IVITS, 8 for AMBAS.

PLAYER_C wins TERRANS for 6, their maximum bid was16 for IVITS, 12 for AMBAS, 6 for TERRANS.

<u>some notable example lines from the log are:</u>

''<code>bids for factions start at 0, so a faction that haven't been bid on yet are essentially at -1VP for the calculation.</code>''

''**PLAYER_B switches from [IVITS] to [AMBAS] when the bid reaches 3 on IVITS, because 9>7 : AMBAS:8--1= '''9''' > IVITS:10-3='''7'''.''

<small><code>explanation: AMBAS: 8(PlayerB max bid for Ambas) - -1(current bid for Ambas) = 9 > IVITS: 10(PlayerB max bid for Ivits) - 3 (current bid for Ivits) =11</code></small>

''++PLAYER_C switches from [IVITS] to [AMBAS] when the bid reaches 5 on IVITS, because 12>11 : AMBAS:12-0='''12''' > IVITS:16-5='''11'''.''

<code><small>explanation: AMBAS: 12(PlayerC max bid for Ambas) - 0(current bid for Ambas) = 12 > IVITS: 16(PlayerC max bid for Ivits) - 5 (current bid for Ivits) =11</small></code>

<u>Actual Log:</u>

Players will automatically bid on the faction with the greatest gap between its current bid and the player's maximum bid

PLAYER_A bids 0 on [IVITS] (and is willing to bid up to 27 if needed)

PLAYER_B bids 1 on [IVITS], outbidding PLAYER_A. (The bid was 10 away from PLAYER_B's max bid of 10.)

PLAYER_C bids 2 on [IVITS], outbidding PLAYER_B. (The bid was 15 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 3 on [IVITS], outbidding PLAYER_C. (The bid was 25 away from PLAYER_A's max bid of 27.)

<nowiki>**</nowiki>PLAYER_B bids 0 on [AMBAS] (and is willing to bid up to 8 if needed)

PLAYER_C bids 4 on [IVITS], outbidding PLAYER_A. (The bid was 13 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 5 on [IVITS], outbidding PLAYER_C. (The bid was 23 away from PLAYER_A's max bid of 27.)

++PLAYER_C bids 1 on [AMBAS], outbidding PLAYER_B. (The bid was 12 away from PLAYER_C's max bid of 12.)

PLAYER_B bids 2 on [AMBAS], outbidding PLAYER_C. (The bid was 7 away from PLAYER_B's max bid of 8.)

PLAYER_C bids 6 on [IVITS], outbidding PLAYER_A. (The bid was 11 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 7 on [IVITS], outbidding PLAYER_C. (The bid was 21 away from PLAYER_A's max bid of 27.)

PLAYER_C bids 3 on [AMBAS], outbidding PLAYER_B. (The bid was 10 away from PLAYER_C's max bid of 12.)

PLAYER_B bids 4 on [AMBAS], outbidding PLAYER_C. (The bid was 5 away from PLAYER_B's max bid of 8.)

PLAYER_C bids 8 on [IVITS], outbidding PLAYER_A. (The bid was 9 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 9 on [IVITS], outbidding PLAYER_C. (The bid was 19 away from PLAYER_A's max bid of 27.)

PLAYER_C bids 5 on [AMBAS], outbidding PLAYER_B. (The bid was 8 away from PLAYER_C's max bid of 12.)

PLAYER_B bids 6 on [AMBAS], outbidding PLAYER_C. (The bid was 3 away from PLAYER_B's max bid of 8.)

PLAYER_C bids 10 on [IVITS], outbidding PLAYER_A. (The bid was 7 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 11 on [IVITS], outbidding PLAYER_C. (The bid was 17 away from PLAYER_A's max bid of 27.)

PLAYER_C bids 0 on [TERRANS] (and is willing to bid up to 6 if needed)

PLAYER_A wins the auction for [IVITS], spending [VP11]

PLAYER_C wins the auction for [TERRANS], spending [VP0]

PLAYER_B wins the auction for [AMBAS], spending [VP6]

All players receive [VP11] to ensure every player starts with at least 10 VP

== FAQ: General ==
Q: The booster tile is covering the conversions pane!

A: Check the preferences for other options for the booster tile.

Q: On iOS/Mac, the game is unresponsive.

A: The rendering engine on Apple devices deals very poorly with shadows. You'll get much better performance by setting the "Structure outlines" user preference to "No outlines." This is true regardless of which browser you're using.

Q: The game isn't allowing me to gain an advanced tech!

Q: The game isn't allowing me to advance to level 5 in a research track!

A: Both of these require a green federation tile. If you want to do both in a single action, you need two federation tiles.

Q: Why can't I upgrade?

A: This is usually because you lack the resources required to perform any available upgrades. Occasionally, it's because you lack the structures (because they are already on the board).

Q: Is there an option to undo my entire turn?

A: The game asks you to confirm or cancel after selecting a planet for a build/upgrade action, selecting planets for a federation, selecting a research track, passing, and so on. However, the developers have decided not to add an option to [https://boardgamearena.com/doc/BGA_Undo_policy undo your entire turn].

== FAQ: Conversions/Power ==
Q: Why do I only get one credit when I convert the Brainstone to credits?

A: If you want to get more than one credit, click on that button more than one time. The game does not do this automatically in order to allow you to allocate the spent power as desired.

Q: Why don't I get a chance to convert resources at the end of my turn?

Q: I should get the option to charge before or after gaining power!

A: There are options in the pull-down menu to the right to enable this under various conditions. By default, options are selected that improve the speed of the game.

Q: I have enough power to perform a power action, but it doesn't show up as available!

A: There are two possible reasons:
- You're lacking something else that would be required to perform that action. For example, if you don't have a mine and enough resources to build a mine, the terraforming actions won't show as available.
- Someone else has taken that action this round.

== FAQ: Federations ==

Q: Why can't I form this federation?

A: The federation rules are surprisingly intricate given the amount of space they occupy in the rulebook. See boardgamegeek.com/thread/2120375/official-federation-faq for more details.

Xenos: note that 7 power is required if you have not built your PI.

Bescods: note that power is only increased on titanium planets, and only after you have built your PI.

Ivits: Your existing federation starts out pre-selected. Your second federation must connect to your existing federation. Don't forget that Ivits spend QICs for satellites!

IMPORTANT: All bug reports regarding federations require the move number of the action and a screenshot showing which hexes are selected. Without these, it's nearly impossible to piece together exactly what's happening and when.

== FAQ: Faction-specific ==

Q: As Hadsch Hallas, how do I use my PI ability?

A: Once you've built your PI, the new conversion options will be available under the Convert menu.

Q: My faction's ability isn't working!

A: Make sure you're not confusing your passive ability with the ability granted by your Planetary Institute. If it's the PI ability, you'll need to have built your PI.

Q: As Nevlas, what happens to the remaining half a power when I convert?

A: Any "half power" not used is lost. Make sure you select all desired conversions before clicking confirm.

Q: How do I form a second federation as Ivits?

A: Your existing federation starts out pre-selected. Your second federation must connect to your existing federation. Don't forget that Ivits spend QICs for satellites!

Gamehelpgaiaproject

2023-08-02T21:02:39Z

RicardoRix: /* Auctions for Drafting Factions */

== Factions ==
{| class="wikitable"
|- style="font-weight:bold; vertical-align:bottom;"
! '''Faction'''
! '''Planet Type'''
! '''Ability'''
! '''Planetary Institute'''
! '''Starting Research'''
! '''Basic Income'''
|-
| style="vertical-align:bottom;" | Terrans
| style="vertical-align:bottom;" | Terra
| style="background-color:rgba(255, 255, 255, 0.85);" | During the Gaia phase, move the power tokens in your Gaia area to area II of your power cycle instead of to area I.
| style="background-color:rgba(255, 255, 255, 0.85);" | During the Gaia phase, when you move power tokens from your Gaia area to area II of your power cycle, you may gain resources as if you were spending that much power to take free actions.
| style="vertical-align:bottom;" | Gaia Project
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Lantids
| style="vertical-align:bottom;" | Terra
| style="background-color:rgba(255, 255, 255, 0.85);" | When you take the “Build a Mine” action, you may build a mine on a planet colonized by an opponent (including the Lost Planet). Place your mine next to the opponent’s structure. You do not have to pay for terraforming, but you must still pay the mine’s cost. This mine counts as a normal mine in all ways except the following: this mine cannot be upgraded, and it does not count for any effects that relate to how many planet types or Gaia planets you have colonized.
| style="background-color:rgba(255, 255, 255, 0.85);" | Each time you build a mine on a planet colonized by an opponent, gain two knowledge.
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Xenos
| style="vertical-align:bottom;" | Desert
| style="background-color:rgba(255, 255, 255, 0.85);" | You place a third starting mine after all other starting mines have been placed.
| style="background-color:rgba(255, 255, 255, 0.85);" | You can form federations with a total power value of six instead of seven. You gain one Q.I.C. as income instead of one power token.
| style="vertical-align:bottom;" | Artificial Intelligence
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Gleens
| style="vertical-align:bottom;" | Desert
| style="background-color:rgba(255, 255, 255, 0.85);" | If you would ever gain Q.I.C., gain that much ore instead; once you have upgraded to the indicated academy, this effect no longer applies. To make a Gaia Planet habitable, pay one ore instead of one Q.I.C. Each time you build a mine on a Gaia Planet, gain two additional VP.
| style="background-color:rgba(255, 255, 255, 0.85);" | When you upgrade to the planetary institute, immediately gain the Gleens’ federation token (gaining the resources shown as normal). Gaining this tile counts as forming a federation. The planetary institute itself can still be part of a federation on the board.
| style="vertical-align:bottom;" | Navigation
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Taklons
| style="vertical-align:bottom;" | Swamp
| style="background-color:rgba(255, 255, 255, 0.85);" | The Brainstone counts as one power token (when starting a Gaia Project, building satellites, etc.), but you can spend it as if it were three power.
| style="background-color:rgba(255, 255, 255, 0.85);" | Each time you would charge power from “Passive Action: Charge Power,” you gain one power token. You can choose to gain the power before or after charging.
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Ambas
| style="vertical-align:bottom;" | Swamp
| style="vertical-align:bottom;" | NA
| style="background-color:rgba(255, 255, 255, 0.85);" | Once per round, as an action, you can swap your planetary institute with one of your mines on the game board (this can help you form a new federation). This has no impact on existing federations, even if their power value becomes less than seven. The swap does not count as a build or upgrade action; no VP or power can be gained from it.
| style="vertical-align:bottom;" | Navigation
| style="vertical-align:bottom;" | 1 Knowledge, 2 Ore
|-
| style="vertical-align:bottom;" | Hadsch Hallas
| style="vertical-align:bottom;" | Oxide
| style="vertical-align:bottom;" | NA
| style="background-color:rgba(255, 255, 255, 0.85);" | You can spend credits instead of power to take free actions that allow you to gain resources. Example: You can spend 3 credits to take the free action that allows you to gain one ore.
| style="vertical-align:bottom;" | Economy
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore, 3 Credits
|-
| style="vertical-align:bottom;" | Ivits
| style="vertical-align:bottom;" | Oxide
| style="background-color:rgba(255, 255, 255, 0.85);" | During setup, do not place mines. Instead, after all other players have placed mines (including the Xenos’ third mine), place your planetary institute on any red planet. You can only have one federation, but each time the power value of your federation becomes a multiple of 7, you may take the "Form A Federation" action again. You must discard Q.I.C. instead of power tokens to make satellites.
| style="background-color:rgba(255, 255, 255, 0.85);" | As a special action, place a space station on an accessible space that does not contain a planet or another space station. The accessibility of a space follows the same rules as the “Build a Mine” action.
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore, 1 QIC
|-
| style="vertical-align:bottom;" | Geodens
| style="vertical-align:bottom;" | Volcanic
| style="vertical-align:bottom;" | NA
| style="background-color:rgba(255, 255, 255, 0.85);" | The first time you build a mine on each planet type, gain 3 knowledge. (You do not gain knowledge for planet types you colonized before upgrading to your planetary institute.)
| style="vertical-align:bottom;" | Terraforming
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Bal T'aks
| style="vertical-align:bottom;" | Volcanic
| style="background-color:rgba(255, 255, 255, 0.85);" | You cannot advance in the “Navigation” research area, even if you take the tech tile below the “Navigation” research area. If you do take that tech tile, no advancement occurs. As a free action, you can move a Gaiaformer from a Gaiaformer space on your faction board to your Gaia area to gain one Q.I.C. Gaiaformers in your Gaia area are not available until the next Gaia phase. In the next Gaia phase, move any Gaiaformer in your Gaia area back to its Gaiaformer space.
| style="background-color:rgba(255, 255, 255, 0.85);" | You can now advance in the “Navigation” research area.
| style="vertical-align:bottom;" | Gaia Project
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Firaks
| style="vertical-align:bottom;" | Titanium
| style="vertical-align:bottom;" | NA
| style="background-color:rgba(255, 255, 255, 0.85);" | As an action, you can “downgrade” a research lab into a trading station and immediately advance one level in a research area of your choice. Advancing in a research area is explained on page 15. This counts as an “Upgrade to a Trading Station” action. You can later upgrade the trading station back into a research lab using the normal rules (including gaining a new tech tile).
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 2 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Bescods
| style="vertical-align:bottom;" | Titanium
| style="background-color:rgba(255, 255, 255, 0.85);" | The positions of your planetary institute and academies are swapped on your faction board, as is the income you gain for trading stations and research labs. As with the other factions, upgrading to an academy or a research lab allows you to gain a tech tile. Once per round, as an action, you can advance your lowest-level token in a research area (without paying knowledge). If multiple of your tokens are tied for the lowest level, choose which of the tied tokens to advance. To advance to level 5 this way, you must still flip a federation token as normal. Remember, only one player can reach level 5 of each research area.
| style="background-color:rgba(255, 255, 255, 0.85);" | The power value of your structures on gray planets (your home type) is increased by one (in addition to any other effects that increase their power value).
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Ore
|-
| style="vertical-align:bottom;" | Nevlas
| style="vertical-align:bottom;" | Ice
| style="background-color:rgba(255, 255, 255, 0.85);" | As a free action, you can move one power token from area III of your power cycle to your Gaia area to gain one knowledge (these power tokens follow the normal Gaia phase rules). This does not count as spending power.
| style="background-color:rgba(255, 255, 255, 0.85);" | You can spend power tokens in area III of your power cycle as if they were each two power. Otherwise, they count as one power token (when starting a Gaia Project, building satellites, etc.). When paying for a power action with an odd power cost (1, 3, 5, etc.), the unspent power is lost.
| style="vertical-align:bottom;" | Science
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Itars
| style="vertical-align:bottom;" | Ice
| style="background-color:rgba(255, 255, 255, 0.85);" | Each time you discard a power token from area II of your power cycle to move another power token to area III, place the discarded power token in your Gaia area instead of returning it to the supply.
| style="background-color:rgba(255, 255, 255, 0.85);" | During the Gaia phase, you can discard 4 power tokens from your Gaia area to immediately gain a tech tile (standard or advanced).
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore, 1 Power in Bowl I
|}

== Rules to Remember ==
* Starting Resources (before receiving income at the beginning of Round 1) - Credits: 15, Ore: 4, Knowledge: 3
* Resource Storage Limits - Credits: 30, Ore: 15, Knowledge: 15

==Actions==
# '''Build a Mine''' - This places a mine on the board, which usually give you ore as income. These mines must be at most a distance away from another building of yours equal to your navigation (the second track from the left). You must pay the cost of the mine. If it's a Gaia planet (green planets without gaiaformers on them), you must also pay one QIC. If it's some other planet type, you must pay additional ore - the exact cost is determined by your terraforming ability (the first track from the left) and the number of terraforming steps required to make the destination planet habitable for your faction.
# '''Start a Gaia Project''' - This allows you to transform Transdim planets (purple) into a Gaia planet. You can only do this if you have at least one available gaiaformer, which you can get as a result of the Gaia Project track (the fourth track from the left). To do this, move power tokens into the gaia section of your board. These tokens are not lost - you'll get them back as the last step of the income phase. At the start of the next round, these planets are now Gaia planets and you can build mines on them normally (without spending a QIC like you normally would to build on a Gaia Planet). The gaiaformer is removed (and sent to your faction board) only after you decide to build on these planets (they are "reserved" for you until then).
# '''Upgrade Existing Structure''' - Mines can be upgraded to Trading Stations, which usually produce credits - note that this has a cheaper cost if it's at most two units away from an opponent's structure. Trade Centers can be upgraded to either a Planetary Institute (which produces power and unlocks an ability specific to your faction) or Research Labs, which produce knowledge and allows you to immediately take a technology tile and advance on one of the tracks (if able, depending on your current position in the track). Research Labs can be upgraded to Academies, which also let you gain more technologies and produce either knowledge or QIC (or other resources depending on the faction).
# '''Form a Federation''' - This allows you to combine structures to gain more points. To do this, you need any cluster of structures whose total power level is 7 or more. This can include empty space as well, but for each empty space included this way, pay 1 power token from any bowl to create a satellite. For doing this, you gain a federation token, which gives you immediate points, some other resource bonus, and can later be spent to advance to the top position of a research track or gain advanced technology tiles.
# '''Research Progress''' - Spend 4 knowledge to advance on any track. The tracks are
##Terraforming, which improves your ability to terraform planets
##Navigation, which increases the range at which you can build structures
##Artificial Intelligence, which gives you more QIC
##Gaia Project, which allows you to start Gaia Projects on Transdim planets
##Economy, which increase your ore, credits, power charge income
##Science, which increases your knowledge income.
# '''Power and Q.I.C. Actions''' - Spend power or QICs to take any of the actions at the bottom of the research board. Each of these can be taken only once per round.
# '''Special Actions''' - Use any actions printed on booster tiles or your faction board. These can be taken only once per round.
# '''Pass''' - Select a new booster tile. Wait until all other players have passed too.
# '''Free Actions''' - Resource Conversions (or burn power to move power from Bowl 2 to Bowl 3).
[[Image:Gaia_Project_Free_Actions.JPG]]
# '''Passive Action''' - Charging power. Spend VP as necessary depending on the amount of power being charged. This is optional.

== Auctions for Drafting Factions ==

Each player submits the maximum amount they are willing to bid for each faction that has been drafted. Once all bids are submitted, a round-robin auction is automatically conducted in turn order until each player has the top bid on one faction. During the round-robin portion, each player automatically bids '''on the faction with the greatest difference between the faction's current bid and that player's maximum possible bid.'''

A typical '''automatic''' auction might look like this behind the scenes.

1) The first player bids zero VP on the faction that has their highest maximum bid (i.e. the faction they wanted most)

2) If the second player submitted the same top bid for two different factions, they'll automatically bid zero on the faction no one has picked yet. If they had placed a higher bid on the same faction as player 1, they would have increased that bid to one VP instead.

3) The third player looks at the current bids and compares those to their maximum bid. They'll automatically bid one higher on the faction with the greatest difference between their maximum bid and the current bid of that faction.

This is all resolved quickly and automatically behind the scenes. It's not uncommon for players to get factions for free if no one outbids them.

After the auction, all players are given VP so that the player that paid the most still starts with 10 VP to use during the game.

'''Here is a game log auction example for a 3 player game:'''

<u>In summary</u>:

PLAYER_A wins IVITS for 11, their maximum bid was 27 for IVITS,

PLAYER_B wins AMBAS for 0, their maximum bid was 10 for IVITS, 8 for AMBAS.

PLAYER_C wins TERRANS for 6, their maximum bid was16 for IVITS, 12 for AMBAS, 6 for TERRANS.

<u>some notable example lines from the log are:</u>

''bids for factions start at 0, so a faction that haven't been bid on yet are essentially at -1VP for the calculation.''

''**PLAYER_B switches from [IVITS] to [AMBAS] when the bid reaches 3 on IVITS, because AMBAS:8--1= '''9''' > IVITS:10-3='''7'''.''

''AMBAS: 8(PlayerB max bid for Ambas) - -1(current bid for Ambas) = 9 > IVITS: 10(PlayerB max bid for Ivits) - 3 (current bid for Ivits) =11''

''++PLAYER_C switches from [IVITS] to [AMBAS] when the bid reaches 5 on IVITS, because AMBAS:12-0='''12''' > IVITS:16-5='''11'''.''

''AMBAS: 12(PlayerC max bid for Ambas) - 0(current bid for Ambas) = '''12''' > IVITS: 16(PlayerC max bid for Ivits) - 5 (current bid for Ivits) ='''11'''''

<u>Actual Log:</u>

Players will automatically bid on the faction with the greatest gap between its current bid and the player's maximum bid

PLAYER_A bids 0 on [IVITS] (and is willing to bid up to 27 if needed)

PLAYER_B bids 1 on [IVITS], outbidding PLAYER_A. (The bid was 10 away from PLAYER_B's max bid of 10.)

PLAYER_C bids 2 on [IVITS], outbidding PLAYER_B. (The bid was 15 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 3 on [IVITS], outbidding PLAYER_C. (The bid was 25 away from PLAYER_A's max bid of 27.)

<nowiki>**</nowiki>PLAYER_B bids 0 on [AMBAS] (and is willing to bid up to 8 if needed)

PLAYER_C bids 4 on [IVITS], outbidding PLAYER_A. (The bid was 13 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 5 on [IVITS], outbidding PLAYER_C. (The bid was 23 away from PLAYER_A's max bid of 27.)

++PLAYER_C bids 1 on [AMBAS], outbidding PLAYER_B. (The bid was 12 away from PLAYER_C's max bid of 12.)

PLAYER_B bids 2 on [AMBAS], outbidding PLAYER_C. (The bid was 7 away from PLAYER_B's max bid of 8.)

PLAYER_C bids 6 on [IVITS], outbidding PLAYER_A. (The bid was 11 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 7 on [IVITS], outbidding PLAYER_C. (The bid was 21 away from PLAYER_A's max bid of 27.)

PLAYER_C bids 3 on [AMBAS], outbidding PLAYER_B. (The bid was 10 away from PLAYER_C's max bid of 12.)

PLAYER_B bids 4 on [AMBAS], outbidding PLAYER_C. (The bid was 5 away from PLAYER_B's max bid of 8.)

PLAYER_C bids 8 on [IVITS], outbidding PLAYER_A. (The bid was 9 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 9 on [IVITS], outbidding PLAYER_C. (The bid was 19 away from PLAYER_A's max bid of 27.)

PLAYER_C bids 5 on [AMBAS], outbidding PLAYER_B. (The bid was 8 away from PLAYER_C's max bid of 12.)

PLAYER_B bids 6 on [AMBAS], outbidding PLAYER_C. (The bid was 3 away from PLAYER_B's max bid of 8.)

PLAYER_C bids 10 on [IVITS], outbidding PLAYER_A. (The bid was 7 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 11 on [IVITS], outbidding PLAYER_C. (The bid was 17 away from PLAYER_A's max bid of 27.)

PLAYER_C bids 0 on [TERRANS] (and is willing to bid up to 6 if needed)

PLAYER_A wins the auction for [IVITS], spending [VP11]

PLAYER_C wins the auction for [TERRANS], spending [VP0]

PLAYER_B wins the auction for [AMBAS], spending [VP6]

All players receive [VP11] to ensure every player starts with at least 10 VP

== FAQ: General ==
Q: The booster tile is covering the conversions pane!

A: Check the preferences for other options for the booster tile.

Q: On iOS/Mac, the game is unresponsive.

A: The rendering engine on Apple devices deals very poorly with shadows. You'll get much better performance by setting the "Structure outlines" user preference to "No outlines." This is true regardless of which browser you're using.

Q: The game isn't allowing me to gain an advanced tech!

Q: The game isn't allowing me to advance to level 5 in a research track!

A: Both of these require a green federation tile. If you want to do both in a single action, you need two federation tiles.

Q: Why can't I upgrade?

A: This is usually because you lack the resources required to perform any available upgrades. Occasionally, it's because you lack the structures (because they are already on the board).

Q: Is there an option to undo my entire turn?

A: The game asks you to confirm or cancel after selecting a planet for a build/upgrade action, selecting planets for a federation, selecting a research track, passing, and so on. However, the developers have decided not to add an option to [https://boardgamearena.com/doc/BGA_Undo_policy undo your entire turn].

== FAQ: Conversions/Power ==
Q: Why do I only get one credit when I convert the Brainstone to credits?

A: If you want to get more than one credit, click on that button more than one time. The game does not do this automatically in order to allow you to allocate the spent power as desired.

Q: Why don't I get a chance to convert resources at the end of my turn?

Q: I should get the option to charge before or after gaining power!

A: There are options in the pull-down menu to the right to enable this under various conditions. By default, options are selected that improve the speed of the game.

Q: I have enough power to perform a power action, but it doesn't show up as available!

A: There are two possible reasons:
- You're lacking something else that would be required to perform that action. For example, if you don't have a mine and enough resources to build a mine, the terraforming actions won't show as available.
- Someone else has taken that action this round.

== FAQ: Federations ==

Q: Why can't I form this federation?

A: The federation rules are surprisingly intricate given the amount of space they occupy in the rulebook. See boardgamegeek.com/thread/2120375/official-federation-faq for more details.

Xenos: note that 7 power is required if you have not built your PI.

Bescods: note that power is only increased on titanium planets, and only after you have built your PI.

Ivits: Your existing federation starts out pre-selected. Your second federation must connect to your existing federation. Don't forget that Ivits spend QICs for satellites!

IMPORTANT: All bug reports regarding federations require the move number of the action and a screenshot showing which hexes are selected. Without these, it's nearly impossible to piece together exactly what's happening and when.

== FAQ: Faction-specific ==

Q: As Hadsch Hallas, how do I use my PI ability?

A: Once you've built your PI, the new conversion options will be available under the Convert menu.

Q: My faction's ability isn't working!

A: Make sure you're not confusing your passive ability with the ability granted by your Planetary Institute. If it's the PI ability, you'll need to have built your PI.

Q: As Nevlas, what happens to the remaining half a power when I convert?

A: Any "half power" not used is lost. Make sure you select all desired conversions before clicking confirm.

Q: How do I form a second federation as Ivits?

A: Your existing federation starts out pre-selected. Your second federation must connect to your existing federation. Don't forget that Ivits spend QICs for satellites!

Gamehelpgaiaproject

2023-08-02T20:40:05Z

RicardoRix: /* Auctions for Drafting Factions */

== Factions ==
{| class="wikitable"
|- style="font-weight:bold; vertical-align:bottom;"
! '''Faction'''
! '''Planet Type'''
! '''Ability'''
! '''Planetary Institute'''
! '''Starting Research'''
! '''Basic Income'''
|-
| style="vertical-align:bottom;" | Terrans
| style="vertical-align:bottom;" | Terra
| style="background-color:rgba(255, 255, 255, 0.85);" | During the Gaia phase, move the power tokens in your Gaia area to area II of your power cycle instead of to area I.
| style="background-color:rgba(255, 255, 255, 0.85);" | During the Gaia phase, when you move power tokens from your Gaia area to area II of your power cycle, you may gain resources as if you were spending that much power to take free actions.
| style="vertical-align:bottom;" | Gaia Project
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Lantids
| style="vertical-align:bottom;" | Terra
| style="background-color:rgba(255, 255, 255, 0.85);" | When you take the “Build a Mine” action, you may build a mine on a planet colonized by an opponent (including the Lost Planet). Place your mine next to the opponent’s structure. You do not have to pay for terraforming, but you must still pay the mine’s cost. This mine counts as a normal mine in all ways except the following: this mine cannot be upgraded, and it does not count for any effects that relate to how many planet types or Gaia planets you have colonized.
| style="background-color:rgba(255, 255, 255, 0.85);" | Each time you build a mine on a planet colonized by an opponent, gain two knowledge.
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Xenos
| style="vertical-align:bottom;" | Desert
| style="background-color:rgba(255, 255, 255, 0.85);" | You place a third starting mine after all other starting mines have been placed.
| style="background-color:rgba(255, 255, 255, 0.85);" | You can form federations with a total power value of six instead of seven. You gain one Q.I.C. as income instead of one power token.
| style="vertical-align:bottom;" | Artificial Intelligence
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Gleens
| style="vertical-align:bottom;" | Desert
| style="background-color:rgba(255, 255, 255, 0.85);" | If you would ever gain Q.I.C., gain that much ore instead; once you have upgraded to the indicated academy, this effect no longer applies. To make a Gaia Planet habitable, pay one ore instead of one Q.I.C. Each time you build a mine on a Gaia Planet, gain two additional VP.
| style="background-color:rgba(255, 255, 255, 0.85);" | When you upgrade to the planetary institute, immediately gain the Gleens’ federation token (gaining the resources shown as normal). Gaining this tile counts as forming a federation. The planetary institute itself can still be part of a federation on the board.
| style="vertical-align:bottom;" | Navigation
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Taklons
| style="vertical-align:bottom;" | Swamp
| style="background-color:rgba(255, 255, 255, 0.85);" | The Brainstone counts as one power token (when starting a Gaia Project, building satellites, etc.), but you can spend it as if it were three power.
| style="background-color:rgba(255, 255, 255, 0.85);" | Each time you would charge power from “Passive Action: Charge Power,” you gain one power token. You can choose to gain the power before or after charging.
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Ambas
| style="vertical-align:bottom;" | Swamp
| style="vertical-align:bottom;" | NA
| style="background-color:rgba(255, 255, 255, 0.85);" | Once per round, as an action, you can swap your planetary institute with one of your mines on the game board (this can help you form a new federation). This has no impact on existing federations, even if their power value becomes less than seven. The swap does not count as a build or upgrade action; no VP or power can be gained from it.
| style="vertical-align:bottom;" | Navigation
| style="vertical-align:bottom;" | 1 Knowledge, 2 Ore
|-
| style="vertical-align:bottom;" | Hadsch Hallas
| style="vertical-align:bottom;" | Oxide
| style="vertical-align:bottom;" | NA
| style="background-color:rgba(255, 255, 255, 0.85);" | You can spend credits instead of power to take free actions that allow you to gain resources. Example: You can spend 3 credits to take the free action that allows you to gain one ore.
| style="vertical-align:bottom;" | Economy
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore, 3 Credits
|-
| style="vertical-align:bottom;" | Ivits
| style="vertical-align:bottom;" | Oxide
| style="background-color:rgba(255, 255, 255, 0.85);" | During setup, do not place mines. Instead, after all other players have placed mines (including the Xenos’ third mine), place your planetary institute on any red planet. You can only have one federation, but each time the power value of your federation becomes a multiple of 7, you may take the "Form A Federation" action again. You must discard Q.I.C. instead of power tokens to make satellites.
| style="background-color:rgba(255, 255, 255, 0.85);" | As a special action, place a space station on an accessible space that does not contain a planet or another space station. The accessibility of a space follows the same rules as the “Build a Mine” action.
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore, 1 QIC
|-
| style="vertical-align:bottom;" | Geodens
| style="vertical-align:bottom;" | Volcanic
| style="vertical-align:bottom;" | NA
| style="background-color:rgba(255, 255, 255, 0.85);" | The first time you build a mine on each planet type, gain 3 knowledge. (You do not gain knowledge for planet types you colonized before upgrading to your planetary institute.)
| style="vertical-align:bottom;" | Terraforming
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Bal T'aks
| style="vertical-align:bottom;" | Volcanic
| style="background-color:rgba(255, 255, 255, 0.85);" | You cannot advance in the “Navigation” research area, even if you take the tech tile below the “Navigation” research area. If you do take that tech tile, no advancement occurs. As a free action, you can move a Gaiaformer from a Gaiaformer space on your faction board to your Gaia area to gain one Q.I.C. Gaiaformers in your Gaia area are not available until the next Gaia phase. In the next Gaia phase, move any Gaiaformer in your Gaia area back to its Gaiaformer space.
| style="background-color:rgba(255, 255, 255, 0.85);" | You can now advance in the “Navigation” research area.
| style="vertical-align:bottom;" | Gaia Project
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Firaks
| style="vertical-align:bottom;" | Titanium
| style="vertical-align:bottom;" | NA
| style="background-color:rgba(255, 255, 255, 0.85);" | As an action, you can “downgrade” a research lab into a trading station and immediately advance one level in a research area of your choice. Advancing in a research area is explained on page 15. This counts as an “Upgrade to a Trading Station” action. You can later upgrade the trading station back into a research lab using the normal rules (including gaining a new tech tile).
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 2 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Bescods
| style="vertical-align:bottom;" | Titanium
| style="background-color:rgba(255, 255, 255, 0.85);" | The positions of your planetary institute and academies are swapped on your faction board, as is the income you gain for trading stations and research labs. As with the other factions, upgrading to an academy or a research lab allows you to gain a tech tile. Once per round, as an action, you can advance your lowest-level token in a research area (without paying knowledge). If multiple of your tokens are tied for the lowest level, choose which of the tied tokens to advance. To advance to level 5 this way, you must still flip a federation token as normal. Remember, only one player can reach level 5 of each research area.
| style="background-color:rgba(255, 255, 255, 0.85);" | The power value of your structures on gray planets (your home type) is increased by one (in addition to any other effects that increase their power value).
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Ore
|-
| style="vertical-align:bottom;" | Nevlas
| style="vertical-align:bottom;" | Ice
| style="background-color:rgba(255, 255, 255, 0.85);" | As a free action, you can move one power token from area III of your power cycle to your Gaia area to gain one knowledge (these power tokens follow the normal Gaia phase rules). This does not count as spending power.
| style="background-color:rgba(255, 255, 255, 0.85);" | You can spend power tokens in area III of your power cycle as if they were each two power. Otherwise, they count as one power token (when starting a Gaia Project, building satellites, etc.). When paying for a power action with an odd power cost (1, 3, 5, etc.), the unspent power is lost.
| style="vertical-align:bottom;" | Science
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore
|-
| style="vertical-align:bottom;" | Itars
| style="vertical-align:bottom;" | Ice
| style="background-color:rgba(255, 255, 255, 0.85);" | Each time you discard a power token from area II of your power cycle to move another power token to area III, place the discarded power token in your Gaia area instead of returning it to the supply.
| style="background-color:rgba(255, 255, 255, 0.85);" | During the Gaia phase, you can discard 4 power tokens from your Gaia area to immediately gain a tech tile (standard or advanced).
| style="vertical-align:bottom;" | NA
| style="vertical-align:bottom;" | 1 Knowledge, 1 Ore, 1 Power in Bowl I
|}

== Rules to Remember ==
* Starting Resources (before receiving income at the beginning of Round 1) - Credits: 15, Ore: 4, Knowledge: 3
* Resource Storage Limits - Credits: 30, Ore: 15, Knowledge: 15

==Actions==
# '''Build a Mine''' - This places a mine on the board, which usually give you ore as income. These mines must be at most a distance away from another building of yours equal to your navigation (the second track from the left). You must pay the cost of the mine. If it's a Gaia planet (green planets without gaiaformers on them), you must also pay one QIC. If it's some other planet type, you must pay additional ore - the exact cost is determined by your terraforming ability (the first track from the left) and the number of terraforming steps required to make the destination planet habitable for your faction.
# '''Start a Gaia Project''' - This allows you to transform Transdim planets (purple) into a Gaia planet. You can only do this if you have at least one available gaiaformer, which you can get as a result of the Gaia Project track (the fourth track from the left). To do this, move power tokens into the gaia section of your board. These tokens are not lost - you'll get them back as the last step of the income phase. At the start of the next round, these planets are now Gaia planets and you can build mines on them normally (without spending a QIC like you normally would to build on a Gaia Planet). The gaiaformer is removed (and sent to your faction board) only after you decide to build on these planets (they are "reserved" for you until then).
# '''Upgrade Existing Structure''' - Mines can be upgraded to Trading Stations, which usually produce credits - note that this has a cheaper cost if it's at most two units away from an opponent's structure. Trade Centers can be upgraded to either a Planetary Institute (which produces power and unlocks an ability specific to your faction) or Research Labs, which produce knowledge and allows you to immediately take a technology tile and advance on one of the tracks (if able, depending on your current position in the track). Research Labs can be upgraded to Academies, which also let you gain more technologies and produce either knowledge or QIC (or other resources depending on the faction).
# '''Form a Federation''' - This allows you to combine structures to gain more points. To do this, you need any cluster of structures whose total power level is 7 or more. This can include empty space as well, but for each empty space included this way, pay 1 power token from any bowl to create a satellite. For doing this, you gain a federation token, which gives you immediate points, some other resource bonus, and can later be spent to advance to the top position of a research track or gain advanced technology tiles.
# '''Research Progress''' - Spend 4 knowledge to advance on any track. The tracks are
##Terraforming, which improves your ability to terraform planets
##Navigation, which increases the range at which you can build structures
##Artificial Intelligence, which gives you more QIC
##Gaia Project, which allows you to start Gaia Projects on Transdim planets
##Economy, which increase your ore, credits, power charge income
##Science, which increases your knowledge income.
# '''Power and Q.I.C. Actions''' - Spend power or QICs to take any of the actions at the bottom of the research board. Each of these can be taken only once per round.
# '''Special Actions''' - Use any actions printed on booster tiles or your faction board. These can be taken only once per round.
# '''Pass''' - Select a new booster tile. Wait until all other players have passed too.
# '''Free Actions''' - Resource Conversions (or burn power to move power from Bowl 2 to Bowl 3).
[[Image:Gaia_Project_Free_Actions.JPG]]
# '''Passive Action''' - Charging power. Spend VP as necessary depending on the amount of power being charged. This is optional.

== Auctions for Drafting Factions ==

Each player submits the maximum amount they are willing to bid for each faction that has been drafted. Once all bids are submitted, a round-robin auction is automatically conducted in turn order until each player has the top bid on one faction. During the round-robin portion, each player automatically bids '''on the faction with the greatest difference between the faction's current bid and that player's maximum possible bid.'''

A typical '''automatic''' auction might look like this behind the scenes.

1) The first player bids zero VP on the faction that has their highest maximum bid (i.e. the faction they wanted most)

2) If the second player submitted the same top bid for two different factions, they'll automatically bid zero on the faction no one has picked yet. If they had placed a higher bid on the same faction as player 1, they would have increased that bid to one VP instead.

3) The third player looks at the current bids and compares those to their maximum bid. They'll automatically bid one higher on the faction with the greatest difference between their maximum bid and the current bid of that faction.

This is all resolved quickly and automatically behind the scenes. It's not uncommon for players to get factions for free if no one outbids them.

After the auction, all players are given VP so that the player that paid the most still starts with 10 VP to use during the game.

'''Here is a game log auction example for a 3 player game:'''

<u>In summary</u>:

PLAYER_A wins IVITS for 11, their maximum bid was 27 for IVITS,

PLAYER_B wins AMBAS for 0, their maximum bid was 10 for IVITS, 8 for AMBAS.

PLAYER_C wins TERRANS for 6, their maximum bid was16 for IVITS, 12 for AMBAS, 6 for TERRANS.

<u>some notable example lines from the log are:</u>

''**PLAYER_B switches from [IVITS] to [AMBAS] when the bid reaches 3 on IVITS (needs a bid of 4 to win), because AMBAS:8-0=8 > IVITS:10-4=6.''

''++PLAYER_C switches from [IVITS] to [AMBAS] when the bid reaches 5 on IVITS (needs a bid of 6 to win), because AMBAS:12-1=11 > IVITS:16-6=10.''

<u>Actual Log:</u>

Players will automatically bid on the faction with the greatest gap between its current bid and the player's maximum bid

PLAYER_A bids 0 on [IVITS] (and is willing to bid up to 27 if needed)

PLAYER_B bids 1 on [IVITS], outbidding PLAYER_A. (The bid was 10 away from PLAYER_B's max bid of 10.)

PLAYER_C bids 2 on [IVITS], outbidding PLAYER_B. (The bid was 15 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 3 on [IVITS], outbidding PLAYER_C. (The bid was 25 away from PLAYER_A's max bid of 27.)

<nowiki>**</nowiki>PLAYER_B bids 0 on [AMBAS] (and is willing to bid up to 8 if needed)

PLAYER_C bids 4 on [IVITS], outbidding PLAYER_A. (The bid was 13 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 5 on [IVITS], outbidding PLAYER_C. (The bid was 23 away from PLAYER_A's max bid of 27.)

++PLAYER_C bids 1 on [AMBAS], outbidding PLAYER_B. (The bid was 12 away from PLAYER_C's max bid of 12.)

PLAYER_B bids 2 on [AMBAS], outbidding PLAYER_C. (The bid was 7 away from PLAYER_B's max bid of 8.)

PLAYER_C bids 6 on [IVITS], outbidding PLAYER_A. (The bid was 11 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 7 on [IVITS], outbidding PLAYER_C. (The bid was 21 away from PLAYER_A's max bid of 27.)

PLAYER_C bids 3 on [AMBAS], outbidding PLAYER_B. (The bid was 10 away from PLAYER_C's max bid of 12.)

PLAYER_B bids 4 on [AMBAS], outbidding PLAYER_C. (The bid was 5 away from PLAYER_B's max bid of 8.)

PLAYER_C bids 8 on [IVITS], outbidding PLAYER_A. (The bid was 9 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 9 on [IVITS], outbidding PLAYER_C. (The bid was 19 away from PLAYER_A's max bid of 27.)

PLAYER_C bids 5 on [AMBAS], outbidding PLAYER_B. (The bid was 8 away from PLAYER_C's max bid of 12.)

PLAYER_B bids 6 on [AMBAS], outbidding PLAYER_C. (The bid was 3 away from PLAYER_B's max bid of 8.)

PLAYER_C bids 10 on [IVITS], outbidding PLAYER_A. (The bid was 7 away from PLAYER_C's max bid of 16.)

PLAYER_A bids 11 on [IVITS], outbidding PLAYER_C. (The bid was 17 away from PLAYER_A's max bid of 27.)

PLAYER_C bids 0 on [TERRANS] (and is willing to bid up to 6 if needed)

PLAYER_A wins the auction for [IVITS], spending [VP11]

PLAYER_C wins the auction for [TERRANS], spending [VP0]

PLAYER_B wins the auction for [AMBAS], spending [VP6]

All players receive [VP11] to ensure every player starts with at least 10 VP

== FAQ: General ==
Q: The booster tile is covering the conversions pane!

A: Check the preferences for other options for the booster tile.

Q: On iOS/Mac, the game is unresponsive.

A: The rendering engine on Apple devices deals very poorly with shadows. You'll get much better performance by setting the "Structure outlines" user preference to "No outlines." This is true regardless of which browser you're using.

Q: The game isn't allowing me to gain an advanced tech!

Q: The game isn't allowing me to advance to level 5 in a research track!

A: Both of these require a green federation tile. If you want to do both in a single action, you need two federation tiles.

Q: Why can't I upgrade?

A: This is usually because you lack the resources required to perform any available upgrades. Occasionally, it's because you lack the structures (because they are already on the board).

Q: Is there an option to undo my entire turn?

A: The game asks you to confirm or cancel after selecting a planet for a build/upgrade action, selecting planets for a federation, selecting a research track, passing, and so on. However, the developers have decided not to add an option to [https://boardgamearena.com/doc/BGA_Undo_policy undo your entire turn].

== FAQ: Conversions/Power ==
Q: Why do I only get one credit when I convert the Brainstone to credits?

A: If you want to get more than one credit, click on that button more than one time. The game does not do this automatically in order to allow you to allocate the spent power as desired.

Q: Why don't I get a chance to convert resources at the end of my turn?

Q: I should get the option to charge before or after gaining power!

A: There are options in the pull-down menu to the right to enable this under various conditions. By default, options are selected that improve the speed of the game.

Q: I have enough power to perform a power action, but it doesn't show up as available!

A: There are two possible reasons:
- You're lacking something else that would be required to perform that action. For example, if you don't have a mine and enough resources to build a mine, the terraforming actions won't show as available.
- Someone else has taken that action this round.

== FAQ: Federations ==

Q: Why can't I form this federation?

A: The federation rules are surprisingly intricate given the amount of space they occupy in the rulebook. See boardgamegeek.com/thread/2120375/official-federation-faq for more details.

Xenos: note that 7 power is required if you have not built your PI.

Bescods: note that power is only increased on titanium planets, and only after you have built your PI.

Ivits: Your existing federation starts out pre-selected. Your second federation must connect to your existing federation. Don't forget that Ivits spend QICs for satellites!

IMPORTANT: All bug reports regarding federations require the move number of the action and a screenshot showing which hexes are selected. Without these, it's nearly impossible to piece together exactly what's happening and when.

== FAQ: Faction-specific ==

Q: As Hadsch Hallas, how do I use my PI ability?

A: Once you've built your PI, the new conversion options will be available under the Convert menu.

Q: My faction's ability isn't working!

A: Make sure you're not confusing your passive ability with the ability granted by your Planetary Institute. If it's the PI ability, you'll need to have built your PI.

Q: As Nevlas, what happens to the remaining half a power when I convert?

A: Any "half power" not used is lost. Make sure you select all desired conversions before clicking confirm.

Q: How do I form a second federation as Ivits?

A: Your existing federation starts out pre-selected. Your second federation must connect to your existing federation. Don't forget that Ivits spend QICs for satellites!

Gamehelptinyfarms

2023-01-16T14:34:23Z

RicardoRix: /* Animals */

==Objective==
Each player places animals in their two farms, red and blue, over 10 rounds to gain the most points.

==Gameplay==
During a round, dice (equal to the number of players +1) are rolled. On your turn pick a die and move a farmer meeple clockwise that number of spaces and collect the two animals depicted on the space that you land on. If you move the red farmer, you place the animals on your red farm. If you move the blue farmer, you place the animals on your blue farm.

Farmers may not share the same space. If the number on the chosen die would land you on the other farmer's spot, you land one space farther.

A round ends once each player has placed two animals. With the remaining die, rotate the top wheel clockwise the number of spaces equal to the die value.

==Milk==
You have the option to spend milk to change the number on the die to be a lower or higher number. Each player starts with 3 milk cartons and any milk remaining by the end of the game is 1 point each.

==Scoring==
===Milk===
1 point per milk remaining
===Balance===
Aim to have an equal number of animals across your farms. Any difference in numbers is minus points. For example if you have 10 animals on your red farm and 8 animals on your blue farm, you will get -2 points.
===Animals===
Some animals are scored per farm:

*1 pig = 1 point
*2 pigs = 6 points (orthogonally adjacent)
*1 sheep = 0 points
*2 sheep = 2 points (orthogonally adjacent)
*3 sheep = 12 points (orthogonally adjacent)
*Each chicken = 2 points
*Cows and calves (orthogonally adjacent) are multiplied, e.g. 2 cows x 4 calves = 8 points. (N.B. Calf tiles have 2 calves on them!), so this example is 2 cow tokens and 2 calf tokens.

Other animals are scored across both farms:

*Whoever has most horses gets 10 points. The player with the second most gets 6 points (0 points in a 2-player game). In the case of a draw both players get 10 points and second place points do not apply.
*Forest friends (all other animals) give you 1/4/8/12/18 points per set of unique animals

Gamehelpyoxii

2022-12-24T16:51:00Z

RicardoRix: Created page with "===YOXII=== (2 players, from 8 years old) ===COMPONENTS=== 1 board with 37 squares 18 «White» pieces with values 1, 2, 3 and 4 18 «Red» pieces with values 1, 2, 3 and 4 1 «Totem» piece ===GAME PURPOSE=== To encircle the Totem and get more points than your opponent in the final count. ===SET UP=== Place the board between the two players and place the Totem on the center square. Players choose 18 pieces of one color and place them in front of them. ===HOW TO PLAY..."

===YOXII===
(2 players, from 8 years old)

===COMPONENTS===
1 board with 37 squares
18 «White» pieces with values 1, 2, 3 and 4
18 «Red» pieces with values 1, 2, 3 and 4
1 «Totem» piece

===GAME PURPOSE===
To encircle the Totem and get more points
than your opponent in the final count.

===SET UP===
Place the board between the two players and
place the Totem on the center square. Players
choose 18 pieces of one color and place them
in front of them.

===HOW TO PLAY===
The player with the white pieces plays first.
Players take turns moving the Totem on the
board and then placing one of their pieces
around it until it is completely surrounded and
immobilized.

===MOVING WITH THE TOTEM===
Each player in turn moves the Totem one
square directly around it in any direction as
long as the destination square is free.
Then they place one of their pieces on another
free square around the new position of the
Totem before handing over to the opponent.
Players can move the Totem several squares
by jumping over their own pieces, only if
they form a continuous line (diagonal or
orthogonal) leading to a free square (it is
therefore also possible to jump over only one
piece further if it leads to a free square).
It is forbidden to jump over the pieces of the
opponent’s color.

===POSITIONING OF PIECES===
Each time a player has moved the Totem, they
must place one of their pieces (of any value)
on one of the free squares directly around it (8
squares maximum).
The value of the pieces played is chosen by the
players according to the strategy they choose
to adopt.

===SPECIAL CASE===
When a player has just moved the Totem and
all the squares around it are occupied, they
must play one of their pieces on any other
available square of the board.

===END OF THE GAME===
The game ends when a player can no
longer move the Totem (at this point, the
Totem must be encircled). Each player
then calculates the total value of the pieces
surrounding the Totem (8 pieces in total).
The player with the most points wins the
game.

===GAME ENDS IN A TIE===
If both players have the same score when
the Totem is encircled, the player with the
most pawns of his color wins the game.
If both score and color are equal, the game
ends in a tie.

Gamehelpagricola

2022-10-13T13:46:34Z

RicardoRix: /* Harvest */

[[Category:Card games]]
== Overview ==
Welcome to the farm! In Agricola, you'll play as a family of farmers over the course of 14 rounds, steadily building up a mostly empty space into a vibrant farm full of grains, vegetables, and animals, as well as improve the living conditions of your family. Players assign their workers to various spaces on the action board to perform various actions to gather resources or improve your farm, most of which will be used to score points, but periodically, players need to pay food to support the family. The player with the most points after 14 rounds wins!

== Game Anatomy ==
Each player has access to various resources, including:
* Food, needed to feed your family periodically
* Wood, needed to build fences, stables, and many improvements
* Clay, needed to build most major improvements
* Stone, needed to build other major improvements
* Reed, needed for some improvements and home renovations
* Grain and vegetables, which can be planted in your farm
* A hand of cards, consisting of 7 minor improvements and 7 occupations
* Workers, represented by meeples. You start the game with 2 of these - the rest can be earned during the game.

Each player also has a board representing their farm, which contains:
* Your home, represented by different tiles. Your home size and what material it's made of limits the size of your family and scores you additional points at the end of the game.
* Fields. Grains and vegetables can be planted on these and are picked up during the harvest phase.
* Pastures and the animals housing them. Pastures are separated by fences, and animals inside them can be cooked for food or held onto for points.
* Any played improvements or occupations, most of which give various abilities, actions, or scoring opportunities as described on them.

The central board contains the following:
* The actions players can take. Note that each round, a new action will be added to this, in a loose order.
* The available major improvements. There are 10 improvement cards that can be built by different players, most of which center on collecting or converting food.

== Game Flow ==
Agricola takes place over the course of 14 rounds. At the beginning of each round, some spaces are stocked with resources, even if they already had resources from a previous round. A new action is added to the board - these new actions are loosely randomized by being sorted into 6 phases, then randomized within each phase. Then each player, starting with whoever has the first player token and proceeding clockwise around the table, takes a turn by placing one of their family members on a particular space, then immediately performing that action. Players can also, as a free action, organize their farm or make certain conversions as described on various improvements. Once they have finished resolving this action, it's the next player's turn. Players continue doing this until all players have placed all available workers. After certain rounds, a harvest phase happens. Then, a new round starts.

=== Starting Actions ===
These actions are available from the start of the game:
* Farm Expansion: Pay 2 reed and 5 of whatever material your house is currently made of (wood by default, to build a new room to your home. This new room must be connected to an existing room. Additionally, you can build a stable on any unoccupied space or a pasture. This stable can hold one animal, or doubles the capacity of an existing pasture.
* Meeting Place: Take the starting player token. This means you will be the first player to take actions in the next round. This is the only way this token moves - if no one takes this action in a particular round, the same player remains the first player again. Additionally, you may play one minor improvement card from your hand by paying the cost on it.
* Grain Seeds: Gain 1 grain.
* Farmland: Add one field to your farm. This field must be adjacent to at least one other field (if any exist).
* Lessons: Play an occupation card from your hand. The first of these cards is free, but all others cost 1 food.
* Day Laborer: Gain 2 food.
* Forest: This space accumulates 3 wood at the beginning of each round. Gain all wood on it.
* Clay Pit: This space accumulates 1 clay at the beginning of each round. Gain all clay on it.
* Reed Bank: This space accumulates 1 reed at the beginning of each round. Gain all reed on it.
* Fishing: This space accumulates 1 food at the beginning of each round. Gain all food on it.
(Other spaces may be available based on the player count.)

=== Actions In Phase 1 ===
These actions will be added at some point in rounds 1 through 4, but the exact order they appear will be random.
* Improvements: Gain 1 major or minor improvement by paying its cost.
* Fencing: Pay any number of wood to build the same number of fences, thus giving you pastures to house animals. You must completely enclose all spaces to be used as pastures this way.
* Sheep Market: This space accumulates 1 sheep at the beginning of each round. Gain all sheep on it.
* Grain Utilization: Sow any number of grains or vegetables in any empty fields. If you place a grain in a field, immediately add two more grains on the same field; you will receive one of them each harvest phase. Vegetables work the same way, except you only add one more vegetable to each field. Additionally, you may bake bread by converting grain to food; any cards that allow you to do this will tell you how much food you get this way.

=== Actions in Phase 2 ===
These actions will be added at some point in rounds 5 through 7, also in a random order.
* Western Quarry: This space accumulates 1 stone at the beginning of each round. Gain all stone on it.
* House Redevelopment: Upgrade a wooden house to a clay house, or a clay house to a stone house. To do this, pay 1 reed and 1 of whatever material you are upgrading to per room in your house. You must be able to upgrade the entire house - you can't upgrade individual rooms. Additionally, you may build a major or minor improvement after completing this.
* Wish For Children: Add a new worker to your family. This can't cause you to have more family members than rooms in your house. This worker will be able to take actions in the following round.

=== Actions in Phase 3 ===
These actions will be added at some point in rounds 8 and 9, in a random order.
* Vegetable Seeds: Gain 1 vegetable.
* Pig Market: This space accumulates 1 pig at the beginning of each round. Gain all pigs on it.

=== Actions in Phase 4 ===
These actions will be added at some point in round 10 and 11, in a random order.
* Eastern Quarry: This space accumulates 1 stone at the beginning of each round. Gain all stone on it.
* Cattle Market: This space accumulates 1 cow at the beginning of each round. Gain all cows on it.

=== Actions in Phase 5 ===
These actions will be added at some point in round 12 and 13, in a random order.
* Cultivation: Place one field in your farm, then sow any number of fields as you would have in Grain Utilization.
* Urgent Wish For Children: Add a new worker to your family. This works the same way as Wish For Children, except that the requirement about rooms in your house is ignored.

=== Actions in Phase 6 ===
This action will be added in round 14.
* Farm Redevelopment: Upgrade your house, then build fences. All rules House Redevelopment and Fencing apply.

=== Harvest ===
A harvest phase happens immediately after each phase (that is, after rounds 4, 7, 9, 11, 13, and 14). In each harvest, the following things happen in order:
* FIELD PHASE: Each player takes one grain or vegetable from each field.
* FEEDING PHASE: Each player pays 2 food for each worker (3 in the solo game, or just 1 if the worker was just added this round and never took an action). Players may freely perform any free actions or exchanges to meet this cost. For each food players are unable to pay, they take a Beggar card, worth -3 points at the end of the game.
* BREEDING PHASE: If you have at least 2 sheep, pigs, or cows, you gain a new animal of that type. You may immediately rearrange any animals in your farm to place these, but may not convert these to food.

== End Of The Game ==
The game ends after the 14th round and its attached harvest phase. After that, players score for their farm.

The player with the most points wins!

==Scoring==

-1 point 1 point 2 points 3 points 4 points
|----------|----------|----------|----------|----------|
Field Tiles | 0-1 | 2 | 3 | 4 | 5+ |
Pastures | 0 | 1 | 2 | 3 | 4+ |
|----------|----------|----------|----------|----------|
Grain | 0 | 1-3 | 4-5 | 6-7 | 8+ |
Vegetables | 0 | 1 | 2 | 3 | 4+ |
|----------|----------|----------|----------|----------|
Sheep | 0 | 1-3 | 4-5 | 6-7 | 8+ |
Wild Boar | 0 | 1-2 | 3-4 | 5-6 | 7+ |
Cattle | 0 | 1 | 2-3 | 4-5 | 6+ |
|----------|----------|----------|----------|----------|

_________________________________________________
| |
| -1 point per unused space in the Farmyard |
| 1 point per fenced stable & per Clay hut room |
| 2 points per Stone house room |
| 3 points per family member |
| |
| -3 points per begging token |
| _ points printed on cards |
| _ bonus points |
| |
-------------------------------------------------

Stock

2022-07-14T14:22:22Z

RicardoRix: /* Layout */

{{Studio_Framework_Navigation}}

== Overview ==

'''Stock''' is a javascript component that you can use in your game interface to display a set of elements of the same size that need to be arranged in single or multiple lines.

Stock is very flexible and is the most used component in BGA games.

Examples of stock use cases:

* Display a set of cards, typically hands (examples: ''Hearts'', ''Seasons'', ''The Boss'', ''Race for the Galaxy'').
* Display items in player panels (examples: ''Takenoko'', ''Amyitis'', ...)
* ... Many other situations. For example, black dice and cubes on cards in ''Troyes'' are displayed with stock components.

Using stock:

* Your items are arranged nicely and sorted by type.
* When adding or removing items to a set, all items slide smoothly to their new position in the set.
* Selecting and unselecting items are built-in functions.
* You don't have to worry about inserting/removing HTML code; the entire life cycle of the stock is managed by the component.

== Using stock: a simple example ==

Let's have a look on how the stock is used in the game ''Hearts'' to display a hand of standard cards.

First, don't forget to add "ebg/stock" as a dependency in your js file:

<pre>
define([
"dojo","dojo/_base/declare",
"ebg/core/gamegui",
"ebg/counter",
"ebg/stock" /// <==== HERE
],
</pre>

The stock is initialized in the Javascript "setup" method like this:

<pre>
// Player hand
this.playerHand = new ebg.stock();
this.playerHand.create( this, $('myhand'), this.cardwidth, this.cardheight );
</pre>

Explanations:
* We create a new stock object for the player hand.
* As parameters of the "create" method, we provide the width/height of an item (a card), and the div container "myhand" - which is a simple empty "div" element defined in our HTML template (.tpl).

Then, we must tell the stock what 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 a "CSS sprite" image named "cards.jpg" with the cards arranged in 4 rows and 13 columns.

Here's how we tell stock what items to display:

<pre>
// Specify that there are 13 images per row in the CSS sprite image
this.playerHand.image_items_per_row = 13;

// Create card types:
for( var color=1;color<=4;color++ )
{
for( var value=2;value<=14;value++ )
{
// Build card type id
var card_type_id = this.getCardUniqueId( color, value );
this.playerHand.addItemType( card_type_id, card_type_id, g_gamethemeurl+'img/cards.jpg', card_type_id );
}
}
</pre>

Explanation:

* 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.
* Then for the 4x13 cards, we call the "addItemType" method that creates 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.

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

From now on, if we need to add a card - for example, the 5 of Hearts - to a player's hand, we can do this:

<pre>
this.playerHand.addToStock( this.getCardUniqueId( 2 /* 2=hearts */, 5 ) );
</pre>

In reality, cards have some IDs, which are useful to manipulate them. This is the reason we are using "addToStockWithId" instead:

<pre>
this.playerHand.addToStockWithId( this.getCardUniqueId( 2 /* 2=hearts */, 5 ), my_card_id );
</pre>

If afterwards we want to remove this card from the stock:

<pre>
this.playerHand.removeFromStockById( my_card_id );
</pre>

== Complete stock component reference ==

=== Creation ===

'''create( page, container_div, item_width, item_height ):'''

With create, you create a new stock component.

Parameters:
* page: the container page. Usually: "this".
* container_div: the container "div" element (an empty div element in your template, with an id).
* width and height (in pixels) for the stock component.

(See ''Hearts'' example above).

'''addItemType( type, weight, image, image_position ):'''

Define a new type of item and add it to the stock.

This is mandatory to define a new item type before adding it to the stock. Example: if you want to have a stock contain cubes of 3 different colors, you must add 3 item types (one for each color).

Parameters:
* {int} type: id of the type to add. You can choose any positive integer. All item types must have distinct IDs.
* {int} 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.
* {string} image: URL of item image. Most of the time, you will use a CSS sprite for stock items, so you have to specify CSS sprite image here.

Be careful: you must specify the image url as this:

<pre>
g_gamethemeurl+'img/yourimage.png'
</pre>

* image_position: if "image" 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 "0" for the first cube image, 1 for the second, 2 for the third.

''Important'': if there is more than one line of items in your CSS sprite, you must specify how many items per line you have in your CSS sprite, see image_items_per_row below:

'''image_items_per_row'''
Class member to set number of columns in css sprite (or how many items per row). I.e. if you sprite is 4 cards horizontally and 6 vertically, you have to set it to 4.
<pre>
// Specify that there are 10 image items per row in images used in "myStockObject" control.
this.myStockObject.image_items_per_row = 4;
</pre>

=== Add/Remove items ===

'''addToStock( type, from )'''

Add an item to the stock, with the specified type, but without a unique ID.

To make your life easier, in most cases we suggest you use '''addToStockWithId''' in order to give an ID to the item added. '''addToStock''' is suitable when you are using a stock to control items that are generic game materials that don't need to be tracked individually (example: a bunch of money tokens).

Parameters:
* type: ID of the item type to use (as specified in "addItemType")
* from: OPTIONAL: if you specify an HTML item here, the item will appear on this item and will be slid to its position on the stock item.

Example:
<pre>
// Add a money token to the "player money" stock.
// The money token will appear on "player_id" player panel and will move to its position.
this.playerMoney.addToStock( MONEY_TOKEN, 'overall_player_board_'+player_id );
</pre>

Important: for a given stock control, you must use either '''addToStock''' or '''addToStockWithId''', but NEVER BOTH OF THEM.

'''addToStockWithId( type, id, from )'''

This is the same method as '''addToStock''', except that it also associates an ID with the newly created item.

This is especially useful:

* When you need to know which item(s) have been selected by the user (see '''getSelectedItems''').
* When you need to remove a specific item from the stock with '''removeFromStockById'''.

'''removeFromStock( type, to, noupdate )'''

Remove an item of the specific type from the stock.

'to' is an optional parameter. If "to" contains the ID of an HTML element, the item removed from the Stock slides to this HTML element before it disappears. Note that this method does not expose the associated animation object, however, so it's not possible to trigger other actions when it finishes, for example. If you need to do that, use Dojo's slideToObject() instead.

'noupdate' is an optional parameter. If set to "true" it will prevent the Stock display from changing. This is useful when multiple (but not all) items are removed at the same time, to avoid ghost items appearing briefly. If you pass noupdate you have to call updateDisplay() after all items are removed.

'''removeFromStockById( id, to, noupdate )'''

Remove an item with a specific ID from the stock.

'to' is an optional parameter. If "to" contains the ID of an HTML element, the item removed from the Stock slides to this HTML element before it disappears. Note that this method does not expose the associated animation object, however, so it's not possible to trigger other actions when it finishes, for example. If you need to do that, use Dojo's slideToObject() instead.

'noupdate' is an optional parameter. If set to "true" it will prevent the Stock display from changing. This is useful when multiple (but not all) items are removed at the same time, to avoid ghost items appearing briefly. If you pass noupdate you have to call updateDisplay() after all items are removed.

'''removeAll()'''

Remove all items from the stock.

'''removeAllTo( to )'''

Remove all items from the stock. If "to" contains the ID of an HTML element, the item removed from the stock slides to this HTML element before it disappears.

=== Getters ===

'''getPresentTypeList()'''

Return an array with all the types of items present in the stock right now.

Example:
<pre>
this.myStockControl.removeAll();
this.myStockControl.addToStock( 65 );
this.myStockControl.addToStock( 34 );
this.myStockControl.addToStock( 89 );
this.myStockControl.addToStock( 65 );

// The following returns: { 34:1, 65:1, 89:1 }
var item_types = this.myStockControl.getPresentTypeList();
</pre>

'''count():'''

Return the total number of items in the stock right now.

'''getAllItems()'''

Get all items (same format as getSelectedItems and getUnselectedItems).

'''getItemDivId(id)'''

Get the div id using the stock item id (to manipulate element properties directly).

'''getItemById(id)'''

Get the Stock item with the id in parameter
ex : return the object { type:1, id: 1001 }

=== Selection ===

'''setSelectionMode( mode )'''

For each stock control, you can specify a selection mode:
* 0: no item can be selected by the player.
* 1: a maximum of one item can be selected by the player at a time.
* 2 (default): multiple items can be selected by the player at the same time.

'''setSelectionAppearance( type )'''

For each stock control, you can specify a selection highlighting type:
* '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).
* 'disappear': the selected item will fade out and disappear. This is useful when the selection has the effect of destroying the item.
* 'class': there will be an extra '''stockitem_selected''' css class added to the element when it is selected (and removed when unselected). The name of the class can be changed by using the '''selectionClass''' attribute. You can also override the default class in the css file for your game but beware of the '''!important''' keyword.

By default this class definition is:
<pre>
.stockitem_selected {
border: 2px solid red ! important;
}
</pre>

If you want to override it (for example, to change the border color) add this in your <game>.css file:
<pre>
.stockitem_selected {
border: 2px solid orange ! important;
}
</pre>

'''isSelected( id )'''

Return a boolean indicating whether the specified item id has been selected.

'''selectItem( id )'''

Select the specified item.

'''unselectItem( id )'''

Unselect the specified item.

'''unselectAll()'''

Unselect all items of the stock.

'''onChangeSelection'''

This callback method is called when the player selects/unselects an item of the stock.

You can connect this to one of your methods like this:

<pre>
dojo.connect( this.myStockControl, 'onChangeSelection', this, 'onMyMethodToCall' );

(...)

onMyMethodToCall: function( control_name, item_id )
{
// This method is called when myStockControl selected items changed
var items = this.myStockControl.getSelectedItems();

// (do something)
},
</pre>

Nota bene:
- The "control_name" argument is the ID (the "DOM" id) of the "div" container of your stock control. Using "control_name", you can use the same callback method for different Stock control and see which one trigger the method.
- The "item_id" argument is the stock ID (index) of the stock item that has just been selected/unselected.

'''getSelectedItems()'''

Return the list of selected items, as an array with the following format:
<pre>
[
{ type:1, id: 1001 },
{ type:1, id: 1002 },
{ type:3, id: 1003 }
...
]
</pre>

'''getUnselectedItems()'''

Same as the previous one, but return unselected item instead of seleted ones.

=== Layout ===

'''resetItemsPosition()'''

If you moved an item from the stock control manually (ex: after a drag'n'drop) and want to reset their positions to their original ones, you can call this method.
Note: it is the same as updateDisplay() without arugment, not sure why there are two methods.

'''updateDisplay(from)'''
Update the display completely (if 'from' is defined: moves new items from this location).

Example code if you change the underlying stock item, or otherwise want to make the stock item refresh:
<pre>
this.myStockControl.updateDisplay();
</pre>

'''item_margin'''

By default, there is a margin of 5px between the items of a stock. You can change the member variable "item_margin" to change this.

Example:
<pre>
this.myStockControl.item_margin=5;
</pre>

'''changeItemsWeight( newWeights )'''

With this method you can change dynamically the weight of the item types in a stock control.

Items are immediately re-sorted with the new weight.

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.

newWeights is an associative array: item type id => new weight.

Example:
<pre>
// Item type 1 gets a new weight of 10, 2 a new weight of 20, 3 a new weight of 30.
this.myStockControl.changeItemsWeight( { 1: 10, 2: 20, 3: 30 } );
</pre>

Example2:
<pre>
// Be careful with object initialisers with variables, use the bracket notation.
// Item type 1 gets a new weight of 10
var card_type = 1;
this.myStockControl.changeItemsWeight( { [card_type]: 10 } );
</pre>

'''centerItems'''

Center the stock items in the middle of the stock container.
e.g. this.myStock.centerItems = true;

'''setOverlap( horizontal_percent, vertical_percent )'''

Make items of the stock control "overlap" each other, to save space.

By default, horizontal_overlap and vertical_overlap are 0.

When horizontal_overlap=20, it means that a stock item will overlap to only show 20% of the width of all the previous items. horizontal_overlap can't be greater than 100.

vertical_overlap works differently: one items on two are shifted up.

See the games "Jaipur" or "Koryŏ" to see examples of use of this function.

'''autowidth'''

Stock does not play well if you attempt to inline-block it with other blocks, to fix that you have to set this flag which will calculate width properly
mystock.autowidth = true;

'''resizeItems( width, height, background_width, background_height )'''

background_width is an optional argument.

background_height is an optional argument.

<pre> stock.resizeItems(100, 120, 150, 170);</pre>

=== Customize apperance ===

'''extraClasses'''

Can be set to a list of class names (separated by space) on stock object, so when div is created these are added, i.e.

this.playerHand.extraClasses='mycard';

Note that it is the same list for all items.

'''onItemCreate'''

Using onItemCreate, you can trigger a method each time a new item is added to the Stock, in order to customize it.

Complete example:
<pre>
// During "setup" phase, we associate our method "setupNewCard" with the creation of a new stock item:
this.myStockItem.onItemCreate = dojo.hitch( this, 'setupNewCard' );

// And here is our "setupNewCard":
setupNewCard: function( card_div, card_type_id, card_id )
{
// Add a special tooltip on the card:
this.addTooltip( card_div.id, _("Some nice tooltip for this item"), '' );

// Note that "card_type_id" contains the type of the item, so you can do special actions depending on the item type

// Add some custom HTML content INSIDE the Stock item:
dojo.place( this.format_block( 'jstpl_my_card_content', {
....
} ), card_div.id );
}

</pre>

'''onItemDelete'''

Function handler called when div is removed

this.myStock.onItemDelete = (card_div, card_type_id, card_id) => { console.log("card deleted from myStock: "+card_id); };

== Tips when adding/removing items to/from Stock components ==

Most cases will be one of the following situations:

'''Situation A''':

When you add a card to a stock item, and this card is '''not''' coming from another stock:

* Use '''addToStockWithId''' with a "from" argument set to the element of your interface where the card should come from (i.e. div id). For example if you want to "reveal" card from player hand and it is not an interface element you can set from to be 'player_board_'+activePlayerId (where activePlayerId is player who played that card).

'''Situation B''':

When you add a card to a stock item, and this card is coming from another stock:

* On the destination Stock, use '''addToStockWithId''' with a "from" argument which is the HTML id of the corresponding item in the source Stock. For example, if the source stock id is "myHand", then the HTML id of card 48 is "myHand_item_48".
* Then, remove the source item with '''removeFromStockById'''. Note: do NOT set the 'to' argument in this call, otherwise you'll get two animations.

(Note that it's important to do things in this order, because the source item must still exist when you use it as the origin of the slide.)

'''Situation C''':

When you move a card from a stock item to something that is not a stock item:

* Insert the card as a classic HTML template (dojo.place / this.format_block).
* Place it on the Stock item with '''this.placeOnObject''', using the Stock item HTML id (see above).
* Slide it to its new position with '''this.slideToObject'''.
* Remove the card from the Stock item with '''removeFromStockById'''.

Using the methods above, your cards should slide to, from, and between your Stock controls smoothly.

You can customize this (showing the default value):
<pre>

this.mystock.jstpl_stock_item= "<div id=\"${id}\" class=\"stockitem\" style=\"top:${top}px;left:${left}px;width:${width}px;height:${height}px;z-index:${position};background-image:url('${image}');\"></div>";
</pre>
To produce a different type of stock item

== Known issues ==

==== Incorrectly displayed sprites on Safari ====

As mentioned above, stock displays its images using "sprites" consisting of a portion of a larger image. To accomplish this, it uses the CSS background-position attribute in negative multiples of 100%. For example, the first element of the first row would be 0% 0%. The second element of the first row would be -100% 0%, etc.

This works fine except in Safari, which sometimes slightly modifies the width of elements at smaller screen sizes (usually when minimum width of 'game_interface_width' is not null) in game. For example, you might get a ~49.99px x ~49.99px div instead of the 50px x 50px specified by CSS width/height. Combined with using percentages in background-position, this can cause sprites to be slightly off-center.

Using pixels in background-position is probably the easiest way to fix this problem, but that would require modifying the stock code itself. As a developer, you can also work around the problem by specifying a background-size attribute based on the size in elements of your source image. For example, if you have a source image that contains 5 rows of 28 sprites, you should specify "background-size: 2800% 500%;"

You can add background-size to your stock items by using the extraClasses attribute as explained above and then specifying the values in your game.css file.

[[Category:Studio]]

Stock

2022-07-14T14:21:55Z

RicardoRix: /* Layout */

{{Studio_Framework_Navigation}}

== Overview ==

'''Stock''' is a javascript component that you can use in your game interface to display a set of elements of the same size that need to be arranged in single or multiple lines.

Stock is very flexible and is the most used component in BGA games.

Examples of stock use cases:

* Display a set of cards, typically hands (examples: ''Hearts'', ''Seasons'', ''The Boss'', ''Race for the Galaxy'').
* Display items in player panels (examples: ''Takenoko'', ''Amyitis'', ...)
* ... Many other situations. For example, black dice and cubes on cards in ''Troyes'' are displayed with stock components.

Using stock:

* Your items are arranged nicely and sorted by type.
* When adding or removing items to a set, all items slide smoothly to their new position in the set.
* Selecting and unselecting items are built-in functions.
* You don't have to worry about inserting/removing HTML code; the entire life cycle of the stock is managed by the component.

== Using stock: a simple example ==

Let's have a look on how the stock is used in the game ''Hearts'' to display a hand of standard cards.

First, don't forget to add "ebg/stock" as a dependency in your js file:

<pre>
define([
"dojo","dojo/_base/declare",
"ebg/core/gamegui",
"ebg/counter",
"ebg/stock" /// <==== HERE
],
</pre>

The stock is initialized in the Javascript "setup" method like this:

<pre>
// Player hand
this.playerHand = new ebg.stock();
this.playerHand.create( this, $('myhand'), this.cardwidth, this.cardheight );
</pre>

Explanations:
* We create a new stock object for the player hand.
* As parameters of the "create" method, we provide the width/height of an item (a card), and the div container "myhand" - which is a simple empty "div" element defined in our HTML template (.tpl).

Then, we must tell the stock what 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 a "CSS sprite" image named "cards.jpg" with the cards arranged in 4 rows and 13 columns.

Here's how we tell stock what items to display:

<pre>
// Specify that there are 13 images per row in the CSS sprite image
this.playerHand.image_items_per_row = 13;

// Create card types:
for( var color=1;color<=4;color++ )
{
for( var value=2;value<=14;value++ )
{
// Build card type id
var card_type_id = this.getCardUniqueId( color, value );
this.playerHand.addItemType( card_type_id, card_type_id, g_gamethemeurl+'img/cards.jpg', card_type_id );
}
}
</pre>

Explanation:

* 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.
* Then for the 4x13 cards, we call the "addItemType" method that creates 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.

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

From now on, if we need to add a card - for example, the 5 of Hearts - to a player's hand, we can do this:

<pre>
this.playerHand.addToStock( this.getCardUniqueId( 2 /* 2=hearts */, 5 ) );
</pre>

In reality, cards have some IDs, which are useful to manipulate them. This is the reason we are using "addToStockWithId" instead:

<pre>
this.playerHand.addToStockWithId( this.getCardUniqueId( 2 /* 2=hearts */, 5 ), my_card_id );
</pre>

If afterwards we want to remove this card from the stock:

<pre>
this.playerHand.removeFromStockById( my_card_id );
</pre>

== Complete stock component reference ==

=== Creation ===

'''create( page, container_div, item_width, item_height ):'''

With create, you create a new stock component.

Parameters:
* page: the container page. Usually: "this".
* container_div: the container "div" element (an empty div element in your template, with an id).
* width and height (in pixels) for the stock component.

(See ''Hearts'' example above).

'''addItemType( type, weight, image, image_position ):'''

Define a new type of item and add it to the stock.

This is mandatory to define a new item type before adding it to the stock. Example: if you want to have a stock contain cubes of 3 different colors, you must add 3 item types (one for each color).

Parameters:
* {int} type: id of the type to add. You can choose any positive integer. All item types must have distinct IDs.
* {int} 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.
* {string} image: URL of item image. Most of the time, you will use a CSS sprite for stock items, so you have to specify CSS sprite image here.

Be careful: you must specify the image url as this:

<pre>
g_gamethemeurl+'img/yourimage.png'
</pre>

* image_position: if "image" 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 "0" for the first cube image, 1 for the second, 2 for the third.

''Important'': if there is more than one line of items in your CSS sprite, you must specify how many items per line you have in your CSS sprite, see image_items_per_row below:

'''image_items_per_row'''
Class member to set number of columns in css sprite (or how many items per row). I.e. if you sprite is 4 cards horizontally and 6 vertically, you have to set it to 4.
<pre>
// Specify that there are 10 image items per row in images used in "myStockObject" control.
this.myStockObject.image_items_per_row = 4;
</pre>

=== Add/Remove items ===

'''addToStock( type, from )'''

Add an item to the stock, with the specified type, but without a unique ID.

To make your life easier, in most cases we suggest you use '''addToStockWithId''' in order to give an ID to the item added. '''addToStock''' is suitable when you are using a stock to control items that are generic game materials that don't need to be tracked individually (example: a bunch of money tokens).

Parameters:
* type: ID of the item type to use (as specified in "addItemType")
* from: OPTIONAL: if you specify an HTML item here, the item will appear on this item and will be slid to its position on the stock item.

Example:
<pre>
// Add a money token to the "player money" stock.
// The money token will appear on "player_id" player panel and will move to its position.
this.playerMoney.addToStock( MONEY_TOKEN, 'overall_player_board_'+player_id );
</pre>

Important: for a given stock control, you must use either '''addToStock''' or '''addToStockWithId''', but NEVER BOTH OF THEM.

'''addToStockWithId( type, id, from )'''

This is the same method as '''addToStock''', except that it also associates an ID with the newly created item.

This is especially useful:

* When you need to know which item(s) have been selected by the user (see '''getSelectedItems''').
* When you need to remove a specific item from the stock with '''removeFromStockById'''.

'''removeFromStock( type, to, noupdate )'''

Remove an item of the specific type from the stock.

'to' is an optional parameter. If "to" contains the ID of an HTML element, the item removed from the Stock slides to this HTML element before it disappears. Note that this method does not expose the associated animation object, however, so it's not possible to trigger other actions when it finishes, for example. If you need to do that, use Dojo's slideToObject() instead.

'noupdate' is an optional parameter. If set to "true" it will prevent the Stock display from changing. This is useful when multiple (but not all) items are removed at the same time, to avoid ghost items appearing briefly. If you pass noupdate you have to call updateDisplay() after all items are removed.

'''removeFromStockById( id, to, noupdate )'''

Remove an item with a specific ID from the stock.

'to' is an optional parameter. If "to" contains the ID of an HTML element, the item removed from the Stock slides to this HTML element before it disappears. Note that this method does not expose the associated animation object, however, so it's not possible to trigger other actions when it finishes, for example. If you need to do that, use Dojo's slideToObject() instead.

'noupdate' is an optional parameter. If set to "true" it will prevent the Stock display from changing. This is useful when multiple (but not all) items are removed at the same time, to avoid ghost items appearing briefly. If you pass noupdate you have to call updateDisplay() after all items are removed.

'''removeAll()'''

Remove all items from the stock.

'''removeAllTo( to )'''

Remove all items from the stock. If "to" contains the ID of an HTML element, the item removed from the stock slides to this HTML element before it disappears.

=== Getters ===

'''getPresentTypeList()'''

Return an array with all the types of items present in the stock right now.

Example:
<pre>
this.myStockControl.removeAll();
this.myStockControl.addToStock( 65 );
this.myStockControl.addToStock( 34 );
this.myStockControl.addToStock( 89 );
this.myStockControl.addToStock( 65 );

// The following returns: { 34:1, 65:1, 89:1 }
var item_types = this.myStockControl.getPresentTypeList();
</pre>

'''count():'''

Return the total number of items in the stock right now.

'''getAllItems()'''

Get all items (same format as getSelectedItems and getUnselectedItems).

'''getItemDivId(id)'''

Get the div id using the stock item id (to manipulate element properties directly).

'''getItemById(id)'''

Get the Stock item with the id in parameter
ex : return the object { type:1, id: 1001 }

=== Selection ===

'''setSelectionMode( mode )'''

For each stock control, you can specify a selection mode:
* 0: no item can be selected by the player.
* 1: a maximum of one item can be selected by the player at a time.
* 2 (default): multiple items can be selected by the player at the same time.

'''setSelectionAppearance( type )'''

For each stock control, you can specify a selection highlighting type:
* '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).
* 'disappear': the selected item will fade out and disappear. This is useful when the selection has the effect of destroying the item.
* 'class': there will be an extra '''stockitem_selected''' css class added to the element when it is selected (and removed when unselected). The name of the class can be changed by using the '''selectionClass''' attribute. You can also override the default class in the css file for your game but beware of the '''!important''' keyword.

By default this class definition is:
<pre>
.stockitem_selected {
border: 2px solid red ! important;
}
</pre>

If you want to override it (for example, to change the border color) add this in your <game>.css file:
<pre>
.stockitem_selected {
border: 2px solid orange ! important;
}
</pre>

'''isSelected( id )'''

Return a boolean indicating whether the specified item id has been selected.

'''selectItem( id )'''

Select the specified item.

'''unselectItem( id )'''

Unselect the specified item.

'''unselectAll()'''

Unselect all items of the stock.

'''onChangeSelection'''

This callback method is called when the player selects/unselects an item of the stock.

You can connect this to one of your methods like this:

<pre>
dojo.connect( this.myStockControl, 'onChangeSelection', this, 'onMyMethodToCall' );

(...)

onMyMethodToCall: function( control_name, item_id )
{
// This method is called when myStockControl selected items changed
var items = this.myStockControl.getSelectedItems();

// (do something)
},
</pre>

Nota bene:
- The "control_name" argument is the ID (the "DOM" id) of the "div" container of your stock control. Using "control_name", you can use the same callback method for different Stock control and see which one trigger the method.
- The "item_id" argument is the stock ID (index) of the stock item that has just been selected/unselected.

'''getSelectedItems()'''

Return the list of selected items, as an array with the following format:
<pre>
[
{ type:1, id: 1001 },
{ type:1, id: 1002 },
{ type:3, id: 1003 }
...
]
</pre>

'''getUnselectedItems()'''

Same as the previous one, but return unselected item instead of seleted ones.

=== Layout ===

'''resetItemsPosition()'''

If you moved an item from the stock control manually (ex: after a drag'n'drop) and want to reset their positions to their original ones, you can call this method.
Note: it is the same as updateDisplay() without arugment, not sure why there are two methods.

'''updateDisplay(from)'''
Update the display completely (if 'from' is defined: moves new items from this location).

Example code if you change the underlying stock item, or otherwise want to make the stock item refresh:
<pre>
this.myStockControl.updateDisplay();
</pre>

'''item_margin'''

By default, there is a margin of 5px between the items of a stock. You can change the member variable "item_margin" to change this.

Example:
<pre>
this.myStockControl.item_margin=5;
</pre>

'''changeItemsWeight( newWeights )'''

With this method you can change dynamically the weight of the item types in a stock control.

Items are immediately re-sorted with the new weight.

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.

newWeights is an associative array: item type id => new weight.

Example:
<pre>
// Item type 1 gets a new weight of 10, 2 a new weight of 20, 3 a new weight of 30.
this.myStockControl.changeItemsWeight( { 1: 10, 2: 20, 3: 30 } );
</pre>

Example2:
<pre>
// Be careful with object initialisers with variables, use the bracket notation.
// Item type 1 gets a new weight of 10
var card_type = 1;
this.myStockControl.changeItemsWeight( { [card_type]: 10 } );
</pre>

'''centerItems'''

Center the stock items in the middle of the stock container.
e.g. this.myStock.centerItems = true;

'''setOverlap( horizontal_percent, vertical_percent )'''

Make items of the stock control "overlap" each other, to save space.

By default, horizontal_overlap and vertical_overlap are 0.

When horizontal_overlap=20, it means that a stock item will overlap to only show 20% of the width of all the previous items. horizontal_overlap can't be greater than 100.

vertical_overlap works differently: one items on two are shifted up.

See the games "Jaipur" or "Koryŏ" to see examples of use of this function.

'''autowidth'''

Stock does not play well if you attempt to inline-block it with other blocks, to fix that you have to set this flag which will calculate width properly
mystock.autowidth = true;

'''resizeItems( width, height, background_width, background_height )'''

background_width is an optional argument.
background_height is an optional argument.
<pre> stock.resizeItems(100, 120, 150, 170);</pre>

=== Customize apperance ===

'''extraClasses'''

Can be set to a list of class names (separated by space) on stock object, so when div is created these are added, i.e.

this.playerHand.extraClasses='mycard';

Note that it is the same list for all items.

'''onItemCreate'''

Using onItemCreate, you can trigger a method each time a new item is added to the Stock, in order to customize it.

Complete example:
<pre>
// During "setup" phase, we associate our method "setupNewCard" with the creation of a new stock item:
this.myStockItem.onItemCreate = dojo.hitch( this, 'setupNewCard' );

// And here is our "setupNewCard":
setupNewCard: function( card_div, card_type_id, card_id )
{
// Add a special tooltip on the card:
this.addTooltip( card_div.id, _("Some nice tooltip for this item"), '' );

// Note that "card_type_id" contains the type of the item, so you can do special actions depending on the item type

// Add some custom HTML content INSIDE the Stock item:
dojo.place( this.format_block( 'jstpl_my_card_content', {
....
} ), card_div.id );
}

</pre>

'''onItemDelete'''

Function handler called when div is removed

this.myStock.onItemDelete = (card_div, card_type_id, card_id) => { console.log("card deleted from myStock: "+card_id); };

== Tips when adding/removing items to/from Stock components ==

Most cases will be one of the following situations:

'''Situation A''':

When you add a card to a stock item, and this card is '''not''' coming from another stock:

* Use '''addToStockWithId''' with a "from" argument set to the element of your interface where the card should come from (i.e. div id). For example if you want to "reveal" card from player hand and it is not an interface element you can set from to be 'player_board_'+activePlayerId (where activePlayerId is player who played that card).

'''Situation B''':

When you add a card to a stock item, and this card is coming from another stock:

* On the destination Stock, use '''addToStockWithId''' with a "from" argument which is the HTML id of the corresponding item in the source Stock. For example, if the source stock id is "myHand", then the HTML id of card 48 is "myHand_item_48".
* Then, remove the source item with '''removeFromStockById'''. Note: do NOT set the 'to' argument in this call, otherwise you'll get two animations.

(Note that it's important to do things in this order, because the source item must still exist when you use it as the origin of the slide.)

'''Situation C''':

When you move a card from a stock item to something that is not a stock item:

* Insert the card as a classic HTML template (dojo.place / this.format_block).
* Place it on the Stock item with '''this.placeOnObject''', using the Stock item HTML id (see above).
* Slide it to its new position with '''this.slideToObject'''.
* Remove the card from the Stock item with '''removeFromStockById'''.

Using the methods above, your cards should slide to, from, and between your Stock controls smoothly.

You can customize this (showing the default value):
<pre>

this.mystock.jstpl_stock_item= "<div id=\"${id}\" class=\"stockitem\" style=\"top:${top}px;left:${left}px;width:${width}px;height:${height}px;z-index:${position};background-image:url('${image}');\"></div>";
</pre>
To produce a different type of stock item

== Known issues ==

==== Incorrectly displayed sprites on Safari ====

As mentioned above, stock displays its images using "sprites" consisting of a portion of a larger image. To accomplish this, it uses the CSS background-position attribute in negative multiples of 100%. For example, the first element of the first row would be 0% 0%. The second element of the first row would be -100% 0%, etc.

This works fine except in Safari, which sometimes slightly modifies the width of elements at smaller screen sizes (usually when minimum width of 'game_interface_width' is not null) in game. For example, you might get a ~49.99px x ~49.99px div instead of the 50px x 50px specified by CSS width/height. Combined with using percentages in background-position, this can cause sprites to be slightly off-center.

Using pixels in background-position is probably the easiest way to fix this problem, but that would require modifying the stock code itself. As a developer, you can also work around the problem by specifying a background-size attribute based on the size in elements of your source image. For example, if you have a source image that contains 5 rows of 28 sprites, you should specify "background-size: 2800% 500%;"

You can add background-size to your stock items by using the extraClasses attribute as explained above and then specifying the values in your game.css file.

[[Category:Studio]]

Stock

2022-07-14T14:20:49Z

RicardoRix: /* Layout */

{{Studio_Framework_Navigation}}

== Overview ==

'''Stock''' is a javascript component that you can use in your game interface to display a set of elements of the same size that need to be arranged in single or multiple lines.

Stock is very flexible and is the most used component in BGA games.

Examples of stock use cases:

* Display a set of cards, typically hands (examples: ''Hearts'', ''Seasons'', ''The Boss'', ''Race for the Galaxy'').
* Display items in player panels (examples: ''Takenoko'', ''Amyitis'', ...)
* ... Many other situations. For example, black dice and cubes on cards in ''Troyes'' are displayed with stock components.

Using stock:

* Your items are arranged nicely and sorted by type.
* When adding or removing items to a set, all items slide smoothly to their new position in the set.
* Selecting and unselecting items are built-in functions.
* You don't have to worry about inserting/removing HTML code; the entire life cycle of the stock is managed by the component.

== Using stock: a simple example ==

Let's have a look on how the stock is used in the game ''Hearts'' to display a hand of standard cards.

First, don't forget to add "ebg/stock" as a dependency in your js file:

<pre>
define([
"dojo","dojo/_base/declare",
"ebg/core/gamegui",
"ebg/counter",
"ebg/stock" /// <==== HERE
],
</pre>

The stock is initialized in the Javascript "setup" method like this:

<pre>
// Player hand
this.playerHand = new ebg.stock();
this.playerHand.create( this, $('myhand'), this.cardwidth, this.cardheight );
</pre>

Explanations:
* We create a new stock object for the player hand.
* As parameters of the "create" method, we provide the width/height of an item (a card), and the div container "myhand" - which is a simple empty "div" element defined in our HTML template (.tpl).

Then, we must tell the stock what 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 a "CSS sprite" image named "cards.jpg" with the cards arranged in 4 rows and 13 columns.

Here's how we tell stock what items to display:

<pre>
// Specify that there are 13 images per row in the CSS sprite image
this.playerHand.image_items_per_row = 13;

// Create card types:
for( var color=1;color<=4;color++ )
{
for( var value=2;value<=14;value++ )
{
// Build card type id
var card_type_id = this.getCardUniqueId( color, value );
this.playerHand.addItemType( card_type_id, card_type_id, g_gamethemeurl+'img/cards.jpg', card_type_id );
}
}
</pre>

Explanation:

* 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.
* Then for the 4x13 cards, we call the "addItemType" method that creates 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.

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

From now on, if we need to add a card - for example, the 5 of Hearts - to a player's hand, we can do this:

<pre>
this.playerHand.addToStock( this.getCardUniqueId( 2 /* 2=hearts */, 5 ) );
</pre>

In reality, cards have some IDs, which are useful to manipulate them. This is the reason we are using "addToStockWithId" instead:

<pre>
this.playerHand.addToStockWithId( this.getCardUniqueId( 2 /* 2=hearts */, 5 ), my_card_id );
</pre>

If afterwards we want to remove this card from the stock:

<pre>
this.playerHand.removeFromStockById( my_card_id );
</pre>

== Complete stock component reference ==

=== Creation ===

'''create( page, container_div, item_width, item_height ):'''

With create, you create a new stock component.

Parameters:
* page: the container page. Usually: "this".
* container_div: the container "div" element (an empty div element in your template, with an id).
* width and height (in pixels) for the stock component.

(See ''Hearts'' example above).

'''addItemType( type, weight, image, image_position ):'''

Define a new type of item and add it to the stock.

This is mandatory to define a new item type before adding it to the stock. Example: if you want to have a stock contain cubes of 3 different colors, you must add 3 item types (one for each color).

Parameters:
* {int} type: id of the type to add. You can choose any positive integer. All item types must have distinct IDs.
* {int} 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.
* {string} image: URL of item image. Most of the time, you will use a CSS sprite for stock items, so you have to specify CSS sprite image here.

Be careful: you must specify the image url as this:

<pre>
g_gamethemeurl+'img/yourimage.png'
</pre>

* image_position: if "image" 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 "0" for the first cube image, 1 for the second, 2 for the third.

''Important'': if there is more than one line of items in your CSS sprite, you must specify how many items per line you have in your CSS sprite, see image_items_per_row below:

'''image_items_per_row'''
Class member to set number of columns in css sprite (or how many items per row). I.e. if you sprite is 4 cards horizontally and 6 vertically, you have to set it to 4.
<pre>
// Specify that there are 10 image items per row in images used in "myStockObject" control.
this.myStockObject.image_items_per_row = 4;
</pre>

=== Add/Remove items ===

'''addToStock( type, from )'''

Add an item to the stock, with the specified type, but without a unique ID.

To make your life easier, in most cases we suggest you use '''addToStockWithId''' in order to give an ID to the item added. '''addToStock''' is suitable when you are using a stock to control items that are generic game materials that don't need to be tracked individually (example: a bunch of money tokens).

Parameters:
* type: ID of the item type to use (as specified in "addItemType")
* from: OPTIONAL: if you specify an HTML item here, the item will appear on this item and will be slid to its position on the stock item.

Example:
<pre>
// Add a money token to the "player money" stock.
// The money token will appear on "player_id" player panel and will move to its position.
this.playerMoney.addToStock( MONEY_TOKEN, 'overall_player_board_'+player_id );
</pre>

Important: for a given stock control, you must use either '''addToStock''' or '''addToStockWithId''', but NEVER BOTH OF THEM.

'''addToStockWithId( type, id, from )'''

This is the same method as '''addToStock''', except that it also associates an ID with the newly created item.

This is especially useful:

* When you need to know which item(s) have been selected by the user (see '''getSelectedItems''').
* When you need to remove a specific item from the stock with '''removeFromStockById'''.

'''removeFromStock( type, to, noupdate )'''

Remove an item of the specific type from the stock.

'to' is an optional parameter. If "to" contains the ID of an HTML element, the item removed from the Stock slides to this HTML element before it disappears. Note that this method does not expose the associated animation object, however, so it's not possible to trigger other actions when it finishes, for example. If you need to do that, use Dojo's slideToObject() instead.

'noupdate' is an optional parameter. If set to "true" it will prevent the Stock display from changing. This is useful when multiple (but not all) items are removed at the same time, to avoid ghost items appearing briefly. If you pass noupdate you have to call updateDisplay() after all items are removed.

'''removeFromStockById( id, to, noupdate )'''

Remove an item with a specific ID from the stock.

'to' is an optional parameter. If "to" contains the ID of an HTML element, the item removed from the Stock slides to this HTML element before it disappears. Note that this method does not expose the associated animation object, however, so it's not possible to trigger other actions when it finishes, for example. If you need to do that, use Dojo's slideToObject() instead.

'noupdate' is an optional parameter. If set to "true" it will prevent the Stock display from changing. This is useful when multiple (but not all) items are removed at the same time, to avoid ghost items appearing briefly. If you pass noupdate you have to call updateDisplay() after all items are removed.

'''removeAll()'''

Remove all items from the stock.

'''removeAllTo( to )'''

Remove all items from the stock. If "to" contains the ID of an HTML element, the item removed from the stock slides to this HTML element before it disappears.

=== Getters ===

'''getPresentTypeList()'''

Return an array with all the types of items present in the stock right now.

Example:
<pre>
this.myStockControl.removeAll();
this.myStockControl.addToStock( 65 );
this.myStockControl.addToStock( 34 );
this.myStockControl.addToStock( 89 );
this.myStockControl.addToStock( 65 );

// The following returns: { 34:1, 65:1, 89:1 }
var item_types = this.myStockControl.getPresentTypeList();
</pre>

'''count():'''

Return the total number of items in the stock right now.

'''getAllItems()'''

Get all items (same format as getSelectedItems and getUnselectedItems).

'''getItemDivId(id)'''

Get the div id using the stock item id (to manipulate element properties directly).

'''getItemById(id)'''

Get the Stock item with the id in parameter
ex : return the object { type:1, id: 1001 }

=== Selection ===

'''setSelectionMode( mode )'''

For each stock control, you can specify a selection mode:
* 0: no item can be selected by the player.
* 1: a maximum of one item can be selected by the player at a time.
* 2 (default): multiple items can be selected by the player at the same time.

'''setSelectionAppearance( type )'''

For each stock control, you can specify a selection highlighting type:
* '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).
* 'disappear': the selected item will fade out and disappear. This is useful when the selection has the effect of destroying the item.
* 'class': there will be an extra '''stockitem_selected''' css class added to the element when it is selected (and removed when unselected). The name of the class can be changed by using the '''selectionClass''' attribute. You can also override the default class in the css file for your game but beware of the '''!important''' keyword.

By default this class definition is:
<pre>
.stockitem_selected {
border: 2px solid red ! important;
}
</pre>

If you want to override it (for example, to change the border color) add this in your <game>.css file:
<pre>
.stockitem_selected {
border: 2px solid orange ! important;
}
</pre>

'''isSelected( id )'''

Return a boolean indicating whether the specified item id has been selected.

'''selectItem( id )'''

Select the specified item.

'''unselectItem( id )'''

Unselect the specified item.

'''unselectAll()'''

Unselect all items of the stock.

'''onChangeSelection'''

This callback method is called when the player selects/unselects an item of the stock.

You can connect this to one of your methods like this:

<pre>
dojo.connect( this.myStockControl, 'onChangeSelection', this, 'onMyMethodToCall' );

(...)

onMyMethodToCall: function( control_name, item_id )
{
// This method is called when myStockControl selected items changed
var items = this.myStockControl.getSelectedItems();

// (do something)
},
</pre>

Nota bene:
- The "control_name" argument is the ID (the "DOM" id) of the "div" container of your stock control. Using "control_name", you can use the same callback method for different Stock control and see which one trigger the method.
- The "item_id" argument is the stock ID (index) of the stock item that has just been selected/unselected.

'''getSelectedItems()'''

Return the list of selected items, as an array with the following format:
<pre>
[
{ type:1, id: 1001 },
{ type:1, id: 1002 },
{ type:3, id: 1003 }
...
]
</pre>

'''getUnselectedItems()'''

Same as the previous one, but return unselected item instead of seleted ones.

=== Layout ===

'''resetItemsPosition()'''

If you moved an item from the stock control manually (ex: after a drag'n'drop) and want to reset their positions to their original ones, you can call this method.
Note: it is the same as updateDisplay() without arugment, not sure why there are two methods.

'''updateDisplay(from)'''
Update the display completely (if 'from' is defined: moves new items from this location).

Example code if you change the underlying stock item, or otherwise want to make the stock item refresh:
<pre>
this.myStockControl.updateDisplay();
</pre>

'''item_margin'''

By default, there is a margin of 5px between the items of a stock. You can change the member variable "item_margin" to change this.

Example:
<pre>
this.myStockControl.item_margin=5;
</pre>

'''changeItemsWeight( newWeights )'''

With this method you can change dynamically the weight of the item types in a stock control.

Items are immediately re-sorted with the new weight.

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.

newWeights is an associative array: item type id => new weight.

Example:
<pre>
// Item type 1 gets a new weight of 10, 2 a new weight of 20, 3 a new weight of 30.
this.myStockControl.changeItemsWeight( { 1: 10, 2: 20, 3: 30 } );
</pre>

Example2:
<pre>
// Be careful with object initialisers with variables, use the bracket notation.
// Item type 1 gets a new weight of 10
var card_type = 1;
this.myStockControl.changeItemsWeight( { [card_type]: 10 } );
</pre>

'''centerItems'''

Center the stock items in the middle of the stock container.
e.g. this.myStock.centerItems = true;

'''setOverlap( horizontal_percent, vertical_percent )'''

Make items of the stock control "overlap" each other, to save space.

By default, horizontal_overlap and vertical_overlap are 0.

When horizontal_overlap=20, it means that a stock item will overlap to only show 20% of the width of all the previous items. horizontal_overlap can't be greater than 100.

vertical_overlap works differently: one items on two are shifted up.

See the games "Jaipur" or "Koryŏ" to see examples of use of this function.

'''autowidth'''

Stock does not play well if you attempt to inline-block it with other blocks, to fix that you have to set this flag which will calculate width properly
mystock.autowidth = true;

'''resizeItems( width, height, background_width, background_height )'''

<pre> stock.resizeItems(100, 120, 150, 170);</pre>

background_width, background_height are optional arguments.

=== Customize apperance ===

'''extraClasses'''

Can be set to a list of class names (separated by space) on stock object, so when div is created these are added, i.e.

this.playerHand.extraClasses='mycard';

Note that it is the same list for all items.

'''onItemCreate'''

Using onItemCreate, you can trigger a method each time a new item is added to the Stock, in order to customize it.

Complete example:
<pre>
// During "setup" phase, we associate our method "setupNewCard" with the creation of a new stock item:
this.myStockItem.onItemCreate = dojo.hitch( this, 'setupNewCard' );

// And here is our "setupNewCard":
setupNewCard: function( card_div, card_type_id, card_id )
{
// Add a special tooltip on the card:
this.addTooltip( card_div.id, _("Some nice tooltip for this item"), '' );

// Note that "card_type_id" contains the type of the item, so you can do special actions depending on the item type

// Add some custom HTML content INSIDE the Stock item:
dojo.place( this.format_block( 'jstpl_my_card_content', {
....
} ), card_div.id );
}

</pre>

'''onItemDelete'''

Function handler called when div is removed

this.myStock.onItemDelete = (card_div, card_type_id, card_id) => { console.log("card deleted from myStock: "+card_id); };

== Tips when adding/removing items to/from Stock components ==

Most cases will be one of the following situations:

'''Situation A''':

When you add a card to a stock item, and this card is '''not''' coming from another stock:

* Use '''addToStockWithId''' with a "from" argument set to the element of your interface where the card should come from (i.e. div id). For example if you want to "reveal" card from player hand and it is not an interface element you can set from to be 'player_board_'+activePlayerId (where activePlayerId is player who played that card).

'''Situation B''':

When you add a card to a stock item, and this card is coming from another stock:

* On the destination Stock, use '''addToStockWithId''' with a "from" argument which is the HTML id of the corresponding item in the source Stock. For example, if the source stock id is "myHand", then the HTML id of card 48 is "myHand_item_48".
* Then, remove the source item with '''removeFromStockById'''. Note: do NOT set the 'to' argument in this call, otherwise you'll get two animations.

(Note that it's important to do things in this order, because the source item must still exist when you use it as the origin of the slide.)

'''Situation C''':

When you move a card from a stock item to something that is not a stock item:

* Insert the card as a classic HTML template (dojo.place / this.format_block).
* Place it on the Stock item with '''this.placeOnObject''', using the Stock item HTML id (see above).
* Slide it to its new position with '''this.slideToObject'''.
* Remove the card from the Stock item with '''removeFromStockById'''.

Using the methods above, your cards should slide to, from, and between your Stock controls smoothly.

You can customize this (showing the default value):
<pre>

this.mystock.jstpl_stock_item= "<div id=\"${id}\" class=\"stockitem\" style=\"top:${top}px;left:${left}px;width:${width}px;height:${height}px;z-index:${position};background-image:url('${image}');\"></div>";
</pre>
To produce a different type of stock item

== Known issues ==

==== Incorrectly displayed sprites on Safari ====

As mentioned above, stock displays its images using "sprites" consisting of a portion of a larger image. To accomplish this, it uses the CSS background-position attribute in negative multiples of 100%. For example, the first element of the first row would be 0% 0%. The second element of the first row would be -100% 0%, etc.

This works fine except in Safari, which sometimes slightly modifies the width of elements at smaller screen sizes (usually when minimum width of 'game_interface_width' is not null) in game. For example, you might get a ~49.99px x ~49.99px div instead of the 50px x 50px specified by CSS width/height. Combined with using percentages in background-position, this can cause sprites to be slightly off-center.

Using pixels in background-position is probably the easiest way to fix this problem, but that would require modifying the stock code itself. As a developer, you can also work around the problem by specifying a background-size attribute based on the size in elements of your source image. For example, if you have a source image that contains 5 rows of 28 sprites, you should specify "background-size: 2800% 500%;"

You can add background-size to your stock items by using the extraClasses attribute as explained above and then specifying the values in your game.css file.

[[Category:Studio]]

Stock

2022-07-14T14:16:52Z

RicardoRix: /* Layout */

{{Studio_Framework_Navigation}}

== Overview ==

'''Stock''' is a javascript component that you can use in your game interface to display a set of elements of the same size that need to be arranged in single or multiple lines.

Stock is very flexible and is the most used component in BGA games.

Examples of stock use cases:

* Display a set of cards, typically hands (examples: ''Hearts'', ''Seasons'', ''The Boss'', ''Race for the Galaxy'').
* Display items in player panels (examples: ''Takenoko'', ''Amyitis'', ...)
* ... Many other situations. For example, black dice and cubes on cards in ''Troyes'' are displayed with stock components.

Using stock:

* Your items are arranged nicely and sorted by type.
* When adding or removing items to a set, all items slide smoothly to their new position in the set.
* Selecting and unselecting items are built-in functions.
* You don't have to worry about inserting/removing HTML code; the entire life cycle of the stock is managed by the component.

== Using stock: a simple example ==

Let's have a look on how the stock is used in the game ''Hearts'' to display a hand of standard cards.

First, don't forget to add "ebg/stock" as a dependency in your js file:

<pre>
define([
"dojo","dojo/_base/declare",
"ebg/core/gamegui",
"ebg/counter",
"ebg/stock" /// <==== HERE
],
</pre>

The stock is initialized in the Javascript "setup" method like this:

<pre>
// Player hand
this.playerHand = new ebg.stock();
this.playerHand.create( this, $('myhand'), this.cardwidth, this.cardheight );
</pre>

Explanations:
* We create a new stock object for the player hand.
* As parameters of the "create" method, we provide the width/height of an item (a card), and the div container "myhand" - which is a simple empty "div" element defined in our HTML template (.tpl).

Then, we must tell the stock what 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 a "CSS sprite" image named "cards.jpg" with the cards arranged in 4 rows and 13 columns.

Here's how we tell stock what items to display:

<pre>
// Specify that there are 13 images per row in the CSS sprite image
this.playerHand.image_items_per_row = 13;

// Create card types:
for( var color=1;color<=4;color++ )
{
for( var value=2;value<=14;value++ )
{
// Build card type id
var card_type_id = this.getCardUniqueId( color, value );
this.playerHand.addItemType( card_type_id, card_type_id, g_gamethemeurl+'img/cards.jpg', card_type_id );
}
}
</pre>

Explanation:

* 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.
* Then for the 4x13 cards, we call the "addItemType" method that creates 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.

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

From now on, if we need to add a card - for example, the 5 of Hearts - to a player's hand, we can do this:

<pre>
this.playerHand.addToStock( this.getCardUniqueId( 2 /* 2=hearts */, 5 ) );
</pre>

In reality, cards have some IDs, which are useful to manipulate them. This is the reason we are using "addToStockWithId" instead:

<pre>
this.playerHand.addToStockWithId( this.getCardUniqueId( 2 /* 2=hearts */, 5 ), my_card_id );
</pre>

If afterwards we want to remove this card from the stock:

<pre>
this.playerHand.removeFromStockById( my_card_id );
</pre>

== Complete stock component reference ==

=== Creation ===

'''create( page, container_div, item_width, item_height ):'''

With create, you create a new stock component.

Parameters:
* page: the container page. Usually: "this".
* container_div: the container "div" element (an empty div element in your template, with an id).
* width and height (in pixels) for the stock component.

(See ''Hearts'' example above).

'''addItemType( type, weight, image, image_position ):'''

Define a new type of item and add it to the stock.

This is mandatory to define a new item type before adding it to the stock. Example: if you want to have a stock contain cubes of 3 different colors, you must add 3 item types (one for each color).

Parameters:
* {int} type: id of the type to add. You can choose any positive integer. All item types must have distinct IDs.
* {int} 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.
* {string} image: URL of item image. Most of the time, you will use a CSS sprite for stock items, so you have to specify CSS sprite image here.

Be careful: you must specify the image url as this:

<pre>
g_gamethemeurl+'img/yourimage.png'
</pre>

* image_position: if "image" 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 "0" for the first cube image, 1 for the second, 2 for the third.

''Important'': if there is more than one line of items in your CSS sprite, you must specify how many items per line you have in your CSS sprite, see image_items_per_row below:

'''image_items_per_row'''
Class member to set number of columns in css sprite (or how many items per row). I.e. if you sprite is 4 cards horizontally and 6 vertically, you have to set it to 4.
<pre>
// Specify that there are 10 image items per row in images used in "myStockObject" control.
this.myStockObject.image_items_per_row = 4;
</pre>

=== Add/Remove items ===

'''addToStock( type, from )'''

Add an item to the stock, with the specified type, but without a unique ID.

To make your life easier, in most cases we suggest you use '''addToStockWithId''' in order to give an ID to the item added. '''addToStock''' is suitable when you are using a stock to control items that are generic game materials that don't need to be tracked individually (example: a bunch of money tokens).

Parameters:
* type: ID of the item type to use (as specified in "addItemType")
* from: OPTIONAL: if you specify an HTML item here, the item will appear on this item and will be slid to its position on the stock item.

Example:
<pre>
// Add a money token to the "player money" stock.
// The money token will appear on "player_id" player panel and will move to its position.
this.playerMoney.addToStock( MONEY_TOKEN, 'overall_player_board_'+player_id );
</pre>

Important: for a given stock control, you must use either '''addToStock''' or '''addToStockWithId''', but NEVER BOTH OF THEM.

'''addToStockWithId( type, id, from )'''

This is the same method as '''addToStock''', except that it also associates an ID with the newly created item.

This is especially useful:

* When you need to know which item(s) have been selected by the user (see '''getSelectedItems''').
* When you need to remove a specific item from the stock with '''removeFromStockById'''.

'''removeFromStock( type, to, noupdate )'''

Remove an item of the specific type from the stock.

'to' is an optional parameter. If "to" contains the ID of an HTML element, the item removed from the Stock slides to this HTML element before it disappears. Note that this method does not expose the associated animation object, however, so it's not possible to trigger other actions when it finishes, for example. If you need to do that, use Dojo's slideToObject() instead.

'noupdate' is an optional parameter. If set to "true" it will prevent the Stock display from changing. This is useful when multiple (but not all) items are removed at the same time, to avoid ghost items appearing briefly. If you pass noupdate you have to call updateDisplay() after all items are removed.

'''removeFromStockById( id, to, noupdate )'''

Remove an item with a specific ID from the stock.

'to' is an optional parameter. If "to" contains the ID of an HTML element, the item removed from the Stock slides to this HTML element before it disappears. Note that this method does not expose the associated animation object, however, so it's not possible to trigger other actions when it finishes, for example. If you need to do that, use Dojo's slideToObject() instead.

'noupdate' is an optional parameter. If set to "true" it will prevent the Stock display from changing. This is useful when multiple (but not all) items are removed at the same time, to avoid ghost items appearing briefly. If you pass noupdate you have to call updateDisplay() after all items are removed.

'''removeAll()'''

Remove all items from the stock.

'''removeAllTo( to )'''

Remove all items from the stock. If "to" contains the ID of an HTML element, the item removed from the stock slides to this HTML element before it disappears.

=== Getters ===

'''getPresentTypeList()'''

Return an array with all the types of items present in the stock right now.

Example:
<pre>
this.myStockControl.removeAll();
this.myStockControl.addToStock( 65 );
this.myStockControl.addToStock( 34 );
this.myStockControl.addToStock( 89 );
this.myStockControl.addToStock( 65 );

// The following returns: { 34:1, 65:1, 89:1 }
var item_types = this.myStockControl.getPresentTypeList();
</pre>

'''count():'''

Return the total number of items in the stock right now.

'''getAllItems()'''

Get all items (same format as getSelectedItems and getUnselectedItems).

'''getItemDivId(id)'''

Get the div id using the stock item id (to manipulate element properties directly).

'''getItemById(id)'''

Get the Stock item with the id in parameter
ex : return the object { type:1, id: 1001 }

=== Selection ===

'''setSelectionMode( mode )'''

For each stock control, you can specify a selection mode:
* 0: no item can be selected by the player.
* 1: a maximum of one item can be selected by the player at a time.
* 2 (default): multiple items can be selected by the player at the same time.

'''setSelectionAppearance( type )'''

For each stock control, you can specify a selection highlighting type:
* '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).
* 'disappear': the selected item will fade out and disappear. This is useful when the selection has the effect of destroying the item.
* 'class': there will be an extra '''stockitem_selected''' css class added to the element when it is selected (and removed when unselected). The name of the class can be changed by using the '''selectionClass''' attribute. You can also override the default class in the css file for your game but beware of the '''!important''' keyword.

By default this class definition is:
<pre>
.stockitem_selected {
border: 2px solid red ! important;
}
</pre>

If you want to override it (for example, to change the border color) add this in your <game>.css file:
<pre>
.stockitem_selected {
border: 2px solid orange ! important;
}
</pre>

'''isSelected( id )'''

Return a boolean indicating whether the specified item id has been selected.

'''selectItem( id )'''

Select the specified item.

'''unselectItem( id )'''

Unselect the specified item.

'''unselectAll()'''

Unselect all items of the stock.

'''onChangeSelection'''

This callback method is called when the player selects/unselects an item of the stock.

You can connect this to one of your methods like this:

<pre>
dojo.connect( this.myStockControl, 'onChangeSelection', this, 'onMyMethodToCall' );

(...)

onMyMethodToCall: function( control_name, item_id )
{
// This method is called when myStockControl selected items changed
var items = this.myStockControl.getSelectedItems();

// (do something)
},
</pre>

Nota bene:
- The "control_name" argument is the ID (the "DOM" id) of the "div" container of your stock control. Using "control_name", you can use the same callback method for different Stock control and see which one trigger the method.
- The "item_id" argument is the stock ID (index) of the stock item that has just been selected/unselected.

'''getSelectedItems()'''

Return the list of selected items, as an array with the following format:
<pre>
[
{ type:1, id: 1001 },
{ type:1, id: 1002 },
{ type:3, id: 1003 }
...
]
</pre>

'''getUnselectedItems()'''

Same as the previous one, but return unselected item instead of seleted ones.

=== Layout ===

'''resetItemsPosition()'''

If you moved an item from the stock control manually (ex: after a drag'n'drop) and want to reset their positions to their original ones, you can call this method.
Note: it is the same as updateDisplay() without arugment, not sure why there are two methods.

'''updateDisplay(from)'''
Update the display completely (if 'from' is defined: moves new items from this location).

Example code if you change the underlying stock item, or otherwise want to make the stock item refresh:
<pre>
this.myStockControl.updateDisplay();
</pre>

'''item_margin'''

By default, there is a margin of 5px between the items of a stock. You can change the member variable "item_margin" to change this.

Example:
<pre>
this.myStockControl.item_margin=5;
</pre>

'''changeItemsWeight( newWeights )'''

With this method you can change dynamically the weight of the item types in a stock control.

Items are immediately re-sorted with the new weight.

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.

newWeights is an associative array: item type id => new weight.

Example:
<pre>
// Item type 1 gets a new weight of 10, 2 a new weight of 20, 3 a new weight of 30.
this.myStockControl.changeItemsWeight( { 1: 10, 2: 20, 3: 30 } );
</pre>

Example2:
<pre>
// Be careful with object initialisers with variables, use the bracket notation.
// Item type 1 gets a new weight of 10
var card_type = 1;
this.myStockControl.changeItemsWeight( { [card_type]: 10 } );
</pre>

'''centerItems'''

Center the stock items in the middle of the stock container.
e.g. this.myStock.centerItems = true;

'''setOverlap( horizontal_percent, vertical_percent )'''

Make items of the stock control "overlap" each other, to save space.

By default, horizontal_overlap and vertical_overlap are 0.

When horizontal_overlap=20, it means that a stock item will overlap to only show 20% of the width of all the previous items. horizontal_overlap can't be greater than 100.

vertical_overlap works differently: one items on two are shifted up.

See the games "Jaipur" or "Koryŏ" to see examples of use of this function.

'''autowidth'''

Stock does not play well if you attempt to inline-block it with other blocks, to fix that you have to set this flag which will calculate width properly
mystock.autowidth = true;

'''resizeItems( width, height, background-width, background-height )'''

<pre> stock.resizeItems(100, 120, 150, 170);</pre>

=== Customize apperance ===

'''extraClasses'''

Can be set to a list of class names (separated by space) on stock object, so when div is created these are added, i.e.

this.playerHand.extraClasses='mycard';

Note that it is the same list for all items.

'''onItemCreate'''

Using onItemCreate, you can trigger a method each time a new item is added to the Stock, in order to customize it.

Complete example:
<pre>
// During "setup" phase, we associate our method "setupNewCard" with the creation of a new stock item:
this.myStockItem.onItemCreate = dojo.hitch( this, 'setupNewCard' );

// And here is our "setupNewCard":
setupNewCard: function( card_div, card_type_id, card_id )
{
// Add a special tooltip on the card:
this.addTooltip( card_div.id, _("Some nice tooltip for this item"), '' );

// Note that "card_type_id" contains the type of the item, so you can do special actions depending on the item type

// Add some custom HTML content INSIDE the Stock item:
dojo.place( this.format_block( 'jstpl_my_card_content', {
....
} ), card_div.id );
}

</pre>

'''onItemDelete'''

Function handler called when div is removed

this.myStock.onItemDelete = (card_div, card_type_id, card_id) => { console.log("card deleted from myStock: "+card_id); };

== Tips when adding/removing items to/from Stock components ==

Most cases will be one of the following situations:

'''Situation A''':

When you add a card to a stock item, and this card is '''not''' coming from another stock:

* Use '''addToStockWithId''' with a "from" argument set to the element of your interface where the card should come from (i.e. div id). For example if you want to "reveal" card from player hand and it is not an interface element you can set from to be 'player_board_'+activePlayerId (where activePlayerId is player who played that card).

'''Situation B''':

When you add a card to a stock item, and this card is coming from another stock:

* On the destination Stock, use '''addToStockWithId''' with a "from" argument which is the HTML id of the corresponding item in the source Stock. For example, if the source stock id is "myHand", then the HTML id of card 48 is "myHand_item_48".
* Then, remove the source item with '''removeFromStockById'''. Note: do NOT set the 'to' argument in this call, otherwise you'll get two animations.

(Note that it's important to do things in this order, because the source item must still exist when you use it as the origin of the slide.)

'''Situation C''':

When you move a card from a stock item to something that is not a stock item:

* Insert the card as a classic HTML template (dojo.place / this.format_block).
* Place it on the Stock item with '''this.placeOnObject''', using the Stock item HTML id (see above).
* Slide it to its new position with '''this.slideToObject'''.
* Remove the card from the Stock item with '''removeFromStockById'''.

Using the methods above, your cards should slide to, from, and between your Stock controls smoothly.

You can customize this (showing the default value):
<pre>

this.mystock.jstpl_stock_item= "<div id=\"${id}\" class=\"stockitem\" style=\"top:${top}px;left:${left}px;width:${width}px;height:${height}px;z-index:${position};background-image:url('${image}');\"></div>";
</pre>
To produce a different type of stock item

== Known issues ==

==== Incorrectly displayed sprites on Safari ====

As mentioned above, stock displays its images using "sprites" consisting of a portion of a larger image. To accomplish this, it uses the CSS background-position attribute in negative multiples of 100%. For example, the first element of the first row would be 0% 0%. The second element of the first row would be -100% 0%, etc.

This works fine except in Safari, which sometimes slightly modifies the width of elements at smaller screen sizes (usually when minimum width of 'game_interface_width' is not null) in game. For example, you might get a ~49.99px x ~49.99px div instead of the 50px x 50px specified by CSS width/height. Combined with using percentages in background-position, this can cause sprites to be slightly off-center.

Using pixels in background-position is probably the easiest way to fix this problem, but that would require modifying the stock code itself. As a developer, you can also work around the problem by specifying a background-size attribute based on the size in elements of your source image. For example, if you have a source image that contains 5 rows of 28 sprites, you should specify "background-size: 2800% 500%;"

You can add background-size to your stock items by using the extraClasses attribute as explained above and then specifying the values in your game.css file.

[[Category:Studio]]

Stock

2022-07-14T14:15:15Z

RicardoRix: /* Layout */

{{Studio_Framework_Navigation}}

== Overview ==

'''Stock''' is a javascript component that you can use in your game interface to display a set of elements of the same size that need to be arranged in single or multiple lines.

Stock is very flexible and is the most used component in BGA games.

Examples of stock use cases:

* Display a set of cards, typically hands (examples: ''Hearts'', ''Seasons'', ''The Boss'', ''Race for the Galaxy'').
* Display items in player panels (examples: ''Takenoko'', ''Amyitis'', ...)
* ... Many other situations. For example, black dice and cubes on cards in ''Troyes'' are displayed with stock components.

Using stock:

* Your items are arranged nicely and sorted by type.
* When adding or removing items to a set, all items slide smoothly to their new position in the set.
* Selecting and unselecting items are built-in functions.
* You don't have to worry about inserting/removing HTML code; the entire life cycle of the stock is managed by the component.

== Using stock: a simple example ==

Let's have a look on how the stock is used in the game ''Hearts'' to display a hand of standard cards.

First, don't forget to add "ebg/stock" as a dependency in your js file:

<pre>
define([
"dojo","dojo/_base/declare",
"ebg/core/gamegui",
"ebg/counter",
"ebg/stock" /// <==== HERE
],
</pre>

The stock is initialized in the Javascript "setup" method like this:

<pre>
// Player hand
this.playerHand = new ebg.stock();
this.playerHand.create( this, $('myhand'), this.cardwidth, this.cardheight );
</pre>

Explanations:
* We create a new stock object for the player hand.
* As parameters of the "create" method, we provide the width/height of an item (a card), and the div container "myhand" - which is a simple empty "div" element defined in our HTML template (.tpl).

Then, we must tell the stock what 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 a "CSS sprite" image named "cards.jpg" with the cards arranged in 4 rows and 13 columns.

Here's how we tell stock what items to display:

<pre>
// Specify that there are 13 images per row in the CSS sprite image
this.playerHand.image_items_per_row = 13;

// Create card types:
for( var color=1;color<=4;color++ )
{
for( var value=2;value<=14;value++ )
{
// Build card type id
var card_type_id = this.getCardUniqueId( color, value );
this.playerHand.addItemType( card_type_id, card_type_id, g_gamethemeurl+'img/cards.jpg', card_type_id );
}
}
</pre>

Explanation:

* 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.
* Then for the 4x13 cards, we call the "addItemType" method that creates 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.

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

From now on, if we need to add a card - for example, the 5 of Hearts - to a player's hand, we can do this:

<pre>
this.playerHand.addToStock( this.getCardUniqueId( 2 /* 2=hearts */, 5 ) );
</pre>

In reality, cards have some IDs, which are useful to manipulate them. This is the reason we are using "addToStockWithId" instead:

<pre>
this.playerHand.addToStockWithId( this.getCardUniqueId( 2 /* 2=hearts */, 5 ), my_card_id );
</pre>

If afterwards we want to remove this card from the stock:

<pre>
this.playerHand.removeFromStockById( my_card_id );
</pre>

== Complete stock component reference ==

=== Creation ===

'''create( page, container_div, item_width, item_height ):'''

With create, you create a new stock component.

Parameters:
* page: the container page. Usually: "this".
* container_div: the container "div" element (an empty div element in your template, with an id).
* width and height (in pixels) for the stock component.

(See ''Hearts'' example above).

'''addItemType( type, weight, image, image_position ):'''

Define a new type of item and add it to the stock.

This is mandatory to define a new item type before adding it to the stock. Example: if you want to have a stock contain cubes of 3 different colors, you must add 3 item types (one for each color).

Parameters:
* {int} type: id of the type to add. You can choose any positive integer. All item types must have distinct IDs.
* {int} 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.
* {string} image: URL of item image. Most of the time, you will use a CSS sprite for stock items, so you have to specify CSS sprite image here.

Be careful: you must specify the image url as this:

<pre>
g_gamethemeurl+'img/yourimage.png'
</pre>

* image_position: if "image" 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 "0" for the first cube image, 1 for the second, 2 for the third.

''Important'': if there is more than one line of items in your CSS sprite, you must specify how many items per line you have in your CSS sprite, see image_items_per_row below:

'''image_items_per_row'''
Class member to set number of columns in css sprite (or how many items per row). I.e. if you sprite is 4 cards horizontally and 6 vertically, you have to set it to 4.
<pre>
// Specify that there are 10 image items per row in images used in "myStockObject" control.
this.myStockObject.image_items_per_row = 4;
</pre>

=== Add/Remove items ===

'''addToStock( type, from )'''

Add an item to the stock, with the specified type, but without a unique ID.

To make your life easier, in most cases we suggest you use '''addToStockWithId''' in order to give an ID to the item added. '''addToStock''' is suitable when you are using a stock to control items that are generic game materials that don't need to be tracked individually (example: a bunch of money tokens).

Parameters:
* type: ID of the item type to use (as specified in "addItemType")
* from: OPTIONAL: if you specify an HTML item here, the item will appear on this item and will be slid to its position on the stock item.

Example:
<pre>
// Add a money token to the "player money" stock.
// The money token will appear on "player_id" player panel and will move to its position.
this.playerMoney.addToStock( MONEY_TOKEN, 'overall_player_board_'+player_id );
</pre>

Important: for a given stock control, you must use either '''addToStock''' or '''addToStockWithId''', but NEVER BOTH OF THEM.

'''addToStockWithId( type, id, from )'''

This is the same method as '''addToStock''', except that it also associates an ID with the newly created item.

This is especially useful:

* When you need to know which item(s) have been selected by the user (see '''getSelectedItems''').
* When you need to remove a specific item from the stock with '''removeFromStockById'''.

'''removeFromStock( type, to, noupdate )'''

Remove an item of the specific type from the stock.

'to' is an optional parameter. If "to" contains the ID of an HTML element, the item removed from the Stock slides to this HTML element before it disappears. Note that this method does not expose the associated animation object, however, so it's not possible to trigger other actions when it finishes, for example. If you need to do that, use Dojo's slideToObject() instead.

'noupdate' is an optional parameter. If set to "true" it will prevent the Stock display from changing. This is useful when multiple (but not all) items are removed at the same time, to avoid ghost items appearing briefly. If you pass noupdate you have to call updateDisplay() after all items are removed.

'''removeFromStockById( id, to, noupdate )'''

Remove an item with a specific ID from the stock.

'to' is an optional parameter. If "to" contains the ID of an HTML element, the item removed from the Stock slides to this HTML element before it disappears. Note that this method does not expose the associated animation object, however, so it's not possible to trigger other actions when it finishes, for example. If you need to do that, use Dojo's slideToObject() instead.

'noupdate' is an optional parameter. If set to "true" it will prevent the Stock display from changing. This is useful when multiple (but not all) items are removed at the same time, to avoid ghost items appearing briefly. If you pass noupdate you have to call updateDisplay() after all items are removed.

'''removeAll()'''

Remove all items from the stock.

'''removeAllTo( to )'''

Remove all items from the stock. If "to" contains the ID of an HTML element, the item removed from the stock slides to this HTML element before it disappears.

=== Getters ===

'''getPresentTypeList()'''

Return an array with all the types of items present in the stock right now.

Example:
<pre>
this.myStockControl.removeAll();
this.myStockControl.addToStock( 65 );
this.myStockControl.addToStock( 34 );
this.myStockControl.addToStock( 89 );
this.myStockControl.addToStock( 65 );

// The following returns: { 34:1, 65:1, 89:1 }
var item_types = this.myStockControl.getPresentTypeList();
</pre>

'''count():'''

Return the total number of items in the stock right now.

'''getAllItems()'''

Get all items (same format as getSelectedItems and getUnselectedItems).

'''getItemDivId(id)'''

Get the div id using the stock item id (to manipulate element properties directly).

'''getItemById(id)'''

Get the Stock item with the id in parameter
ex : return the object { type:1, id: 1001 }

=== Selection ===

'''setSelectionMode( mode )'''

For each stock control, you can specify a selection mode:
* 0: no item can be selected by the player.
* 1: a maximum of one item can be selected by the player at a time.
* 2 (default): multiple items can be selected by the player at the same time.

'''setSelectionAppearance( type )'''

For each stock control, you can specify a selection highlighting type:
* '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).
* 'disappear': the selected item will fade out and disappear. This is useful when the selection has the effect of destroying the item.
* 'class': there will be an extra '''stockitem_selected''' css class added to the element when it is selected (and removed when unselected). The name of the class can be changed by using the '''selectionClass''' attribute. You can also override the default class in the css file for your game but beware of the '''!important''' keyword.

By default this class definition is:
<pre>
.stockitem_selected {
border: 2px solid red ! important;
}
</pre>

If you want to override it (for example, to change the border color) add this in your <game>.css file:
<pre>
.stockitem_selected {
border: 2px solid orange ! important;
}
</pre>

'''isSelected( id )'''

Return a boolean indicating whether the specified item id has been selected.

'''selectItem( id )'''

Select the specified item.

'''unselectItem( id )'''

Unselect the specified item.

'''unselectAll()'''

Unselect all items of the stock.

'''onChangeSelection'''

This callback method is called when the player selects/unselects an item of the stock.

You can connect this to one of your methods like this:

<pre>
dojo.connect( this.myStockControl, 'onChangeSelection', this, 'onMyMethodToCall' );

(...)

onMyMethodToCall: function( control_name, item_id )
{
// This method is called when myStockControl selected items changed
var items = this.myStockControl.getSelectedItems();

// (do something)
},
</pre>

Nota bene:
- The "control_name" argument is the ID (the "DOM" id) of the "div" container of your stock control. Using "control_name", you can use the same callback method for different Stock control and see which one trigger the method.
- The "item_id" argument is the stock ID (index) of the stock item that has just been selected/unselected.

'''getSelectedItems()'''

Return the list of selected items, as an array with the following format:
<pre>
[
{ type:1, id: 1001 },
{ type:1, id: 1002 },
{ type:3, id: 1003 }
...
]
</pre>

'''getUnselectedItems()'''

Same as the previous one, but return unselected item instead of seleted ones.

=== Layout ===

'''resetItemsPosition()'''

If you moved an item from the stock control manually (ex: after a drag'n'drop) and want to reset their positions to their original ones, you can call this method.
Note: it is the same as updateDisplay() without arugment, not sure why there are two methods.

'''updateDisplay(from)'''
Update the display completely (if 'from' is defined: moves new items from this location).

Example code if you change the underlying stock item, or otherwise want to make the stock item refresh:
<pre>
this.myStockControl.updateDisplay();
</pre>

'''item_margin'''

By default, there is a margin of 5px between the items of a stock. You can change the member variable "item_margin" to change this.

Example:
<pre>
this.myStockControl.item_margin=5;
</pre>

'''changeItemsWeight( newWeights )'''

With this method you can change dynamically the weight of the item types in a stock control.

Items are immediately re-sorted with the new weight.

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.

newWeights is an associative array: item type id => new weight.

Example:
<pre>
// Item type 1 gets a new weight of 10, 2 a new weight of 20, 3 a new weight of 30.
this.myStockControl.changeItemsWeight( { 1: 10, 2: 20, 3: 30 } );
</pre>

Example2:
<pre>
// Be careful with object initialisers with variables, use the bracket notation.
// Item type 1 gets a new weight of 10
var card_type = 1;
this.myStockControl.changeItemsWeight( { [card_type]: 10 } );
</pre>

'''centerItems'''

Center the stock items in the middle of the stock container.
e.g. this.myStock.centerItems = true;

'''setOverlap( horizontal_percent, vertical_percent )'''

Make items of the stock control "overlap" each other, to save space.

By default, horizontal_overlap and vertical_overlap are 0.

When horizontal_overlap=20, it means that a stock item will overlap to only show 20% of the width of all the previous items. horizontal_overlap can't be greater than 100.

vertical_overlap works differently: one items on two are shifted up.

See the games "Jaipur" or "Koryŏ" to see examples of use of this function.

'''autowidth'''

Stock does not play well if you attempt to inline-block it with other blocks, to fix that you have to set this flag which will calculate width properly
mystock.autowidth = true;

'''resizeItems'''

<pre> stock.resizeItems(width, height, background-width, background-height);</pre>

=== Customize apperance ===

'''extraClasses'''

Can be set to a list of class names (separated by space) on stock object, so when div is created these are added, i.e.

this.playerHand.extraClasses='mycard';

Note that it is the same list for all items.

'''onItemCreate'''

Using onItemCreate, you can trigger a method each time a new item is added to the Stock, in order to customize it.

Complete example:
<pre>
// During "setup" phase, we associate our method "setupNewCard" with the creation of a new stock item:
this.myStockItem.onItemCreate = dojo.hitch( this, 'setupNewCard' );

// And here is our "setupNewCard":
setupNewCard: function( card_div, card_type_id, card_id )
{
// Add a special tooltip on the card:
this.addTooltip( card_div.id, _("Some nice tooltip for this item"), '' );

// Note that "card_type_id" contains the type of the item, so you can do special actions depending on the item type

// Add some custom HTML content INSIDE the Stock item:
dojo.place( this.format_block( 'jstpl_my_card_content', {
....
} ), card_div.id );
}

</pre>

'''onItemDelete'''

Function handler called when div is removed

this.myStock.onItemDelete = (card_div, card_type_id, card_id) => { console.log("card deleted from myStock: "+card_id); };

== Tips when adding/removing items to/from Stock components ==

Most cases will be one of the following situations:

'''Situation A''':

When you add a card to a stock item, and this card is '''not''' coming from another stock:

* Use '''addToStockWithId''' with a "from" argument set to the element of your interface where the card should come from (i.e. div id). For example if you want to "reveal" card from player hand and it is not an interface element you can set from to be 'player_board_'+activePlayerId (where activePlayerId is player who played that card).

'''Situation B''':

When you add a card to a stock item, and this card is coming from another stock:

* On the destination Stock, use '''addToStockWithId''' with a "from" argument which is the HTML id of the corresponding item in the source Stock. For example, if the source stock id is "myHand", then the HTML id of card 48 is "myHand_item_48".
* Then, remove the source item with '''removeFromStockById'''. Note: do NOT set the 'to' argument in this call, otherwise you'll get two animations.

(Note that it's important to do things in this order, because the source item must still exist when you use it as the origin of the slide.)

'''Situation C''':

When you move a card from a stock item to something that is not a stock item:

* Insert the card as a classic HTML template (dojo.place / this.format_block).
* Place it on the Stock item with '''this.placeOnObject''', using the Stock item HTML id (see above).
* Slide it to its new position with '''this.slideToObject'''.
* Remove the card from the Stock item with '''removeFromStockById'''.

Using the methods above, your cards should slide to, from, and between your Stock controls smoothly.

You can customize this (showing the default value):
<pre>

this.mystock.jstpl_stock_item= "<div id=\"${id}\" class=\"stockitem\" style=\"top:${top}px;left:${left}px;width:${width}px;height:${height}px;z-index:${position};background-image:url('${image}');\"></div>";
</pre>
To produce a different type of stock item

== Known issues ==

==== Incorrectly displayed sprites on Safari ====

As mentioned above, stock displays its images using "sprites" consisting of a portion of a larger image. To accomplish this, it uses the CSS background-position attribute in negative multiples of 100%. For example, the first element of the first row would be 0% 0%. The second element of the first row would be -100% 0%, etc.

This works fine except in Safari, which sometimes slightly modifies the width of elements at smaller screen sizes (usually when minimum width of 'game_interface_width' is not null) in game. For example, you might get a ~49.99px x ~49.99px div instead of the 50px x 50px specified by CSS width/height. Combined with using percentages in background-position, this can cause sprites to be slightly off-center.

Using pixels in background-position is probably the easiest way to fix this problem, but that would require modifying the stock code itself. As a developer, you can also work around the problem by specifying a background-size attribute based on the size in elements of your source image. For example, if you have a source image that contains 5 rows of 28 sprites, you should specify "background-size: 2800% 500%;"

You can add background-size to your stock items by using the extraClasses attribute as explained above and then specifying the values in your game.css file.

[[Category:Studio]]

Stock

2022-07-14T14:13:32Z

RicardoRix: /* Layout */

{{Studio_Framework_Navigation}}

== Overview ==

'''Stock''' is a javascript component that you can use in your game interface to display a set of elements of the same size that need to be arranged in single or multiple lines.

Stock is very flexible and is the most used component in BGA games.

Examples of stock use cases:

* Display a set of cards, typically hands (examples: ''Hearts'', ''Seasons'', ''The Boss'', ''Race for the Galaxy'').
* Display items in player panels (examples: ''Takenoko'', ''Amyitis'', ...)
* ... Many other situations. For example, black dice and cubes on cards in ''Troyes'' are displayed with stock components.

Using stock:

* Your items are arranged nicely and sorted by type.
* When adding or removing items to a set, all items slide smoothly to their new position in the set.
* Selecting and unselecting items are built-in functions.
* You don't have to worry about inserting/removing HTML code; the entire life cycle of the stock is managed by the component.

== Using stock: a simple example ==

Let's have a look on how the stock is used in the game ''Hearts'' to display a hand of standard cards.

First, don't forget to add "ebg/stock" as a dependency in your js file:

<pre>
define([
"dojo","dojo/_base/declare",
"ebg/core/gamegui",
"ebg/counter",
"ebg/stock" /// <==== HERE
],
</pre>

The stock is initialized in the Javascript "setup" method like this:

<pre>
// Player hand
this.playerHand = new ebg.stock();
this.playerHand.create( this, $('myhand'), this.cardwidth, this.cardheight );
</pre>

Explanations:
* We create a new stock object for the player hand.
* As parameters of the "create" method, we provide the width/height of an item (a card), and the div container "myhand" - which is a simple empty "div" element defined in our HTML template (.tpl).

Then, we must tell the stock what 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 a "CSS sprite" image named "cards.jpg" with the cards arranged in 4 rows and 13 columns.

Here's how we tell stock what items to display:

<pre>
// Specify that there are 13 images per row in the CSS sprite image
this.playerHand.image_items_per_row = 13;

// Create card types:
for( var color=1;color<=4;color++ )
{
for( var value=2;value<=14;value++ )
{
// Build card type id
var card_type_id = this.getCardUniqueId( color, value );
this.playerHand.addItemType( card_type_id, card_type_id, g_gamethemeurl+'img/cards.jpg', card_type_id );
}
}
</pre>

Explanation:

* 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.
* Then for the 4x13 cards, we call the "addItemType" method that creates 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.

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

From now on, if we need to add a card - for example, the 5 of Hearts - to a player's hand, we can do this:

<pre>
this.playerHand.addToStock( this.getCardUniqueId( 2 /* 2=hearts */, 5 ) );
</pre>

In reality, cards have some IDs, which are useful to manipulate them. This is the reason we are using "addToStockWithId" instead:

<pre>
this.playerHand.addToStockWithId( this.getCardUniqueId( 2 /* 2=hearts */, 5 ), my_card_id );
</pre>

If afterwards we want to remove this card from the stock:

<pre>
this.playerHand.removeFromStockById( my_card_id );
</pre>

== Complete stock component reference ==

=== Creation ===

'''create( page, container_div, item_width, item_height ):'''

With create, you create a new stock component.

Parameters:
* page: the container page. Usually: "this".
* container_div: the container "div" element (an empty div element in your template, with an id).
* width and height (in pixels) for the stock component.

(See ''Hearts'' example above).

'''addItemType( type, weight, image, image_position ):'''

Define a new type of item and add it to the stock.

This is mandatory to define a new item type before adding it to the stock. Example: if you want to have a stock contain cubes of 3 different colors, you must add 3 item types (one for each color).

Parameters:
* {int} type: id of the type to add. You can choose any positive integer. All item types must have distinct IDs.
* {int} 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.
* {string} image: URL of item image. Most of the time, you will use a CSS sprite for stock items, so you have to specify CSS sprite image here.

Be careful: you must specify the image url as this:

<pre>
g_gamethemeurl+'img/yourimage.png'
</pre>

* image_position: if "image" 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 "0" for the first cube image, 1 for the second, 2 for the third.

''Important'': if there is more than one line of items in your CSS sprite, you must specify how many items per line you have in your CSS sprite, see image_items_per_row below:

'''image_items_per_row'''
Class member to set number of columns in css sprite (or how many items per row). I.e. if you sprite is 4 cards horizontally and 6 vertically, you have to set it to 4.
<pre>
// Specify that there are 10 image items per row in images used in "myStockObject" control.
this.myStockObject.image_items_per_row = 4;
</pre>

=== Add/Remove items ===

'''addToStock( type, from )'''

Add an item to the stock, with the specified type, but without a unique ID.

To make your life easier, in most cases we suggest you use '''addToStockWithId''' in order to give an ID to the item added. '''addToStock''' is suitable when you are using a stock to control items that are generic game materials that don't need to be tracked individually (example: a bunch of money tokens).

Parameters:
* type: ID of the item type to use (as specified in "addItemType")
* from: OPTIONAL: if you specify an HTML item here, the item will appear on this item and will be slid to its position on the stock item.

Example:
<pre>
// Add a money token to the "player money" stock.
// The money token will appear on "player_id" player panel and will move to its position.
this.playerMoney.addToStock( MONEY_TOKEN, 'overall_player_board_'+player_id );
</pre>

Important: for a given stock control, you must use either '''addToStock''' or '''addToStockWithId''', but NEVER BOTH OF THEM.

'''addToStockWithId( type, id, from )'''

This is the same method as '''addToStock''', except that it also associates an ID with the newly created item.

This is especially useful:

* When you need to know which item(s) have been selected by the user (see '''getSelectedItems''').
* When you need to remove a specific item from the stock with '''removeFromStockById'''.

'''removeFromStock( type, to, noupdate )'''

Remove an item of the specific type from the stock.

'to' is an optional parameter. If "to" contains the ID of an HTML element, the item removed from the Stock slides to this HTML element before it disappears. Note that this method does not expose the associated animation object, however, so it's not possible to trigger other actions when it finishes, for example. If you need to do that, use Dojo's slideToObject() instead.

'noupdate' is an optional parameter. If set to "true" it will prevent the Stock display from changing. This is useful when multiple (but not all) items are removed at the same time, to avoid ghost items appearing briefly. If you pass noupdate you have to call updateDisplay() after all items are removed.

'''removeFromStockById( id, to, noupdate )'''

Remove an item with a specific ID from the stock.

'to' is an optional parameter. If "to" contains the ID of an HTML element, the item removed from the Stock slides to this HTML element before it disappears. Note that this method does not expose the associated animation object, however, so it's not possible to trigger other actions when it finishes, for example. If you need to do that, use Dojo's slideToObject() instead.

'noupdate' is an optional parameter. If set to "true" it will prevent the Stock display from changing. This is useful when multiple (but not all) items are removed at the same time, to avoid ghost items appearing briefly. If you pass noupdate you have to call updateDisplay() after all items are removed.

'''removeAll()'''

Remove all items from the stock.

'''removeAllTo( to )'''

Remove all items from the stock. If "to" contains the ID of an HTML element, the item removed from the stock slides to this HTML element before it disappears.

=== Getters ===

'''getPresentTypeList()'''

Return an array with all the types of items present in the stock right now.

Example:
<pre>
this.myStockControl.removeAll();
this.myStockControl.addToStock( 65 );
this.myStockControl.addToStock( 34 );
this.myStockControl.addToStock( 89 );
this.myStockControl.addToStock( 65 );

// The following returns: { 34:1, 65:1, 89:1 }
var item_types = this.myStockControl.getPresentTypeList();
</pre>

'''count():'''

Return the total number of items in the stock right now.

'''getAllItems()'''

Get all items (same format as getSelectedItems and getUnselectedItems).

'''getItemDivId(id)'''

Get the div id using the stock item id (to manipulate element properties directly).

'''getItemById(id)'''

Get the Stock item with the id in parameter
ex : return the object { type:1, id: 1001 }

=== Selection ===

'''setSelectionMode( mode )'''

For each stock control, you can specify a selection mode:
* 0: no item can be selected by the player.
* 1: a maximum of one item can be selected by the player at a time.
* 2 (default): multiple items can be selected by the player at the same time.

'''setSelectionAppearance( type )'''

For each stock control, you can specify a selection highlighting type:
* '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).
* 'disappear': the selected item will fade out and disappear. This is useful when the selection has the effect of destroying the item.
* 'class': there will be an extra '''stockitem_selected''' css class added to the element when it is selected (and removed when unselected). The name of the class can be changed by using the '''selectionClass''' attribute. You can also override the default class in the css file for your game but beware of the '''!important''' keyword.

By default this class definition is:
<pre>
.stockitem_selected {
border: 2px solid red ! important;
}
</pre>

If you want to override it (for example, to change the border color) add this in your <game>.css file:
<pre>
.stockitem_selected {
border: 2px solid orange ! important;
}
</pre>

'''isSelected( id )'''

Return a boolean indicating whether the specified item id has been selected.

'''selectItem( id )'''

Select the specified item.

'''unselectItem( id )'''

Unselect the specified item.

'''unselectAll()'''

Unselect all items of the stock.

'''onChangeSelection'''

This callback method is called when the player selects/unselects an item of the stock.

You can connect this to one of your methods like this:

<pre>
dojo.connect( this.myStockControl, 'onChangeSelection', this, 'onMyMethodToCall' );

(...)

onMyMethodToCall: function( control_name, item_id )
{
// This method is called when myStockControl selected items changed
var items = this.myStockControl.getSelectedItems();

// (do something)
},
</pre>

Nota bene:
- The "control_name" argument is the ID (the "DOM" id) of the "div" container of your stock control. Using "control_name", you can use the same callback method for different Stock control and see which one trigger the method.
- The "item_id" argument is the stock ID (index) of the stock item that has just been selected/unselected.

'''getSelectedItems()'''

Return the list of selected items, as an array with the following format:
<pre>
[
{ type:1, id: 1001 },
{ type:1, id: 1002 },
{ type:3, id: 1003 }
...
]
</pre>

'''getUnselectedItems()'''

Same as the previous one, but return unselected item instead of seleted ones.

=== Layout ===

'''resetItemsPosition()'''

If you moved an item from the stock control manually (ex: after a drag'n'drop) and want to reset their positions to their original ones, you can call this method.
Note: it is the same as updateDisplay() without arugment, not sure why there are two methods.

'''updateDisplay(from)'''
Update the display completely (if 'from' is defined: moves new items from this location).

Example code if you change the underlying stock item, or otherwise want to make the stock item refresh:
<pre>
this.myStockControl.updateDisplay();
</pre>

'''item_margin'''

By default, there is a margin of 5px between the items of a stock. You can change the member variable "item_margin" to change this.

Example:
<pre>
this.myStockControl.item_margin=5;
</pre>

'''changeItemsWeight( newWeights )'''

With this method you can change dynamically the weight of the item types in a stock control.

Items are immediately re-sorted with the new weight.

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.

newWeights is an associative array: item type id => new weight.

Example:
<pre>
// Item type 1 gets a new weight of 10, 2 a new weight of 20, 3 a new weight of 30.
this.myStockControl.changeItemsWeight( { 1: 10, 2: 20, 3: 30 } );
</pre>

Example2:
<pre>
// Be careful with object initialisers with variables, use the bracket notation.
// Item type 1 gets a new weight of 10
var card_type = 1;
this.myStockControl.changeItemsWeight( { [card_type]: 10 } );
</pre>

'''centerItems'''

Center the stock items in the middle of the stock container.
e.g. this.myStock.centerItems = true;

'''setOverlap( horizontal_percent, vertical_percent )'''

Make items of the stock control "overlap" each other, to save space.

By default, horizontal_overlap and vertical_overlap are 0.

When horizontal_overlap=20, it means that a stock item will overlap to only show 20% of the width of all the previous items. horizontal_overlap can't be greater than 100.

vertical_overlap works differently: one items on two are shifted up.

See the games "Jaipur" or "Koryŏ" to see examples of use of this function.

'''autowidth'''

Stock does not play well if you attempt to inline-block it with other blocks, to fix that you have to set this flag which will calculate width properly
mystock.autowidth = true;

'''resizeItems'''

resizeItems(width, height, <background-width>, <background-height>);

=== Customize apperance ===

'''extraClasses'''

Can be set to a list of class names (separated by space) on stock object, so when div is created these are added, i.e.

this.playerHand.extraClasses='mycard';

Note that it is the same list for all items.

'''onItemCreate'''

Using onItemCreate, you can trigger a method each time a new item is added to the Stock, in order to customize it.

Complete example:
<pre>
// During "setup" phase, we associate our method "setupNewCard" with the creation of a new stock item:
this.myStockItem.onItemCreate = dojo.hitch( this, 'setupNewCard' );

// And here is our "setupNewCard":
setupNewCard: function( card_div, card_type_id, card_id )
{
// Add a special tooltip on the card:
this.addTooltip( card_div.id, _("Some nice tooltip for this item"), '' );

// Note that "card_type_id" contains the type of the item, so you can do special actions depending on the item type

// Add some custom HTML content INSIDE the Stock item:
dojo.place( this.format_block( 'jstpl_my_card_content', {
....
} ), card_div.id );
}

</pre>

'''onItemDelete'''

Function handler called when div is removed

this.myStock.onItemDelete = (card_div, card_type_id, card_id) => { console.log("card deleted from myStock: "+card_id); };

== Tips when adding/removing items to/from Stock components ==

Most cases will be one of the following situations:

'''Situation A''':

When you add a card to a stock item, and this card is '''not''' coming from another stock:

* Use '''addToStockWithId''' with a "from" argument set to the element of your interface where the card should come from (i.e. div id). For example if you want to "reveal" card from player hand and it is not an interface element you can set from to be 'player_board_'+activePlayerId (where activePlayerId is player who played that card).

'''Situation B''':

When you add a card to a stock item, and this card is coming from another stock:

* On the destination Stock, use '''addToStockWithId''' with a "from" argument which is the HTML id of the corresponding item in the source Stock. For example, if the source stock id is "myHand", then the HTML id of card 48 is "myHand_item_48".
* Then, remove the source item with '''removeFromStockById'''. Note: do NOT set the 'to' argument in this call, otherwise you'll get two animations.

(Note that it's important to do things in this order, because the source item must still exist when you use it as the origin of the slide.)

'''Situation C''':

When you move a card from a stock item to something that is not a stock item:

* Insert the card as a classic HTML template (dojo.place / this.format_block).
* Place it on the Stock item with '''this.placeOnObject''', using the Stock item HTML id (see above).
* Slide it to its new position with '''this.slideToObject'''.
* Remove the card from the Stock item with '''removeFromStockById'''.

Using the methods above, your cards should slide to, from, and between your Stock controls smoothly.

You can customize this (showing the default value):
<pre>

this.mystock.jstpl_stock_item= "<div id=\"${id}\" class=\"stockitem\" style=\"top:${top}px;left:${left}px;width:${width}px;height:${height}px;z-index:${position};background-image:url('${image}');\"></div>";
</pre>
To produce a different type of stock item

== Known issues ==

==== Incorrectly displayed sprites on Safari ====

As mentioned above, stock displays its images using "sprites" consisting of a portion of a larger image. To accomplish this, it uses the CSS background-position attribute in negative multiples of 100%. For example, the first element of the first row would be 0% 0%. The second element of the first row would be -100% 0%, etc.

This works fine except in Safari, which sometimes slightly modifies the width of elements at smaller screen sizes (usually when minimum width of 'game_interface_width' is not null) in game. For example, you might get a ~49.99px x ~49.99px div instead of the 50px x 50px specified by CSS width/height. Combined with using percentages in background-position, this can cause sprites to be slightly off-center.

Using pixels in background-position is probably the easiest way to fix this problem, but that would require modifying the stock code itself. As a developer, you can also work around the problem by specifying a background-size attribute based on the size in elements of your source image. For example, if you have a source image that contains 5 rows of 28 sprites, you should specify "background-size: 2800% 500%;"

You can add background-size to your stock items by using the extraClasses attribute as explained above and then specifying the values in your game.css file.

[[Category:Studio]]

Gamehelpcommanderchess

2022-06-20T09:21:35Z

RicardoRix:

== Description ==
Commander Chess, or Cờ tư lệnh (literally "Chess Command") is a xiangqi variant created by Hải Quý Nguyễn.

Cờ tư lệnh is played with 38 pieces (19 per player) on a board that is 11 lines wide and 12 lines long. It is played on the vertices of the grid. The board is divided into two land territories by a river in the middle of the board. The three files on one side of the board form the sea.

== Object of the game ==
To win you must capture the opponent's Commander, or all units of a single division of the opponent's army:
*Sea - Both Navy ships. 2 pieces total.
*Land - Artillery, Tanks, Infantry. 6 pieces total.
*Air - Both Planes. 2 pieces total.
*Commander - 1 piece total.

== Pieces and movement ==

* All pieces have a range of movement. For example if a piece has a range of 3, then it may move 1, 2 or 3 spaces.
* All pieces move orthogonally (like a castle in standard chess), and some also move diagonally (like a queen in standard chess).
* Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.
* Normally pieces block other pieces from moving but some pieces can Jump over other pieces.
* Some pieces can carry other pieces, a piece will embark onto the carrier and share the same location. Either piece can move to the other piece. See 'Stack moves'.
* Anti-Aircraft pieces provide a Ring-of-fire range. See 'Airspace' for more details.

{| class="wikitable" style="text-align:center;"
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Commander
| [[File:commander.png|50px]]
| C
| Land
| 10
| -
| -
| T,N,Af,HQ
| -
| -
| -
| If captured you lose.
Cannot goes past opponents C line-of-sight, and if you open a direct line-of-sight then you immediately lose.
If opponents pieces place the commander in check they gain 'hero' status.
The commander has protection inside the HQ from pieces[In,M,Aa,Ms].
|-

| Infantry
| [[File:infantry.png|50px]]
| I
| Land
| 1
| -
| -
| T,N,Af
| -
| -
| -
| -

|-
| Tank
| [[File:tank.png|50px]]
| I
| Land
| 2
| -
| C,In,M
| N,Af
| -
| -
| -
| Only 1 tank maybe carried by a Navy on Plane.
May only carry 1 Infantry.

|-
| Militia
| [[File:militia.png|50px]]
| M
| Land
| 1
| yes
| -
| T,N,Af
| -
| -
| -
| -

|-
| Engineer
| [[File:engineer.png|50px]]
| E
| Land
| 1
| -
| A, Aa, Ms
| -
| -
| -
| -
| May carry all pieces, but only the single space across the river.

|-
| Artillery
| [[File:artillery.png|50px]]
| A
| Land
| 3
| yes
| -
| E
| to capture
| restriction
| -
| May jump over other pieces to capture.
May only cross the river at 2 BANK positions, but can capture and move across the sea.
May cross the sea if being carried.

|-
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Anti-Aircraft
| [[File:aa.png|50px]]
| Aa
| Land
| 1
| -
| -
| E
| -
| restriction
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Missile
| [[File:missile.png|50px]]
| Ms
| Land
| 1
| -
| -
| E
| -
| restriction
| 2
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Headquaters
| [[File:hq.png|50px]]
| HQ
| Land
| 0
| -
| C
| -
| -
| -
| -
| Doesn't move. Protects commander against [In,M,Aa,Ms]

|-
| Airforce
| [[File:plane.png|50px]]
| Af
| Air
| 4
| yes
| T,In,M
| N
| yes
| -
| shot down
| May perform 'bombing' on an opponents land and sea pieces (not Af) and return to original position. See 'Airspace' for more details about being shot-down.

|-
| Navy
| [[File:navy.png|50px]]
| N
| Sea
| 4 (3)
| yes
| Af,T,In,M
| -
| yes
| -
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
Cannot diagonally move across land, but can fire gun (range 3) onto land pieces. If it can legally move to capture a piece, it does.
May move into the river but may not move onto or passed the bank.

|}

==Airspace==
When moving Planes'''[Af]''' may be shot down by the opponents anti-aircraft pieces.

Anti-Aircraft Pieces (range): '''[Ms]'''Missile(2), '''[Aa]'''Anti-Aircraft(1), '''[N]'''Navy(1).
''''Note'''': this range a circular radius.

A plane can commit kamikaze (capture the opponents piece) while staying in opponents anti-aircraft range; But if the plane leaves the ROF before reaching it's target then it will be shot down, and will be unsuccessful in performing kamikaze. Please see image for cases of 2 Aa pieces.

[[File:4planes.png]]

The last '''[Af]''' plane committing kamikaze against the opponents last '''[N]''' Navy will win the game, even though the plane gets shot down.

A plane can get shot down during it's own turn due to anti-aircraft pieces, when this happens a player cannot undo their turn.

==General rules==
Pieces capture as they move, and never jump, unless noted.

Pieces can cross the river but not occupy sea points unless noted.

'''[N]'''Navy piece may not cut across land when moving diagonally.

Pieces which check the opposing Commander are promoted, gaining 'hero' status and gain special abilities.

Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.

When a land piece captures a '''[N]'''Navy at sea (not the coast), it must stay where it is.
When a '''[N]'''Navy captures a land piece in-land (not the coast), it must stay where it is.
If navy/land piece capture is at coast position, then the captured piece is replaced as usual.

== Stack: Pieces that can carry other pieces ==

'''Stacks''' are a group of pieces all at the same location. They may form groups of 2 or 3 pieces.

A stack of pieces can all move in a single turn. The stack may move as a single group or any piece from the stack may instead disembark and move elsewhere. Multiple captures are possible. See the user interface section for specific instructions on moving with the stack.

The following list are pieces that can be carriers followed by the pieces and restrictions of what they can carry:

'''Stacks''' maximum group of '''3 pieces''' (1 carrier and 2 other pieces)
* '''[N]'''Navy. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank, '''[Af]'''Plane.
* '''[Af]'''Plane. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank. '''but not 2 tanks'''.
* '''[T]'''Tank. May carry 1 '''[In]'''Infantry and 1 other piece. '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia.

'''Stacks''' maximum group of '''2 pieces''' (1 carrier and 1 other piece):
* '''[HQ]'''Headquarters, may hold '''[C]'''Commander. '''HQ does not move'''
* '''[E]'''Engineer, may carry heavy weapons '''[A]'''Artillery, '''[Aa]'''Anti-aircraft, '''[Ms]'''Missile '''Also specifically must be carried across the river from one side to the other.'''

== Examples of unusual play ==
Both navy and land pieces may be placed on the coast. A '''[N]''' Navy has a gun and may capture a land piece, if it does then it will only capture and move if this land piece is on the coast, otherwise the '''[N]'''Navy piece will remain still and capture.

'''[E]'''Engineers may only carry pieces from the limited number of river bank spaces, and move just the 1 space across the river. All other carried stack movements with the engineer are not allowed.

'''[A]''' Artillery can only jump over pieces when capturing another piece. Otherwise, they cannot jump over pieces.

On the Sea/Land border (coast) land pieces do not block the movement of a Navy piece and vice versa. So these pieces are not being jumped over. One is on land, the other is in the sea, but both are on the coast.

A commander that exposes themselves to the opponents commander will immediately lose. (Line-of-sight).

Pieces that can jump and are not blocked by ANY piece. '''[Af]''' Plane, '''[N]''' Navy and the Navy gun. '''[A]''' Artillery(but only when capturing),

Without Enforce Check, it's possible to move into check, if you do this with your commander, then the opponents piece will become heroic.

== User Interface ==
* Some pieces stack on top of each other. It is recommended to use the squares to the right of the board from top to bottom. It automatically selects the stack to be moved as 1 group, if you would like to split up the pieces then user must select the pieces individually.
By selecting a box you will see the colour of the box change and the text.

GREEN means this is the selected piece and the piece you are currently moving.

RED means this piece is being carried and will not move separately.

GREY means this piece will move later after you have moved the current GREEN (selected) piece.

'Stay' will mean that the carried piece will disembark and stay in its current position.

* When playing with 'Enforce check' option a player needs to RESIGN if there are no playable moves.

* There are various 'confirm' options available from the context menu (3 lines, burger menu).

* You can play with (0,0) always at the bottom, available from the context menu (3 lines, burger menu).

Gamehelpcommanderchess

2022-06-20T09:17:59Z

RicardoRix:

== Description ==
Commander Chess, or Cờ tư lệnh (literally "Chess Command") is a xiangqi variant created by Hải Quý Nguyễn.

Cờ tư lệnh is played with 38 pieces (19 per player) on a board that is 11 lines wide and 12 lines long. It is played on the vertices of the grid. The board is divided into two land territories by a river in the middle of the board. The three files on one side of the board form the sea.

== Object of the game ==
To win you must capture the opponent's Commander, or all units of a single division of the opponent's army:
*Sea - Both Navy ships. 2 pieces total.
*Land - Artillery, Tanks, Infantry. 6 pieces total.
*Air - Both Planes. 2 pieces total.
*Commander - 1 piece total.

== Pieces and movement ==

* All pieces have a range of movement. For example if a piece has a range of 3, then it may move 1, 2 or 3 spaces.
* All pieces move orthogonally (like a castle in standard chess), and some also move diagonally (like a queen in standard chess).
* Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.
* Normally pieces block other pieces from moving but some pieces can Jump over other pieces.
* Some pieces can carry other pieces, a piece will embark onto the carrier and share the same location. Either piece can move to the other piece. See 'Stack moves'.
* Anti-Aircraft pieces provide a Ring-of-fire range. See 'Airspace' for more details.

{| class="wikitable" style="text-align:center;"
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Commander
| [[File:commander.png|50px]]
| C
| Land
| 10
| -
| -
| T,N,Af,HQ
| -
| -
| -
| If captured you lose.
Cannot goes past opponents C line-of-sight, and if you open a direct line-of-sight then you immediately lose.
If opponents pieces place the commander in check they gain 'hero' status.
The commander has protection inside the HQ from pieces[In,M,Aa,Ms].
|-

| Infantry
| [[File:infantry.png|50px]]
| I
| Land
| 1
| -
| -
| T,N,Af
| -
| -
| -
| -

|-
| Tank
| [[File:tank.png|50px]]
| I
| Land
| 2
| -
| C,In,M
| N,Af
| -
| -
| -
| Only 1 tank maybe carried by a Navy on Plane.
May only carry 1 Infantry.

|-
| Militia
| [[File:militia.png|50px]]
| M
| Land
| 1
| yes
| -
| T,N,Af
| -
| -
| -
| -

|-
| Engineer
| [[File:engineer.png|50px]]
| E
| Land
| 1
| -
| A, Aa, Ms
| -
| -
| -
| -
| May carry all pieces, but only the single space across the river.

|-
| Artillery
| [[File:artillery.png|50px]]
| A
| Land
| 3
| yes
| -
| E
| to capture
| restriction
| -
| May jump over other pieces to capture.
May only cross the river at 2 BANK positions, but can capture and move across the sea.
May cross the sea if being carried.

|-
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Anti-Aircraft
| [[File:aa.png|50px]]
| Aa
| Land
| 1
| -
| -
| E
| -
| restriction
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Missile
| [[File:missile.png|50px]]
| Ms
| Land
| 1
| -
| -
| E
| -
| restriction
| 2
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Headquaters
| [[File:hq.png|50px]]
| HQ
| Land
| 0
| -
| C
| -
| -
| -
| -
| Doesn't move. Protects commander against [In,M,Aa,Ms]

|-
| Airforce
| [[File:plane.png|50px]]
| Af
| Air
| 4
| yes
| T,In,M
| N
| yes
| -
| shot down
| May perform 'bombing' on an opponents land and sea pieces (not Af) and return to original position. See 'Airspace' for more details about being shot-down.

|-
| Navy
| [[File:navy.png|50px]]
| N
| Sea
| 4 (3)
| yes
| Af,T,In,M
| -
| yes
| -
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
Cannot diagonally move across land, but can fire gun (range 3) onto land pieces. If it can legally move to capture a piece, it does.
May move into the river but may not move onto or passed the bank.

|}

==Airspace==
When moving Planes'''[Af]''' may be shot down by the opponents anti-aircraft pieces.

Anti-Aircraft Pieces (range): '''[Ms]'''Missile(2), '''[Aa]'''Anti-Aircraft(1), '''[N]'''Navy(1).
''''Note'''': this range a circular radius.

A plane can commit kamikaze (capture the opponents piece) while staying in opponents anti-aircraft range; But if the plane leaves the ROF before reaching it's target then it will be shot down, and will be unsuccessful in performing kamikaze. Please see image for cases of 2 Aa pieces.

[[File:4planes.png]]

The last '''[Af]''' plane committing kamikaze against the opponents last '''[N]''' Navy will win the game, even though the plane gets shot down.

A plane can get shot down during it's own turn due to anti-aircraft pieces, when this happens a player cannot undo their turn.

==General rules==
Pieces capture as they move, and never jump, unless noted.

Pieces can cross the river but not occupy sea points unless noted.

'''[N]'''Navy piece may not cut across land when moving diagonally.

Pieces which check the opposing Commander are promoted, gaining 'hero' status and gain special abilities.

Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.

When a land piece captures a '''[N]'''Navy, it must stay where it is. When a '''[N]'''Navy captures a land piece, in-land they can stay where they are. But if navy captures a land piece at coast position, it must be most there and replace the captured piece.

== Stack: Pieces that can carry other pieces ==

'''Stacks''' are a group of pieces all at the same location. They may form groups of 2 or 3 pieces.

A stack of pieces can all move in a single turn. The stack may move as a single group or any piece from the stack may instead disembark and move elsewhere. Multiple captures are possible. See the user interface section for specific instructions on moving with the stack.

The following list are pieces that can be carriers followed by the pieces and restrictions of what they can carry:

'''Stacks''' maximum group of '''3 pieces''' (1 carrier and 2 other pieces)
* '''[N]'''Navy. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank, '''[Af]'''Plane.
* '''[Af]'''Plane. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank. '''but not 2 tanks'''.
* '''[T]'''Tank. May carry 1 '''[In]'''Infantry and 1 other piece. '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia.

'''Stacks''' maximum group of '''2 pieces''' (1 carrier and 1 other piece):
* '''[HQ]'''Headquarters, may hold '''[C]'''Commander. '''HQ does not move'''
* '''[E]'''Engineer, may carry heavy weapons '''[A]'''Artillery, '''[Aa]'''Anti-aircraft, '''[Ms]'''Missile '''Also specifically must be carried across the river from one side to the other.'''

== Examples of unusual play ==
Both navy and land pieces may be placed on the coast. A '''[N]''' Navy has a gun and may capture a land piece, if it does then it will only capture and move if this land piece is on the coast, otherwise the '''[N]'''Navy piece will remain still and capture.

'''[E]'''Engineers may only carry pieces from the limited number of river bank spaces, and move just the 1 space across the river. All other carried stack movements with the engineer are not allowed.

'''[A]''' Artillery can only jump over pieces when capturing another piece. Otherwise, they cannot jump over pieces.

On the Sea/Land border (coast) land pieces do not block the movement of a Navy piece and vice versa. So these pieces are not being jumped over. One is on land, the other is in the sea, but both are on the coast.

A commander that exposes themselves to the opponents commander will immediately lose. (Line-of-sight).

Pieces that can jump and are not blocked by ANY piece. '''[Af]''' Plane, '''[N]''' Navy and the Navy gun. '''[A]''' Artillery(but only when capturing),

Without Enforce Check, it's possible to move into check, if you do this with your commander, then the opponents piece will become heroic.

== User Interface ==
* Some pieces stack on top of each other. It is recommended to use the squares to the right of the board from top to bottom. It automatically selects the stack to be moved as 1 group, if you would like to split up the pieces then user must select the pieces individually.
By selecting a box you will see the colour of the box change and the text.

GREEN means this is the selected piece and the piece you are currently moving.

RED means this piece is being carried and will not move separately.

GREY means this piece will move later after you have moved the current GREEN (selected) piece.

'Stay' will mean that the carried piece will disembark and stay in its current position.

* When playing with 'Enforce check' option a player needs to RESIGN if there are no playable moves.

* There are various 'confirm' options available from the context menu (3 lines, burger menu).

* You can play with (0,0) always at the bottom, available from the context menu (3 lines, burger menu).

Gamehelpcommanderchess

2022-06-20T09:14:26Z

RicardoRix:

== Description ==
Commander Chess, or Cờ tư lệnh (literally "Chess Command") is a xiangqi variant created by Hải Quý Nguyễn.

Cờ tư lệnh is played with 38 pieces (19 per player) on a board that is 11 lines wide and 12 lines long. It is played on the vertices of the grid. The board is divided into two land territories by a river in the middle of the board. The three files on one side of the board form the sea.

== Object of the game ==
To win you must capture the opponent's Commander, or all units of a single division of the opponent's army:
*Sea - Both Navy ships. 2 pieces total.
*Land - Artillery, Tanks, Infantry. 6 pieces total.
*Air - Both Planes. 2 pieces total.
*Commander - 1 piece total.

== Pieces and movement ==

* All pieces have a range of movement. For example if a piece has a range of 3, then it may move 1, 2 or 3 spaces.
* All pieces move orthogonally (like a castle in standard chess), and some also move diagonally (like a queen in standard chess).
* Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.
* Normally pieces block other pieces from moving but some pieces can Jump over other pieces.
* Some pieces can carry other pieces, a piece will embark onto the carrier and share the same location. Either piece can move to the other piece. See 'Stack moves'.
* Anti-Aircraft pieces provide a Ring-of-fire range. See 'Airspace' for more details.

{| class="wikitable" style="text-align:center;"
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Commander
| [[File:commander.png|50px]]
| C
| Land
| 10
| -
| -
| T,N,Af,HQ
| -
| -
| -
| If captured you lose.
Cannot goes past opponents C line-of-sight, and if you open a direct line-of-sight then you immediately lose.
If opponents pieces place the commander in check they gain 'hero' status.
The commander has protection inside the HQ from pieces[In,M,Aa,Ms].
|-

| Infantry
| [[File:infantry.png|50px]]
| I
| Land
| 1
| -
| -
| T,N,Af
| -
| -
| -
| -

|-
| Tank
| [[File:tank.png|50px]]
| I
| Land
| 2
| -
| C,In,M
| N,Af
| -
| -
| -
| Only 1 tank maybe carried by a Navy on Plane.
May only carry 1 Infantry.

|-
| Militia
| [[File:militia.png|50px]]
| M
| Land
| 1
| yes
| -
| T,N,Af
| -
| -
| -
| -

|-
| Engineer
| [[File:engineer.png|50px]]
| E
| Land
| 1
| -
| A, Aa, Ms
| -
| -
| -
| -
| May carry all pieces, but only the single space across the river.

|-
| Artillery
| [[File:artillery.png|50px]]
| A
| Land
| 3
| yes
| -
| E
| to capture
| restriction
| -
| May jump over other pieces to capture.
May only cross the river at 2 BANK positions, but can capture and move across the sea.
May cross the sea if being carried.

|-
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Anti-Aircraft
| [[File:aa.png|50px]]
| Aa
| Land
| 1
| -
| -
| E
| -
| restriction
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Missile
| [[File:missile.png|50px]]
| Ms
| Land
| 1
| -
| -
| E
| -
| restriction
| 2
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Headquaters
| [[File:hq.png|50px]]
| HQ
| Land
| 0
| -
| C
| -
| -
| -
| -
| Doesn't move. Protects commander against [In,M,Aa,Ms]

|-
| Airforce
| [[File:plane.png|50px]]
| Af
| Air
| 4
| yes
| T,In,M
| N
| yes
| -
| shot down
| May perform 'bombing' on an opponents land and sea pieces (not Af) and return to original position. See 'Airspace' for more details about being shot-down.

|-
| Navy
| [[File:navy.png|50px]]
| N
| Sea
| 4 (3)
| yes
| Af,T,In,M
| -
| yes
| -
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
Cannot diagonally move across land, but can fire gun (range 3) onto land pieces. If it can legally move to capture a piece, it does.
May move into the river but may not move onto or passed the bank.

|}

==Airspace==
When moving Planes'''[Af]''' may be shot down by the opponents anti-aircraft pieces.

Anti-Aircraft Pieces (range): '''[Ms]'''Missile(2), '''[Aa]'''Anti-Aircraft(1), '''[N]'''Navy(1).
''''Note'''': this range a circular radius.

A plane can commit kamikaze (capture the opponents piece) while staying in opponents anti-aircraft range; But if the plane leaves the ROF before reaching it's target then it will be shot down, and will be unsuccessful in performing kamikaze. Please see image for cases of 2 Aa pieces.

[[File:4planes.png]]

The last '''[Af]''' plane committing kamikaze against the opponents last '''[N]''' Navy will win the game, even though the plane gets shot down.

A plane can get shot down during it's own turn due to anti-aircraft pieces, when this happens a player cannot undo their turn.

==General rules==
Pieces capture as they move, and never jump, unless noted.

Pieces can cross the river but not occupy sea points unless noted.

'''[N]'''Navy piece may not cut across land when moving diagonally.

Pieces which check the opposing Commander are promoted, gaining 'hero' status and gain special abilities.

Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.

== Stack: Pieces that can carry other pieces ==

'''Stacks''' are a group of pieces all at the same location. They may form groups of 2 or 3 pieces.

A stack of pieces can all move in a single turn. The stack may move as a single group or any piece from the stack may instead disembark and move elsewhere. Multiple captures are possible. See the user interface section for specific instructions on moving with the stack.

The following list are pieces that can be carriers followed by the pieces and restrictions of what they can carry:

'''Stacks''' maximum group of '''3 pieces''' (1 carrier and 2 other pieces)
* '''[N]'''Navy. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank, '''[Af]'''Plane.
* '''[Af]'''Plane. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank. '''but not 2 tanks'''.
* '''[T]'''Tank. May carry 1 '''[In]'''Infantry and 1 other piece. '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia.

'''Stacks''' maximum group of '''2 pieces''' (1 carrier and 1 other piece):
* '''[HQ]'''Headquarters, may hold '''[C]'''Commander. '''HQ does not move'''
* '''[E]'''Engineer, may carry heavy weapons '''[A]'''Artillery, '''[Aa]'''Anti-aircraft, '''[Ms]'''Missile '''Also specifically must be carried across the river from one side to the other.'''

When a land piece captures a '''[N]'''Navy, it must stay where it is. When a '''[N]'''Navy captures a land piece, in-land they can stay where they are. But if navy captures a land piece at coast position, it must be most there and replace the captured piece.

== Examples of unusual play ==
Both navy and land pieces may be placed on the coast. A '''[N]''' Navy has a gun and may capture a land piece, if it does then it will only capture and move if this land piece is on the coast, otherwise the '''[N]'''Navy piece will remain still and capture.

'''[E]'''Engineers may only carry pieces from the limited number of river bank spaces, and move just the 1 space across the river. All other carried stack movements with the engineer are not allowed.

'''[A]''' Artillery can only jump over pieces when capturing another piece. Otherwise, they cannot jump over pieces.

On the Sea/Land border (coast) land pieces do not block the movement of a Navy piece and vice versa. So these pieces are not being jumped over. One is on land, the other is in the sea, but both are on the coast.

A commander that exposes themselves to the opponents commander will immediately lose. (Line-of-sight).

Pieces that can jump and are not blocked by ANY piece. '''[Af]''' Plane, '''[N]''' Navy and the Navy gun. '''[A]''' Artillery(but only when capturing),

Without Enforce Check, it's possible to move into check, if you do this with your commander, then the opponents piece will become heroic.

== User Interface ==
* Some pieces stack on top of each other. It is recommended to use the squares to the right of the board from top to bottom. It automatically selects the stack to be moved as 1 group, if you would like to split up the pieces then user must select the pieces individually.
By selecting a box you will see the colour of the box change and the text.

GREEN means this is the selected piece and the piece you are currently moving.

RED means this piece is being carried and will not move separately.

GREY means this piece will move later after you have moved the current GREEN (selected) piece.

'Stay' will mean that the carried piece will disembark and stay in its current position.

* When playing with 'Enforce check' option a player needs to RESIGN if there are no playable moves.

* There are various 'confirm' options available from the context menu (3 lines, burger menu).

* You can play with (0,0) always at the bottom, available from the context menu (3 lines, burger menu).

Gamehelpcommanderchess

2022-04-09T12:26:20Z

RicardoRix: /* Airspace */

== Description ==
Commander Chess, or Cờ tư lệnh (literally "Chess Command") is a xiangqi variant created by Hải Quý Nguyễn.

Cờ tư lệnh is played with 38 pieces (19 per player) on a board that is 11 lines wide and 12 lines long. It is played on the vertices of the grid. The board is divided into two land territories by a river in the middle of the board. The three files on one side of the board form the sea.

== Object of the game ==
To win you must capture the opponent's Commander, or all units of a single division of the opponent's army:
*Sea - Both Navy ships. 2 pieces total.
*Land - Artillery, Tanks, Infantry. 6 pieces total.
*Air - Both Planes. 2 pieces total.
*Commander - 1 piece total.

== Pieces and movement ==

* All pieces have a range of movement. For example if a piece has a range of 3, then it may move 1, 2 or 3 spaces.
* All pieces move orthogonally (like a castle in standard chess), and some also move diagonally (like a queen in standard chess).
* Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.
* Normally pieces block other pieces from moving but some pieces can Jump over other pieces.
* Some pieces can carry other pieces, a piece will embark onto the carrier and share the same location. Either piece can move to the other piece. See 'Stack moves'.
* Anti-Aircraft pieces provide a Ring-of-fire range. See 'Airspace' for more details.

{| class="wikitable" style="text-align:center;"
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Commander
| [[File:commander.png|50px]]
| C
| Land
| 10
| -
| -
| T,N,Af,HQ
| -
| -
| -
| If captured you lose.
Cannot goes past opponents C line-of-sight, and if you open a direct line-of-sight then you immediately lose.
If opponents pieces place the commander in check they gain 'hero' status.
The commander has protection inside the HQ from pieces[In,M,Aa,Ms].
|-

| Infantry
| [[File:infantry.png|50px]]
| I
| Land
| 1
| -
| -
| T,N,Af
| -
| -
| -
| -

|-
| Tank
| [[File:tank.png|50px]]
| I
| Land
| 2
| -
| C,In,M
| N,Af
| -
| -
| -
| Only 1 tank maybe carried by a Navy on Plane.
May only carry 1 Infantry.

|-
| Militia
| [[File:militia.png|50px]]
| M
| Land
| 1
| yes
| -
| T,N,Af
| -
| -
| -
| -

|-
| Engineer
| [[File:engineer.png|50px]]
| E
| Land
| 1
| -
| A, Aa, Ms
| -
| -
| -
| -
| May carry all pieces, but only the single space across the river.

|-
| Artillery
| [[File:artillery.png|50px]]
| A
| Land
| 3
| yes
| -
| E
| to capture
| restriction
| -
| May jump over other pieces to capture.
May only cross the river at 2 BANK positions, but can capture and move across the sea.
May cross the sea if being carried.

|-
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Anti-Aircraft
| [[File:aa.png|50px]]
| Aa
| Land
| 1
| -
| -
| E
| -
| restriction
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Missile
| [[File:missile.png|50px]]
| Ms
| Land
| 1
| -
| -
| E
| -
| restriction
| 2
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Headquaters
| [[File:hq.png|50px]]
| HQ
| Land
| 0
| -
| C
| -
| -
| -
| -
| Doesn't move. Protects commander against [In,M,Aa,Ms]

|-
| Airforce
| [[File:plane.png|50px]]
| Af
| Air
| 4
| yes
| T,In,M
| N
| yes
| -
| shot down
| May perform 'bombing' on an opponents land and sea pieces (not Af) and return to original position. See 'Airspace' for more details about being shot-down.

|-
| Navy
| [[File:navy.png|50px]]
| N
| Sea
| 4 (3)
| yes
| Af,T,In,M
| -
| yes
| -
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
Cannot diagonally move across land, but can fire gun (range 3) onto land pieces. If it can legally move to capture a piece, it does.
May move into the river but may not move onto or passed the bank.

|}

==Airspace==
When moving Planes'''[Af]''' may be shot down by the opponents anti-aircraft pieces.

Anti-Aircraft Pieces (range): '''[Ms]'''Missile(2), '''[Aa]'''Anti-Aircraft(1), '''[N]'''Navy(1).
''''Note'''': this range a circular radius.

A plane can commit kamikaze (capture the opponents piece) while staying in opponents anti-aircraft range; But if the plane leaves the ROF before reaching it's target then it will be shot down, and will be unsuccessful in performing kamikaze. Please see image for cases of 2 Aa pieces.

[[File:4planes.png]]

The last '''[Af]''' plane committing kamikaze against the opponents last '''[N]''' Navy will win the game, even though the plane gets shot down.

A plane can get shot down during it's own turn due to anti-aircraft pieces, when this happens a player cannot undo their turn.

==General rules==
Pieces capture as they move, and never jump, unless noted.

Pieces can cross the river but not occupy sea points unless noted.

'''[N]'''Navy piece may not cut across land when moving diagonally.

Pieces which check the opposing Commander are promoted, gaining 'hero' status and gain special abilities.

Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.

== Stack: Pieces that can carry other pieces ==

'''Stacks''' are a group of pieces all at the same location. They may form groups of 2 or 3 pieces.

A stack of pieces can all move in a single turn. The stack may move as a single group or any piece from the stack may instead disembark and move elsewhere. Multiple captures are possible. See the user interface section for specific instructions on moving with the stack.

The following list are pieces that can be carriers followed by the pieces and restrictions of what they can carry:

'''Stacks''' maximum group of '''3 pieces''' (1 carrier and 2 other pieces)
* '''[N]'''Navy. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank, '''[Af]'''Plane.
* '''[Af]'''Plane. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank. '''but not 2 tanks'''.
* '''[T]'''Tank. May carry 1 '''[In]'''Infantry and 1 other piece. '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia.

'''Stacks''' maximum group of '''2 pieces''' (1 carrier and 1 other piece):
* '''[HQ]'''Headquarters, may hold '''[C]'''Commander. '''HQ does not move'''
* '''[E]'''Engineer, may carry heavy weapons '''[A]'''Artillery, '''[Aa]'''Anti-aircraft, '''[Ms]'''Missile '''Also specifically must be carried across the river from one side to the other.'''

== Examples of unusual play ==
Both navy and land pieces may be placed on the coast. A '''[N]''' Navy has a gun and may capture a land piece, if it does then it will only capture and move if this land piece is on the coast, otherwise the '''[N]'''Navy piece will remain still and capture.

'''[E]'''Engineers may only carry pieces from the limited number of river bank spaces, and move just the 1 space across the river. All other carried stack movements with the engineer are not allowed.

'''[A]''' Artillery can only jump over pieces when capturing another piece. Otherwise, they cannot jump over pieces.

On the Sea/Land border (coast) land pieces do not block the movement of a Navy piece and vice versa. So these pieces are not being jumped over. One is on land, the other is in the sea, but both are on the coast.

A commander that exposes themselves to the opponents commander will immediately lose. (Line-of-sight).

Pieces that can jump and are not blocked by ANY piece. '''[Af]''' Plane, '''[N]''' Navy and the Navy gun. '''[A]''' Artillery(but only when capturing),

Without Enforce Check, it's possible to move into check, if you do this with your commander, then the opponents piece will become heroic.

== User Interface ==
* Some pieces stack on top of each other. It is recommended to use the squares to the right of the board from top to bottom. It automatically selects the stack to be moved as 1 group, if you would like to split up the pieces then user must select the pieces individually.
By selecting a box you will see the colour of the box change and the text.

GREEN means this is the selected piece and the piece you are currently moving.

RED means this piece is being carried and will not move separately.

GREY means this piece will move later after you have moved the current GREEN (selected) piece.

'Stay' will mean that the carried piece will disembark and stay in its current position.

* When playing with 'Enforce check' option a player needs to RESIGN if there are no playable moves.

* There are various 'confirm' options available from the context menu (3 lines, burger menu).

* You can play with (0,0) always at the bottom, available from the context menu (3 lines, burger menu).

File:4planes.png

2022-04-09T12:25:16Z

RicardoRix:

Gamehelpcommanderchess

2022-04-09T12:22:39Z

RicardoRix:

== Description ==
Commander Chess, or Cờ tư lệnh (literally "Chess Command") is a xiangqi variant created by Hải Quý Nguyễn.

Cờ tư lệnh is played with 38 pieces (19 per player) on a board that is 11 lines wide and 12 lines long. It is played on the vertices of the grid. The board is divided into two land territories by a river in the middle of the board. The three files on one side of the board form the sea.

== Object of the game ==
To win you must capture the opponent's Commander, or all units of a single division of the opponent's army:
*Sea - Both Navy ships. 2 pieces total.
*Land - Artillery, Tanks, Infantry. 6 pieces total.
*Air - Both Planes. 2 pieces total.
*Commander - 1 piece total.

== Pieces and movement ==

* All pieces have a range of movement. For example if a piece has a range of 3, then it may move 1, 2 or 3 spaces.
* All pieces move orthogonally (like a castle in standard chess), and some also move diagonally (like a queen in standard chess).
* Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.
* Normally pieces block other pieces from moving but some pieces can Jump over other pieces.
* Some pieces can carry other pieces, a piece will embark onto the carrier and share the same location. Either piece can move to the other piece. See 'Stack moves'.
* Anti-Aircraft pieces provide a Ring-of-fire range. See 'Airspace' for more details.

{| class="wikitable" style="text-align:center;"
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Commander
| [[File:commander.png|50px]]
| C
| Land
| 10
| -
| -
| T,N,Af,HQ
| -
| -
| -
| If captured you lose.
Cannot goes past opponents C line-of-sight, and if you open a direct line-of-sight then you immediately lose.
If opponents pieces place the commander in check they gain 'hero' status.
The commander has protection inside the HQ from pieces[In,M,Aa,Ms].
|-

| Infantry
| [[File:infantry.png|50px]]
| I
| Land
| 1
| -
| -
| T,N,Af
| -
| -
| -
| -

|-
| Tank
| [[File:tank.png|50px]]
| I
| Land
| 2
| -
| C,In,M
| N,Af
| -
| -
| -
| Only 1 tank maybe carried by a Navy on Plane.
May only carry 1 Infantry.

|-
| Militia
| [[File:militia.png|50px]]
| M
| Land
| 1
| yes
| -
| T,N,Af
| -
| -
| -
| -

|-
| Engineer
| [[File:engineer.png|50px]]
| E
| Land
| 1
| -
| A, Aa, Ms
| -
| -
| -
| -
| May carry all pieces, but only the single space across the river.

|-
| Artillery
| [[File:artillery.png|50px]]
| A
| Land
| 3
| yes
| -
| E
| to capture
| restriction
| -
| May jump over other pieces to capture.
May only cross the river at 2 BANK positions, but can capture and move across the sea.
May cross the sea if being carried.

|-
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Anti-Aircraft
| [[File:aa.png|50px]]
| Aa
| Land
| 1
| -
| -
| E
| -
| restriction
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Missile
| [[File:missile.png|50px]]
| Ms
| Land
| 1
| -
| -
| E
| -
| restriction
| 2
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Headquaters
| [[File:hq.png|50px]]
| HQ
| Land
| 0
| -
| C
| -
| -
| -
| -
| Doesn't move. Protects commander against [In,M,Aa,Ms]

|-
| Airforce
| [[File:plane.png|50px]]
| Af
| Air
| 4
| yes
| T,In,M
| N
| yes
| -
| shot down
| May perform 'bombing' on an opponents land and sea pieces (not Af) and return to original position. See 'Airspace' for more details about being shot-down.

|-
| Navy
| [[File:navy.png|50px]]
| N
| Sea
| 4 (3)
| yes
| Af,T,In,M
| -
| yes
| -
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
Cannot diagonally move across land, but can fire gun (range 3) onto land pieces. If it can legally move to capture a piece, it does.
May move into the river but may not move onto or passed the bank.

|}

==Airspace==
When moving Planes'''[Af]''' may be shot down by the opponents anti-aircraft pieces.

Anti-Aircraft Pieces (range): '''[Ms]'''Missile(2), '''[Aa]'''Anti-Aircraft(1), '''[N]'''Navy(1).
''''Note'''': this range a circular radius.

A plane can commit kamikaze (capture the opponents piece) while staying in opponents anti-aircraft range; But if the plane leaves the ROF before reaching it's target then it will be shot down, and will be unsuccessful in performing kamikaze. Please see image for cases of 2 Aa pieces.
[[File:4planes.png]]

The last '''[Af]''' plane committing kamikaze against the opponents last '''[N]''' Navy will win the game, even though the plane gets shot down.

A plane can get shot down during it's own turn due to anti-aircraft pieces, when this happens a player cannot undo their turn.

==General rules==
Pieces capture as they move, and never jump, unless noted.

Pieces can cross the river but not occupy sea points unless noted.

'''[N]'''Navy piece may not cut across land when moving diagonally.

Pieces which check the opposing Commander are promoted, gaining 'hero' status and gain special abilities.

Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.

== Stack: Pieces that can carry other pieces ==

'''Stacks''' are a group of pieces all at the same location. They may form groups of 2 or 3 pieces.

A stack of pieces can all move in a single turn. The stack may move as a single group or any piece from the stack may instead disembark and move elsewhere. Multiple captures are possible. See the user interface section for specific instructions on moving with the stack.

The following list are pieces that can be carriers followed by the pieces and restrictions of what they can carry:

'''Stacks''' maximum group of '''3 pieces''' (1 carrier and 2 other pieces)
* '''[N]'''Navy. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank, '''[Af]'''Plane.
* '''[Af]'''Plane. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank. '''but not 2 tanks'''.
* '''[T]'''Tank. May carry 1 '''[In]'''Infantry and 1 other piece. '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia.

'''Stacks''' maximum group of '''2 pieces''' (1 carrier and 1 other piece):
* '''[HQ]'''Headquarters, may hold '''[C]'''Commander. '''HQ does not move'''
* '''[E]'''Engineer, may carry heavy weapons '''[A]'''Artillery, '''[Aa]'''Anti-aircraft, '''[Ms]'''Missile '''Also specifically must be carried across the river from one side to the other.'''

== Examples of unusual play ==
Both navy and land pieces may be placed on the coast. A '''[N]''' Navy has a gun and may capture a land piece, if it does then it will only capture and move if this land piece is on the coast, otherwise the '''[N]'''Navy piece will remain still and capture.

'''[E]'''Engineers may only carry pieces from the limited number of river bank spaces, and move just the 1 space across the river. All other carried stack movements with the engineer are not allowed.

'''[A]''' Artillery can only jump over pieces when capturing another piece. Otherwise, they cannot jump over pieces.

On the Sea/Land border (coast) land pieces do not block the movement of a Navy piece and vice versa. So these pieces are not being jumped over. One is on land, the other is in the sea, but both are on the coast.

A commander that exposes themselves to the opponents commander will immediately lose. (Line-of-sight).

Pieces that can jump and are not blocked by ANY piece. '''[Af]''' Plane, '''[N]''' Navy and the Navy gun. '''[A]''' Artillery(but only when capturing),

Without Enforce Check, it's possible to move into check, if you do this with your commander, then the opponents piece will become heroic.

== User Interface ==
* Some pieces stack on top of each other. It is recommended to use the squares to the right of the board from top to bottom. It automatically selects the stack to be moved as 1 group, if you would like to split up the pieces then user must select the pieces individually.
By selecting a box you will see the colour of the box change and the text.

GREEN means this is the selected piece and the piece you are currently moving.

RED means this piece is being carried and will not move separately.

GREY means this piece will move later after you have moved the current GREEN (selected) piece.

'Stay' will mean that the carried piece will disembark and stay in its current position.

* When playing with 'Enforce check' option a player needs to RESIGN if there are no playable moves.

* There are various 'confirm' options available from the context menu (3 lines, burger menu).

* You can play with (0,0) always at the bottom, available from the context menu (3 lines, burger menu).

Gamehelpcommanderchess

2022-04-09T12:21:20Z

RicardoRix: /* Airspace */

== Description ==
Commander Chess, or Cờ tư lệnh (literally "Chess Command") is a xiangqi variant created by Hải Quý Nguyễn.

Cờ tư lệnh is played with 38 pieces (19 per player) on a board that is 11 lines wide and 12 lines long. It is played on the vertices of the grid. The board is divided into two land territories by a river in the middle of the board. The three files on one side of the board form the sea.

== Object of the game ==
To win you must capture the opponent's Commander, or all units of a single division of the opponent's army:
*Sea - Both Navy ships. 2 pieces total.
*Land - Artillery, Tanks, Infantry. 6 pieces total.
*Air - Both Planes. 2 pieces total.
*Commander - 1 piece total.

== Pieces and movement ==

* All pieces have a range of movement. For example if a piece has a range of 3, then it may move 1, 2 or 3 spaces.
* All pieces move orthogonally (like a castle in standard chess), and some also move diagonally (like a queen in standard chess).
* Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.
* Normally pieces block other pieces from moving but some pieces can Jump over other pieces.
* Some pieces can carry other pieces, a piece will embark onto the carrier and share the same location. Either piece can move to the other piece. See 'Stack moves'.
* Anti-Aircraft pieces provide a Ring-of-fire range. See 'Airspace' for more details.

{| class="wikitable" style="text-align:center;"
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Commander
| [[File:commander.png|50px]]
| C
| Land
| 10
| -
| -
| T,N,Af,HQ
| -
| -
| -
| If captured you lose.
Cannot goes past opponents C line-of-sight, and if you open a direct line-of-sight then you immediately lose.
If opponents pieces place the commander in check they gain 'hero' status.
The commander has protection inside the HQ from pieces[In,M,Aa,Ms].
|-

| Infantry
| [[File:infantry.png|50px]]
| I
| Land
| 1
| -
| -
| T,N,Af
| -
| -
| -
| -

|-
| Tank
| [[File:tank.png|50px]]
| I
| Land
| 2
| -
| C,In,M
| N,Af
| -
| -
| -
| Only 1 tank maybe carried by a Navy on Plane.
May only carry 1 Infantry.

|-
| Militia
| [[File:militia.png|50px]]
| M
| Land
| 1
| yes
| -
| T,N,Af
| -
| -
| -
| -

|-
| Engineer
| [[File:engineer.png|50px]]
| E
| Land
| 1
| -
| A, Aa, Ms
| -
| -
| -
| -
| May carry all pieces, but only the single space across the river.

|-
| Artillery
| [[File:artillery.png|50px]]
| A
| Land
| 3
| yes
| -
| E
| to capture
| restriction
| -
| May jump over other pieces to capture.
May only cross the river at 2 BANK positions, but can capture and move across the sea.
May cross the sea if being carried.

|-
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Anti-Aircraft
| [[File:aa.png|50px]]
| Aa
| Land
| 1
| -
| -
| E
| -
| restriction
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Missile
| [[File:missile.png|50px]]
| Ms
| Land
| 1
| -
| -
| E
| -
| restriction
| 2
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Headquaters
| [[File:hq.png|50px]]
| HQ
| Land
| 0
| -
| C
| -
| -
| -
| -
| Doesn't move. Protects commander against [In,M,Aa,Ms]

|-
| Airforce
| [[File:plane.png|50px]]
| Af
| Air
| 4
| yes
| T,In,M
| N
| yes
| -
| shot down
| May perform 'bombing' on an opponents land and sea pieces (not Af) and return to original position. See 'Airspace' for more details about being shot-down.

|-
| Navy
| [[File:navy.png|50px]]
| N
| Sea
| 4 (3)
| yes
| Af,T,In,M
| -
| yes
| -
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
Cannot diagonally move across land, but can fire gun (range 3) onto land pieces. If it can legally move to capture a piece, it does.
May move into the river but may not move onto or passed the bank.

|}

==Airspace==
When moving Planes'''[Af]''' may be shot down by the opponents anti-aircraft pieces.

Anti-Aircraft Pieces (range): '''[Ms]'''Missile(2), '''[Aa]'''Anti-Aircraft(1), '''[N]'''Navy(1).
''''Note'''': this range a circular radius.

A plane can commit kamikaze (capture the opponents piece) while staying in opponents anti-aircraft range; But if the plane leaves the ROF before reaching it's target then it will be shot down, and will be unsuccessful in performing kamikaze. Please see image for cases of 2 Aa pieces.

The last '''[Af]''' plane committing kamikaze against the opponents last '''[N]''' Navy will win the game, even though the plane gets shot down.

A plane can get shot down during it's own turn due to anti-aircraft pieces, when this happens a player cannot undo their turn.

==General rules==
Pieces capture as they move, and never jump, unless noted.

Pieces can cross the river but not occupy sea points unless noted.

'''[N]'''Navy piece may not cut across land when moving diagonally.

Pieces which check the opposing Commander are promoted, gaining 'hero' status and gain special abilities.

Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.

== Stack: Pieces that can carry other pieces ==

'''Stacks''' are a group of pieces all at the same location. They may form groups of 2 or 3 pieces.

A stack of pieces can all move in a single turn. The stack may move as a single group or any piece from the stack may instead disembark and move elsewhere. Multiple captures are possible. See the user interface section for specific instructions on moving with the stack.

The following list are pieces that can be carriers followed by the pieces and restrictions of what they can carry:

'''Stacks''' maximum group of '''3 pieces''' (1 carrier and 2 other pieces)
* '''[N]'''Navy. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank, '''[Af]'''Plane.
* '''[Af]'''Plane. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank. '''but not 2 tanks'''.
* '''[T]'''Tank. May carry 1 '''[In]'''Infantry and 1 other piece. '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia.

'''Stacks''' maximum group of '''2 pieces''' (1 carrier and 1 other piece):
* '''[HQ]'''Headquarters, may hold '''[C]'''Commander. '''HQ does not move'''
* '''[E]'''Engineer, may carry heavy weapons '''[A]'''Artillery, '''[Aa]'''Anti-aircraft, '''[Ms]'''Missile '''Also specifically must be carried across the river from one side to the other.'''

== Examples of unusual play ==
Both navy and land pieces may be placed on the coast. A '''[N]''' Navy has a gun and may capture a land piece, if it does then it will only capture and move if this land piece is on the coast, otherwise the '''[N]'''Navy piece will remain still and capture.

'''[E]'''Engineers may only carry pieces from the limited number of river bank spaces, and move just the 1 space across the river. All other carried stack movements with the engineer are not allowed.

'''[A]''' Artillery can only jump over pieces when capturing another piece. Otherwise, they cannot jump over pieces.

On the Sea/Land border (coast) land pieces do not block the movement of a Navy piece and vice versa. So these pieces are not being jumped over. One is on land, the other is in the sea, but both are on the coast.

A commander that exposes themselves to the opponents commander will immediately lose. (Line-of-sight).

Pieces that can jump and are not blocked by ANY piece. '''[Af]''' Plane, '''[N]''' Navy and the Navy gun. '''[A]''' Artillery(but only when capturing),

Without Enforce Check, it's possible to move into check, if you do this with your commander, then the opponents piece will become heroic.

== User Interface ==
* Some pieces stack on top of each other. It is recommended to use the squares to the right of the board from top to bottom. It automatically selects the stack to be moved as 1 group, if you would like to split up the pieces then user must select the pieces individually.
By selecting a box you will see the colour of the box change and the text.

GREEN means this is the selected piece and the piece you are currently moving.

RED means this piece is being carried and will not move separately.

GREY means this piece will move later after you have moved the current GREEN (selected) piece.

'Stay' will mean that the carried piece will disembark and stay in its current position.

* When playing with 'Enforce check' option a player needs to RESIGN if there are no playable moves.

* There are various 'confirm' options available from the context menu (3 lines, burger menu).

* You can play with (0,0) always at the bottom, available from the context menu (3 lines, burger menu).

Gamehelpcommanderchess

2022-03-15T11:19:17Z

RicardoRix: /* Examples of unusual play */

== Description ==
Commander Chess, or Cờ tư lệnh (literally "Chess Command") is a xiangqi variant created by Hải Quý Nguyễn.

Cờ tư lệnh is played with 38 pieces (19 per player) on a board that is 11 lines wide and 12 lines long. It is played on the vertices of the grid. The board is divided into two land territories by a river in the middle of the board. The three files on one side of the board form the sea.

== Object of the game ==
To win you must capture the opponent's Commander, or all units of a single division of the opponent's army:
*Sea - Both Navy ships. 2 pieces total.
*Land - Artillery, Tanks, Infantry. 6 pieces total.
*Air - Both Planes. 2 pieces total.
*Commander - 1 piece total.

== Pieces and movement ==

* All pieces have a range of movement. For example if a piece has a range of 3, then it may move 1, 2 or 3 spaces.
* All pieces move orthogonally (like a castle in standard chess), and some also move diagonally (like a queen in standard chess).
* Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.
* Normally pieces block other pieces from moving but some pieces can Jump over other pieces.
* Some pieces can carry other pieces, a piece will embark onto the carrier and share the same location. Either piece can move to the other piece. See 'Stack moves'.
* Anti-Aircraft pieces provide a Ring-of-fire range. See 'Airspace' for more details.

{| class="wikitable" style="text-align:center;"
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Commander
| [[File:commander.png|50px]]
| C
| Land
| 10
| -
| -
| T,N,Af,HQ
| -
| -
| -
| If captured you lose.
Cannot goes past opponents C line-of-sight, and if you open a direct line-of-sight then you immediately lose.
If opponents pieces place the commander in check they gain 'hero' status.
The commander has protection inside the HQ from pieces[In,M,Aa,Ms].
|-

| Infantry
| [[File:infantry.png|50px]]
| I
| Land
| 1
| -
| -
| T,N,Af
| -
| -
| -
| -

|-
| Tank
| [[File:tank.png|50px]]
| I
| Land
| 2
| -
| C,In,M
| N,Af
| -
| -
| -
| Only 1 tank maybe carried by a Navy on Plane.
May only carry 1 Infantry.

|-
| Militia
| [[File:militia.png|50px]]
| M
| Land
| 1
| yes
| -
| T,N,Af
| -
| -
| -
| -

|-
| Engineer
| [[File:engineer.png|50px]]
| E
| Land
| 1
| -
| A, Aa, Ms
| -
| -
| -
| -
| May carry all pieces, but only the single space across the river.

|-
| Artillery
| [[File:artillery.png|50px]]
| A
| Land
| 3
| yes
| -
| E
| to capture
| restriction
| -
| May jump over other pieces to capture.
May only cross the river at 2 BANK positions, but can capture and move across the sea.
May cross the sea if being carried.

|-
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Anti-Aircraft
| [[File:aa.png|50px]]
| Aa
| Land
| 1
| -
| -
| E
| -
| restriction
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Missile
| [[File:missile.png|50px]]
| Ms
| Land
| 1
| -
| -
| E
| -
| restriction
| 2
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Headquaters
| [[File:hq.png|50px]]
| HQ
| Land
| 0
| -
| C
| -
| -
| -
| -
| Doesn't move. Protects commander against [In,M,Aa,Ms]

|-
| Airforce
| [[File:plane.png|50px]]
| Af
| Air
| 4
| yes
| T,In,M
| N
| yes
| -
| shot down
| May perform 'bombing' on an opponents land and sea pieces (not Af) and return to original position. See 'Airspace' for more details about being shot-down.

|-
| Navy
| [[File:navy.png|50px]]
| N
| Sea
| 4 (3)
| yes
| Af,T,In,M
| -
| yes
| -
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
Cannot diagonally move across land, but can fire gun (range 3) onto land pieces. If it can legally move to capture a piece, it does.
May move into the river but may not move onto or passed the bank.

|}

==Airspace==
When moving Planes'''[Af]''' may be shot down by the opponents anti-aircraft pieces.

Anti-Aircraft Pieces (range): '''[Ms]'''Missile(2), '''[Aa]'''Anti-Aircraft(1), '''[N]'''Navy(1).
''''Note'''': this range a circular radius.

Pieces join together to form a single ring-of-fire(ROF).

A plane can commit kamikaze (capture the opponents piece) while staying in opponents anti-aircraft range (ROF); In this instance, when 2 or more Anti-aircraft pieces are present they together form a single ring-of-fire(ROF) area. Only when the plane leaves ROF or captures its target does it get shot down and removed from play. But if the plane leaves the ROF before reaching it's target then it will be shot down, and will be unsuccessful in performing kamikaze.

The last '''[Af]''' plane committing kamikaze against the opponents last '''[N]''' Navy will win the game, even though the plane gets shot down.

A plane can get shot down during it's own turn due to anti-aircraft pieces, when this happens a player cannot undo their turn.

==General rules==
Pieces capture as they move, and never jump, unless noted.

Pieces can cross the river but not occupy sea points unless noted.

'''[N]'''Navy piece may not cut across land when moving diagonally.

Pieces which check the opposing Commander are promoted, gaining 'hero' status and gain special abilities.

Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.

== Stack: Pieces that can carry other pieces ==

'''Stacks''' are a group of pieces all at the same location. They may form groups of 2 or 3 pieces.

A stack of pieces can all move in a single turn. The stack may move as a single group or any piece from the stack may instead disembark and move elsewhere. Multiple captures are possible. See the user interface section for specific instructions on moving with the stack.

The following list are pieces that can be carriers followed by the pieces and restrictions of what they can carry:

'''Stacks''' maximum group of '''3 pieces''' (1 carrier and 2 other pieces)
* '''[N]'''Navy. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank, '''[Af]'''Plane.
* '''[Af]'''Plane. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank. '''but not 2 tanks'''.
* '''[T]'''Tank. May carry 1 '''[In]'''Infantry and 1 other piece. '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia.

'''Stacks''' maximum group of '''2 pieces''' (1 carrier and 1 other piece):
* '''[HQ]'''Headquarters, may hold '''[C]'''Commander. '''HQ does not move'''
* '''[E]'''Engineer, may carry heavy weapons '''[A]'''Artillery, '''[Aa]'''Anti-aircraft, '''[Ms]'''Missile '''Also specifically must be carried across the river from one side to the other.'''

== Examples of unusual play ==
Both navy and land pieces may be placed on the coast. A '''[N]''' Navy has a gun and may capture a land piece, if it does then it will only capture and move if this land piece is on the coast, otherwise the '''[N]'''Navy piece will remain still and capture.

'''[E]'''Engineers may only carry pieces from the limited number of river bank spaces, and move just the 1 space across the river. All other carried stack movements with the engineer are not allowed.

'''[A]''' Artillery can only jump over pieces when capturing another piece. Otherwise, they cannot jump over pieces.

On the Sea/Land border (coast) land pieces do not block the movement of a Navy piece and vice versa. So these pieces are not being jumped over. One is on land, the other is in the sea, but both are on the coast.

A commander that exposes themselves to the opponents commander will immediately lose. (Line-of-sight).

Pieces that can jump and are not blocked by ANY piece. '''[Af]''' Plane, '''[N]''' Navy and the Navy gun. '''[A]''' Artillery(but only when capturing),

Without Enforce Check, it's possible to move into check, if you do this with your commander, then the opponents piece will become heroic.

== User Interface ==
* Some pieces stack on top of each other. It is recommended to use the squares to the right of the board from top to bottom. It automatically selects the stack to be moved as 1 group, if you would like to split up the pieces then user must select the pieces individually.
By selecting a box you will see the colour of the box change and the text.

GREEN means this is the selected piece and the piece you are currently moving.

RED means this piece is being carried and will not move separately.

GREY means this piece will move later after you have moved the current GREEN (selected) piece.

'Stay' will mean that the carried piece will disembark and stay in its current position.

* When playing with 'Enforce check' option a player needs to RESIGN if there are no playable moves.

* There are various 'confirm' options available from the context menu (3 lines, burger menu).

* You can play with (0,0) always at the bottom, available from the context menu (3 lines, burger menu).

Gamehelpcommanderchess

2022-03-15T11:13:19Z

RicardoRix: /* Pieces and movement */

== Description ==
Commander Chess, or Cờ tư lệnh (literally "Chess Command") is a xiangqi variant created by Hải Quý Nguyễn.

Cờ tư lệnh is played with 38 pieces (19 per player) on a board that is 11 lines wide and 12 lines long. It is played on the vertices of the grid. The board is divided into two land territories by a river in the middle of the board. The three files on one side of the board form the sea.

== Object of the game ==
To win you must capture the opponent's Commander, or all units of a single division of the opponent's army:
*Sea - Both Navy ships. 2 pieces total.
*Land - Artillery, Tanks, Infantry. 6 pieces total.
*Air - Both Planes. 2 pieces total.
*Commander - 1 piece total.

== Pieces and movement ==

* All pieces have a range of movement. For example if a piece has a range of 3, then it may move 1, 2 or 3 spaces.
* All pieces move orthogonally (like a castle in standard chess), and some also move diagonally (like a queen in standard chess).
* Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.
* Normally pieces block other pieces from moving but some pieces can Jump over other pieces.
* Some pieces can carry other pieces, a piece will embark onto the carrier and share the same location. Either piece can move to the other piece. See 'Stack moves'.
* Anti-Aircraft pieces provide a Ring-of-fire range. See 'Airspace' for more details.

{| class="wikitable" style="text-align:center;"
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Commander
| [[File:commander.png|50px]]
| C
| Land
| 10
| -
| -
| T,N,Af,HQ
| -
| -
| -
| If captured you lose.
Cannot goes past opponents C line-of-sight, and if you open a direct line-of-sight then you immediately lose.
If opponents pieces place the commander in check they gain 'hero' status.
The commander has protection inside the HQ from pieces[In,M,Aa,Ms].
|-

| Infantry
| [[File:infantry.png|50px]]
| I
| Land
| 1
| -
| -
| T,N,Af
| -
| -
| -
| -

|-
| Tank
| [[File:tank.png|50px]]
| I
| Land
| 2
| -
| C,In,M
| N,Af
| -
| -
| -
| Only 1 tank maybe carried by a Navy on Plane.
May only carry 1 Infantry.

|-
| Militia
| [[File:militia.png|50px]]
| M
| Land
| 1
| yes
| -
| T,N,Af
| -
| -
| -
| -

|-
| Engineer
| [[File:engineer.png|50px]]
| E
| Land
| 1
| -
| A, Aa, Ms
| -
| -
| -
| -
| May carry all pieces, but only the single space across the river.

|-
| Artillery
| [[File:artillery.png|50px]]
| A
| Land
| 3
| yes
| -
| E
| to capture
| restriction
| -
| May jump over other pieces to capture.
May only cross the river at 2 BANK positions, but can capture and move across the sea.
May cross the sea if being carried.

|-
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Anti-Aircraft
| [[File:aa.png|50px]]
| Aa
| Land
| 1
| -
| -
| E
| -
| restriction
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Missile
| [[File:missile.png|50px]]
| Ms
| Land
| 1
| -
| -
| E
| -
| restriction
| 2
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Headquaters
| [[File:hq.png|50px]]
| HQ
| Land
| 0
| -
| C
| -
| -
| -
| -
| Doesn't move. Protects commander against [In,M,Aa,Ms]

|-
| Airforce
| [[File:plane.png|50px]]
| Af
| Air
| 4
| yes
| T,In,M
| N
| yes
| -
| shot down
| May perform 'bombing' on an opponents land and sea pieces (not Af) and return to original position. See 'Airspace' for more details about being shot-down.

|-
| Navy
| [[File:navy.png|50px]]
| N
| Sea
| 4 (3)
| yes
| Af,T,In,M
| -
| yes
| -
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
Cannot diagonally move across land, but can fire gun (range 3) onto land pieces. If it can legally move to capture a piece, it does.
May move into the river but may not move onto or passed the bank.

|}

==Airspace==
When moving Planes'''[Af]''' may be shot down by the opponents anti-aircraft pieces.

Anti-Aircraft Pieces (range): '''[Ms]'''Missile(2), '''[Aa]'''Anti-Aircraft(1), '''[N]'''Navy(1).
''''Note'''': this range a circular radius.

Pieces join together to form a single ring-of-fire(ROF).

A plane can commit kamikaze (capture the opponents piece) while staying in opponents anti-aircraft range (ROF); In this instance, when 2 or more Anti-aircraft pieces are present they together form a single ring-of-fire(ROF) area. Only when the plane leaves ROF or captures its target does it get shot down and removed from play. But if the plane leaves the ROF before reaching it's target then it will be shot down, and will be unsuccessful in performing kamikaze.

The last '''[Af]''' plane committing kamikaze against the opponents last '''[N]''' Navy will win the game, even though the plane gets shot down.

A plane can get shot down during it's own turn due to anti-aircraft pieces, when this happens a player cannot undo their turn.

==General rules==
Pieces capture as they move, and never jump, unless noted.

Pieces can cross the river but not occupy sea points unless noted.

'''[N]'''Navy piece may not cut across land when moving diagonally.

Pieces which check the opposing Commander are promoted, gaining 'hero' status and gain special abilities.

Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.

== Stack: Pieces that can carry other pieces ==

'''Stacks''' are a group of pieces all at the same location. They may form groups of 2 or 3 pieces.

A stack of pieces can all move in a single turn. The stack may move as a single group or any piece from the stack may instead disembark and move elsewhere. Multiple captures are possible. See the user interface section for specific instructions on moving with the stack.

The following list are pieces that can be carriers followed by the pieces and restrictions of what they can carry:

'''Stacks''' maximum group of '''3 pieces''' (1 carrier and 2 other pieces)
* '''[N]'''Navy. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank, '''[Af]'''Plane.
* '''[Af]'''Plane. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank. '''but not 2 tanks'''.
* '''[T]'''Tank. May carry 1 '''[In]'''Infantry and 1 other piece. '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia.

'''Stacks''' maximum group of '''2 pieces''' (1 carrier and 1 other piece):
* '''[HQ]'''Headquarters, may hold '''[C]'''Commander. '''HQ does not move'''
* '''[E]'''Engineer, may carry heavy weapons '''[A]'''Artillery, '''[Aa]'''Anti-aircraft, '''[Ms]'''Missile '''Also specifically must be carried across the river from one side to the other.'''

== Examples of unusual play ==
Both navy and land pieces may be placed on the coast. A '''[N]''' Navy has a gun and may capture a land piece, if it does then it will only capture and move if this land piece is on the coast, otherwise the '''[N]'''Navy piece will remain still and capture.

'''[E]'''Engineers may only carry pieces from the limited number of river bank spaces, and move just the 1 space across the river. All other carried stack movements with the engineer are not allowed.

'''[A]'''Artillery, '''[Aa]''' Anti-aircraft and '''[Ms]''' Missile may capture (shoot) across the river (but stay still) where normally they would not be able to cross the river.

'''[A]''' Artillery can only jump over pieces when capturing another piece. Otherwise, they cannot jump over pieces.

On the Sea/Land border (coast) land pieces do not block the movement of a Navy piece and vice versa. So these pieces are not being jumped over. One is on land, the other is in the sea, but both are on the coast.

A commander that exposes themselves to the opponents commander will immediately lose. (Line-of-sight).

Pieces that can jump and are not blocked by ANY piece. '''[Af]''' Plane, '''[N]''' Navy and the Navy gun. '''[A]''' Artillery(but only when capturing),

Without Enforce Check, it's possible to move into check, if you do this with your commander, then the opponents piece will become heroic.

== User Interface ==
* Some pieces stack on top of each other. It is recommended to use the squares to the right of the board from top to bottom. It automatically selects the stack to be moved as 1 group, if you would like to split up the pieces then user must select the pieces individually.
By selecting a box you will see the colour of the box change and the text.

GREEN means this is the selected piece and the piece you are currently moving.

RED means this piece is being carried and will not move separately.

GREY means this piece will move later after you have moved the current GREEN (selected) piece.

'Stay' will mean that the carried piece will disembark and stay in its current position.

* When playing with 'Enforce check' option a player needs to RESIGN if there are no playable moves.

* There are various 'confirm' options available from the context menu (3 lines, burger menu).

* You can play with (0,0) always at the bottom, available from the context menu (3 lines, burger menu).

Gamehelpcommanderchess

2022-03-15T11:09:13Z

RicardoRix: /* Examples of unusual play */

== Description ==
Commander Chess, or Cờ tư lệnh (literally "Chess Command") is a xiangqi variant created by Hải Quý Nguyễn.

Cờ tư lệnh is played with 38 pieces (19 per player) on a board that is 11 lines wide and 12 lines long. It is played on the vertices of the grid. The board is divided into two land territories by a river in the middle of the board. The three files on one side of the board form the sea.

== Object of the game ==
To win you must capture the opponent's Commander, or all units of a single division of the opponent's army:
*Sea - Both Navy ships. 2 pieces total.
*Land - Artillery, Tanks, Infantry. 6 pieces total.
*Air - Both Planes. 2 pieces total.
*Commander - 1 piece total.

== Pieces and movement ==

* All pieces have a range of movement. For example if a piece has a range of 3, then it may move 1, 2 or 3 spaces.
* All pieces move orthogonally (like a castle in standard chess), and some also move diagonally (like a queen in standard chess).
* Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.
* Normally pieces block other pieces from moving but some pieces can Jump over other pieces.
* Some pieces can carry other pieces, a piece will embark onto the carrier and share the same location. Either piece can move to the other piece. See 'Stack moves'.
* Anti-Aircraft pieces provide a Ring-of-fire range. See 'Airspace' for more details.

{| class="wikitable" style="text-align:center;"
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Commander
| [[File:commander.png|50px]]
| C
| Land
| 10
| -
| -
| T,N,Af,HQ
| -
| -
| -
| If captured you lose.
Cannot goes past opponents C line-of-sight, and if you open a direct line-of-sight then you immediately lose.
If opponents pieces place the commander in check they gain 'hero' status.
The commander has protection inside the HQ from pieces[In,M,Aa,Ms].
|-

| Infantry
| [[File:infantry.png|50px]]
| I
| Land
| 1
| -
| -
| T,N,Af
| -
| -
| -
| -

|-
| Tank
| [[File:tank.png|50px]]
| I
| Land
| 2
| -
| C,In,M
| N,Af
| -
| -
| -
| Only 1 tank maybe carried by a Navy on Plane.
May only carry 1 Infantry.

|-
| Militia
| [[File:militia.png|50px]]
| M
| Land
| 1
| yes
| -
| T,N,Af
| -
| -
| -
| -

|-
| Engineer
| [[File:engineer.png|50px]]
| E
| Land
| 1
| -
| A, Aa, Ms
| -
| -
| -
| -
| May carry all pieces, but only the single space across the river.

|-
| Artillery
| [[File:artillery.png|50px]]
| A
| Land
| 3
| yes
| -
| -
| to capture
| restriction
| -
| May jump over other pieces to capture.
May only cross the river at 2 BANK positions, but can capture and move across the sea.
May cross the sea if being carried.

|-
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Anti-Aircraft
| [[File:aa.png|50px]]
| Aa
| Land
| 1
| -
| -
| -
| -
| restriction
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Missile
| [[File:missile.png|50px]]
| Ms
| Land
| 1
| -
| -
| -
| -
| restriction
| 2
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Headquaters
| [[File:hq.png|50px]]
| HQ
| Land
| 0
| -
| C
| -
| -
| -
| -
| Doesn't move. Protects commander against [In,M,Aa,Ms]

|-
| Airforce
| [[File:plane.png|50px]]
| Af
| Air
| 4
| yes
| T,In,M
| N
| yes
| -
| shot down
| May perform 'bombing' on an opponents land and sea pieces (not Af) and return to original position. See 'Airspace' for more details about being shot-down.

|-
| Navy
| [[File:navy.png|50px]]
| N
| Sea
| 4 (3)
| yes
| Af,T,In,M
| -
| yes
| -
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
Cannot diagonally move across land, but can fire gun (range 3) onto land pieces. If it can legally move to capture a piece, it does.
May move into the river but may not move onto or passed the bank.

|}

==Airspace==
When moving Planes'''[Af]''' may be shot down by the opponents anti-aircraft pieces.

Anti-Aircraft Pieces (range): '''[Ms]'''Missile(2), '''[Aa]'''Anti-Aircraft(1), '''[N]'''Navy(1).
''''Note'''': this range a circular radius.

Pieces join together to form a single ring-of-fire(ROF).

A plane can commit kamikaze (capture the opponents piece) while staying in opponents anti-aircraft range (ROF); In this instance, when 2 or more Anti-aircraft pieces are present they together form a single ring-of-fire(ROF) area. Only when the plane leaves ROF or captures its target does it get shot down and removed from play. But if the plane leaves the ROF before reaching it's target then it will be shot down, and will be unsuccessful in performing kamikaze.

The last '''[Af]''' plane committing kamikaze against the opponents last '''[N]''' Navy will win the game, even though the plane gets shot down.

A plane can get shot down during it's own turn due to anti-aircraft pieces, when this happens a player cannot undo their turn.

==General rules==
Pieces capture as they move, and never jump, unless noted.

Pieces can cross the river but not occupy sea points unless noted.

'''[N]'''Navy piece may not cut across land when moving diagonally.

Pieces which check the opposing Commander are promoted, gaining 'hero' status and gain special abilities.

Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.

== Stack: Pieces that can carry other pieces ==

'''Stacks''' are a group of pieces all at the same location. They may form groups of 2 or 3 pieces.

A stack of pieces can all move in a single turn. The stack may move as a single group or any piece from the stack may instead disembark and move elsewhere. Multiple captures are possible. See the user interface section for specific instructions on moving with the stack.

The following list are pieces that can be carriers followed by the pieces and restrictions of what they can carry:

'''Stacks''' maximum group of '''3 pieces''' (1 carrier and 2 other pieces)
* '''[N]'''Navy. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank, '''[Af]'''Plane.
* '''[Af]'''Plane. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank. '''but not 2 tanks'''.
* '''[T]'''Tank. May carry 1 '''[In]'''Infantry and 1 other piece. '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia.

'''Stacks''' maximum group of '''2 pieces''' (1 carrier and 1 other piece):
* '''[HQ]'''Headquarters, may hold '''[C]'''Commander. '''HQ does not move'''
* '''[E]'''Engineer, may carry heavy weapons '''[A]'''Artillery, '''[Aa]'''Anti-aircraft, '''[Ms]'''Missile '''Also specifically must be carried across the river from one side to the other.'''

== Examples of unusual play ==
Both navy and land pieces may be placed on the coast. A '''[N]''' Navy has a gun and may capture a land piece, if it does then it will only capture and move if this land piece is on the coast, otherwise the '''[N]'''Navy piece will remain still and capture.

'''[E]'''Engineers may only carry pieces from the limited number of river bank spaces, and move just the 1 space across the river. All other carried stack movements with the engineer are not allowed.

'''[A]'''Artillery, '''[Aa]''' Anti-aircraft and '''[Ms]''' Missile may capture (shoot) across the river (but stay still) where normally they would not be able to cross the river.

'''[A]''' Artillery can only jump over pieces when capturing another piece. Otherwise, they cannot jump over pieces.

On the Sea/Land border (coast) land pieces do not block the movement of a Navy piece and vice versa. So these pieces are not being jumped over. One is on land, the other is in the sea, but both are on the coast.

A commander that exposes themselves to the opponents commander will immediately lose. (Line-of-sight).

Pieces that can jump and are not blocked by ANY piece. '''[Af]''' Plane, '''[N]''' Navy and the Navy gun. '''[A]''' Artillery(but only when capturing),

Without Enforce Check, it's possible to move into check, if you do this with your commander, then the opponents piece will become heroic.

== User Interface ==
* Some pieces stack on top of each other. It is recommended to use the squares to the right of the board from top to bottom. It automatically selects the stack to be moved as 1 group, if you would like to split up the pieces then user must select the pieces individually.
By selecting a box you will see the colour of the box change and the text.

GREEN means this is the selected piece and the piece you are currently moving.

RED means this piece is being carried and will not move separately.

GREY means this piece will move later after you have moved the current GREEN (selected) piece.

'Stay' will mean that the carried piece will disembark and stay in its current position.

* When playing with 'Enforce check' option a player needs to RESIGN if there are no playable moves.

* There are various 'confirm' options available from the context menu (3 lines, burger menu).

* You can play with (0,0) always at the bottom, available from the context menu (3 lines, burger menu).

Gamehelpcommanderchess

2022-03-15T11:07:43Z

RicardoRix: /* Pieces and movement */

== Description ==
Commander Chess, or Cờ tư lệnh (literally "Chess Command") is a xiangqi variant created by Hải Quý Nguyễn.

Cờ tư lệnh is played with 38 pieces (19 per player) on a board that is 11 lines wide and 12 lines long. It is played on the vertices of the grid. The board is divided into two land territories by a river in the middle of the board. The three files on one side of the board form the sea.

== Object of the game ==
To win you must capture the opponent's Commander, or all units of a single division of the opponent's army:
*Sea - Both Navy ships. 2 pieces total.
*Land - Artillery, Tanks, Infantry. 6 pieces total.
*Air - Both Planes. 2 pieces total.
*Commander - 1 piece total.

== Pieces and movement ==

* All pieces have a range of movement. For example if a piece has a range of 3, then it may move 1, 2 or 3 spaces.
* All pieces move orthogonally (like a castle in standard chess), and some also move diagonally (like a queen in standard chess).
* Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.
* Normally pieces block other pieces from moving but some pieces can Jump over other pieces.
* Some pieces can carry other pieces, a piece will embark onto the carrier and share the same location. Either piece can move to the other piece. See 'Stack moves'.
* Anti-Aircraft pieces provide a Ring-of-fire range. See 'Airspace' for more details.

{| class="wikitable" style="text-align:center;"
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Commander
| [[File:commander.png|50px]]
| C
| Land
| 10
| -
| -
| T,N,Af,HQ
| -
| -
| -
| If captured you lose.
Cannot goes past opponents C line-of-sight, and if you open a direct line-of-sight then you immediately lose.
If opponents pieces place the commander in check they gain 'hero' status.
The commander has protection inside the HQ from pieces[In,M,Aa,Ms].
|-

| Infantry
| [[File:infantry.png|50px]]
| I
| Land
| 1
| -
| -
| T,N,Af
| -
| -
| -
| -

|-
| Tank
| [[File:tank.png|50px]]
| I
| Land
| 2
| -
| C,In,M
| N,Af
| -
| -
| -
| Only 1 tank maybe carried by a Navy on Plane.
May only carry 1 Infantry.

|-
| Militia
| [[File:militia.png|50px]]
| M
| Land
| 1
| yes
| -
| T,N,Af
| -
| -
| -
| -

|-
| Engineer
| [[File:engineer.png|50px]]
| E
| Land
| 1
| -
| A, Aa, Ms
| -
| -
| -
| -
| May carry all pieces, but only the single space across the river.

|-
| Artillery
| [[File:artillery.png|50px]]
| A
| Land
| 3
| yes
| -
| -
| to capture
| restriction
| -
| May jump over other pieces to capture.
May only cross the river at 2 BANK positions, but can capture and move across the sea.
May cross the sea if being carried.

|-
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Anti-Aircraft
| [[File:aa.png|50px]]
| Aa
| Land
| 1
| -
| -
| -
| -
| restriction
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Missile
| [[File:missile.png|50px]]
| Ms
| Land
| 1
| -
| -
| -
| -
| restriction
| 2
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Headquaters
| [[File:hq.png|50px]]
| HQ
| Land
| 0
| -
| C
| -
| -
| -
| -
| Doesn't move. Protects commander against [In,M,Aa,Ms]

|-
| Airforce
| [[File:plane.png|50px]]
| Af
| Air
| 4
| yes
| T,In,M
| N
| yes
| -
| shot down
| May perform 'bombing' on an opponents land and sea pieces (not Af) and return to original position. See 'Airspace' for more details about being shot-down.

|-
| Navy
| [[File:navy.png|50px]]
| N
| Sea
| 4 (3)
| yes
| Af,T,In,M
| -
| yes
| -
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
Cannot diagonally move across land, but can fire gun (range 3) onto land pieces. If it can legally move to capture a piece, it does.
May move into the river but may not move onto or passed the bank.

|}

==Airspace==
When moving Planes'''[Af]''' may be shot down by the opponents anti-aircraft pieces.

Anti-Aircraft Pieces (range): '''[Ms]'''Missile(2), '''[Aa]'''Anti-Aircraft(1), '''[N]'''Navy(1).
''''Note'''': this range a circular radius.

Pieces join together to form a single ring-of-fire(ROF).

A plane can commit kamikaze (capture the opponents piece) while staying in opponents anti-aircraft range (ROF); In this instance, when 2 or more Anti-aircraft pieces are present they together form a single ring-of-fire(ROF) area. Only when the plane leaves ROF or captures its target does it get shot down and removed from play. But if the plane leaves the ROF before reaching it's target then it will be shot down, and will be unsuccessful in performing kamikaze.

The last '''[Af]''' plane committing kamikaze against the opponents last '''[N]''' Navy will win the game, even though the plane gets shot down.

A plane can get shot down during it's own turn due to anti-aircraft pieces, when this happens a player cannot undo their turn.

==General rules==
Pieces capture as they move, and never jump, unless noted.

Pieces can cross the river but not occupy sea points unless noted.

'''[N]'''Navy piece may not cut across land when moving diagonally.

Pieces which check the opposing Commander are promoted, gaining 'hero' status and gain special abilities.

Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.

== Stack: Pieces that can carry other pieces ==

'''Stacks''' are a group of pieces all at the same location. They may form groups of 2 or 3 pieces.

A stack of pieces can all move in a single turn. The stack may move as a single group or any piece from the stack may instead disembark and move elsewhere. Multiple captures are possible. See the user interface section for specific instructions on moving with the stack.

The following list are pieces that can be carriers followed by the pieces and restrictions of what they can carry:

'''Stacks''' maximum group of '''3 pieces''' (1 carrier and 2 other pieces)
* '''[N]'''Navy. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank, '''[Af]'''Plane.
* '''[Af]'''Plane. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank. '''but not 2 tanks'''.
* '''[T]'''Tank. May carry 1 '''[In]'''Infantry and 1 other piece. '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia.

'''Stacks''' maximum group of '''2 pieces''' (1 carrier and 1 other piece):
* '''[HQ]'''Headquarters, may hold '''[C]'''Commander. '''HQ does not move'''
* '''[E]'''Engineer, may carry heavy weapons '''[A]'''Artillery, '''[Aa]'''Anti-aircraft, '''[Ms]'''Missile '''Also specifically must be carried across the river from one side to the other.'''

== Examples of unusual play ==
Both navy and land pieces may be placed on the coast. A '''[N]''' Navy has a gun and may capture a land piece, if it does then it will only capture and move if this land piece is on the coast, otherwise the '''[N]'''Navy piece will remain still and capture.

'''[E]'''Engineers may only carry pieces from the limited number of river bank spaces, and move just the 1 space across the river. All other stack movements with the engineer are not allowed.

'''[A]'''Artillery, '''[Aa]''' Anti-aircraft and '''[Ms]''' Missile may capture (shoot) across the river (but stay still) where normally they would not be able to cross the river.

'''[A]''' Artillery can only jump over pieces when capturing another piece. Otherwise, they cannot jump over pieces.

On the Sea/Land border (coast) land pieces do not block the movement of a Navy piece and vice versa. So these pieces are not being jumped over. One is on land, the other is in the sea, but both are on the coast.

A commander that exposes themselves to the opponents commander will immediately lose. (Line-of-sight).

Pieces that can jump and are not blocked by ANY piece. '''[Af]''' Plane, '''[N]''' Navy and the Navy gun. '''[A]''' Artillery(but only when capturing),

Without Enforce Check, it's possible to move into check, if you do this with your commander, then the opponents piece will become heroic.

== User Interface ==
* Some pieces stack on top of each other. It is recommended to use the squares to the right of the board from top to bottom. It automatically selects the stack to be moved as 1 group, if you would like to split up the pieces then user must select the pieces individually.
By selecting a box you will see the colour of the box change and the text.

GREEN means this is the selected piece and the piece you are currently moving.

RED means this piece is being carried and will not move separately.

GREY means this piece will move later after you have moved the current GREEN (selected) piece.

'Stay' will mean that the carried piece will disembark and stay in its current position.

* When playing with 'Enforce check' option a player needs to RESIGN if there are no playable moves.

* There are various 'confirm' options available from the context menu (3 lines, burger menu).

* You can play with (0,0) always at the bottom, available from the context menu (3 lines, burger menu).

Gamehelpcommanderchess

2022-03-15T11:03:34Z

RicardoRix: /* Pieces and movement */

== Description ==
Commander Chess, or Cờ tư lệnh (literally "Chess Command") is a xiangqi variant created by Hải Quý Nguyễn.

Cờ tư lệnh is played with 38 pieces (19 per player) on a board that is 11 lines wide and 12 lines long. It is played on the vertices of the grid. The board is divided into two land territories by a river in the middle of the board. The three files on one side of the board form the sea.

== Object of the game ==
To win you must capture the opponent's Commander, or all units of a single division of the opponent's army:
*Sea - Both Navy ships. 2 pieces total.
*Land - Artillery, Tanks, Infantry. 6 pieces total.
*Air - Both Planes. 2 pieces total.
*Commander - 1 piece total.

== Pieces and movement ==

* All pieces have a range of movement. For example if a piece has a range of 3, then it may move 1, 2 or 3 spaces.
* All pieces move orthogonally (like a castle in standard chess), and some also move diagonally (like a queen in standard chess).
* Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.
* Normally pieces block other pieces from moving but some pieces can Jump over other pieces.
* Some pieces can carry other pieces, a piece will embark onto the carrier and share the same location. Either piece can move to the other piece. See 'Stack moves'.
* Anti-Aircraft pieces provide a Ring-of-fire range. See 'Airspace' for more details.

{| class="wikitable" style="text-align:center;"
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Commander
| [[File:commander.png|50px]]
| C
| Land
| 10
| -
| -
| T,N,Af,HQ
| -
| -
| -
| If captured you lose.
Cannot goes past opponents C line-of-sight, and if you open a direct line-of-sight then you immediately lose.
If opponents pieces place the commander in check they gain 'hero' status.
The commander has protection inside the HQ from pieces[In,M,Aa,Ms].
|-

| Infantry
| [[File:infantry.png|50px]]
| I
| Land
| 1
| -
| -
| T,N,Af
| -
| -
| -
| -

|-
| Tank
| [[File:tank.png|50px]]
| I
| Land
| 2
| -
| C,In,M
| N,Af
| -
| -
| -
| Only 1 tank maybe carried by a Navy on Plane.
May only carry 1 Infantry.

|-
| Militia
| [[File:militia.png|50px]]
| M
| Land
| 1
| yes
| -
| T,N,Af
| -
| -
| -
| -

|-
| Engineer
| [[File:engineer.png|50px]]
| E
| Land
| 1
| -
| All
| -
| -
| -
| -
| May carry all pieces, but only the single space across the river.

|-
| Artillery
| [[File:artillery.png|50px]]
| A
| Land
| 3
| yes
| -
| -
| to capture
| restriction
| -
| May jump over other pieces to capture.
May only cross the river at 2 BANK positions, but can capture and move across the sea.
May cross the sea if being carried.

|-
! Piece
! Image
! Letter
! Type
! Range
! Diagonal
! Carry
! Embark
! Jump
! River Bank
! ROF Range
! Special

|-
| Anti-Aircraft
| [[File:aa.png|50px]]
| Aa
| Land
| 1
| -
| -
| -
| -
| restriction
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Missile
| [[File:missile.png|50px]]
| Ms
| Land
| 1
| -
| -
| -
| -
| restriction
| 2
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
May only cross the river at 2 BANK positions.

|-
| Headquaters
| [[File:hq.png|50px]]
| HQ
| Land
| 0
| -
| C
| -
| -
| -
| -
| Doesn't move. Protects commander against [In,M,Aa,Ms]

|-
| Airforce
| [[File:plane.png|50px]]
| Af
| Air
| 4
| yes
| T,In,M
| N
| yes
| -
| shot down
| May perform 'bombing' on an opponents land and sea pieces (not Af) and return to original position. See 'Airspace' for more details about being shot-down.

|-
| Navy
| [[File:navy.png|50px]]
| N
| Sea
| 4 (3)
| yes
| Af,T,In,M
| -
| yes
| -
| 1
| Anti-aircraft. May shoot down opponents plane. See 'Airspace' for more details.
Cannot diagonally move across land, but can fire gun (range 3) onto land pieces. If it can legally move to capture a piece, it does.
May move into the river but may not move onto or passed the bank.

|}

==Airspace==
When moving Planes'''[Af]''' may be shot down by the opponents anti-aircraft pieces.

Anti-Aircraft Pieces (range): '''[Ms]'''Missile(2), '''[Aa]'''Anti-Aircraft(1), '''[N]'''Navy(1).
''''Note'''': this range a circular radius.

Pieces join together to form a single ring-of-fire(ROF).

A plane can commit kamikaze (capture the opponents piece) while staying in opponents anti-aircraft range (ROF); In this instance, when 2 or more Anti-aircraft pieces are present they together form a single ring-of-fire(ROF) area. Only when the plane leaves ROF or captures its target does it get shot down and removed from play. But if the plane leaves the ROF before reaching it's target then it will be shot down, and will be unsuccessful in performing kamikaze.

The last '''[Af]''' plane committing kamikaze against the opponents last '''[N]''' Navy will win the game, even though the plane gets shot down.

A plane can get shot down during it's own turn due to anti-aircraft pieces, when this happens a player cannot undo their turn.

==General rules==
Pieces capture as they move, and never jump, unless noted.

Pieces can cross the river but not occupy sea points unless noted.

'''[N]'''Navy piece may not cut across land when moving diagonally.

Pieces which check the opposing Commander are promoted, gaining 'hero' status and gain special abilities.

Hero status will mean a piece can move 1 additional space. The piece will also be able to move diagonally. '''[Af]'''Planes become stealth planes and are immune to ALL anti-aircraft.

== Stack: Pieces that can carry other pieces ==

'''Stacks''' are a group of pieces all at the same location. They may form groups of 2 or 3 pieces.

A stack of pieces can all move in a single turn. The stack may move as a single group or any piece from the stack may instead disembark and move elsewhere. Multiple captures are possible. See the user interface section for specific instructions on moving with the stack.

The following list are pieces that can be carriers followed by the pieces and restrictions of what they can carry:

'''Stacks''' maximum group of '''3 pieces''' (1 carrier and 2 other pieces)
* '''[N]'''Navy. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank, '''[Af]'''Plane.
* '''[Af]'''Plane. May carry any combination of '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia, '''[T]'''Tank. '''but not 2 tanks'''.
* '''[T]'''Tank. May carry 1 '''[In]'''Infantry and 1 other piece. '''[C]'''Commander, '''[In]'''Infantry, '''[M]'''Militia.

'''Stacks''' maximum group of '''2 pieces''' (1 carrier and 1 other piece):
* '''[HQ]'''Headquarters, may hold '''[C]'''Commander. '''HQ does not move'''
* '''[E]'''Engineer, may carry heavy weapons '''[A]'''Artillery, '''[Aa]'''Anti-aircraft, '''[Ms]'''Missile '''Also specifically must be carried across the river from one side to the other.'''

== Examples of unusual play ==
Both navy and land pieces may be placed on the coast. A '''[N]''' Navy has a gun and may capture a land piece, if it does then it will only capture and move if this land piece is on the coast, otherwise the '''[N]'''Navy piece will remain still and capture.

'''[E]'''Engineers may only carry pieces from the limited number of river bank spaces, and move just the 1 space across the river. All other stack movements with the engineer are not allowed.

'''[A]'''Artillery, '''[Aa]''' Anti-aircraft and '''[Ms]''' Missile may capture (shoot) across the river (but stay still) where normally they would not be able to cross the river.

'''[A]''' Artillery can only jump over pieces when capturing another piece. Otherwise, they cannot jump over pieces.

On the Sea/Land border (coast) land pieces do not block the movement of a Navy piece and vice versa. So these pieces are not being jumped over. One is on land, the other is in the sea, but both are on the coast.

A commander that exposes themselves to the opponents commander will immediately lose. (Line-of-sight).

Pieces that can jump and are not blocked by ANY piece. '''[Af]''' Plane, '''[N]''' Navy and the Navy gun. '''[A]''' Artillery(but only when capturing),

Without Enforce Check, it's possible to move into check, if you do this with your commander, then the opponents piece will become heroic.

== User Interface ==
* Some pieces stack on top of each other. It is recommended to use the squares to the right of the board from top to bottom. It automatically selects the stack to be moved as 1 group, if you would like to split up the pieces then user must select the pieces individually.
By selecting a box you will see the colour of the box change and the text.

GREEN means this is the selected piece and the piece you are currently moving.

RED means this piece is being carried and will not move separately.

GREY means this piece will move later after you have moved the current GREEN (selected) piece.

'Stay' will mean that the carried piece will disembark and stay in its current position.

* When playing with 'Enforce check' option a player needs to RESIGN if there are no playable moves.

* There are various 'confirm' options available from the context menu (3 lines, burger menu).

* You can play with (0,0) always at the bottom, available from the context menu (3 lines, burger menu).