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
No edit summary
 
(155 intermediate revisions by 19 users not shown)
Line 1: Line 1:
[[File:Bga_studio_small.jpg]]
{{InfoBox|title=User contributions|body=The Studio wiki is kept for dev contributions. Official documentation is here:
[https://doc.studio.boardgamearena.com/get-started/ <span class="mw-ui-button mw-ui-progressive mw-ui-big">Get Started!</span>] [https://doc.studio.boardgamearena.com/framework-documentation/ <span class="mw-ui-button mw-ui-progressive mw-ui-big">Framework documentation</span>]
}}


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


== What is this? ==
[[File:Bga_studio_small.jpg|frameless|300px]]


'''Board Game Arena Studio''' is a platform to build online board game adaptation using the Board Game Arena platform.
*Note: Please DO NOT translate Studio Documentation, so that there can be one place where you can find the latest information available.*


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


See announcement here:
To search wiki pages on studio enter this text in search bar:  
http://forum.boardgamearena.com/viewtopic.php?f=10&t=1973
  "Category:Studio" white rabbit
That is if you want to search for white rabbit


== How can I develop a board game on BGA Studio? ==
==== Game interface (Client side) ====


Check these presentations first:
* [[Your game mobile version]]


* [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]
==== Other components ====
* [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? ==
* [[Translations]] (how to make your game translatable)
* [[Game replay]]


Registering is done by e-mail at '''studio(at)boardgamearena.com'''.
=== BGA Studio user guide ===


Please provide the following information:
This part of the documentation is a user guide for the BGA Studio online development environment.
* your developer user name to be used on “BGA Studio” (for technical reasons, no space, number or special character);
* your real name;
* your e-mail address;
* your postal address.


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


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'.
* [[BGA game Lifecycle]]
* [[BGA Game licenses]]
* [https://doc.studio.boardgamearena.com/get-started/start-real-project/ Create a game in BGA Studio: Complete Walkthrough]
* [[Pre-release checklist]] - Go throught this list if you think you done development
* [[Post-release phase]]


And of course, we also encourage you to tell us about which games you would love to develop on BGA!


== Ok, I registered, what do I get? ==
Tools and Advice
* [https://doc.studio.boardgamearena.com/framework-documentation/guidelines/ 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
** [https://doc.studio.boardgamearena.com/get-started/vscode-setup/ 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
* [[Production issues reporting|Production issues reporting tool]]
* [[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
** [[Bots and Artificial Intelligence]] - How to add AI/Bots to the game
** [[Using AI for BGA game development]] - Shared resources about setting up AI agents
* [[BGA Studio Migration Guide]] - Migration tips from older version of studio framework
* [[Studio FAQ]]


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)
Sharing
* [[Common board game elements image resources]] - Dice, meeples, cubes, etc
* [[BGA Code Sharing]] - Shared resources, projects on git hub, common code, other links


<pre>NB: during the BETA pĥase, to smooth things up and make sure that everything is working correctly,
== Other resources ==
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:
[http://forum.boardgamearena.com/viewforum.php?f=12 Development forum]
* one login / password to access files through SFTP
* ten logins with numeric suffixes from 0 to 9 and a common simple password to test games on the studio website while developing.
 
Once logged in to your SFTP root folder, you will find:
* 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!


== Great, I'm in! ... How should I start? ==
[https://studio.boardgamearena.com/bugs Bug tracking system FOR STUDIO issues and APIs]


If you didn't already, check the presentations at the top of this page to get the basics.
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


After that, we would advise you to take a peek at one or both of these two game creation tutorials:
Developer BLOGS https://bga-devs.github.io/blog/
* [[Tutorial reversi]]
* [[Tutorial gomoku]]


Then start editing files and see what happens! ;)
BGA Mainsite releases https://en.boardgamearena.com/forum/viewtopic.php?t=23289&start=100


If you have any questions, please ask them on the [http://forum.boardgamearena.com/viewforum.php?f=12 development forum].
[https://doc.studio.boardgamearena.com/get-started/before-starting-real-project/#communication-with-the-bga-team Contact BGA Studio]


== Other resources ==
[[Studio FAQ]]
[[Studio file reference]]
[[Studio function reference]]
[[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 14:18, 10 November 2026

User contributions
The Studio wiki is kept for dev contributions. Official documentation is here: Get Started! Framework documentation


Official documentation


Useful Components

Official

Unofficial



Game Development Process



Guides for Common Topics



Miscellaneous Resources

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

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

Game interface (Client side)

Other components

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

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/

BGA Mainsite releases https://en.boardgamearena.com/forum/viewtopic.php?t=23289&start=100

Contact BGA Studio