This is a documentation for Board Game Arena: play board games online !

Khác biệt giữa bản sửa đổi của “First steps with BGA Studio”

Từ Board Game Arena
Bước tới điều hướng Bước tới tìm kiếm
Không có tóm lược sửa đổi
 
(Không hiển thị 9 phiên bản của 3 người dùng ở giữa)
Dòng 6: Dòng 6:
Choose one of your 10 accounts (ex: myusername0), and login into the website - as you would do for Board Game Arena.
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 ==
If you don't have account see [[How to join BGA developer team?]]


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


== 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:
You first "game" should be one of the tutorial, so you project name should be something like "tutorialbob".
 
At this stage its too early to create a real game but if you really don't want to start until you have a game in mind, check [[Create a game in BGA Studio: Complete Walkthrough]]
section "Select a First Game"
 
For reference top bar studio links
* AVAILABLE LICENSES - list of all available licenses (not public domain) -  http://en.studio.boardgamearena.com/#!licensing
* STUDIO PROJECTS - list of all registered studio projects - http://en.studio.boardgamearena.com/#!projects
* CONTROL PANEL - manage projects - http://en.studio.boardgamearena.com/#!controlpanel
 
== Connect to your SFTP folder ==
 
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
* 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], see [[Tools_and_tips_of_BGA_Studio#File_Sync_on_Windows|File Sync]])
# 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 remote 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.
# Note: You have to setup AUTOMATED sync between your folder and remote folder, manually ftp'ing files would be no-starter. For WinSCP you can do this from the file menu (Commands->Keep remote directories up to Date...)


== 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  :
# Find your game in the 'PLAY NOW' section and create a table
#* 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
# 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.'.
# 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.
# 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.
# 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.
# Click on the 'Gear' icon on the top right, and in the popup choose 'Express 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.
# 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.
# 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 BGA's [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.
 
You can automatically commit your sources in the repository from "Control Panel / Manage Games / Your game / Commit my modifications now". Then:


Here is how to go through your first commit:
# Enter your commit comment (such as 'My first commit') then hit the 'Submit' button;
# 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:
# Check the log for errors, it should end with the following lines:


Dòng 58: Dòng 62:
   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.
NOTE: committing the code is currently not working until admin commits it manually the first time. Even if it does you cannot automatically deal with this version control system except for committing. Therefore its recommended to use another means of storing the code in version control system, such as local git repo or github, see [[Tools_and_tips_of_BGA_Studio#Version_Control|Version Control]]
 


== That's all! ==
== That's all! ==
Dòng 65: Dòng 68:
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 specificites of each file, please check out the [[Studio#BGA_Studio_documentation | reference documentation for the framework]].
Now you can select one of the tutorials to play with and start coding.
 
For links to tutorials and ALL studio documentation see [[Studio]].

Bản mới nhất lúc 12:59, ngày 27 tháng 3 năm 2019

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.

If you don't have account see How to join BGA developer team?


Create a new game project

You can do most of projects-related operation from "Control Panel / Manage games". In particular, you can create a new project automatically from there.

You first "game" should be one of the tutorial, so you project name should be something like "tutorialbob".

At this stage its too early to create a real game but if you really don't want to start until you have a game in mind, check Create a game in BGA Studio: Complete Walkthrough section "Select a First Game"

For reference top bar studio links

Connect to your SFTP folder

From the initial email from the Studio you get:

  • the name of the SFTP server to connect to
  • your SFTP login and password

Using this information:

  1. Connect to the SFTP server using your SFTP login and password, through your favourite SFTP client software (such as WinSCP, see File Sync)
  2. Check that your remote 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.
  3. Note: You have to setup AUTOMATED sync between your folder and remote folder, manually ftp'ing files would be no-starter. For WinSCP you can do this from the file menu (Commands->Keep remote directories up to Date...)

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.

  1. Find your game in the 'PLAY NOW' section and create a table
  2. Use the 'I want between X and X' players to tick down the maximum players number to the minimum
  3. 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.'.
  4. 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.
  5. Go back to your browser and refresh, check that the game zone has updated.
  6. Click on the 'Gear' icon on the top right, and in the popup choose 'Express STOP'. The game ends automatically and you are brought back to the table screen for this ended game.
  7. Switch to your game folder, go into the img folder and overwrite your game_box.png file with another image.
  8. 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

Committing uploads your changes on BGA's 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.

You can automatically commit your sources in the repository from "Control Panel / Manage Games / Your game / Commit my modifications now". Then:

  1. Enter your commit comment (such as 'My first commit') then hit the 'Submit' button;
  2. Check the log for errors, it should end with the following lines:
 Transmitting file data .
 Committed revision #revision number#.
 HAL says: done.

NOTE: committing the code is currently not working until admin commits it manually the first time. Even if it does you cannot automatically deal with this version control system except for committing. Therefore its recommended to use another means of storing the code in version control system, such as local git repo or github, see Version Control

That's all!

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

Now you can select one of the tutorials to play with and start coding.

For links to tutorials and ALL studio documentation see Studio.

Lấy từ “http:///index.php?title=First_steps_with_BGA_Studio&oldid=3398”