Tools and tips of BGA Studio - Revision history

Thoun: /* Server Tools and Tips */

2026-03-10T08:30:38Z

Server Tools and Tips

@@ Line 52: / Line 52: @@
 Note: if you click on some notification title, you can resend it immediately to the user interface.
 === Zombify a player ===
-Call this from chat (studio only) to zombify current player (who is "thinking")
+Using the red arrow, go to the player view and select Quit game (make sure you're playing in friendly mode to avoid your studio accounts to go to 0 karma while testing zombie).
 === Stopping Hanging Game ===

Victoria La: EmptyGame

2025-12-23T19:37:03Z

EmptyGame

← Older revision		Revision as of 21:37, 23 December 2025
Line 243:		Line 243:

	On linux tool that does it in command line "pdfimages"		On linux tool that does it in command line "pdfimages"

			=== Restore project to Original template ===
			You can restore your project with default project using Studio Control Panel.
			I.e go to https://studio.boardgamearena.com/studio find your project click on it's link, find Override text in the control panel.
			* Use words ''EmptyGame'' as second project.
			* Use your own project name (with capital/s) as first project.
			* Press Go (or whatever button named)

	=== Rename/Copy project ===		=== Rename/Copy project ===

Victoria La: /* Image Manipulation */

2025-12-23T19:31:29Z

Image Manipulation

← Older revision		Revision as of 21:31, 23 December 2025
Line 244:		Line 244:
	On linux tool that does it in command line "pdfimages"		On linux tool that does it in command line "pdfimages"

	==== Rename/Copy project ====		=== Rename/Copy project ===

	You can now override your project with any other project using Studio Control Panel.		You can now override your project with any other project using Studio Control Panel.
Line 262:		Line 262:
	php8.4 git/bga-sharedcode/tools/bgaprojectrename.php remote/hearts/ remote/heartsmyproject/		php8.4 git/bga-sharedcode/tools/bgaprojectrename.php remote/hearts/ remote/heartsmyproject/

	==== BGA Workbench ====		=== BGA Workbench ===

	PHP library providing tools to help manage BGA Studio projects including deployment and test utilities. https://github.com/danielholmes/bga-workbench		Unofficial/unsupported PHP library providing tools to help manage BGA Studio projects including deployment and test utilities. https://github.com/danielholmes/bga-workbench

	=== Testing and validation tools ===		=== Testing and validation tools ===

Victoria La: /* Rename/Copy project */

2025-12-23T19:30:09Z

Rename/Copy project

← Older revision		Revision as of 21:30, 23 December 2025
Line 247:		Line 247:

	You can now override your project with any other project using Studio Control Panel.		You can now override your project with any other project using Studio Control Panel.

			I.e go to https://studio.boardgamearena.com/studio find your project click on it's link, find Override text in the control panel and read instructions.

	Alternatively there is a script available in sharedcode project to do the renaming which can be called in command line if you have php command line installed.		Alternatively there is a script available in sharedcode project to do the renaming which can be called in command line if you have php command line installed.
Line 258:		Line 260:
	Example on how to call it in command line if you project name is "heartsmyproject"		Example on how to call it in command line if you project name is "heartsmyproject"

	~~php7~~.0 git/bga-sharedcode/tools/bgaprojectrename.php remote/hearts/ remote/heartsmyproject/		php8.4 git/bga-sharedcode/tools/bgaprojectrename.php remote/hearts/ remote/heartsmyproject/

	==== BGA Workbench ====		==== BGA Workbench ====

Mavit: BGA SFTP server moved to port 2022.

2025-11-26T14:09:56Z

BGA SFTP server moved to port 2022.

← Older revision		Revision as of 16:09, 26 November 2025
Line 140:		Line 140:

	===== Option 1 - Nautilus (file manager) =====		===== Option 1 - Nautilus (file manager) =====
	You can just use Nautilus "connect to a server" function with URL sftp://1.studio.boardgamearena.com		You can just use Nautilus "connect to a server" function with URL sftp://1.studio.boardgamearena.com:2022
	Then you'll get a mounted local folder mapping your studio folder and you can use any editor you like without further need for sync. Downside - if connection goes down you cannot work on source code, no local copy.		Then you'll get a mounted local folder mapping your studio folder and you can use any editor you like without further need for sync. Downside - if connection goes down you cannot work on source code, no local copy.

Line 187:		Line 187:
	To upload your project to BGA studio, use the "mirror" command like this:		To upload your project to BGA studio, use the "mirror" command like this:

	'''lftp sftp://<span style="color:blue">myuser</span>:<span style="color:red">mypassword</span>@1.studio.boardgamearena.com/ -e "mirror --reverse --parallel=10 --delete <span style="color:orange">/local/path/to/myproject</span>/ <span style="color:green">myproject</span>/; exit"		'''lftp sftp://<span style="color:blue">myuser</span>:<span style="color:red">mypassword</span>@1.studio.boardgamearena.com:2022/ -e "mirror --reverse --parallel=10 --delete <span style="color:orange">/local/path/to/myproject</span>/ <span style="color:green">myproject</span>/; exit"

	Be sure to include the trailing '''/''' after both directory names.		Be sure to include the trailing '''/''' after both directory names.

Victoria La: /* Option 2 - sftp and rsync */

2025-07-03T22:09:22Z

Option 2 - sftp and rsync

← Older revision		Revision as of 00:09, 4 July 2025
Line 143:		Line 143:
	Then you'll get a mounted local folder mapping your studio folder and you can use any editor you like without further need for sync. Downside - if connection goes down you cannot work on source code, no local copy.		Then you'll get a mounted local folder mapping your studio folder and you can use any editor you like without further need for sync. Downside - if connection goes down you cannot work on source code, no local copy.

	===== Option 2 - ~~sftp~~ and rsync =====		===== Option 2 - sshfs and rsync =====
	This setup will sync in the background (~~continious~~ sync) when file is saved, after you set it up and start just save your files and they be on server before you can hit refresh.		This setup will sync in the background (continuous sync) when file is saved, after you set it up and start just save your files and they be on server before you can hit refresh. You need to install "sshfs" first.
			This is linux script:

	<pre>		<pre>
Line 150:		Line 151:
	BASEDIR=`dirname $0`		BASEDIR=`dirname $0`
	REMOTE=$BASEDIR/remote		REMOTE=$BASEDIR/remote
	~~LOCAL=$BASEDIR/workspace~~
	~~GAME=mygamenamehere~~

	#mount remote		#mount remote
Line 161:		Line 161:
	#this starts auto-sync from local to remote mount		#this starts auto-sync from local to remote mount
	killall lsyncd		killall lsyncd
			LOCAL=$BASEDIR/workspace

			#for every game you can do something like this
			GAME=mygamenamehere
	lsyncd -delay 1 -rsync $LOCAL/$GAME/ $REMOTE/$GAME		lsyncd -delay 1 -rsync $LOCAL/$GAME/ $REMOTE/$GAME
	</pre>		</pre>

Thoun: /* State machine diagram generation tool */

2025-06-04T10:49:37Z

State machine diagram generation tool

← Older revision		Revision as of 12:49, 4 June 2025
Line 283:		Line 283:

	'''Legend:'''		'''Legend:'''
	* states of type ~~game~~ appear in yellow		* states of type GAME appear in yellow
	* states of type ~~activeplayer~~ appear in blue		* states of type ACTIVE_PLAYER appear in blue
	* states of type ~~multipleactiveplayer~~ appear in green		* states of type MULTIPLE_ACTIVE_PLAYER appear in green
	Once you have this state machine, you can use it to generate boilerplate code using the [https://github.com/xmakina/bga-statemachinegenerator BGA State Machine Generator]		Once you have this state machine, you can use it to generate boilerplate code using the [https://github.com/xmakina/bga-statemachinegenerator BGA State Machine Generator]

Thoun: /* Run PHP functions from the chat */

2025-04-03T09:05:39Z

Run PHP functions from the chat

← Older revision		Revision as of 11:05, 3 April 2025
Line 55:		Line 55:

	=== Run PHP functions from the chat ===		=== Run PHP functions from the chat ===
			Obsolete, please use [[Practical debugging#Writing custom debug functions]] instead.

	On BGA Studio, you can directly run a PHP method from the table chat. The production environment does not allow PHP methods to be called from the table chat.		On BGA Studio, you can directly run a PHP method from the table chat. The production environment does not allow PHP methods to be called from the table chat.

Victoria La: /* File Sync */

2024-09-20T13:08:14Z

File Sync

← Older revision		Revision as of 15:08, 20 September 2024
Line 130:		Line 130:

	IMPORTANT NOTE: The ssh port is 2022 - All methods below need to be updated to include port number		IMPORTANT NOTE: The ssh port is 2022 - All methods below need to be updated to include port number
			IMPORTANT NOTE 2: If you uploaded ssh key - PASSWORD method is automatically disabled, you can no longer use password

	==== File Sync on Windows ====		==== File Sync on Windows ====

	Install [http://winscp.net/ WinSCP]. Map a remote directory to a local one and enable continuous sync (one way). You need SFTP password you get when you registered dev account.		Install [http://winscp.net/ WinSCP]. Map a remote directory to a local one and enable continuous sync (one way). You need SFTP password you get when you registered dev account (or ssh key).

	==== File Sync on Linux ====		==== File Sync on Linux ====

Victoria La: /* File Sync */

2024-09-03T12:13:21Z

File Sync

← Older revision		Revision as of 14:13, 3 September 2024
Line 129:		Line 129:
	NOTE: If you use VS Code you don't need to use methods below, use one of the sync methods provided by VS Code extensios. See [[Setting up BGA Development environment using VSCode]]		NOTE: If you use VS Code you don't need to use methods below, use one of the sync methods provided by VS Code extensios. See [[Setting up BGA Development environment using VSCode]]

	IMPORTANT NOTE: The ssh port is ~~not~~ 2022 - All methods below need to be updated to include port number		IMPORTANT NOTE: The ssh port is 2022 - All methods below need to be updated to include port number

	==== File Sync on Windows ====		==== File Sync on Windows ====