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

Studio: Difference between revisions

From Board Game Arena
Jump to navigation Jump to search
No edit summary
(Manually reverting the page)
Tag: Manual revert
 
(124 intermediate revisions by 17 users not shown)
Line 1: Line 1:
[[File:Bga_studio_small.jpg]]
{{Studio_Framework_Navigation}}


[[File:Bga_studio_small.jpg|frameless|300px]]


== What is this? ==
Note: Please DO NOT translate Studio Documentation, so that there can be one place where you can find the latest information available.


'''Board Game Arena Studio''' is a platform to build online board game adaptation using the Board Game Arena platform.
__TOC__


It is open to any gamer with development skills :)
== What is Board Game Arena Studio? ==


See announcement here:
'''Board Game Arena Studio''' is a platform to build online board game adaptations using the Board Game Arena platform.
http://forum.boardgamearena.com/viewtopic.php?f=10&t=1973


== How can I develop a board game on BGA Studio? ==
It is open to any gamer with software development skills :)


Check these presentations first:
BGA Studio website: https://studio.boardgamearena.com


* [http://www.slideshare.net/boardgamearena/5-reasons-why-you-should-use-bga-studio-for-your-online-board-game 5 reasons why you should use BGA Studio for your online board game]
Original announcement on BGA forum: https://forum.boardgamearena.com/viewtopic.php?f=10&t=1973
* [http://www.slideshare.net/boardgamearena/the-8-steps-to-create-a-board-game-on-board-game-arena The 8 steps to create a board game on Board Game Arena]
* [http://www.slideshare.net/boardgamearena/the-bga-framework-at-a-glance The BGA Framework at a glance]
* [http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine Focus on BGA game state machine]
* [http://www.slideshare.net/boardgamearena/bga-studio-guidelines BGA developers guidelines]


== How do I register? ==
== Discover BGA Studio in 5 presentations ==


Registering is done by e-mail at '''studio(at)boardgamearena.com'''.
Why, how, what... to start discovering BGA Studio, we prepared 5 "powerpoint" presentations for you:


Please provide the following information:
* [http://www.slideshare.net/boardgamearena/5-reasons-why-you-should-use-bga-studio-for-your-online-board-game 5 reasons why you should use BGA Studio for your online board game] (or [http://en.doc.boardgamearena.com/images/5/58/1-why-developing.pdf ‎Download as PDF])
* your developer user name to be used on “BGA Studio” (for technical reasons, no space, number or special character);
* [http://www.slideshare.net/boardgamearena/the-8-steps-to-create-a-board-game-on-board-game-arena The 8 steps to create a board game on Board Game Arena] (or [http://en.doc.boardgamearena.com/images/1/1e/2-8-steps-to-realize.pdf Download as PDF])
* your real name;
* [http://www.slideshare.net/boardgamearena/the-bga-framework-at-a-glance The BGA Framework at a glance] (or [http://en.doc.boardgamearena.com/images/7/79/3-thebgaframework.pdf Download as PDF])
* your e-mail address;
* [http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine Focus on BGA game state machine] (or [http://en.doc.boardgamearena.com/images/9/98/4-gamestates.pdf Download as PDF])
* your postal address.
* [http://www.slideshare.net/boardgamearena/bga-studio-guidelines BGA developers guidelines] (or [http://en.doc.boardgamearena.com/images/7/76/5-guidelines.pdf ‎Download as PDF])


We also drafted a quick [http://en.doc.boardgamearena.com/images/0/02/BGA_TC_Dev_en.pdf 'terms & conditions' document]. It's very light, so as to get to the fun part faster.
== How to join the BGA developer team? ==


To be valid, the registration e-mail must contain this document as an attachment, with the following sentence in the mail body: 'I agree with the terms & conditions for developers on BGA Studio joined as an attachment'.
Please see this page: [[How to join BGA developer team?]]


And of course, we also encourage you to tell us about which games you would love to develop on BGA!
== Great, I'm in! ... How should I start? ==
 
If you didn't already, check the presentations at the top of this page to get the basics.
 
Then, you should checkout the [[First steps with BGA Studio]] to make sure that runs fine.
 
After that, we strongly advise you to take one of these game creation tutorials:
* [[Tutorial reversi]] ('''recommended''', closest to the actual BGA implementation and maintained by the BGA team) - an abstract strategy game played on an 8×8 uncheckered board for 2 players
* [[Tutorial gomoku]] - an abstract strategy game tic-tac-toe style for 2 players
* [[Tutorial hearts]] - a card game for 4 players
 
Then start editing files and see what happens! ;)


== Ok, I registered, what do I get? ==
Once you're done with tutorials, you can start a real game (or join existing project)
* [[Create a game in BGA Studio: Complete Walkthrough]]


First, from time to time you will get by e-mail the names of some of the games we have an agreement to develop, so that you can tell us 'Hey, this game is great! I want to develop it!' (please keep these names confidential, or it would ruin our tradition to make players guess the name of the next game on the forum)
If you have any questions, please check out the [[Studio FAQ]] or [[Contact BGA Studio]].


<pre>NB: during the BETA pĥase, to smooth things up and make sure that everything is working correctly,
we will work only with 3 fearless developers on 3 simple games.</pre>


Second, once we have discussed together and are fixed on a game you'll take charge of, we'll create your studio account and you will get:
To search wiki pages on studio enter this text in search bar:  
* one login / password to access files through SFTP
  "Category:Studio" white rabbit
* ten logins with numeric suffixes from 0 to 9 and a common simple password to test games on the studio website while developing.
That is if you want to search for white rabbit


Once logged in to your SFTP root folder, you will find:
== BGA Studio documentation ==
* a 'resources.html' file with the URLs to use and some extra connection information
* three folders containing the three simple games provided as examples
* a folder for the game you will be developing initialized after our 'EmptyGame' template, providing the game structure (and comments! and examples!)


Then... that's all, you can start!
=== BGA Studio Framework reference ===


== Great, I'm in! ... How should I start? ==
This part of the documentation focuses on the development framework itself: functions and methods available to build your game.
 
[[Studio file reference|File structure of a BGA game]]
 
==== Game logic (Server side) ====
 
* [[Main game logic: yourgamename.game.php]]
* [[Your game state machine: states.inc.php]]
* [[Game database model: dbmodel.sql]]
* [[Players actions: yourgamename.action.php]]
* [[Game material description: material.inc.php]]
* [[Game statistics: stats.inc.php]]
 
==== Game interface (Client side) ====
 
* [[Game interface logic: yourgamename.js]]
* [[Game art: img directory]]
* [[Game interface stylesheet: yourgamename.css]]
* [[Game layout: view and template: yourgamename.view.php and yourgamename_yourgamename.tpl]]
* [[Your game mobile version]]
 
==== Other components ====
 
* [[Translations]] (how to make your game translatable)
* [[Options_and_preferences:_gameoptions.json,_gamepreferences.json|Game Options and Preferences]]
* [[Game meta-information: gameinfos.inc.php]]
* [[Game replay]]
* [[3D]]
 
=== BGA Studio game components reference ===
 
Game components are useful tools you can use in your game adaptations.
 
JS:
 
* [[Counter]]: a JS component to manage a counter that can increase/decrease (ex: player's score).
* [[Scrollmap]]: a JS component to manage a scrollable game area (useful when the game area can be infinite. Examples:  Saboteur or Takenoko games).
* [[Stock]]: a JS component to manage and display a set of game elements displayed at a position.
* [[Zone]]: a JS component to manage a zone of the board where several game elements can come and leave, but should be well displayed together (See for example: token's places at Can't Stop).
* [[Draggable]]: a JS component to manage drag'n'drop actions.
* [[ExpandableSection]]: a JS component to manage a rectangular block of HTML than can be displayed/hidden.
* [[Anti-Stock]]: Code snippets in vanilla JS/HTML5 to do what stock does (that is if you cannot beat Stock into submission)
 
PHP:
* [[Deck]]: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).
 
Reference for classes in game class hierarchy
 
* [[Table]]: a PHP class that you inherit from for the game php
 
=== BGA Studio user guide ===
 
This part of the documentation is a user guide for the BGA Studio online development environment.
 
Lifecycle
 
* [[BGA game Lifecycle]]
* [[Create a game in BGA Studio: Complete Walkthrough]]
* [[Pre-release checklist]] - Go throught this list if you think you done development
* [[Post-release phase]]
 
 
Tools and Advice
* [[BGA Studio Guidelines]]
* [[Tutorials checklist]]
* [[I wish I knew this when I started]] - one liners on most common missed features, mistakes, etc with further doc references
* [[Tools and tips of BGA Studio]] - Tips and instructions on setting up development environment
** [[Setting up BGA Development environment using VSCode]]
** [[Practical debugging]] - Tips focused on debugging
** [[Testing by developer]]
** [[Studio logs]] - Instructions for log access
** [[Troubleshooting]] - Most common "I am really stuck" situations
* [[BGA Studio Cookbook]] - Tips and instructions on using API's, libraries and frameworks
** [[Using Vue]] - work-in-progress guide on using the modern framework Vue.js to create a game
** [[Using Typescript and Scss]] - How to auto-build Typescript and SCSS files to make your code cleaner
** [[BGA Type Safe Template]] - Setting up a fully typed project using typescript and more!
** [[Bots and Artificial Intelligence]] - How to add AI/Bots to the game
* [[Studio FAQ]]
 
Sharing
* [[Common board game elements image resources]] - Dice, meeples, cubes, etc
* [[BGA Code Sharing]] - Shared resources, projects on git hub, common code, other links
 
== Software Versions ==
 
Versions currently used by BGA framework:


If you didn't already, check the presentations at the top of this page to get the basics.
* Dojo Toolkit 1.15
* PHP: 8.2
* SQL: MySQL 5.7
* JS/CSS/HTML: limited by what minimization tools support: [[Game_interface_logic:_yourgamename.js#Javascript_minimization_.28after_July_2020.29|JS minimization]]
* Font Awesome: 4.7 https://fontawesome.com/v4.7/icons/ (available as <code><nowiki><i class="fa fa-clock" /></nowiki></code>)
* Font Awesome: 6.4.0 https://fontawesome.com/v6/search?o=r&m=free (available as <code><nowiki><i class="fa6 fa6-clock" /></nowiki></code>)


After that, we would advise you to take a peek at this tutorial for creating the Reversi example game:
=== PHP Extensions Used ===
* [[Tutorial reversi]]


Then start editing files and see what happens! ;)
The following PHP extensions are - as of May 8th, 2022 - in use in BGA Studio and available:


If you have any questions, please ask them on the [http://forum.boardgamearena.com/viewforum.php?f=12 development forum].
date, libxml, openssl, pcre, zlib, filter, hash, Reflection, SPL, session, standard, sodium, apache2handler, mysqlnd, PDO, xml, apcu, bz2, calendar, ctype, curl, dom, mbstring, FFI, fileinfo, ftp, gd, gettext, gmp, iconv, igbinary, json, exif, msgpack, mysqli, pdo_mysql, apc, posix, readline, shmop, SimpleXML, sockets, sysvmsg, sysvsem, sysvshm, tokenizer, v8js, xmlreader, xmlwriter, xsl, zip, Phar, memcached, Zend OPcache


== Other resources ==
== Other resources ==


[[Studio FAQ]]
[http://forum.boardgamearena.com/viewforum.php?f=12 Development forum]
 
[https://studio.boardgamearena.com/bugs Bug tracking system FOR STUDIO issues and APIs]
 
DISCORD chat server/room invite link https://discord.gg/YxEUacY if it does not work check this topic https://forum.boardgamearena.com/viewtopic.php?f=12&t=17403&hilit=discord


[[Studio file reference]]
Developer BLOGS https://bga-devs.github.io/blog/


[[Studio function reference]]
[[Contact BGA Studio]]


[[Studio back-office]]


[http://forum.boardgamearena.com/viewforum.php?f=12 Development forum]


[http://forum.boardgamearena.com/viewforum.php?f=4 Bugs forum]
[[Category:Studio]]

Latest revision as of 06:24, 17 October 2024


Game File Reference


Useful Components

Official

  • Deck: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).
  • Draggable: a JS component to manage drag'n'drop actions.
  • Counter: a JS component to manage a counter that can increase/decrease (ex: player's score).
  • ExpandableSection: a JS component to manage a rectangular block of HTML than can be displayed/hidden.
  • Scrollmap: a JS component to manage a scrollable game area (useful when the game area can be infinite. Examples: Saboteur or Takenoko games).
  • Stock: a JS component to manage and display a set of game elements displayed at a position.
  • Zone: a JS component to manage a zone of the board where several game elements can come and leave, but should be well displayed together (See for example: token's places at Can't Stop).

Undocumented component (if somebody knows please help with docs)

  • Wrapper: a JS component to wrap a <div> element around its child, even if these elements are absolute positioned.

Unofficial


Game Development Process


Guides for Common Topics


Miscellaneous Resources

Bga studio small.jpg

Note: Please DO NOT translate Studio Documentation, so that there can be one place where you can find the latest information available.

What is Board Game Arena Studio?

Board Game Arena Studio is a platform to build online board game adaptations using the Board Game Arena platform.

It is open to any gamer with software development skills :)

BGA Studio website: https://studio.boardgamearena.com

Original announcement on BGA forum: https://forum.boardgamearena.com/viewtopic.php?f=10&t=1973

Discover BGA Studio in 5 presentations

Why, how, what... to start discovering BGA Studio, we prepared 5 "powerpoint" presentations for you:

How to join the BGA developer team?

Please see this page: How to join BGA developer team?

Great, I'm in! ... How should I start?

If you didn't already, check the presentations at the top of this page to get the basics.

Then, you should checkout the First steps with BGA Studio to make sure that runs fine.

After that, we strongly advise you to take one of these game creation tutorials:

  • Tutorial reversi (recommended, closest to the actual BGA implementation and maintained by the BGA team) - an abstract strategy game played on an 8×8 uncheckered board for 2 players
  • Tutorial gomoku - an abstract strategy game tic-tac-toe style for 2 players
  • Tutorial hearts - a card game for 4 players

Then start editing files and see what happens! ;)

Once you're done with tutorials, you can start a real game (or join existing project)

If you have any questions, please check out the Studio FAQ or Contact BGA Studio.


To search wiki pages on studio enter this text in search bar: 

 "Category:Studio" white rabbit

That is if you want to search for white rabbit

BGA Studio documentation

BGA Studio Framework reference

This part of the documentation focuses on the development framework itself: functions and methods available to build your game.

File structure of a BGA game

Game logic (Server side)

Game interface (Client side)

Other components

BGA Studio game components reference

Game components are useful tools you can use in your game adaptations.

JS:

  • Counter: a JS component to manage a counter that can increase/decrease (ex: player's score).
  • Scrollmap: a JS component to manage a scrollable game area (useful when the game area can be infinite. Examples: Saboteur or Takenoko games).
  • Stock: a JS component to manage and display a set of game elements displayed at a position.
  • Zone: a JS component to manage a zone of the board where several game elements can come and leave, but should be well displayed together (See for example: token's places at Can't Stop).
  • Draggable: a JS component to manage drag'n'drop actions.
  • ExpandableSection: a JS component to manage a rectangular block of HTML than can be displayed/hidden.
  • Anti-Stock: Code snippets in vanilla JS/HTML5 to do what stock does (that is if you cannot beat Stock into submission)

PHP:

  • Deck: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).

Reference for classes in game class hierarchy

  • Table: a PHP class that you inherit from for the game php

BGA Studio user guide

This part of the documentation is a user guide for the BGA Studio online development environment.

Lifecycle


Tools and Advice

Sharing

Software Versions

Versions currently used by BGA framework:

PHP Extensions Used

The following PHP extensions are - as of May 8th, 2022 - in use in BGA Studio and available:

date, libxml, openssl, pcre, zlib, filter, hash, Reflection, SPL, session, standard, sodium, apache2handler, mysqlnd, PDO, xml, apcu, bz2, calendar, ctype, curl, dom, mbstring, FFI, fileinfo, ftp, gd, gettext, gmp, iconv, igbinary, json, exif, msgpack, mysqli, pdo_mysql, apc, posix, readline, shmop, SimpleXML, sockets, sysvmsg, sysvsem, sysvshm, tokenizer, v8js, xmlreader, xmlwriter, xsl, zip, Phar, memcached, Zend OPcache

Other resources

Development forum

Bug tracking system FOR STUDIO issues and APIs

DISCORD chat server/room invite link https://discord.gg/YxEUacY if it does not work check this topic https://forum.boardgamearena.com/viewtopic.php?f=12&t=17403&hilit=discord

Developer BLOGS https://bga-devs.github.io/blog/

Contact BGA Studio

Retrieved from "http:///index.php?title=Studio&oldid=23044"