Setting up BGA Development environment using VSCode - Revision history

Dakvid: Provide guidance on how to connect with an SSH key

2026-10-07T08:34:28Z

Provide guidance on how to connect with an SSH key

← Older revision		Revision as of 08:34, 7 October 2026
Line 100:		Line 100:
	</pre>		</pre>

			* '''Note:''' if you have uploaded an SSH public key to your account then replace the "password" line with <code>"privateKeyPath": "<path_to_your_private_key>",</code> You must use your private key - eg "~/.ssh/id_rsa" - not the public key - eg "~/.ssh/id_rsa.pub"
	* syncOption delete: true - means you want to delete remote file if deleted locally		* syncOption delete: true - means you want to delete remote file if deleted locally
	* syncOption skipCreate: false - means you want to add new files when added locally (false because its reverse option)		* syncOption skipCreate: false - means you want to add new files when added locally (false because its reverse option)

KalevTait: /* File Sync */

2026-10-03T05:42:32Z

File Sync

← Older revision		Revision as of 05:42, 3 October 2026
Line 103:		Line 103:
	* syncOption skipCreate: false - means you want to add new files when added locally (false because its reverse option)		* syncOption skipCreate: false - means you want to add new files when added locally (false because its reverse option)
	* remotePath - do not remove slashes, it is part of the path		* remotePath - do not remove slashes, it is part of the path
			* Note that if you are doing first time sync as described below, you may not want to include the _ide_helper.php in the ignore list, at least not till after your first sync.

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

KalevTait: /* File Sync */

2026-09-29T20:03:40Z

File Sync

← Older revision		Revision as of 20:03, 29 September 2026
Line 60:		Line 60:

	*'''Install this extension''' https://marketplace.visualstudio.com/items?itemName=Natizyskunk.sftp (File->Preferences->Extensions ... type SFTP and make sure its by Natizyskunk)		*'''Install this extension''' https://marketplace.visualstudio.com/items?itemName=Natizyskunk.sftp (File->Preferences->Extensions ... type SFTP and make sure its by Natizyskunk)
			**Because of the bug listed below in 'first sync', the recomended solution is to install the SFTP extension by Satiro Marra instead, though the json config process has a wizard instead (which you can safely ignore and just edit the sftp.json directly)

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

Kenpoh: /* One time only - first sync */

2026-09-01T21:20:47Z

One time only - first sync

← Older revision		Revision as of 21:20, 1 September 2026
Line 111:		Line 111:
	After initially downloading the project, you can add _ide_helper.php to the "ignore" list. Even though it is needed locally for the IDE to understand BGA-related php code, you will never need to update it.		After initially downloading the project, you can add _ide_helper.php to the "ignore" list. Even though it is needed locally for the IDE to understand BGA-related php code, you will never need to update it.

	Please note, if you download the files and they are empty when you look at them~~. Do~~ not type anything into them until you deal with the TypeError: isDate is not a function error first. The recommended sftp extension in vscode as of 2026-09-01 has some issues with its code. Perhaps try WireFerry instead. If you type something into the files and auto sync is on, you may overwrite files on the server.		Please note, if you download the files and they are empty when you look at them, do not type anything into them until you deal with the TypeError: isDate is not a function error first. The recommended sftp extension in vscode as of 2026-09-01 has some issues with its code. Looking up the error online will lead you to fixes. Perhaps try WireFerry instead. If you type something into the files and auto sync is on, you may overwrite files on the server.

	=== Daily use===		=== Daily use===

Kenpoh: /* One time only - first sync */

2026-09-01T21:20:00Z

One time only - first sync

← Older revision		Revision as of 21:20, 1 September 2026
Line 110:		Line 110:

	After initially downloading the project, you can add _ide_helper.php to the "ignore" list. Even though it is needed locally for the IDE to understand BGA-related php code, you will never need to update it.		After initially downloading the project, you can add _ide_helper.php to the "ignore" list. Even though it is needed locally for the IDE to understand BGA-related php code, you will never need to update it.

			Please note, if you download the files and they are empty when you look at them. Do not type anything into them until you deal with the TypeError: isDate is not a function error first. The recommended sftp extension in vscode as of 2026-09-01 has some issues with its code. Perhaps try WireFerry instead. If you type something into the files and auto sync is on, you may overwrite files on the server.

	=== Daily use===		=== Daily use===

Victoria La: /* User templates */

2026-03-14T12:54:15Z

User templates

@@ Line 206: / Line 206: @@
 <pre>
+{
    "Player loop in game.php": {
      "prefix": ["players"],

Victoria La: /* PHP Intellisense */

2026-03-14T12:52:48Z

PHP Intellisense

← Older revision		Revision as of 12:52, 14 March 2026
Line 25:		Line 25:
	===PHP Intellisense===		===PHP Intellisense===

	The ~~ide_helper~~ file, included in every project, will help your IDE know the available functions of the framework. This file may be updated automatically on your FTP folder, so don't hesitate to pull it back if it misses something, it might have been updated!		The "_ide_helper.php" file, included in every project, will help your IDE know the available functions of the framework. This file may be updated automatically on your FTP folder, so don't hesitate to pull it back if it misses something, it might have been updated!

	To solve the warning about the material file class members (warning only appears if you use legacy material file)		To solve the warning about the material file class members (warning only appears if you use legacy material file)

Victoria La: /* JavaScript Intellisense */

2026-03-14T12:51:35Z

JavaScript Intellisense

← Older revision		Revision as of 12:51, 14 March 2026
Line 18:		Line 18:
	=== JavaScript Intellisense ===		=== JavaScript Intellisense ===

	* Since BGA framework ditched dojo in 2025 we can rejoice and enjoy full ide support. If try it for old dojo projects - it does not really work.		* Since BGA framework ditched dojo in 2025 we can rejoice and enjoy full ide support. If you try it for old dojo projects - it does not really work.

	* A good way to improve auto-complete and such is to use Typescript and SCSS, this is not for the beginners.		* A good way to improve auto-complete and such is to use Typescript and SCSS, this is not for the beginners.
	** Original wiki: https://en.doc.boardgamearena.com/Using_Typescript_and_Scss		** Original wiki: https://en.doc.boardgamearena.com/Using_Typescript_and_Scss


	===PHP Intellisense===		===PHP Intellisense===

Victoria La: /* Intellisense - Navigation/Auto-complete */

2026-03-14T12:51:06Z

Intellisense - Navigation/Auto-complete

← Older revision		Revision as of 12:51, 14 March 2026
Line 18:		Line 18:
	=== JavaScript Intellisense ===		=== 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~~.		* Since BGA framework ditched dojo in 2025 we can rejoice and enjoy full ide support. If try it for old dojo projects - it does not really work.

	* ~~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~~		* A good way to improve auto-complete and such is to use Typescript and SCSS, this is not for the beginners.
	** 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		** Original wiki: https://en.doc.boardgamearena.com/Using_Typescript_and_Scss

	* Another way to improve auto-complete and such is to use Typescript and SCSS, this is not for the beginners.
	** Original wiki: https://en.doc.boardgamearena.com/Using_Typescript_and_Scss
	** There is also 3rd party software that automates typescript template above: [[BGA Type Safe Template]]. It claims to offers a much cleaner initial file, clearer workflow, and nearly complete type and autofill support for whatever you may need.

	===PHP Intellisense===		===PHP Intellisense===

Thoun: /* Unit testing */

2026-03-12T09:20:04Z

Unit testing

← Older revision		Revision as of 09:20, 12 March 2026
Line 47:		Line 47:
	If using phpunit, install it via composer somewhere in home directory, i.e.		If using phpunit, install it via composer somewhere in home directory, i.e.
	cd /home/<yourusername>/php-composer		cd /home/<yourusername>/php-composer
	composer require --dev phpunit/phpunit ^11		composer require --dev phpunit/phpunit ^13

	Then add this path to include paths in settings		Then add this path to include paths in settings
Line 54:		Line 54:
	"/home/<yourusername>/php-composer"		"/home/<yourusername>/php-composer"
	],		],

	~~Also add this to your .bashrc~~
	~~phpunit() {~~
	~~/home/<yourusername>/php-composer/vendor/bin/phpunit \~~
	~~-c "$PWD/phpunit.xml.dist" \~~
	~~--bootstrap "$PWD/tests/bootstrap.php" \~~
	~~"$@"~~
	}

	~~With that, you should be able to run the tests with one of the following commands at the root of your project :~~
	~~phpunit~~
	~~phpunit tests/BoardManagerTest.php~~
	~~phpunit --filter testGivesExtraTime~~

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