Tools and tips of BGA Studio - Гісторыя версій

Victoria La: /* Rename/Copy project */

2020-10-14T00:21:14Z

Rename/Copy project

← Папярэдн. версія		Версія ад 02:21, 14 кастрычніка 2020
Радок 239:		Радок 239:

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

			Edit: there is project override command now available on control panel on studio

	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.		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.

Matthijs Kooijman: /* Version Control */ Link to BGA_Code_Sharing page

2020-09-21T08:23:15Z

Version Control: Link to BGA_Code_Sharing page

← Папярэдн. версія		Версія ад 10:23, 21 верасня 2020
Радок 202:		Радок 202:
	A quick option is to use a local repo, which you can sync to cloud or backup.		A quick option is to use a local repo, which you can sync to cloud or backup.

	Other option is to host source code on github. If you do, the convention is to use github.com/<yourname>/bga-<yourgame> ~~and~~ add the [https://github.com/topics/boardgamearena boardgamearena] tag.		Other option is to host source code on github. If you do, the convention is to use github.com/<yourname>/bga-<yourgame>. It is recommended to add the [https://github.com/topics/boardgamearena boardgamearena] tag and add your repo to the list on the [[BGA_Code_Sharing]] page.

	If you publish the source somewhere externally, make sure you '''don't post high-res publisher graphics''', only web resources, and post a separate license for graphics files. Also, '''don't include a file with your sftp password''' (github is automatically crawled for passwords by hackers; a hacking attempt occurred on BGA studio for this reason in June 2020).		If you publish the source somewhere externally, make sure you '''don't post high-res publisher graphics''', only web resources, and post a separate license for graphics files. Also, '''don't include a file with your sftp password''' (github is automatically crawled for passwords by hackers; a hacking attempt occurred on BGA studio for this reason in June 2020).

Matthijs Kooijman: /* Version Control */ Recommend adding a github tag, link to auto-deploy-from-github instructions and improve wording

2020-09-21T08:16:46Z

Version Control: Recommend adding a github tag, link to auto-deploy-from-github instructions and improve wording

← Папярэдн. версія		Версія ад 10:16, 21 верасня 2020
Радок 198:		Радок 198:

	=== Version Control ===		=== Version Control ===
	Studio ~~providers~~ svn for you code on server, there are some limited abilities there to see history and restore. I recommend to keep your code in another repository. ~~I suggest~~ to use ~~git with~~ local repo, which you can sync to cloud or backup.		Studio provides svn for you code on server, there are some limited abilities there to see history and restore. I recommend to also keep your code in another repository, which allows keeping more fine-grained history and can simplify collaboration.
	Other option is to host source code on github~~, if~~ you do use ~~this convention~~ github.com/<yourname>/bga-<yourgame>. ~~In such case~~ make sure you '''don't post high-res publisher graphics''' only web resources, and post a separate license for graphics files. Also, '''don't include a file with your sftp password''' (github is automatically crawled for passwords by hackers; a hacking attempt occurred on BGA studio for this reason in June 2020).
			A quick option is to use a local repo, which you can sync to cloud or backup.

			Other option is to host source code on github. If you do, the convention is to use github.com/<yourname>/bga-<yourgame> and add the [https://github.com/topics/boardgamearena boardgamearena] tag.

			If you publish the source somewhere externally, make sure you '''don't post high-res publisher graphics''', only web resources, and post a separate license for graphics files. Also, '''don't include a file with your sftp password''' (github is automatically crawled for passwords by hackers; a hacking attempt occurred on BGA studio for this reason in June 2020).

			You can also configure github to automatically deploy to BGA whenever you push to a branch. See [https://forum.boardgamearena.com/viewtopic.php?f=12&t=13370&start=10#p59537 this forum post] for instructions.

	=== PHP CLI ===		=== PHP CLI ===

Pickardj79 на 21:05, 18 жніўня 2020

2020-08-18T21:05:24Z

← Папярэдн. версія		Версія ад 23:05, 18 жніўня 2020
Радок 236:		Радок 236:
	You need to have php clt (command line interface) installed, then you can download script and run it.		You need to have php clt (command line interface) installed, then you can download script and run it.

	https://github.com/elaskavaia/bga-sharedcode/blob/master/~~tools~~/bgaprojectrename.php		https://github.com/elaskavaia/bga-sharedcode/blob/master/misc/bgaprojectrename.php

	Usage:		Usage:

Brainchild: Moved lftp to the Linux sub-section of File Sync

2020-07-12T23:48:18Z

Moved lftp to the Linux sub-section of File Sync

← Папярэдн. версія		Версія ад 01:48, 13 ліпеня 2020
Радок 109:		Радок 109:

	=== File Sync ===		=== File Sync ===

	~~==== File Sync using lftp ====~~
	~~[https://lftp.yar.ru/ lftp] is a fast command-line file transfer program. It's a much better choice than rsync for BGA Studio since it supports parallel threads, transfering multiple files at a time.~~

	* Windows 10: Enable "Windows Subsystem for Linux" and install a Linux distribution from the Microsoft Store. [https://ubuntu.com/tutorials/ubuntu-on-windows Follow these instructions to install Ubuntu]. Then install lftp as below for Linux (e.g., open Ubuntu command prompt and run '''sudo apt-get install lftp''').
	* Linux: Install using your package manager, for example: '''sudo apt-get install lftp'''
	* Mac: Install [https://brew.sh/ Homebrew], then install lftp using '''brew install lftp'''

	~~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"

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

	By default, if a file already exists on BGA Studio with the same time + size it assumed to be the same and won't be transferred. This makes the transfer process much quicker after the first time. If you're working with multiple developers on the same project and you find that it is transfers all files every time, you may want to add the option '''--ignore-time''' (if a file already exist on BGA Studio with the same size it is assumed to be the same and won't be transferred). Read [https://lftp.yar.ru/lftp-man.html the manual] for more details.

	==== File Sync on Windows ====		==== File Sync on Windows ====
Радок 131:		Радок 116:
	==== File Sync on Linux ====		==== File Sync on Linux ====

	* 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
	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 - sftp and rsync =====

	<pre>		<pre>

	#!/bin/bash		#!/bin/bash
	BASEDIR=`dirname $0`		BASEDIR=`dirname $0`
Радок 153:		Радок 136:
	killall lsyncd		killall lsyncd
	lsyncd -delay 1 -rsync $LOCAL/$GAME/ $REMOTE/$GAME		lsyncd -delay 1 -rsync $LOCAL/$GAME/ $REMOTE/$GAME

	</pre>		</pre>

Радок 162:		Радок 144:
	You can also sync on demand (from a build script or editor command) using		You can also sync on demand (from a build script or editor command) using
	rsync -vlrt $LOCAL/$GAME/ $REMOTE/$GAME		rsync -vlrt $LOCAL/$GAME/ $REMOTE/$GAME

			===== Option 3 - lftp =====

			[https://lftp.yar.ru/ lftp] is a fast command-line file transfer program. It's a much better choice than rsync for BGA Studio since it supports parallel threads, transferring multiple files at a time.

			* Linux: Install using your package manager, for example: '''sudo apt-get install lftp'''
			* Mac: Install [https://brew.sh/ Homebrew], then install lftp using '''brew install lftp'''

			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"

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

			By default, if a file already exists on BGA Studio with the same time + size it assumed to be the same and won't be transferred. This makes the transfer process much quicker after the first time. If you're working with multiple developers on the same project and you find that it is transfers all files every time, you may want to add the option '''--ignore-time''' (if a file already exist on BGA Studio with the same size it is assumed to be the same and won't be transferred). Read [https://lftp.yar.ru/lftp-man.html the manual] for more details.

	==== File Sync using VSCode ====		==== File Sync using VSCode ====

Quietmint: /* File Sync using lftp */

2020-07-08T02:48:07Z

File Sync using lftp

← Папярэдн. версія		Версія ад 04:48, 8 ліпеня 2020
Радок 119:		Радок 119:
	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 -R --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/ -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.

Quietmint: /* File Sync */

2020-07-08T02:40:57Z

File Sync

← Папярэдн. версія		Версія ад 04:40, 8 ліпеня 2020
Радок 109:		Радок 109:

	=== File Sync ===		=== File Sync ===

			==== File Sync using lftp ====
			[https://lftp.yar.ru/ lftp] is a fast command-line file transfer program. It's a much better choice than rsync for BGA Studio since it supports parallel threads, transfering multiple files at a time.

			* Windows 10: Enable "Windows Subsystem for Linux" and install a Linux distribution from the Microsoft Store. [https://ubuntu.com/tutorials/ubuntu-on-windows Follow these instructions to install Ubuntu]. Then install lftp as below for Linux (e.g., open Ubuntu command prompt and run '''sudo apt-get install lftp''').
			* Linux: Install using your package manager, for example: '''sudo apt-get install lftp'''
			* Mac: Install [https://brew.sh/ Homebrew], then install lftp using '''brew install lftp'''

			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 -R --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.

			By default, if a file already exists on BGA Studio with the same time + size it assumed to be the same and won't be transferred. This makes the transfer process much quicker after the first time. If you're working with multiple developers on the same project and you find that it is transfers all files every time, you may want to add the option '''--ignore-time''' (if a file already exist on BGA Studio with the same size it is assumed to be the same and won't be transferred). Read [https://lftp.yar.ru/lftp-man.html the manual] for more details.

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

DargorX: /* Starting a game in one click */

2020-06-30T08:41:39Z

Starting a game in one click

← Папярэдн. версія		Версія ад 10:41, 30 чэрвеня 2020
Радок 5:		Радок 5:

	To start a game:		To start a game:
	* ~~Create a new table with~~ your game.		* Go to Play now and configure game type: Simple game -> Turn-based -> Manual
			* Select your game and click on "Create".
	* If you want to play a game with 3 players, specify that you want a maximum of 3 players at this table.		* If you want to play a game with 3 players, specify that you want a maximum of 3 players at this table.
	* Click on "Express Start".		* Click on "Express Start".

Een: Github warning

2020-06-24T08:56:38Z

Github warning

← Папярэдн. версія		Версія ад 10:56, 24 чэрвеня 2020
Радок 186:		Радок 186:
	=== Version Control ===		=== Version Control ===
	Studio providers svn for you code on server, there are some limited abilities there to see history and restore. I recommend to keep your code in another repository. I suggest to use git with local repo, which you can sync to cloud or backup.		Studio providers svn for you code on server, there are some limited abilities there to see history and restore. I recommend to keep your code in another repository. I suggest to use git with local repo, which you can sync to cloud or backup.
	Other option is to host source code on github, if you do use this convention github.com/<yourname>/bga-<yourgame>. In such case make sure you don't post high-res publisher graphics only web resources, and post a separate license for graphics files.		Other option is to host source code on github, if you do use this convention github.com/<yourname>/bga-<yourgame>. In such case make sure you '''don't post high-res publisher graphics''' only web resources, and post a separate license for graphics files. Also, '''don't include a file with your sftp password''' (github is automatically crawled for passwords by hackers; a hacking attempt occurred on BGA studio for this reason in June 2020).

	=== PHP CLI ===		=== PHP CLI ===

Ricardorix: /* PDF Scrapper */

2020-05-06T15:06:03Z

PDF Scrapper

← Папярэдн. версія		Версія ад 17:06, 6 мая 2020
Радок 212:		Радок 212:
	==== PDF Scrapper ====		==== PDF Scrapper ====
	extract images from PDF file (i.e. game rulebook) :		extract images from PDF file (i.e. game rulebook) :


	https://www.ilovepdf.com/		https://www.ilovepdf.com/

	http://www.extractpdf.com/		http://www.extractpdf.com/