Board Game Arena - User contributions [en]

Setting up BGA Development environment using VSCode

2024-03-21T11:53:12Z

Catwillow: /* PHP Intellisense */ added git command with updated syntax

Microsoft Visual Studio Code is light weight IDE/Editor. All desktops.

== Downloads ==

* Download and install vscode from https://code.visualstudio.com
* Download and install php (7.4) command line interface (for local tests and debugging)

== Extensions ==

* PHP Intelephense - https://marketplace.visualstudio.com/items?itemName=bmewburn.vscode-intelephense-client
* Or PHP IntelliSense - https://marketplace.visualstudio.com/items?itemName=zobo.php-intellisense
* PHP Debug - https://marketplace.visualstudio.com/items?itemName=xdebug.php-debug
* SQLTools - https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools
* Prettier - code formatter - https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
* SFTP (by Natizyskunk) - https://marketplace.visualstudio.com/items?itemName=Natizyskunk.sftp

== Intellisense - Navigation/Auto-complete ==

=== JavaScript Intellisense ===

Because of dojo style class/method declarations most IDE won't be able to index main JavaScript file properly (i.e. go to definition of function and such).
If you manage to get it working in VS code, let us know how.

There is a way to re-structure code to avoid using this style, but this is not for beginners. Do not use this on your first game!
https://en.doc.boardgamearena.com/BGA_Studio_Cookbook#Avoiding_code_in_dojo_declare_style

There is also a complete example of a "dojo-less" project, it also includes a (incomplete) typescript definition file (.d.ts) for auto-completion of js BGA interfaces
https://github.com/elaskavaia/bga-dojoless

=== PHP Intellisense ===

If you don't do anything PHP will complain about undefined symbols from BGA framework (as well as from the material file).
To solve the warning about framework issues, you need a stubs for the BGA APIs:

* git clone git@github.com:elaskavaia/bga-sharedcode.git (you can also get and unzip it from the GitHub page)
** if that doesn't work, try git clone <nowiki>https://github.com/elaskavaia/bga-sharedcode.git</nowiki>
** you can do this in a terminal from VS Code - Terminal menu -> New Terminal
* add reference (include path) to bga-sharedcode/misc using settings of PHP extension, see example below

If you're using the Intelephense plugin, add this to global user settings (modify the path obviously)

"intelephense.environment.includePaths": [
"/home/victoria/git/bga-sharedcode/misc/"
],

To solve the warning about the material file class members

Option 1)
If you don't have too many class members you can define them, for example if I have $this->token_types = [...] in the material file I can define them in in the class of game.php

private $token_types;

Option 2)

Put this line in the settings.json if you using Intelliphense extension to ignore them:

"intelephense.diagnostics.undefinedProperties": false

=== Unit testing ===

If using phpunit, install it via composer somewhere in home directory, i.e.
cd /home/victoria/php-composer
composer require --dev phpunit/phpunit ^9

Then add this path (e.x. /home/victoria/php-composer) to include paths as above

See more about unit testing in [[Testing by developer]]

== File Sync ==
You can set up your sync using other methods, not related to vscode (such as rsync), if you want to do that see [[Tools_and_tips_of_BGA_Studio#File_Sync]] otherwise see below:

You might rely on your IDE to sync the files with the SFTP server. Each time you "save" a file with your modifications, the IDE will also submit it to the sFTP server. These are instructions for VS Code

* '''Install this extension''' https://marketplace.visualstudio.com/items?itemName=Natizyskunk.sftp (File->Preferences->Extensions ... type SFTP and make sure its by Natizyskunk)

* '''Open VSCode on an empty folder''' that will be the local root of your project.

* Execute Ctrl+Shift+P on Windows/Linux or Cmd+Shift+P on Mac to open the command palette, and the type/run : '''"SFTP: config"''' - the edit will open with json config

* '''Update the json''' as below:

<pre>
{
"name": "BGA",
"host": "1.studio.boardgamearena.com",
"protocol": "sftp",
"port": 22,
"username": "<your SFTP username>",
"password": "<your SFTP password>",
"remotePath": "/<your project name>/",
"uploadOnSave": true,
"ignore": [
".vscode",
".git",
".DS_Store"
],
"syncOption": {
"skipCreate": false, # syncs new files
"delete": true # syncs deleted files
}
}
</pre>

=== One time only - first sync ===

- Execute Ctrl+Shift+P on Windows/Linux or Cmd+Shift+P on Mac to open the command palette, and the type/run : '''"SFTP: Download Project"'''.

This will download all the files locally.

=== Daily use ===

You don't have to do anything else! Each time you modify/save a file in VSCode, it will upload it to the SFTP Server.

To force upload to a server, execute Ctrl+Shift+P -> '''"SFTP: Sync Local -> Remote"'''.

Note: the SFTP sync may fail with a permissions error when create or delete nested folders. To fix this, execute `chmod -R 755 <your directory name>` in your terminal, then force sync to remote.

=== Split settings for version control ===
If you want to commit this file to version control, use private key (upload ssh key https://studio.boardgamearena.com/controlpanel) instead and move user/password settings into vscode user settings

I.e. in user setting add this (have to edit settings.js manually, google for location its os specific)
<pre>
"remotefs.remote": {
"bgadev": {
"name": "BGA",
"host": "1.studio.boardgamearena.com",
"protocol": "sftp",
"port": 22,
"username": "<yourdevusername>",
"privateKeyPath": "~/.ssh/id_rsa",
},
}
</pre>
in project folder sftp.json (replace <yourproject> with project name)
<pre>
{
"remote": "bgadev",
"remotePath": "/<yourproject>/",
"uploadOnSave": true,
"ignore": [
".git"
],
"syncOption": {
"skipCreate": false,
"delete": true
},
"watcher": {
"files": "**/*.{js,css}",
"autoUpload": true,
"autoDelete": true
}
}
</pre>

Note: you don't need watcher section if you don't use code generators, but its needed if you use typescript, scss or similar code generator tools.

== Code Formatter ==
I think Prettier has better format, you can install Prettier plugin to do the formatting, for PHP add the following in package.json

"devDependencies": {
"@prettier/plugin-php": "^0.19.1",
"prettier": "^2.7.1"
},
"prettier": {
"braceStyle": "1tbs"
}

== Code generators ==
If you want to run code generators for example for typescript or scss you can install this extension:
* https://marketplace.visualstudio.com/items?itemName=emeraldwalk.RunOnSave

In settings.json add these (example only):
"emeraldwalk.runonsave": {
"commands": [
{
"match": ".*\\.ts$",
"isAsync": true,
"cmd": "npm run build:ts"
},
{
"match": ".*\\.scss$",
"isAsync": true,
"cmd": "npm run build:scss"
}
]
}

In this example <code>build:ts</code> and <code>build:scss</code> are scripts configured via package.json

Another example - you can run php script that will generate material.inc.php from misc/xxx_material.csv
{
"match": "misc/.*material\\.csv$",
"isAsync": true,
"cmd": "php7.4 ${env.HOME}/git/bga-sharedcode/misc/genmat.php ${file}"
}

== User templates ==

You can define user template to avoid writing boilerplate code, here is example of php template for states
(it is placed in global location php.json - you can open it from the gui File->Preferences->Configure User Snippets and type php

<pre>
{
"Single player state": {
"prefix": ["state", "playerstate"],

"body": [
"$LINE_COMMENT playerTurn${1:something}",
"${1/(.*)/STATE_PLAYER_TURN_${1:/upcase}/} => [",
"'name' => 'playerTurn${1:something}',",
"'description' => clienttranslate('\\${actplayer} must ${1:something}'),",
"'descriptionmyturn' => clienttranslate('\\${you} must ${1:something}'),",
"'type' => 'activeplayer',",
"'args'=>'arg_playerTurn${1:something}',",
"'action'=>'st_playerTurn${1:something}',",
"'possibleactions' => [ 'playCard', 'pass' ],",
"'transitions' => [",
"'next' => STATE_GAME_TURN_NEXT_PLAYER,",
"'loopback' => ${1/(.*)/STATE_PLAYER_TURN_${1:/upcase}/} ]",
"],"
],

"description": "Create single player state defition, use tab to fill template parameters"
},

"Multiple player state": {
"prefix": ["mstate", "multiplayerstate"],

"body": [
"$LINE_COMMENT mplayerTurn${1:something}",
"${1/(.*)/STATE_MPLAYER_TURN_${1:/upcase}/} => [",
"'name' => 'mplayerTurn${1:something}',",
"'description' => clienttranslate('Other players must ${1:something}'),",
"'descriptionmyturn' => clienttranslate('\\${you} must ${1:something}'),",
"'type' => 'multipleactiveplayer',",
"'args'=>'arg_mplayerTurn${1:something}',",
"'action'=>'stMakeEveryoneActive',",
"'possibleactions' => [ 'playCard', 'pass' ],",
"'transitions' => [",
"'next' => STATE_GAME_TURN_NEXT_MPLAYER,",
"'loopback' => ${1/(.*)/STATE_MPLAYER_TURN_${1:/upcase}/} ]",
"],"
],

"description": "Create multi player state defition, use tab to fill template parameters"
},
"Action in action.php": {
"prefix": ["action"],
"body": [
"public function ${1:actionName}() {",
"\tself::setAjaxMode();",
"\t\\$${2:arg} = self::getArg('${2:arg}', AT_posint, false, 0);",
"\t\\$this->game->action_${1:actionName}(\\$${2:arg});",
"\tself::ajaxResponse();",
"}"
]
},
"Player loop in game.php": {
"prefix": ["players"],
"body": [
"\\$players = \\$this->loadPlayersBasicInfos();",
"foreach (\\$players as \\$player_id => \\$player_info) {",
"${1}",
"}"
]
}

}
</pre>

[[Category:Studio]]

Gamehelpbutterfly

2024-02-02T15:48:26Z

Catwillow: /* Gameplay */ clarified turning rule

[https://www.boardgamegeek.com/boardgame/284229/butterfly Butterfly] is simple tile set collection game by Rio Grande. You take the hedgehog from tile to tile scoring points for the tiles you collect.

== Gameplay ==

The player to the left of the starting player places the hedgehog on any tile.

Players then take turns. On your turn, you first turn the hedgehog to its left or right, or keep it pointing as is, but may not reverse it. You then must move the hedgehog to any tile which is in a straight line ahead of it, in the direction it is now facing. So no move can ever be in the opposite direction of the previous move.

You can skip over empty spaces to reach the tile. When you land on a tile, you collect it.

Some spaces on the board have Butterfly Nets, which are revealed when tiles are collected. If the hedgehog moves over an exposed butterfly net, the player may immediately choose to draw and score a random tile from the bag.

=== Scoring ===
[[File:Scoring.jpg|Scoring Chart]]

*Butterflies score the number of points shown. (There are also colored x2 multipliers which multiply the score in that colour)
*Dragonflies score only the highest dragonfly collected.
*Lightning bugs score only the lowest lightning bug collected.
*Grasshoppers score only the last grasshopper collected, previous tiles are discarded.
*Flowers are each worth the number of collected flowers. (Example: if you have 4 flowers, each flower is worth 4 points = a total of 16 points in flowers.)
*For each Bee which you can pair with a Honeycomb, the Bee scores 0 and the Honeycomb scores the printed value.
**Bees are worth -3 without a Honeycomb to live in.
**Honeycombs are worth 0 points without a bee to live in them.
*Wasps are worth negative points as shown on each wasp tile.

=== End Game ===
The game is over when the hedgehog can no longer be moved. The player with the highest score at that time wins!

Gamehelpluckynumbers

2023-12-17T00:34:37Z

Catwillow: /* Game play */ explained play options

== Overview ==

Lucky Numbers is a simple game of luck mixed with thinking ahead.

== Objective ==

* The objective is to make a full grid of 16 number tiles.
* The numbers in each row must increase from left to right, and the numbers in each column must increase from top to bottom.
* You cannot have the same number twice in a row or column.

Example of a completed grid:

[[File:Lucky numbers.jpg|Lucky numbers.jpg]]

'''Single Round'''

* The first player to fill their grid wins.

==== Tournament Mode ====
The game is played multiple times with each player getting a chance to go first.
* The winner of each round earns two points.
* The other players lose one point for each empty space on their grid.
Highest total score wins.

== Game play ==

* For each player, a set of 20 tiles numbered from 1 to 20 are shuffled together, and each player starts with 4 distinct numbers in a diagonal line. (In the "easy setup" option, the first four tiles for the diagonal spaces are automatically drawn and placed in ascending order from least in the top left to greatest in the bottom right. With the "Michael's setup" option, the first four tiles are drawn one at a time and placed one by one on the diagonal according to the player's choice.)
* The remaining tiles (16 from each set) are mixed together in one pot.
* At the beginning of each of your turns, you may either draw a random tile from the pot or take a tile from the table (if there are any).
* You may play the tile you have as long as it is higher than each tile before it in the same row and column, and lower than each tile after it in the same row and column.
* If you take a tile from the table, you must play it.
* To play a tile, you may either play it in an empty space or replace an existing tile on your grid.
* If you replace a tile on your grid, or choose to discard a drawn tile, that tile goes onto the table.
* Normally the next player then takes their turn, but in "Bruno's variant" if you place a tile diagonally adjacent to a tile with the same number then you immediately get another turn. In this way, you can take several turns in a row.

Gamehelpthebuilders

2023-12-08T15:50:35Z

Catwillow: /* Tie Breakers */ corrected tiebreaker condition and removed incorrect note

== The Goal ==

You must get the most victory points by using your workers to construct buildings.

== Content ==

'''Cards'''

There are 84 cards:

* 34 Building cards plus 8 machines
* 42 Workers cards

'''Coins'''

There are 40 coins:

* 15 Golden Coins (Value 5)
* 25 Silver Coins (Value 1)

''Note: You will earn 1 victory point for every 10 coins at the end of the game''

== Playing the Game ==

On your turn you get to play 3 actions. If you wish you can pay 5 coins per each additional action.

'''The Actions'''

# Start Construction
# Recruit a Worker
# Send a Worker
# Take Coins

=== Start Construction ===
(Cost 1 action)

You can choose one building from the 5 open Building cards. Immediately replace the card with the top card from the building deck. You may repeat this action as long as you have actions during your turn. (Remember that for every 5 coins you pay to the bank you can get 1 more action)

'''Machines'''

A machine is built as a building and is worth victory points but when you build a machine it is treated as a worker that does not require payment for its work.

=== Recruit a Worker ===
(Cost 1 action)

You can choose one worker from the 5 open Worker cards. Immediately replace the card with the top card from the worker deck. You may repeat this action as long as you have actions during your turn. (Remember that for every 5 coins you pay to the bank you can get 1 more action)

=== Send a Worker to Work ===
(variable action cost)

When you send a worker you must pay the number of coins in the upper right corner of the Worker card. Once you send a worker to work on a building it can not move until the building is complete.

'''Action cost of sending a Worker'''

In addition to paying the coin cost on the card, the action cost of sending a worker increases for each worker you send to that same building during your turn.

First worker sent to the building this turn = 1 action (regardless of the amount of workers already working on the building)

Second worker sent to that building = 2 more actions (for a total of 3)

Third worker sent to that building = 3 more actions (for a total of 6)

And so on...

'''Finishing a Building''' ''(is not an action)''

For completing the building you need to add workers until all of the requirements for the building are met or exceeded. You will earn the amount of coins shown on the building card from the bank and the amount of victory points.

=== Take Coins ===
(variable action cost)

You can take Coins from the bank:

* For 1 action you can take 1 Coin
* For 2 actions you can take 3 Coins
* For 3 actions you can take 6 Coins

== End of the Game ==

When a player gets 17 victory points from building alone (not coins) the game will end after each player finish their turn for that round. The player with the most amount of victory points will win the game, this time adding 1 more victory point for every 10 coins to the victory point received from the buildings and machines.

=== Tie Breakers ===

If there is a tie where both players have the same number of victory points, then the winner is whoever has more VPs from buildings alone (including machines, but not coins).
<br>

If there is still a tie, then the winner is whoever has more coins.
If there is still a tie, the game is drawn.