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

Difference between revisions of "Game database model: dbmodel.sql"

From Board Game Arena
Jump to navigation Jump to search
(Added navigation)
Line 1: Line 1:
 +
{{Studio_Framework_Navigation}}
 +
 
In this file you specify the database schema of your game.
 
In this file you specify the database schema of your game.
  

Revision as of 22:02, 15 April 2020


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

In this file you specify the database schema of your game.

This file contains SQL queries that will be executed during the creation of your game table.

Note: you can't change the database schema during the game.

Create your schema

To build this file, we recommend you to build the tables you need with the PhpMyAdmin tool (see BGA user guide), and then to export them and to copy/paste the content inside this file.

Note: you must not use for a column the same name as for the table, as the framework replay function relies on regexp substitution to save/restore a previous state in a clone table with another name.

Default tables

Important: by default, BGA creates 4 tables for your game: global, stats, gamelog, and player.

You must not modify the schema of global, stats and gamelog tables (and you must not access them directly with SQL queries in your PHP code).

You may add columns to "player" table. This is very practical to add simple values associated with players.

Example:

ALTER TABLE `player` ADD `player_reserve_size` SMALLINT UNSIGNED NOT NULL DEFAULT '7';

For your information, the useful columns of default "player" table are:

  • player_no: the index of player in natural playing order.
  • player_id
  • player_name: (note: you should better access this date with getActivePlayerName() or loadPlayersBasicInfos() methods)
  • player_score: the current score of the player (displayed in the player panel). You must update this field to update player's scores.
  • player_score_aux: the secondary score, used as a tie breaker. You must update this field according to tie breaking rules of the game (see also: Manage_player_scores_and_Tie_breaker)

CREATE TABLES

you can create tables, using engine InnoDB

CREATE TABLE IF NOT EXISTS `hands` 
(
`id` INT(10) UNSIGNED NOT NULL AUTO_INCREMENT, 
`player_id` TINYINT(1) NOT NULL,
`1` BOOL NOT NULL DEFAULT 1,	
`2` BOOL NOT NULL DEFAULT 1,	
`3` BOOL NOT NULL DEFAULT 1,	
`4` BOOL NOT NULL DEFAULT 1,	
`5` BOOL NOT NULL DEFAULT 1,		
`6` BOOL NOT NULL DEFAULT 1,	
`7` BOOL NOT NULL DEFAULT 1,	
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 AUTO_INCREMENT=1 ;

Note: if you put comments, you cannot do it in the same line as code.

Example:

`3` BOOL NOT NULL DEFAULT 1, --  activated or not

will also comment out `3` BOOL, and that code will not be executed.

Link

You can add your Db inits in function SetupNewGame() from file 'gamename.game.php'

Errors Log

To trace Database creation check the logs that you can access in /admin/studio.

Post-release database modification

If you want to modify your database schema after the first release of your game in production, you should consult the related section