BgaScoreSheet

Game File Reference

Overview

• dbmodel.sql - database model
• gameinfos.inc.php - meta-information
• gameoptions.json - game options & user preferences
• img/ - game art
• Game Metadata Manager - tags and metadata media
• material.inc.php - static data
• misc/ - studio-only storage
• modules/ - additional game code
• States/ - State classes
• states.inc.php - state machine
• stats.json - statistics
• X.action.php - player actions
• X.css - interface stylesheet
• Game.php - main logic
• X.js - interface logic
• X.view.php - dynamic game layout
• X_X.tpl - static game layout

---

Useful Components

Official

• Deck: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).
• PlayerCounter and TableCounter: PHP components to manage counters.
• 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).
• bga-animations : a JS component for animations.
• bga-cards : a JS component for cards.
• bga-dice : a JS component for dice.
• bga-autofit : a JS component to make text fit on a fixed size div.
• bga-score-sheet : a JS component to help you display an animated score sheet at the end of the game.

Unofficial

• BGA Code Sharing - Shared resources, projects on git hub, common code, other links
• BGA Studio Cookbook - Tips and instructions on using API's, libraries and frameworks
• Common board game elements image resources

---

Game Development Process

• First steps with BGA Studio
• Create a game in BGA Studio: Complete Walkthrough
• Tutorial reversi
• Tutorial hearts
• BGA Studio Guidelines
• BGA game Lifecycle
• Pre-release checklist
• Post-release phase
• Player Resources - add player help/rules to your game page

---

Guides for Common Topics

• Translations - make your game translatable
• Game Replay
• Mobile Users
• 3D
• Compatibility

---

Miscellaneous Resources

• Studio FAQ
• Tools and tips of BGA Studio - Tips and instructions on setting up development environment
• Studio logs - Instructions for log access
• Practical debugging - Tips focused on debugging
• Troubleshooting - Most common "I am really stuck" situations
• Studio Bugs - Reports against Studio itself (not BGA!)

Demo Doc

Overview

bga-score-sheet is a javascript component to help you display an animated score sheet at the end of the game.

Usage

Load the lib:

define([
    "dojo","dojo/_base/declare",
    "ebg/core/gamegui",
    "ebg/counter",
    getLibUrl('bga-score-sheet', '1.x'),
],
function (dojo, declare, gamegui, counter, BgaScoreSheet) { // note that the index of `BgaScoreSheet` must match the index of the define array

At the end of your game setup:

this.scoreSheet = new BgaScoreSheet.ScoreSheet(
    document.getElementById(`my-score-sheet`), // an empty div on your template to place the score sheet on
    {
      animationsActive: () => game.bgaAnimationsActive(), // so the animation doesn't trigger on replay fast mode
      playerNameWidth: 80,
      playerNameHeight: 30,
      entryLabelWidth: 120,
      entryLabelHeight: 20,
      classes: 'score-sheet-background',
      players: gamedatas.players,
      entries: [
        {
          property: 'conquest-cards',
          label: _('Conquest cards'),
          labelClasses: 'entries-label',
        },
        {
          property: 'politics-cards',
          label: _('Politics cards'),
          labelClasses: 'entries-label',
        },
        {
          property: 'diplomacy-cards',
          label: _('Diplomacy cards'),
          labelClasses: 'entries-label',
        },
        {
          property: 'total',
          label: _('Total'),
          labelClasses: 'entries-label',
          scoresClasses: 'total',
          width: 80,
          height: 40,
        },
      ],
      scores: gamedatas.scores, // to defined if the game state is 99, else null, so the score displays directly on reload when the game is ended. If unset, the score sheet will be hidden by default.
      onScoreDisplayed: (property, playerId, score) => { // if you want to do something when a score is revealed
        if (property === 'total') {
          this.scoreCtrl[playerId].setValue(score);
        }
      },
    }
  );    

On the notification sending the end score details (supposing you use bgaSetupPromiseNotifications for async notifs) :

    async notif_endScores(args: NotifEndScoresArgs) {
        // setting scores will make the score sheet visible if it isn't already
        await this.scoreSheet.setScores(args.endScores, {
            startBy: this.getPlayerId()
        });
    }

The endScores object sent on the notification should look like this :

{
  156463: { // key is player id
    'conquest-cards': 18, // the score code must match the entry name
    'politics-cards': 4,
    'diplomacy-cards': 12,
    'total': 34
  },
  278971: {
    'conquest-cards': 31,
    'politics-cards': 7,
    'diplomacy-cards': 5,
    'total': 41
  },
}

Versioning

The lib is using semver, so you can require 1.x to be sure to have the last fixes without risking a breaking change. Any breaking change will be noted on the Changelog section.

Changelog

1.0.0: Initial version