BgaDice

2026-09-09T10:26:14Z

Jiiru: /* Overview */

{{Studio_Framework_Navigation}}

== Overview ==
'''bga-dice''' is a javascript component to display dice.

The lib will handle associated animations (roll animation, moving between stocks).

To see how its work and access examples of source code (via browser dev tools) see
'''[https://x.boardgamearena.net/data/game-libs/bga-dice/1.x/demo/index.html Demo]'''

For comprehensive API docs see
'''[https://x.boardgamearena.net/data/game-libs/bga-dice/1.x/docs/index.html Doc]'''

== Usage ==
Load the lib:
<pre>
const BgaAnimations = await importEsmLib('bga-animations', '1.x'); // the library uses bga-animations so this is required!
const BgaDice = await importEsmLib('bga-dice', '1.x');
</pre>
This line should be placed on top of the JS file, before any class declaration.

Legacy way;
<pre>
define([
"dojo","dojo/_base/declare",
"ebg/core/gamegui",
"ebg/counter",
getLibUrl('bga-animations', '1.x'), // the lib uses bga-animations so this is required!
getLibUrl('bga-dice', '1.x'),
],
function (dojo, declare, gamegui, counter, BgaAnimations, BgaDice) { // note that the index of `BgaAnimations` must match the index of the define array
</pre>

In your game setup:
<pre>
// create the animation manager, and bind it to the `gameui.bgaAnimationsActive()` function
this.animationManager = new BgaAnimations.Manager({
animationsActive: () => this.bga.gameui.bgaAnimationsActive(),
});

// create the dice manager
this.diceManager = new BgaDice.Manager({
animationManager: this.animationManager,
type: 'my-game-die',
});
</pre>
Only setup an animation manager if you don't already have one, else re-use the same one.

Example of usage:
<pre>

// create the stock, in the game setup
this.dieStock = new BgaDice.LineStock(this.diceManager, document.getElementById('dice-stock'));
this.dieStock.addDice(gamedatas.dice); // dice should be something like [{ id: 1, face: 5, location: 'table' }]

async notif_rollDice(args) {
await this.dieStock.rollDice(args.rolledDice); // similar form as above, but with a different face value.
}

</pre>

Look at the demo page and the demo source code for a list of all possibilities!

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

== Using with TypeScript ==
If you use TypeScript and this lib, you can download the '''[https://x.boardgamearena.net/data/game-libs/bga-dice/1.x/dist/bga-dice.d.ts d.ts]''' file to put in on your game folder to benefit from auto-completion. Depending on the way you build, you might need to remove the last line (the export instruction) to be able to use it.

If your game class is not declared on the define callback, you will need to modify it with this trick (to avoid a "ReferenceError: BgaAnimations is not defined" error) :
<pre>
define([
"dojo",
"dojo/_base/declare",
"ebg/core/gamegui",
"ebg/counter",
"ebg/stock",
getLibUrl('bga-animations', '1.x'),
],
function (dojo, declare, gamegui, counter, stock, BgaAnimations) {
(window as any).BgaAnimations = BgaAnimations; //trick
return declare("bgagame.reforest", ebg.core.gamegui, new Reforest());
});
</pre>

== Changelog ==
'''1.0.2''': more logs for dice element not matching a card / accept keyed objects in addition to arrays on inputs

'''1.0.1''': Fix documentation

'''1.0.0''': Initial version

[[Category:Studio]]

Gamehelparctic

2024-08-28T13:48:05Z

Jiiru: /* Game End */

Arctic is a collection game where you will create a personal pile with Animal cards from the Arctic landscape.

=== OVERVIEW ===
The objective of the game is to score the most points by:

- Creating the longest possible sequence of consecutive cards for each animal from the Arctic landscape,

- Diversifying your sequences,

- Advancing your secret totem animal as far as possible.

Important Rules:

>> An animal only counts once, only its longest sequence is considered.

>> A sequence requires at least two cards.

>> The scoring rules for all three ways to earn points are the same: 1=0pt, 2=1pt, 3=3pt, 4=6pt, 5=10pt, 6=15pt. You can find this scoring table on the Landscape.

=== GAME TURN ===
Each turn, you must:

1 • Add Animal cards to your pile and take a Power card.

2 • Move the Animal tokens on the Landscape.

3 • Draw cards into your hand.

IMPORTANT: The most important card is the visible card on top of your pile. It determines your turn's characteristics, such as how many cards you will draw this turn, which animals you will move, and how many cards you will place during the next turn. This visible card changes every turn.

1 • Choose from your Hand a number of cards equal to the placement value on your visible Animal card and place them on top of your personal pile in the order of your choice. Take the Power card corresponding to the main animal on your visible Animal card. Keep this Power card until someone takes it from you. (Power card details are on pages 10-11 of the rules.)

>> If you don't have enough cards in your hand, draw the necessary cards from the common draw pile and add them to your Penalty zone.

2 • Move the Animal tokens on the Landscape corresponding to the main animal and the companion animal on your visible Animal card.

>> The Animal tokens always move in opposite directions unless they are both on one of the two ends of the Landscape (cards 0 and 15).

3 • Draw from the River a number of cards equal to the draw value on your visible Animal card.

>> You can only have a maximum of 7 cards in your hand at the end of your turn. If you have more than 7, discard the excess cards of your choice into your Penalty zone.

>> Final Scoring: For each card in your Penalty zone at the end of the game, deduct 1 point from your score.

Board Game Arena - User contributions [en]

BgaDice

Gamehelparctic