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

Create a game in BGA Studio: Complete Walkthrough

From Board Game Arena
Jump to navigation Jump to search

Game File Reference

Overview



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

Introduction

This document is not a tutorial, but step by step instructions on how to build your own first game adaptation using BGA Studio framework.

Before you read this material, you must:

  • Read the overall presentations of the BGA Studio.
  • Some-what know the languages used by BGA Studio: PHP, SQL, HTML, CSS, Javascript
  • Setup your development environment First Steps with BGA Studio
  • Create a game using one of the available tutorials. Don't bother with a new game if you have not completed at least one of the tutorials.


If you are stuck or have questions about this page post on BGA Developers forum. If you're uncomfortable posting on the public forum you can send messages directly to developers who post answers on that forum but NOT the BGA admins. If you find typos in this wiki - fix it.

Select a First Game

For your first real game you must either

But what if the game you want is not there? If you are able to successfully publish your first game, you would gain the trust of the BGA admins and they will be happy to assist you in obtaining a license for a game you really want to do or you can request a license yourself. You can read more about game licenses on BGA Game licenses page.

Once you selected the game but before creating a new project, please take a few seconds to check that someone is not already developing this game. If it is the case, maybe you can propose to join the project?

Check the list of current projects

Even if you see a few projects with name of the game they may not be active. There are a lot of abandoned game projects. If it's not clear by the status, post to Developers forum asking if anybody actively working on the project or send a message to developers listed for the abandoned projects, and at the same time ask admins on the same forum post to send you graphics for that game if they have them (there a button on Available Licenses page to request graphics, but it will just send email).

If your goal was to fix bugs in an existing project, first try to locate on studio, projects developed by bga admins are not in the studio. Then get read only access to the project and you can create your own as a copy of the existing one. Contact existing project admin about getting write access to the original project or if they willing to take your patches - apply them.

If you want to take over an existing project first ask on forum to see if project is abandoned, then get read only access (via project list) and see if this worth using it, if it has no code or graphics just start from the scratch, don't worry about project name it can be renamed later.

Create a project

If you have not already, you have to create a project in BGA Studio for this game. If the original game name is taken use gamenameYOURINITIALS template, i.e."heartsla". Don't worry too much about the name, if game would be good enough to be publish it will be renamed to original name.

Find and start the game in turn based mode, make sure it works.

Second, modify the text in .tpl file, reload the page in the browser and make sure your ftp sync works as expected. Note: if you have not setup FTP auto-sync yet, do it now, manually copying files is a no-starter.

Update your project status in Control Panel > Manage games page, you can say "development started" or "waiting for license" or "waiting for graphics" or combination of those.


Development Tools

At some point you need to setup your development environment which consist of multiple tools, such as

  • Editor or IDE
  • Browser with dev tools
  • File sync tools
  • BGA Web tools
  • Image manipulation tools
  • Version control tools

Please scan though articles from Studio#BGA_Studio_user_guide especially related to debugging and tools, there is a lot of useful info there.

Hook version control system

If its a real game I would commit the code to version control right at start. You going to find yourself in the situation when game does not even start anymore and no way of debugging it unless you have a way to revert. That is where version control becomes very handy. If you don't know what I am talking about then at least back-up your files after each of major steps. Starting now. You can also create a project on github, but make sure you don't commit original publisher graphics files and you 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 (and should) also commit your modification periodically via studio's control panel.

Obtain game graphics

If you developing a game from Available Licenses games, ask the admins to send you graphics by contacting studio@boardgamearena.com. While that request is being processed (it can take time, as it often requires some back and forth between the admins and the publishers) you can proceed to next step - project creation.

If you don't get original graphics you go to Scavenger Hunt

  • If you developing a public domain card game you can borrow standard cards graphics from hearts project (see Tutorial hearts).
  • Standard game pieces - meeples, cubes, dice can be found here https://github.com/elaskavaia/bga-sharedcode/tree/master/img
  • Go to boardgamegeek.com find your game and obtain 3D game box image, 2D box image, and if you lucky they also sometime have boards and token scans in "Game Pieces" section of Images
  • If that fail google "boardgame <name>" and check Images section
  • Get the rules PDF as well, there tools that allows you to extract graphics from PDF, which usually good for meeples, cubes and such

Once you get the graphics one way or another you have to massage it to fit in the BGA criteria, which usually involves

  • If publisher sends graphics in one token/card per file mode, you have to stitch them in sprite and scale down
  • For non square tiles and game pieces you need transparency
  • Usually you chop off scoring "ring" around the board of the game since scoring track not needed for online adaptation

More details about graphics requirements can be found here Game art: img directory.

Rrr search.png

Obtain game documentation

Also at this time obtain a electronic copy of rules, such as PDF (English version).

Also grab any other documents you may find on boardgamegeek such as FAQ, additional Reference books, and user created assistant documents, such as cheat-sheets (may be easier to get a data from these then trying to scrub pdf). You create and place them in the doc/ folder of the project then exclude them from version control. There is also a misc/ folder now but it will hold up to 1 Mb of data files which would be checked in, so rules pdf's may not fit there.


Update game infos and box graphics

Even it does not nothing yet start with making sure game looks descent in the game selector, meaning it has nice box graphics and information is correct.

For that we need to edit gameinfos.inc.php. What you would do for real game you would go to http://boardgamegeek.com find the game and use the information from web-site to fill the gameinfos.


The next step is to replace game_box.png with proper images, usually you can find all images including publisher logo on boardgamegeek website.

Details about images can be found here: Game art: img directory.

Now important step. You have to LOAD these files in studio website through control panel. So go to Control Panel -> Manager Games -> YOURPROJECT and press Reload for 'Reload game informations' and 'Reload game box image'

Gamepanel sharedcode.png

Now try to start the game again. If you some-how introduced a syntax error in gameinfos file it may not actually work (game won't start). Always use "Express Start" button to start the game. You should see a standard state prompt from template. You should see X players on the right, testdude0 .. testdudeX-1. To switch between them press the red arrow button near their names, it will open another tab. This way you don't need to login and logout from multiple accounts!

Fix source copyright

Now since you have your own project, you want put your name in the copyright header, so replace

 © <Your name here> <Your email address here>

with

 © John Snow <jsnow@gameofthrones.com>

Well not exactly this but whatever your real name is. For all files in project directory, its about 10 files. Make sure project still starts after that :)

Reduce the Rules

Programming a game will take a lot more time than you may think. Most of the projects in the studio are abandoned because of lack of patience or skill. To keep sane, start the game with *reduced* rules and try to complete that first.

  • If it has any expansions - do not even attempt to deal with them, not even - "I will just add graphics for them now and not use" - waste of time if you don't complete basic
  • If it has advanced rules - start with basic rules only, i.e. "beginner game"
  • If it has special rules for 2 player vs 4, start with most basic form (i.e. 4), restrict to 4 players
  • If it has 50 unique cards of 2 each - start with 2 unique cards with 25 each (just to keep it moving)
  • Any sort of rules that you think can be removed and not included in base - set aside for now
  • Ignore any sort of cool animations - dice rolling, card flipping, choo-choo sounds of the trains - all this fluff can be added later

Create Initial Layout and Game Graphics

Mentally it is easier to start with game layout and graphics pieces. Even when nothing is working its give you moral satisfaction!

There are a few ways how the html could have been generated. You could have started with nothing and generate it all by java script, or you could have started with complete game markup in html and make java script just hide and move pieces around. BGA framework also provides a third way, which is mix of both, plus a template engine to generate HTML using php. The only thing that is really annoying about the template engine is that you cannot put any translatable strings in the template (which means any visible text at all). If you are using the template approach all strings have to extracted as variables and injected through php (.view.php). This page explains the template engine in great detail:Template Engine.

The other disadvantage of the template engine is you cannot run and debug it locally, in the beginning of development it's a lot faster run off local pages, you can do it with some trickery described here Tools and Tips for BGA Studio

During this step you have to decide what technical solutions you will be using, such as

  • Use inline positioning of all moving pieces, controlled by JS. There are a few classes that already exist in Studio to help with that (see Game Interface - Client Side). OR use html/css layout engine to position pieces (my personal choice).
  • Use BGA template engine OR create all ui elements by JS OR manually write or generate complete html markup. The game usually contain 200-300 pieces, it seems wrong but actually its faster to type all of this up in html/css when trying write than debug code for page generator.

Static HTML markup also means you have to use players color or abstracted player number (such as red is 1, blue is 2) not player id's anywhere in JS, since player id is dynamic by nature.

Start by creating and mapping all games assets, best way is probably to open rule book on "boardgame contents" page and go through every piece. Every pieces of boardgame would have its "print" in multiple files in your game:

  • Some sort if "div" in html, where id of element match id of element in database (easiest way)
  • Css for the element (either unique or for class), usually with background propery refering to part of sprite image
  • Entry in material.inc.php referring to static properties of the element, i.e. name, tooltip, rules, etc
  • Entry in .tpl file to represent static or initial location on the table OR creation template

Here are some specific examples:

Game Board

Create entry in .tpl file for the board, it will be static entry as we never need to create this dynamically

  <div id="board" class="board shadow board4p"> ... </div>

Create entry in .css file for this board and other board variants (in example below we have 4 ppl board whcih is diffrent than 2 ppl board)

.board {
	position: relative;
	width: 980px;
	height: 433px;
	margin-bottom: 5px;
}

.board4p {
	background-image: url(img/board4p.jpg);
}

That wold be pretty much it for the board itself, as it does not really tooltip on the whole things so we don't need entry in material.inc.php


Game Board Slots

These are interactive areas on the board, usually illustrated as such. In most cases you can get away with rectangular shapes, but sometimes you have to create circle or oval shapes (and in really advanced case would be some svg paths). For slots you can do the following:

Entry in material.inc.php

$this->token_types = array(
...
'slot_action_2' => array(
  'type' => 'slot_action',
  'name' => clienttranslate("2 Gray Track Advancements"),
  'tooltip' => clienttranslate("This action gives you two advancements of gray track. You cannot use this action if you cannot complete all advancements."),
  'o'=>"1,0,0,gg", // automatic rules
),
...

Entry in template inside the "board" div

	<div id="slot_action_2" class="slot_action_2 slot_action slot_w_1 slot"></div>

Entry in .css with absolute position within the board (its actually better to use percentage - would be easier to scale later)

.slot_action_2 {
	top: 83px;
	left: 37px;
}
.slot_action {
	position: absolute;
	width: 46px;
	height: 26px;
	padding: 9px 7px 6px 4px;
}

Meeples - also cards, tokens, other mobile stuff

In css these guys will use "sprite" images with transparency, so it will look like this this

.meeple {
	background-image: url(img/tokens.png);
	width: 25px;
	height: 25px;
}
.meeple_ff0000 { /* red */
	background-position: 14% 0%;
}

As for creation you can either generate them using template (where whole thing wrapped in template block and {COLOR} replace with all possible colors in .view.php

 <div id="meeple_{COLOR}_1" class="meeple meeple_{COLOR} meepleable"></div>
 <div id="meeple_{COLOR}_2" class="meeple meeple_{COLOR} meepleable"></div>
 ...

Or you can declare a template js var in .tpl file

    var jstpl_mepple = '<div id="meeple_${color}_${num}" class="meeple meeple_${color} meepleable"></div>'; // this is in .tpl file at the bottom

and create in js, like this

 var tokenDiv = this.format_block('jstpl_mepple', {
                                "color" : color,
                                "num" : i
                            }); // this in js code somewhere before placing it

If you dealing with cards and decks, there are pre-build components that can generate stuff for you.

One of the greatest part about the web is all client side code can be viewed in your browser, so if you wondering how something is done in another BGA game just load the page and spy on it! In Chrome that would be right click and "Inspect Element". That would immediately show html of the given element alongside with css used for it (on the right). Another great way to learn was introduced recently is you can add yourself to any BGA project as read only from the project page!

So at the end of this stage you should complete the following:

  • Create a layout of the game, with positioning of main board, player areas, zones, other supporting areas, etc
  • Create css and html snippets for all game pieces: boards, tokens, meeples, etc. Place them all in initial template (even if they're not supposed to be visible at start). I.e. create fake player's hand with cards, put meeples on the board
  • Hook layout to number of players and colors picked by the game and test with multiple players
  • Figure out what you want to display in mini-player boards and hook it up
  • Create material.inc.php and populate with initial values (names, tooltips, rules) for all relevant game elements or classes of elements

If at this time you don't have graphics yet create pieces with just css, you can use shape, background color and object text using css ::after construct to fake the pieces.


Injected text.png

Hook Input and Animation

This step can be done before or after some of the server steps, or you go in iterations switching back and forward until you get it done, up to you.

At this time you want to hook clicking on pieces and buttons and provide some reaction, such of moving a piece. The handler code will be replaced later by the server hook, but at the begging you want you game to be alive as early as possible.

Usually all pieces will be hooked to onclick during JS "setup" method, in addition if you create elements during server notification they have to be hooked up at that time.

You can play with animation effects you want put in place, in general all the pieces that move in real game should be moving, such as meeples, resources tokens/cubes, cards, vp tokens. Regular piece animation is provided by BGA framework, but if you use html layout positioning not inline positioning you have to remove absolute positions (inline position styling) after each move. The set of functions for relative position token animation can found in https://github.com/elaskavaia/bga-sharedcode/blob/master/sharedcode.js

Also its a good idea to give player a visual cues on what game elements are clickable now, usually it will be a style, such as "active_slot", with visual effect of white dashed outline (outline is better then border, because border changes will make piece slightly move since it changes the size) or box-shadow (i.e. neon glow)

If you read BGA developers guidelines you know that you should not get carried away with animation, you creating a board game not a video game... That also applies to sound effects (in general, you should not use any sounds effects beside already provided by framework).

See Player's Input and Animation and DOM Manipulation for JS reference.

Create Database Schema

At some point you have to design your game database. Do it sooner then later since it would be harder to change it later, since some code decisions would be based on that.

If you have grid-based abstract game use template from reversi, if you have a card game use template from hearts (the cards one also commented out in generated template for your project). The cards database goes with php class called Deck.

In general make it as simple as possible. Think about it, your game has 300 pieces (likely less). Using database to store this amount of data is like shooting a mosquito with a tank. Anything more complex then one table with 5 columns or two tables will only going to make it harder to develop and not improve performance. You can forget about normalising and any fancy stuff you learn about databases in school. String field for a primary key would be as fast as integer when we talking about this size of data. So don't over-optimize with trying to have integers field that have state based on bitmask!

Also remember that static (non dynamic) information about the game does not need to be stored in the database, that all include everything that does not change, i.e all token/card properties such as name, tooltips, "strength", color, etc. This is stored in material.inc.php and server has access to it from anywhere, as well as client if you send it with getAllDatas(). The only reason store some of it in database if it can affect your queries (i.e. type of token).

Usually design process will contain the following steps:

  • Design game model - model that represent your game in progress, such as at any given step you can restore the game from that model
  • Mapping - now map real game to that model
  • Encoding - now represent this model in database and material file with reasonable amount of fields

Example: The card game

  • In real word to "save" the game we take a picture a play area, save cards from it, then put away draw deck, discard and hand of each player separately and mark it, also we will record current scoring (if any) and who's turn was it
  • Framework handles state machine transition, so you don't have to worry about database design for that (i.e. who's turn it is, what phase of the game we are at, you still have to design it but as part of state machine step)
  • Also framework supports basic player information, color, order around the table, basic scoring, etc, so you don't have to worry about it either
  • The only thing you need in your database is state of the "board", which is "where each pieces is, and in what state", or (position,rotation) pair.
  • The card state is very simple, its usually "face up/face down", "tapped/untapped", "right side up/up side down"
  • As position go we never need real x,y,z. We need to know what "zone" card was, and depending on the zone it may sometimes need an extra "z" or "x" as card order. The zone position itself usually static or irrelevant.
  • So our model is: we have cards, which have some attributes, at any given point in time they belong to a "zone", and can also have order and state
  • Now for mapping we should consider what info changes and what info is static, static info is always candidate for material file or html
  • For dynamic stuff we should try to reduce amount of fields we need, i.e. we need a field for card, so its one, we need to know what zone cards belong to, its 2, and we have possible few other fields, but if you look closely at you game you may find out that most of the zone only need one attribute at a time, i.e. draw pile always have cards face down, hand always face up, also for hand and discard order does not matter at all (but for draw it does matter). So in majority of cases we can get away with one single extra integer field representing state or order
  • In real database both card and zone will be integers as primary keys referring to additional tables, but in our case its total overkill, so they can be strings as easily

You can also use cards database schema and Deck implementation for most purposes (even you not dealing with cards).

CREATE TABLE IF NOT EXISTS `card` (
  `card_id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `card_type` varchar(16) NOT NULL,
  `card_type_arg` int(11) NOT NULL,
  `card_location` varchar(16) NOT NULL,
  `card_location_arg` int(11) NOT NULL,
  PRIMARY KEY (`card_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 AUTO_INCREMENT=1 ;

Another Example: The euro game

See details on database design for euro game at BGA_Studio_Cookbook#Database_for_The_euro_game


So the piece mapping for non-grid based games can be in most case represented by (string: token_key, string: location, int: state), example of such database schema can be found here: dbmodel.sql and class implementing access to it here tokens.php.

CREATE TABLE IF NOT EXISTS `token` (
  `token_key` varchar(32) NOT NULL,
  `token_location` varchar(32) NOT NULL,
  `token_state` int(10),
  PRIMARY KEY (`token_key`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;


See Game database model: dbmodel.sql for details about editing the file.

Implement Game Setup

Once you have your database schema you can do a proper game setup. Usually you open rulebook on the "Game Setup" page and implement these step by step populating the database (using db access API). Game initialization is performed in php method setupNewGame, this method is called once when game table is created. Game notifications cannot be sent during this time.

Implement One time game model synchronisation

Now at any point in the game we need to make sure that database information can be reflected back in UI, so we fix getAllDatas function to return all possible data we need to reconstruct the game. The template for getAllDatas already taking care of player info, but you have to alter it to return all other data from database visible to the "current" player.

After that on the client side we should display this data, so in your .js file in setup function (which is the receiver of getAllDatas) you add calls that handle data send by server, usually by calling animation function such as "placeToken" or "placeCard".

Create State Machine

Now you need to create a game state machine.

The state handling spread across 4 files, so you have to make sure all the pieces are connected together. The state machine states.inc.php defines all the states, and function handlers on php side in a form of string, and if any of these functions are not implemented it would be very hard to debug because it will break in random places.

Please first watch this again BGA game state machine and then please read Your game state machine: states.inc.php.

Now the state machine should be relatively simple. If you find yourself with machine with more than 10 states its probably not the way to go. Not all the player interactions need separate states, a lot of things can be implemented directly on client, i.e. if your player need to select a reward token, which offers choice of resource, instead of two states on server just have one state on server and possible few states on client (client side states) to collect this info.

Implement Notification handling

Now to implement things for real we have hook UI actions to ajax calls, and process notifications send by server. So previously we hooked onclick js handler right to client animation, in real game its a two step operation. When user clicks on something, client sends an ajax call to server, server processes it and updates database, server sends notification in response, client hooks animations to server notification. See JS Notifications.

Exception to this is client states, if you need to process two step user interaction such as select meeple, place meeple, you may want to avoid sending data to server until step is complete (which may involve direct client side animation).

Part of the sending notifications would be to update player's scoring, BGA uses standard control for score (on JS side), see Update Player's Score.


Wrap Up

  • Implement game progression (getGameProgression() in php)
  • Implement Zombie turn (zombieTurn() in php)
  • Define and implemented some meaningful statistics for your game (i.e. total points, point from source A, B, C...)
  • The games logs should explain what happened if player was not looking
  • You need to implemented tiebreaking (using aux score field) and updated tiebreaker description in meta-data
  • Make sure all UI strings are marked for translation
  • UI elements which are images (i.e. tokens, cards) should have tooltips


When you think you game is completely working there is still bunch of stuff you have to do/check before telling admin that game is ready, please go though this Pre-release checklist.

Finally, visit the game page for your alpha game (https://boardgamearena.com/gamepanel?game=…) to add the following information if you can:

  • Links to the rules (in multiple languages if available).
  • Links to teaching videos.
  • In the "On the web" section, links to:
    • The official website for the game (if there is one).
    • The BoardGameGeek page for the game.
  • Consider writing a summary of the rules.