First steps with BGA Studio - Redigeerimiste ajalugu

Christopheryoder: /* Connect to your SFTP folder */

2015-02-04T17:26:03Z

Connect to your SFTP folder

←Vanem redaktsioon		Redaktsioon: 4. veebruar 2015, kell 19:26
19. rida:		19. rida:
	== Connect to your SFTP folder ==		== Connect to your SFTP folder ==

	From the initial email from the ~~Studion~~ you get:		From the initial email from the Studio you get:
	* the name of the SFTP server to connect to		* the name of the SFTP server to connect to
	* your SFTP login and password		* your SFTP login and password

Sourisdudesert – 30. september 2013, kell 16:15

2013-09-30T16:15:35Z

←Vanem redaktsioon		Redaktsioon: 30. september 2013, kell 18:15
13. rida:		13. rida:
	* Try to get a licence for a game you don't see in the "available game licences" page (see how-to on "available licences" page).		* Try to get a licence for a game you don't see in the "available game licences" page (see how-to on "available licences" page).

			== Create a new game project ==

	~~== Connect to your SFTP folder and to the BGA Studio website ==~~		You can do most of projects-related operation from "Control Panel / Manage games". In particular, you can create a new project automatically from there.

	~~After~~ your ~~account has been created,~~ you ~~will~~ get ~~by email~~:		== Connect to your SFTP folder ==

			From the initial email from the Studion you get:
	* the name of the SFTP server to connect to		* the name of the SFTP server to connect to
	* your SFTP login and password		* your SFTP login and password
	* ten BGA Studio logins ending with a numeral ranging from 0 to 9 and the password needed to use them.


	Using this information:		Using this information:
	# Connect to the SFTP server using your SFTP login and password, through your favourite SFTP client software (such as [http://winscp.net/ WinSCP] for example)		# Connect to the SFTP server using your SFTP login and password, through your favourite SFTP client software (such as [http://winscp.net/ WinSCP] for example)
	# Check that your home folder contains one folder for each of the three example games (reversi, hearts, gomoku). ~~Each time~~ you ~~create~~ a new game project, one additional folder ~~is added to~~ your "home" folder.		# Check that your home folder contains one folder for each of the three example games (reversi, hearts, gomoku). If you have already created a new game project, one additional folder should be in your "home" folder.

			== Let's code! ==

			Now, you can try to launch a new game on BGA Studio from the "Play now" menu entry, as you would do on Board Game Arena website.

	~~# Open the resources.html file, it contains :~~
	~~#* The URL pointing to the BGA Studio website (protected with an HTTP Basic authentication scheme, the login and password are also referenced in the 'resources.html' file~~
	#* The URL pointing to the BGA Studio backoffice (please note that you must first be logged in on the BGA Studio website to be able to access the backoffice, as the authentication is shared between the two)
	~~#* The URL pointing to the web administration tool for the BGA Studio database.~~
	# Click on the URL to the BGA Studio website, enter the HTTP Basic credentials when prompted for them (and have your browser conveniently memorize them for you). Then you get to an home page just like the one of the main BGA website. Enter one of your ten BGA studio logins to connect as a user.

	~~== Launch your game and check how to update it ==~~
	# Find your game in the 'Play now' section and launch a table		# Find your game in the 'Play now' section and launch a table
	# Use the 'I want between X and X' players to tick down the maximum players number to the minimum		# Use the 'I want between X and X' players to tick down the maximum players number to the minimum
44. rida:		40. rida:
	# Go back to your browser, '''empty your browser cache''', then refresh the page, and check that the game box image has been updated.		# Go back to your browser, '''empty your browser cache''', then refresh the page, and check that the game box image has been updated.

			Then you can modify the provided skeleton and begin to develop your game :)

	== Commit your changes ==		== Commit your changes ==

	Committing uploads your changes on our [http://en.wikipedia.org/wiki/Revision_control revision control] system. This is an extra assurance not to lose your code, and to have the possibility ~~(by asking BGA administrators)~~ to get a previous version of your code if you need to backtrack. It also helps us to follow your progress (we get an email when you commit). So you should commit from time to time, when you hit some landmark in your development.		Committing uploads your changes on our [http://en.wikipedia.org/wiki/Revision_control revision control] system. This is an extra assurance not to lose your code, and to have the possibility to get a previous version of your code if you need to backtrack. It also helps us to follow your progress (we get an email when you commit). So you should commit from time to time, when you hit some landmark in your development.

	~~Here is how to go through your first~~ commit:		You can automatically commit your sources in the repository from "Control Panel / Manage Games / Your games / Commit my modifications". Then:
	~~# Go back to~~ your ~~browser tab showing~~ the ~~'resources~~.html' file. Click on the URL pointing to the BGA Studio backoffice (do not log out of the BGA Studio website before doing so, or you will get a '''Not authorized''' error message as the authentication is shared);
	# ~~Click on the 'Sources' menu entry to show the commit form.~~ Enter ~~your game name (under the same form as the name of your game folder: lowercase, no spaces), enter~~ your commit comment (such as 'My first commit') then hit the 'Submit' button;		# Enter your commit comment (such as 'My first commit') then hit the 'Submit' button;
	# Check the log for errors, it should end with the following lines:		# Check the log for errors, it should end with the following lines:

57. rida:		54. rida:
	Committed revision #revision number#.		Committed revision #revision number#.
	HAL says: done.		HAL says: done.

	NB: you should also commit each time you make a change to your gameoptions.inc.php file or to your stats.inc.php file, as an extra deployment action is needed from us for these files to take effect. Please mention in your commit comment that you need us to deploy those files, or send us an email to ask us to do so.

Sourisdudesert – 30. september 2013, kell 16:08

2013-09-30T16:08:02Z

←Vanem redaktsioon		Redaktsioon: 30. september 2013, kell 18:08
1. rida:		1. rida:
			== Connect to the BGA Studio website ==

			Go to BGA Studio website:
			http://en.studio.boardgamearena.com

			Choose one of your 10 accounts (ex: myusername0), and login into the website - as you would do for Board Game Arena.

			== Check projects in progress and available game licences ==

			On the left menu, you can check game projects under development and available game licences. From this point, you can choose what you want to do:
			* Join an existing project.
			* Create a new project.
			* Try to get a licence for a game you don't see in the "available game licences" page (see how-to on "available licences" page).


	== Connect to your SFTP folder and to the BGA Studio website ==		== Connect to your SFTP folder and to the BGA Studio website ==

Sourisdudesert: /* Connect to your SFTP folder and to the BGA Studio website */

2013-09-30T16:04:24Z

Connect to your SFTP folder and to the BGA Studio website

←Vanem redaktsioon		Redaktsioon: 30. september 2013, kell 18:04
9. rida:		9. rida:
	Using this information:		Using this information:
	# Connect to the SFTP server using your SFTP login and password, through your favourite SFTP client software (such as [http://winscp.net/ WinSCP] for example)		# Connect to the SFTP server using your SFTP login and password, through your favourite SFTP client software (such as [http://winscp.net/ WinSCP] for example)
	# Check that your home folder contains :		# Check that your home folder contains one folder for each of the three example games (reversi, hearts, gomoku). Each time you create a new game project, one additional folder is added to your "home" folder.
	~~#* One~~ folder for each of the three example games (reversi, hearts, gomoku)
	~~#* One folder matching the game you will be developing~~
	~~#* One 'resources.html' file~~
	# Open the resources.html file, it contains :		# Open the resources.html file, it contains :
	#* The URL pointing to the BGA Studio website (protected with an HTTP Basic authentication scheme, the login and password are also referenced in the 'resources.html' file		#* The URL pointing to the BGA Studio website (protected with an HTTP Basic authentication scheme, the login and password are also referenced in the 'resources.html' file

Sourisdudesert: /* Connect to your SFTP folder and to the BGA Studio website */

2013-09-30T16:01:31Z

Connect to your SFTP folder and to the BGA Studio website

←Vanem redaktsioon		Redaktsioon: 30. september 2013, kell 18:01
8. rida:		8. rida:

	Using this information:		Using this information:
	# Connect to the SFTP server using your SFTP login and password, through your favourite SFTP client software (such as WinSCP for example)		# Connect to the SFTP server using your SFTP login and password, through your favourite SFTP client software (such as [http://winscp.net/ WinSCP] for example)
	# Check that your home folder contains :		# Check that your home folder contains :
	#* One folder for each of the three example games (reversi, hearts, gomoku)		#* One folder for each of the three example games (reversi, hearts, gomoku)
18. rida:		18. rida:
	#* The URL pointing to the web administration tool for the BGA Studio database.		#* The URL pointing to the web administration tool for the BGA Studio database.
	# Click on the URL to the BGA Studio website, enter the HTTP Basic credentials when prompted for them (and have your browser conveniently memorize them for you). Then you get to an home page just like the one of the main BGA website. Enter one of your ten BGA studio logins to connect as a user.		# Click on the URL to the BGA Studio website, enter the HTTP Basic credentials when prompted for them (and have your browser conveniently memorize them for you). Then you get to an home page just like the one of the main BGA website. Enter one of your ten BGA studio logins to connect as a user.


	== Launch your game and check how to update it ==		== Launch your game and check how to update it ==

Mlgx – 21. aprill 2013, kell 21:50

2013-04-21T21:50:04Z

←Vanem redaktsioon		Redaktsioon: 21. aprill 2013, kell 23:50
9. rida:		9. rida:
	Using this information:		Using this information:
	# Connect to the SFTP server using your SFTP login and password, through your favourite SFTP client software (such as WinSCP for example)		# Connect to the SFTP server using your SFTP login and password, through your favourite SFTP client software (such as WinSCP for example)
	# Check ~~than in~~ your home folder ~~you have~~:		# Check that your home folder contains :
	#* One folder for each of the three example games (reversi, hearts, gomoku)		#* One folder for each of the three example games (reversi, hearts, gomoku)
	#* One folder matching the game you will be developing		#* One folder matching the game you will be developing
	#* One 'resources.html' file		#* One 'resources.html' file
	# Open the resources.html file, it contains		# Open the resources.html file, it contains :
	#* The URL pointing to the BGA Studio website (protected with an HTTP Basic authentication scheme, the login and password are also referenced in the 'resources.html' file		#* The URL pointing to the BGA Studio website (protected with an HTTP Basic authentication scheme, the login and password are also referenced in the 'resources.html' file
	#* The URL pointing to the BGA Studio backoffice (please note that you must first be logged in on the BGA Studio website to be able to access the backoffice, as the authentication is shared between the two)		#* The URL pointing to the BGA Studio backoffice (please note that you must first be logged in on the BGA Studio website to be able to access the backoffice, as the authentication is shared between the two)
44. rida:		44. rida:
	HAL says: done.		HAL says: done.

	NB: you should also commit each time you make an change to your gameoptions.inc.php file or to your stats.inc.php file, as an extra deployment action is needed from us for these files to take effect. Please mention in your commit comment that you need us to deploy those files, or send us an email to ask us to do it.		NB: you should also commit each time you make a change to your gameoptions.inc.php file or to your stats.inc.php file, as an extra deployment action is needed from us for these files to take effect. Please mention in your commit comment that you need us to deploy those files, or send us an email to ask us to do so.


51. rida:		51. rida:
	Now you know about the basics of updating your game on BGA Studio and testing your changes.		Now you know about the basics of updating your game on BGA Studio and testing your changes.

	For more information on the ~~specifics~~ of each file, please check out the [[Studio#BGA_Studio_documentation \| reference documentation for the framework]].		For more information on the specificites of each file, please check out the [[Studio#BGA_Studio_documentation \| reference documentation for the framework]].

Een: /* That's all! */

2013-04-13T13:41:24Z

That's all!

←Vanem redaktsioon		Redaktsioon: 13. aprill 2013, kell 15:41
49. rida:		49. rida:
	== That's all! ==		== That's all! ==

	Now you know about the basics of updating your game on ~~the studio~~ and testing your changes.		Now you know about the basics of updating your game on BGA Studio and testing your changes.

	For more information on the specifics of each file, please check out the [[Studio#BGA_Studio_documentation \| reference documentation for the framework]].		For more information on the specifics of each file, please check out the [[Studio#BGA_Studio_documentation \| reference documentation for the framework]].

Een: /* That's all for your first steps! */

2013-04-13T13:41:04Z

That's all for your first steps!

←Vanem redaktsioon		Redaktsioon: 13. aprill 2013, kell 15:41
47. rida:		47. rida:


	== That's all ~~for your first steps~~! ==		== That's all! ==

	Now you know about the basics of updating your game on the studio and testing your changes.		Now you know about the basics of updating your game on the studio and testing your changes.

	For more information on the specifics of each file, please check out the [[Studio#BGA_Studio_documentation \| reference documentation for the framework]].		For more information on the specifics of each file, please check out the [[Studio#BGA_Studio_documentation \| reference documentation for the framework]].

Een: /* Commit your changes */

2013-04-13T13:40:33Z

Commit your changes

←Vanem redaktsioon		Redaktsioon: 13. aprill 2013, kell 15:40
33. rida:		33. rida:
	== Commit your changes ==		== Commit your changes ==

			Committing uploads your changes on our [http://en.wikipedia.org/wiki/Revision_control revision control] system. This is an extra assurance not to lose your code, and to have the possibility (by asking BGA administrators) to get a previous version of your code if you need to backtrack. It also helps us to follow your progress (we get an email when you commit). So you should commit from time to time, when you hit some landmark in your development.

	That's all! Now you know about the basics of updating your game on the studio and testing your changes!		Here is how to go through your first commit:
			# Go back to your browser tab showing the 'resources.html' file. Click on the URL pointing to the BGA Studio backoffice (do not log out of the BGA Studio website before doing so, or you will get a '''Not authorized''' error message as the authentication is shared);
			# Click on the 'Sources' menu entry to show the commit form. Enter your game name (under the same form as the name of your game folder: lowercase, no spaces), enter your commit comment (such as 'My first commit') then hit the 'Submit' button;
			# Check the log for errors, it should end with the following lines:

			Transmitting file data .
			Committed revision #revision number#.
			HAL says: done.

			NB: you should also commit each time you make an change to your gameoptions.inc.php file or to your stats.inc.php file, as an extra deployment action is needed from us for these files to take effect. Please mention in your commit comment that you need us to deploy those files, or send us an email to ask us to do it.


			== That's all for your first steps! ==

			Now you know about the basics of updating your game on the studio and testing your changes.

			For more information on the specifics of each file, please check out the [[Studio#BGA_Studio_documentation \| reference documentation for the framework]].

Een: Created page with "== Connect to your SFTP folder and to the BGA Studio website == After your account has been created, you will get by email: * the name of the SFTP server to connect to * you..."

2013-04-13T13:11:19Z

Created page with "== Connect to your SFTP folder and to the BGA Studio website == After your account has been created, you will get by email: * the name of the SFTP server to connect to * you..."

Uus lehekülg

== Connect to your SFTP folder and to the BGA Studio website ==

After your account has been created, you will get by email:
* the name of the SFTP server to connect to
* your SFTP login and password
* ten BGA Studio logins ending with a numeral ranging from 0 to 9 and the password needed to use them.

Using this information:
# Connect to the SFTP server using your SFTP login and password, through your favourite SFTP client software (such as WinSCP for example)
# Check than in your home folder you have:
#* One folder for each of the three example games (reversi, hearts, gomoku)
#* One folder matching the game you will be developing
#* One 'resources.html' file
# Open the resources.html file, it contains
#* The URL pointing to the BGA Studio website (protected with an HTTP Basic authentication scheme, the login and password are also referenced in the 'resources.html' file
#* The URL pointing to the BGA Studio backoffice (please note that you must first be logged in on the BGA Studio website to be able to access the backoffice, as the authentication is shared between the two)
#* The URL pointing to the web administration tool for the BGA Studio database.
# Click on the URL to the BGA Studio website, enter the HTTP Basic credentials when prompted for them (and have your browser conveniently memorize them for you). Then you get to an home page just like the one of the main BGA website. Enter one of your ten BGA studio logins to connect as a user.

== Launch your game and check how to update it ==
# Find your game in the 'Play now' section and launch a table
# Use the 'I want between X and X' players to tick down the maximum players number to the minimum
# Click 'Express start': your game launches with the maximum number of players specified. It shows an empty canvas: in the game zone you just have a sentence 'This is your game interface. You can edit this HTML in your ".tpl" file.'.
# Switch to your SFTP home folder, go into your game folder. Edit the game_game.tpl file, and change this sentence to 'Hey, this is my first game!', then save.
# Go back to your browser and refresh, check that the game zone has updated.
# Click on the 'Exit game' icon on the top right, and in the popup choose 'Express game stop'. The game ends automatically and you are brought back to the table screen for this ended game.
# Switch to your game folder, go into the img folder and overwrite your game_box.png file with another image.
# Go back to your browser, '''empty your browser cache''', then refresh the page, and check that the game box image has been updated.

== Commit your changes ==

That's all! Now you know about the basics of updating your game on the studio and testing your changes!