Board Game Arena - User contributions [en]

Practical debugging

2024-04-23T09:29:37Z

Tisaac: /* Fully automated version */

This page gives you practical tips to debug your game during development. Don't hesitate to share your difficulties with us so that we can improve this section.

__TOC__

== Tools ==

To work on BGA Studio, we recommend that you use [http://www.google.com/chrome Google Chrome] as it's currently the fastest browser for the BGA platform, and it's available for all OSes.

Another reason to use Chrome is that it embeds all the tools you need to work on BGA Studio. You can see them by pressing "F12" or from the menu ("Tools > Development tools").

A good practice is to use a second browser to develop the game, in order to verify that your game is working fine on this browser too.

To debug with Firefox browser, we advise you to use these 2 extensions:
* [https://addons.mozilla.org/firefox/addon/firebug/ Firebug]
* [https://addons.mozilla.org/firefox/addon/web-developer/ Web developer]

To debug with other browsers (IE, Edge, Opera), we advise you to use one of the most recent versions. Latest versions of the browser will likely have better development tools than the previous ones...

== General tip for debugging ==

=== Save & Restore ===

In general for debugging, think of using the '[[Tools_and_tips_of_BGA_Studio#Save_.26_restore_state|save & restore]] state' functionality. It enables you to save the state of your game just before the issue you are investigating, then come back to that point with one click as many times as needed to understand what is going wrong.

You can save up to 3 different states.

=== Refresh ===

If something does not seems to work properly even you "fixed it", it may be refresh issue. Not all files born equal. Some require a lot more steps to get into the game.

See https://en.doc.boardgamearena.com/Studio_file_reference for information on how to "refresh" each files.

== Debugging my game when it cannot start ==

If your game won't start because of an error, you are probably in one of these situations:
* There is a SQL error in your dbmodel.sql file.
* You have a syntax error in your PHP file.
* Your PHP "setupNewGame" generates exception
* You transition to new game state from the initial state which generates exception (or state is misconfigured)
* You transition to player state from the initial state which has excpetion in arg* or action* method (or state is misconfigured)

If the error is not explicitly displayed when you click on "Express start", you should check the "Gameserver error log" as per [[Studio logs]].
However errors and logs generated by setupNewGame not always (almost never) there, so see Debug setupNewGame session.
More cases of why game can't start are described on the [[Troubleshooting]] page.

== Debugging an issue with the waiting screen ==

BGA displays a waiting screen during a few seconds inviting free players to become premium when they are playing a lot.

This waiting screen should not in principle impact your game, but in some cases it might.

To test the waiting screen on the studio, you can set the desired duration by adding the get parameter studioLockingDuration with the number of seconds for the lock screen to be displayed. For example to have a 10 seconds waiting screen when you launch a game on the studio:
https://studio.boardgamearena.com?studioLockingDuration=10

Then you can just set it back to zero in the same way with https://studio.boardgamearena.com?studioLockingDuration=0 (or restart your browser to clear the session value).

== Debugging my PHP game logic (or my view) ==

=== Add traces to your code ===

You can use the following functions in your game to add server side logging:

'''$this->dump( 'name_of_variable', $variable );''' // dump variable, like var_dump but in the log debug level logging, goes to [[Studio_logs|BGA request&SQL logs]]

'''$this->debug( $message );''' // debug level logging, goes to [[Studio_logs|BGA request&SQL logs]]

'''$this->trace( $message );''' // info level logging, goes to [[Studio_logs|BGA request&SQL logs]]

'''$this->warn( $message );''' // warning level logging, goes to [[Studio_logs#BGA_unexpected_exceptions_logs|BGA unexpected exceptions log]]

'''$this->error( $message );''' // error level logging, goes to [[Studio_logs#BGA_unexpected_exceptions_logs|BGA unexpected exceptions log]]

Check [[Studio logs]] for more details on how to access your logs.

This can be useful when you need to follow the flow of your code and not just stop it to see how it goes at some point.

Only the error log level will appear in production. This level should be used only for critical problems.
Other levels will show only in the development environment and can be used as you see fit.

'''WARNING''': tracing does not work in constructor, setupNewGame and game states immediately following starting state (not sure why). Use other method described below in this case (seciton "Debugging setupNewGame").

=== Call php functions from chat ===

This is best feature ever, you can call individual function in your game.php from chat window, see details
at https://en.doc.boardgamearena.com/Tools_and_tips_of_BGA_Studio#Run_PHP_functions_from_the_chat

=== Dump data and die ===
First, make sure you can reproduce the needed game situation with one click. Use Save ("[[Tools_and_tips_of_BGA_Studio#Save_.26_restore_state|save & restore]]") function before doing some "test actions".

If you want to see what data looks like on some path you can simply throw this in exception, i.e.
<pre>
$value = var_export($my_var, true);
throw new BgaUserException('I am here: '.$value);
</pre>

Alternately use json instead of php formaing:
$value = json_encode($my_var, JSON_PRETTY_PRINT);

Another possibility for this is to place a '''die('ok')''' and '''var_dump(...)''' functions
<pre>
echo "<pre>";
var_dump( $my_variable );
echo "</pre>";
die('ok');
</pre>

Note: since this text will be returned back to client it will usually choke on this, but you can actually see it better if you wrap it some html (hence the <pre> tag)

=== Debug at home ===

If you develop some complex logic it is better sometimes to stub all external calls and debug it locally using command line or IDE debugger for php.
You can get some basic stubs here https://github.com/elaskavaia/bga-sharedcode/raw/master/misc/module/table/table.game.php

To run php locally you need to wrap it into test or something, see example https://en.doc.boardgamearena.com/BGA_Studio_Cookbook#Creating_a_test_class_to_run_PHP_locally

=== Debugging setupNewGame ===

This is separate section because tracing method do not work in this function.
Recommended way to debug it
* leave setupNewGame exactly as in template (inlcuding setting up player table and activating first player), and add a single call at the end
$this->initMyTables();
This will be your own function which you will be changing, so you don't touch setupNewGame anymore.

Remember that this function cannot send notification or query active or current player. If you need to get player data use $this->loadPlayersBasicInfos().

function initMyTables() {
try {
$players = $this->loadPlayersBasicInfos();
// ... code the function
} catch ( Exception $e ) {
// logging does not actually work in game init :(
// but if you calling from php chat it will work
$this->error("Fatal error while creating game");
$this->dump('err', $e);
}
}

Create a code for this function, and if it does not work run it from the chat window of the just created game (i.e. 'initMyTables()' without quotes). That way you can see debug output!
The only trick is you have to clear all your tables in the begging so when you run it multiple times your db does not puke.
If your game does not start at all - do not even call it from setupNewGame, comment it out and only call from chat window until it works.
Don't forget you can also look at tables in db using php-admin tool (link at the bottom of the game table in studio).

The same problem exists if you game state immediately follow starting state (problem of debugging it without the logs), in this case create a dummy player state in which player just press OK that will transition
to you game state, after you done debugging it remove the state and shortcut the transition to your game state.

Instead of calling initMyTables directly you can call helper function instead from chat window which will also reset the client, i.e.
<pre>
function debug_initMyTables() {
$this->deleteAllTables(); // this suppose to delete/reset all data - you have to implement this function
$this->initMyTables();
$newGameDatas = $this->getAllTableDatas(); // this is framework function
$this->notifyPlayer($this->getActivePlayerId(), 'resetInterfaceWithAllDatas', '', $newGameDatas); // this is notification to reset all data
$this->notifyAllPlayers("message",'setup called',[]);
}
</pre>HINT: This is a great suggestion. If you make any simple mistake in any code in setupNewGame, you may see "BGA Service Exception" instead of anything very useful, since setupNewGame failed. For example, even sending a bad SQL string to $this->dbQuery() will generate this error. Very hard to debug!

=== Debugging endOfGame ===

Debugging end of game is hard if game ends! Make sure it does not end, then you can restore to previous state using saved states.
In php file:

$this->processEndOfGame();
if ($this->getBgaEnvironment() == 'studio')
$this->gamestate->nextState('debuglast'); // debug end
else
$this->gamestate->nextState('last'); // real end

You have to add a special user state in states.inc.php file (note: this snippet uses php constants instead of state numbers)

<pre>
STATE_GAME_TURN_NEXT_PLAYER => array( // normal state
"name" => "gameTurnNextPlayer",
"description" => '',
"type" => "game",
"action" => "st_gameTurnNextPlayer",
"updateGameProgression" => true,
"transitions" => array(
"next" => STATE_PLAYER_TURN_ACTION,
"loopback" => STATE_GAME_TURN_NEXT_PLAYER,
"last" => STATE_END_GAME,
"debuglast" => STATE_PLAYER_GAME_END // for debugging on studio
),
),
// for debugging end of game
STATE_PLAYER_GAME_END => array(
"name" => "playerGameEnd",
"description" => clienttranslate('Game Over'),
"descriptionmyturn" => clienttranslate('Game Over'),
"type" => "activeplayer",
"args"=>"arg_playerTurnAction",
"possibleactions" => array( "end"),
"transitions" =>
array(
"next" => STATE_END_GAME,
"loopback"=> STATE_PLAYER_GAME_END)
),
</pre>

== Debugging my HTML/CSS layout ==

Example situations

* Why doesn't my game element show up in the interface?
* Why hasn't my CSS property been applied to this element?
* Why is this game element displayed at this position?

A useful tip when an element does not show up in the interface is to give it a red background:
<pre>
#my_element {
... some CSS definitions ...
background-color: red;
}
</pre>

This way, you know if the element is not visible because of some CSS property or because of something else.

Another tip: sometimes, changing a CSS property has no visible effect on your interface. In that case, add a "display:none" property. If your element does not disappear, the bug probably comes from your CSS selector and not from your CSS property.

Using Chrome "Elements" tab (the first one), you can:
* See the CURRENT HTML of your page. Remember that the classical "show page source" is inefficient with BGA as you are modifying the page source with your Javascript code.
* Using the "magnifying glass", you can click on any part of your game interface and check its HTML code and associated CSS styles.
* You can even modify directly some CSS properties and see how it looks immediately in the game interface.

When changing css you have to force reload (Ctrl+R). But it also reloads all images which is long, if you want it faster you can click the Reload CSS button.
=== Debugging Toolips CSS/Layout ===

To inspect tooltip you need to pin it so it does not disappear.
* Chrome tools:
** Open dev tools and switch to Source tab to engage with debugger
** Hover over you element until tooltip showing
** Press F8 - that stops the JS, so tooltip should freeze
** Now you can go to Elements tab and find your tooltip at the botton in dijitTooltip div
** Don't forget to resume it again to continue (F8 again or resume button)
* Other method: Open the console (dev tools) large enough window, hover to make the tooltip appear and alt + tab to focus the console that will cover the tooltip. That way the onmouseout will never be triggered.

=== Debugging my Javascript game interface logic ===

To debug javascript you just use embedded browser debugger, usually found in Source tab of dev tools (F12)

Modern browsers also allow you to put breakpoints in your js code. It is in source tab, but its a bit difficult to find (your code that is), see picture below on how to insert breakpoints.

You can do this by pressing Ctrl + B when your cursor is on the line where you want to set the breakpoint, or by clicking just to the left of the line number. One thing to be aware of is that refreshing via F5 removes set breakpoints, due to some cache busting values added to the URL. This can be remedied by adding this line to the end of your javascript source file, which enables the proper source mapping:

<pre>//# sourceURL=myjsfile.js</pre>

[[File:Bga-debug.jpg]]

The easier method is to add breakpoint directly into your code and reload.

In Chrome, to add a breakpoint: add a line to your .js file

<pre>debugger; </pre>

Refresh the page F5, and make sure you have the Developer tools window open, press F12.
When the break-point is hit you can then step through your code and visualise variables, etc.

=== Do complex things on the PHP side ===

The most frequent case is the following: you want to compute possible moves in a game situation. Doing it in Javascript is a nightmare. Do it in PHP, and transfer the results to your client interface using the "args" game state property.

Note: See the Reversi tutorial for an example.

=== Add traces in your code ===

You can use the following:

'''console.log( variable_to_inspect )'''

It will give you the object structure of the variable in the Javascript console, without blocking the execution.

It's often a good idea to precede this call with a console.log( '### HERE ###' ); to find more easily the appropriate line in the console log.

'''alert( variable_to_inspect )'''

It will popup what you wish and pause the execution until you click ok.

This won't be useful for complex structures; only native types will be plainly displayed. But this is sometimes useful just with messages to make sure which way the execution goes.

== Online format checkers ==
Copy and paste code for a quick code sanity check like the right number of brackets.

PHP: [https://phpcodechecker.com/ https://phpcodechecker.com/]

JS: [http://esprima.org/demo/validate.html http://esprima.org/demo/validate.html]

Checks for proper attributes values and browser's compatibility

CSS: http://jigsaw.w3.org/css-validator/

== Some frequent errors ==

See [[Troubleshooting]].

== Get the database matching a bug report ==

When a player creates a bug report in production, a snapshot of the game database is taken. You can get access to this snapshot from the studio by following the steps below:
* Create a table in the studio with the same game and number of players as the table for which the report has been written. Launch this table.
* Open another tab on the studio and go to "Manage game" page for your project (you have to be admin for this project)
* In the "Errors in production" section, fill up the fields "Bug report ID" (this is the ID of the bug report in production) and "Studio table ID" (this is the ID of the table you created above) then click the "⇨ Load bug report state into this table save slot #1" button.
* If the snapshot is correctly retrieved, you see a "Done!" message.
* Go back to the tab with your studio table and click "Load 1".
* The page refreshes automatically and is broken. This is normal, as the player ids from the snapshot are the player ids of the production, not those of the studio. We'll need to update them.
** '''Important note:''' if you see a "Done!" message but clicking "Load 1" doesn't bring any change, it's that the snapshot is unfortunately not available (most likely because the bug report was declared too long after the game ended and the database had already been garbage collected to reclaim space).
* Click on the "Go to game database" button
* For each table using player_ids, you'll need to update the player_ids from the production to use the player_ids from the studio. You can see the player_ids from the table page before entering the game by hovering over the player names.
* Tables to update:
** player
** global (value with ID 2 is the active player)
** stats
** tables specific to your schema that use player_ids
* If your changes to player_ids are not taken into account, it may be a cache problem: use the "Clear PHP cache" button on your "Manage game" page.
* Then you should be able to play with the same state of the game as when the report was created in production.
* If the game has ended, you can place it again in the game state you want to debug by setting the value with ID 1 in the global table to the appropriate state value, and the value with ID 2 to the player you want active).
*
* Below is an example php function you may want to make. You can call this function from the chat window: LoadDebug()
* change instances of 2308257, and 2308258 to you own BGA Studio logins YourLogin0 and YourLogin1
* change $id0 and $id1 to the player_ids from the table you want to debug, and have recently imported.
* Before you load Slot1, open a second tab with the table, because after loading the slot, that tab will be unusable. In the second tab you can call LoadDebug() in the chat window

<pre>
public function LoadDebug()
{
// These are the id's from the BGAtable I need to debug.
// you can get them by running this query : SELECT JSON_ARRAYAGG(`player_id`) FROM `player`
$ids = [
86107517,
86872172,
85086097,
84380410,
11000525
];
// You can also get the ids automatically with $ids = array_map(fn($dbPlayer) => intval($dbPlayer['player_id']), array_values($this->getCollectionFromDb('select player_id from player order by player_no')));

// Id of the first player in BGA Studio
$sid = 2296755;

foreach ($ids as $id) {
// basic tables
$this->DbQuery("UPDATE player SET player_id=$sid WHERE player_id = $id" );
$this->DbQuery("UPDATE global SET global_value=$sid WHERE global_value = $id" );
$this->DbQuery("UPDATE stats SET stats_player_id=$sid WHERE stats_player_id = $id" );

// 'other' game specific tables. example:
// tables specific to your schema that use player_ids
$this->DbQuery("UPDATE card SET card_location_arg=$sid WHERE card_location_arg = $id" );

++$sid;
}
}
</pre>

=== Fully automated version===
Thanks to quietmint for [https://boardgamearena.com/forum/viewtopic.php?f=12&t=16454#p63167 coming up] with that!
(updated and working on 05/06/2922)

CAREFUL: due to php8, the URL might be different depending whether you have php8 enabled or not on studio.

If you use php8, make sure to update the 3rd URL below like this : https://studio.boardgamearena.com/2/$game/$game/... (replace /1/ by /2/)

; In ggg.php
<pre>
/*
* loadBug: in studio, type loadBug(20762) into the table chat to load a bug report from production
* client side JavaScript will fetch each URL below in sequence, then refresh the page
*/
public function loadBug($reportId)
{
$db = explode('_', $this->getUniqueValueFromDB("SELECT SUBSTRING_INDEX(DATABASE(), '_', -2)"));
$game = $db[0];
$tableId = $db[1];
$this->notifyAllPlayers('loadBug', "Trying to load <a href='https://boardgamearena.com/bug?id=$reportId' target='_blank'>bug report $reportId</a>", [
'urls' => [
// Emulates "load bug report" in control panel
"https://studio.boardgamearena.com/admin/studio/getSavedGameStateFromProduction.html?game=$game&report_id=$reportId&table_id=$tableId",

// Emulates "load 1" at this table
"https://studio.boardgamearena.com/table/table/loadSaveState.html?table=$tableId&state=1",

// Calls the function below to update SQL
"https://studio.boardgamearena.com/1/$game/$game/loadBugSQL.html?table=$tableId&report_id=$reportId",

// Emulates "clear PHP cache" in control panel
// Needed at the end because BGA is caching player info
"https://studio.boardgamearena.com/admin/studio/clearGameserverPhpCache.html?game=$game",
]
]);
}

/*
* loadBugSQL: in studio, this is one of the URLs triggered by loadBug() above
*/
public function loadBugSQL($reportId)
{
$studioPlayer = $this->getCurrentPlayerId();
$players = $this->getObjectListFromDb("SELECT player_id FROM player", true);

// Change for your game
// We are setting the current state to match the start of a player's turn if it's already game over
$sql = [
"UPDATE global SET global_value=2 WHERE global_id=1 AND global_value=99"
];
foreach ($players as $pId) {
// All games can keep this SQL
$sql[] = "UPDATE player SET player_id=$studioPlayer WHERE player_id=$pId";
$sql[] = "UPDATE global SET global_value=$studioPlayer WHERE global_value=$pId";
$sql[] = "UPDATE stats SET stats_player_id=$studioPlayer WHERE stats_player_id=$pId";
$sql[] = "UPDATE gamelog SET gamelog_player=$studioPlayer WHERE gamelog_player=$pId";
$sql[] = "UPDATE gamelog SET gamelog_current_player=$studioPlayer WHERE gamelog_current_player=$pId";
$sql[] = "UPDATE gamelog SET gamelog_notification=REPLACE(gamelog_notification, $pId, $studioPlayer)";

// TODO Add game-specific SQL updates for the tables, everywhere players ids are used in your game
$sql[] = "UPDATE deck SET card_location_arg=$studioPlayer WHERE card_location_arg=$pId";
$sql[] = "UPDATE card SET card_location_arg=$studioPlayer WHERE card_location_arg=$pId";
$sql[] = "UPDATE piece SET player_id=$studioPlayer WHERE player_id=$pId";
$sql[] = "UPDATE log SET player_id=$studioPlayer WHERE player_id=$pId";
$sql[] = "UPDATE log SET action_arg=REPLACE(action_arg, $pId, $studioPlayer)";

// This could be improved, it assumes you had sequential studio accounts before loading
// e.g., quietmint0, quietmint1, quietmint2, etc. are at the table
$studioPlayer++;
}
$msg = <nowiki>"Loaded <a href='https://boardgamearena.com/bug?id=$reportId' target='_blank'>bug report $reportId</a><hr><ul><li>" . implode(';</li><li>', $sql) . ';</li></ul>';</nowiki>
$this->warn($msg);
$this->notifyAllPlayers('message', $msg, []);

foreach ($sql as $q) {
$this->DbQuery($q);
}
$this->reloadPlayersBasicInfos();
$this->gamestate->reloadState();
}
</pre>

; In ggg.action.php
<pre>
public function loadBugSQL() {
$this->setAjaxMode(false);
$reportId = (int) $this->getArg('report_id', AT_int, true);
$this->game->loadBugSQL($reportId);
$this->ajaxResponse();
}
</pre>

; In ggg.js
<pre>
// Load production bug report handler
const self = this; // save the `this` context in a variable
dojo.subscribe("loadBug", this, function loadBug(n) {
function fetchNextUrl() {
var url = n.args.urls.shift();
console.log("Fetching URL", url, "...");
// all the calls have to be made with ajaxcall in order to add the csrf token, otherwise you'll get "Invalid session information for this action. Please try reloading the page or logging in again"
self.ajaxcall(url,
{
lock: true,
},
self,
function (success) {
console.log("=> Success ", success);

if (n.args.urls.length > 1) {
fetchNextUrl();
}
else if (n.args.urls.length > 0) {
//except the last one, clearing php cache
url = n.args.urls.shift();
dojo.xhrGet({
url: url,
headers: {
"X-Request-Token": bgaConfig.requestToken
},
load: function (success) {
console.log("Success for URL", url, success);
console.log("Done, reloading page");
window.location.reload();
},
handleAs: "text",
error: function (error) {
console.log("Error while loading : ", error);
}
});
}
}
,
function (error) {
if (error)
console.log("=> Error ", error);
}
);
}
console.log("Notif: load bug", n.args);
fetchNextUrl();
});
</pre>

== Studio environment ==

Some developers have requested a method allowing to know which environment the module is running on. While in general, your code should be the same on all environments so that the validation process makes sense, this may allow for example to display some helpers for testing during development while being sure that they'll never show up outside of the studio.

From your <gamename>.game.php file you can use:

<pre>if ($this->getBgaEnvironment() == 'studio') { ... }</pre>

Or if needed from your <gamename>.view.php file:

<pre>if ($this->game->getBgaEnvironment() == 'studio') { ... }</pre>

[[Category:Studio]]

BGA Code Sharing

2022-05-01T12:33:56Z

Tisaac: /* Community shared components, pens, etc */

{{Studio_Framework_Navigation}}

This page is for listing of externally hosted bga projects, tools and resources, as well as internal project
intended for sharing

== Community shared components, pens, etc ==

{| class="wikitable"
|-
! NAME
! CODE LINK
! DESCRIPTION
|-
! colspan="3" | Dice models and animation
|-
| Die: 4 sided
| https://codepen.io/mrkiffie/pen/doVZgW
| code pen
|-
| Die: 6 sided
| https://github.com/elaskavaia/bga-sharedcode
| Code can be found in project
|-
| Die: 12 sided (dodecahedron)
| https://codepen.io/VictoriaLa/pen/xxLLxOP
| Code pen
|-
| Die: 20 sided
| https://codepen.io/vicentemundim/details/cenIh
| Code pen
|-
! colspan="3" | Moving object using CSS animation (mostly)
|-
| Phantom object move on oversurface
| https://codepen.io/VictoriaLa/pen/gORvdJo
| This technique creates clone of the object it moves it on another surface. It works well when parents that css transform applies such as scale and rotate
|-
| Move object directly using positioning
| https://codepen.io/VictoriaLa/pen/dyzgKVX
| This technique is modification of BGA framework method to allow mobile object not to have absolute position before or after the move (and uses css animation not dojo). Methods slideToObjectRelative, attachToNewObjectNoDestroy
|-
! colspan="3" | Responsive layout for game boards
|-
|Flex Layout
|https://codepen.io/VictoriaLa/pen/XWjJJgG
|Example on how to create flexible layout just by using css
|-
! colspan="3" | Algorithms
|-
|Hex grid
|tapestry,...
|
|-
|Shortest path on hex grid
|memoir 44
| Disjktra
|-
|Largest area on hex grid
|tapestry, ...
|
|-
|Largest area on square grid
|king domino, ...
|
|-
|Tetris pieces
|patchwork, ...
|Matrix manupations to rotate, flip and fit tetris pieces
|-
|Line of sights on hex grid
|memoir 44
|Find intersecting hexes on a line between two cells
|-
|}

== Projects hosted not in studio ==

See the table a link and nickname of the developer on bga (same as used for dev forum), and short description. See [[Tools_and_tips_of_BGA_Studio#Version_Control]] for some suggestions on how and where to publish your code externally. Also see the [https://github.com/topics/boardgamearena boardgamearena] tag on github.

'''Important notice about artwork on BGA Open Source projects: original hi-resolution images from publishers must not be published on the repositories. In addition, it is better to specify that the images derivated from publishers artwork are copyrighted and cannot be licensed under a free license like Creative Commons.
'''

{| class="wikitable"
|-
! NON-GAME PROJECTS
! CODE LINK
! DEVELOPER
! COMMENT
|-
| Shared Code (not a game)
| https://github.com/elaskavaia/bga-sharedcode
| Victoria_La
| Examples of various game components and PHP stubs of framework code to make IDE happy
|-
| BoardGameArena Workbench (not a game)
| https://github.com/danielholmes/bga-workbench
| Daniel Holmes (dhau)
|-
! GAME
! CODE LINK
! DEVELOPER
! COMMENT
|-
| 99 (Trick-taking Card Game)
| https://github.com/ekelly/bga-ninetynine
| QuasarDukeDev
|-
| Assyria
| https://github.com/sebastien-prudhomme/bga-assyria
| daikinee
|-
| Aura
| https://github.com/micahstairs/bga-aura
| Micah Stairs (micahstairs)
|-
| Bandido
| https://github.com/opheliehb/BandidoBGA
| ophelopede & Harkle
|-
| The Battle for Hill 218
| https://github.com/danielholmes/battle-for-hill-218
| Daniel Holmes (dhau)
|-
| Bonbons
| https://github.com/AntonioSoler/bga-bonbons
| Morgalad
|-
| Coinche
| https://github.com/drasill/bga-coinche
| Draasill
|-
| Coup: City State
| https://github.com/quietmint/bga-coupcitystate
| quietmint
|-
| Dungeon Roll
| https://github.com/MartinGoulet/bga-dungeonroll
| MGoulet
|-
| Egyptian Ratscrew
| https://github.com/0BuRner/bga-egyptianratscrew
| 0BuRner
|-
| Eruption
| https://github.com/AndyKerrison/bga-eruption
| Andy_K
|-
| A Fistful Of Gold
| https://bitbucket.org/Joel_L/fistfulofgold
| Brainchild
|-
| Florenza: The Card Game
| https://github.com/alberto-bottarini/bga-florenza
| tarini
|-
| Hearts '''(Tutorial)'''
| https://github.com/elaskavaia/bga-heartsla
| Victoria_La
|-
| Homesteaders
| https://github.com/npatron/bga-homesteaders
| TheBoot
|-
| Incan Gold
| https://github.com/AntonioSoler/bga-incangold
| Morgalad
|-
| Innovation
| https://github.com/micahstairs/bga-innovation
| Micah Stairs (micahstairs)
|-
| Mapmaker: The Gerrymandering Game
| https://github.com/gzhang01/bga-mapmaker
| gkz
|-
| Marco Polo
| https://github.com/rcitaliano/MarcoPolo
| rcitaliano
|-
| Nile
| https://github.com/AndyKerrison/bga-nile
| Andy_K
|-
| Noir: Killer vs Inspector
| https://bitbucket.org/chhuang76/bga_noirkvi
| ch huang
|-
| Penny Press
| https://github.com/AdamNovotny/bga-blooms
| A-dam
|-
| P.I.
| https://gitlab.com/fa81/bga-pi, https://github.com/hellp/bga-pi (mirror)
| Fabian Neumann (fa81)
|-
| Santorini
| https://github.com/AntonioSoler/bga-santorini
| Morgalad, quietmint, Tisaac
|-
| Tablut
| https://github.com/Lucas-C/tablut
| Lucas-C & ntaffore
|-
| Takara Island
| https://github.com/AntonioSoler/bga-takaraisland
| Morgalad
|-
| Taluva
| https://github.com/quietmint/bga-taluva
| Morgalad & quietmint
|-
| Teotihuacan: City of Gods
| https://github.com/Trompetenhut/bga-teotihuacan
| Trompetenhut
|-
| Texas 42 (domino game, still under development)
| https://github.com/ishermandom/bga-42
| Stardust Spikes, Jason Turner-Maier, Ilya Sherman
|-
| Uptown
| https://github.com/elliotkendall/bga-uptown
| SpottedShroom
|-
| Via Magica
| https://github.com/christopherburke/bga_viamagica
| CuriousTerran
|-
| Just Desserts
| https://github.com/mizutismask/bga-just-desserts
| mizutismask
|-
| The King's Guild
| https://github.com/AdamNovotny/BGG-KingsGuild
| A-dam
|-
| Get the MacGuffin
| https://github.com/mizutismask/bga-get-the-MacGuffin
| mizutismask
|-
| President
| https://github.com/quaresma95/president
| quaresma95
|-
| Hardback
| https://github.com/quietmint/bga-hardback
| quietmint
|-
| Dice Summoners
| https://github.com/eoincos/bga-dicesummoners
| eoincos
|-
|}

== Projects on studio ==

Any developer can add themselves to a project as read-only from https://studio.boardgamearena.com/#!projects page (almost any project).
The list below are no-games which do not have bgg id and not showing up there.

{| class="wikitable"
|-
! NAME
! CODE LINK
! DEVELOPER
|-
| Shared Code
| https://studio.boardgamearena.com/gamepanel?game=sharedcode
| Victoria_La
|-
| Original BGA template
| https://studio.boardgamearena.com/gamepanel?game=template
| Victoria_La
|-
|}

== Other useful resources ==

Moved to [[Tools_and_tips_of_BGA_Studio]]

BGA Code Sharing

2022-05-01T12:32:50Z

Tisaac: /* Community shared components, pens, etc */

{{Studio_Framework_Navigation}}

This page is for listing of externally hosted bga projects, tools and resources, as well as internal project
intended for sharing

== Community shared components, pens, etc ==

{| class="wikitable"
|-
! NAME
! CODE LINK
! DESCRIPTION
|-
! colspan="3" | Dice models and animation
|-
| Die: 4 sided
| https://codepen.io/mrkiffie/pen/doVZgW
| code pen
|-
| Die: 6 sided
| https://github.com/elaskavaia/bga-sharedcode
| Code can be found in project
|-
| Die: 12 sided (dodecahedron)
| https://codepen.io/VictoriaLa/pen/xxLLxOP
| Code pen
|-
| Die: 20 sided
| https://codepen.io/vicentemundim/details/cenIh
| Code pen
|-
! colspan="3" | Moving object using CSS animation (mostly)
|-
| Phantom object move on oversurface
| https://codepen.io/VictoriaLa/pen/gORvdJo
| This technique creates clone of the object it moves it on another surface. It works well when parents that css transform applies such as scale and rotate
|-
| Move object directly using positioning
| https://codepen.io/VictoriaLa/pen/dyzgKVX
| This technique is modification of BGA framework method to allow mobile object not to have absolute position before or after the move (and uses css animation not dojo). Methods slideToObjectRelative, attachToNewObjectNoDestroy
|-
! colspan="3" | Responsive layout for game boards
|-
|Flex Layout
|https://codepen.io/VictoriaLa/pen/XWjJJgG
|Example on how to create flexible layout just by using css
|-
! colspan="3" | Algorithms
|-
|Hex grid
|tapestry,...
|
|-
|Shortest path on hex grid
|memoir 44
|(add your games already in bga here)
|-
|Largest area on hex grid
|tapestry, ...
|
|-
|Largest area on square grid
|king domino, ...
|
|-
|Tetris pieces
|patchwork, ...
|Matrix manupations to rotate, flip and fit tetris pieces
|-
|}

== Projects hosted not in studio ==

See the table a link and nickname of the developer on bga (same as used for dev forum), and short description. See [[Tools_and_tips_of_BGA_Studio#Version_Control]] for some suggestions on how and where to publish your code externally. Also see the [https://github.com/topics/boardgamearena boardgamearena] tag on github.

'''Important notice about artwork on BGA Open Source projects: original hi-resolution images from publishers must not be published on the repositories. In addition, it is better to specify that the images derivated from publishers artwork are copyrighted and cannot be licensed under a free license like Creative Commons.
'''

{| class="wikitable"
|-
! NON-GAME PROJECTS
! CODE LINK
! DEVELOPER
! COMMENT
|-
| Shared Code (not a game)
| https://github.com/elaskavaia/bga-sharedcode
| Victoria_La
| Examples of various game components and PHP stubs of framework code to make IDE happy
|-
| BoardGameArena Workbench (not a game)
| https://github.com/danielholmes/bga-workbench
| Daniel Holmes (dhau)
|-
! GAME
! CODE LINK
! DEVELOPER
! COMMENT
|-
| 99 (Trick-taking Card Game)
| https://github.com/ekelly/bga-ninetynine
| QuasarDukeDev
|-
| Assyria
| https://github.com/sebastien-prudhomme/bga-assyria
| daikinee
|-
| Aura
| https://github.com/micahstairs/bga-aura
| Micah Stairs (micahstairs)
|-
| Bandido
| https://github.com/opheliehb/BandidoBGA
| ophelopede & Harkle
|-
| The Battle for Hill 218
| https://github.com/danielholmes/battle-for-hill-218
| Daniel Holmes (dhau)
|-
| Bonbons
| https://github.com/AntonioSoler/bga-bonbons
| Morgalad
|-
| Coinche
| https://github.com/drasill/bga-coinche
| Draasill
|-
| Coup: City State
| https://github.com/quietmint/bga-coupcitystate
| quietmint
|-
| Dungeon Roll
| https://github.com/MartinGoulet/bga-dungeonroll
| MGoulet
|-
| Egyptian Ratscrew
| https://github.com/0BuRner/bga-egyptianratscrew
| 0BuRner
|-
| Eruption
| https://github.com/AndyKerrison/bga-eruption
| Andy_K
|-
| A Fistful Of Gold
| https://bitbucket.org/Joel_L/fistfulofgold
| Brainchild
|-
| Florenza: The Card Game
| https://github.com/alberto-bottarini/bga-florenza
| tarini
|-
| Hearts '''(Tutorial)'''
| https://github.com/elaskavaia/bga-heartsla
| Victoria_La
|-
| Homesteaders
| https://github.com/npatron/bga-homesteaders
| TheBoot
|-
| Incan Gold
| https://github.com/AntonioSoler/bga-incangold
| Morgalad
|-
| Innovation
| https://github.com/micahstairs/bga-innovation
| Micah Stairs (micahstairs)
|-
| Mapmaker: The Gerrymandering Game
| https://github.com/gzhang01/bga-mapmaker
| gkz
|-
| Marco Polo
| https://github.com/rcitaliano/MarcoPolo
| rcitaliano
|-
| Nile
| https://github.com/AndyKerrison/bga-nile
| Andy_K
|-
| Noir: Killer vs Inspector
| https://bitbucket.org/chhuang76/bga_noirkvi
| ch huang
|-
| Penny Press
| https://github.com/AdamNovotny/bga-blooms
| A-dam
|-
| P.I.
| https://gitlab.com/fa81/bga-pi, https://github.com/hellp/bga-pi (mirror)
| Fabian Neumann (fa81)
|-
| Santorini
| https://github.com/AntonioSoler/bga-santorini
| Morgalad, quietmint, Tisaac
|-
| Tablut
| https://github.com/Lucas-C/tablut
| Lucas-C & ntaffore
|-
| Takara Island
| https://github.com/AntonioSoler/bga-takaraisland
| Morgalad
|-
| Taluva
| https://github.com/quietmint/bga-taluva
| Morgalad & quietmint
|-
| Teotihuacan: City of Gods
| https://github.com/Trompetenhut/bga-teotihuacan
| Trompetenhut
|-
| Texas 42 (domino game, still under development)
| https://github.com/ishermandom/bga-42
| Stardust Spikes, Jason Turner-Maier, Ilya Sherman
|-
| Uptown
| https://github.com/elliotkendall/bga-uptown
| SpottedShroom
|-
| Via Magica
| https://github.com/christopherburke/bga_viamagica
| CuriousTerran
|-
| Just Desserts
| https://github.com/mizutismask/bga-just-desserts
| mizutismask
|-
| The King's Guild
| https://github.com/AdamNovotny/BGG-KingsGuild
| A-dam
|-
| Get the MacGuffin
| https://github.com/mizutismask/bga-get-the-MacGuffin
| mizutismask
|-
| President
| https://github.com/quaresma95/president
| quaresma95
|-
| Hardback
| https://github.com/quietmint/bga-hardback
| quietmint
|-
| Dice Summoners
| https://github.com/eoincos/bga-dicesummoners
| eoincos
|-
|}

== Projects on studio ==

Any developer can add themselves to a project as read-only from https://studio.boardgamearena.com/#!projects page (almost any project).
The list below are no-games which do not have bgg id and not showing up there.

{| class="wikitable"
|-
! NAME
! CODE LINK
! DEVELOPER
|-
| Shared Code
| https://studio.boardgamearena.com/gamepanel?game=sharedcode
| Victoria_La
|-
| Original BGA template
| https://studio.boardgamearena.com/gamepanel?game=template
| Victoria_La
|-
|}

== Other useful resources ==

Moved to [[Tools_and_tips_of_BGA_Studio]]

Players actions: yourgamename.action.php

2021-05-18T19:36:43Z

Tisaac:

{{Studio_Framework_Navigation}}

== Purpose of this file ==

With this file, you define all the player entry points (i.e., possible game actions) for your game.

This file is a sort of "bridge" between the AJAX calls you perform from the Javascript client side, and your main PHP code in "yourgame.game.php".

The role of the methods defined in this file is to filter the arguments, format them a bit, and then call a corresponding PHP method from your main game logic ("yourgame.game.php" file).

Methods in this file should be short: no game logic must be introduced here.

== Example of typical action method ==

(from Reversi example)

<pre>
public function playDisc()
{
self::setAjaxMode();
$x = self::getArg( "x", AT_posint, true );
$y = self::getArg( "y", AT_posint, true );
$result = $this->game->playDisc( $x, $y );
self::ajaxResponse( );
}
</pre>

== Methods to use in action methods ==

'''function setAjaxMode()'''

Must be used at the beginning of each action method.

'''function ajaxResponse()'''

Must be used at the end of each action method.

'''function getArg( $argName, $argType, $mandatory=false, $default=NULL, $argTypeDetails=array(), $bCanFail=false )'''

This method must be used to retrieve the arguments sent with your AJAX query.

You must ''not'' use "_GET", "_POST" or equivalent PHP variables to do this, as it is unsafe.

This method uses the following arguments:

* argName: the name of the argument to retrieve.
* argType: the type of the argument. You should use one of the following:
'AT_int' for an integer
'AT_posint' for a positive integer
'AT_float' for a float
'AT_bool' for 1/0/true/false
'AT_enum' for an enumeration (argTypeDetails lists the possible values as an array)
'AT_alphanum' for a string with 0-9a-zA-Z_ and space
'AT_alphanum_dash' for a string with 0-9a-zA-Z_- and space
'AT_numberlist' for a list of numbers separated with "," or ";" (example: 1,4;2,3;-1,2)
'AT_base64' for a base64-encoded string (SECURITY WARNING*)
'AT_json' for a JSON stringified string (SECURITY WARNING**)

* mandatory: specify "true" if the argument is mandatory.
* default: if mandatory=false, you can specify here a default value in case the argument is not present.
* argTypeDetails: see AT_enum above.
* bCanFail: if true, specify that it may be possible that the argument won't be of the type specified by argType (and then do not log this as a fatal error in the system, and return a standard exception to the player).

'''SECURITY WARNING''': If using AT_base64 or AT_json, or other undocumented unchecked types you must perform validation on unpacked data, i.e. do not use any of it unchecked, i.e. pass to DB queries or return back in notifications.

Here is an example of a sanity check for JSON :
'''
public function actMyAction()
{
self::setAjaxMode();
$args = self::getArg('actionArgs', AT_json, true);
$this->validateJSonAlphaNum($args, 'actionArgs');
$this->game->actMyAction($args);
self::ajaxResponse();
}

public function validateJSonAlphaNum($value, $argName = 'unknown')
{
if (is_array($value)) {
foreach ($value as $key => $v) {
$this->validateJSonAlphaNum($key, $argName);
$this->validateJSonAlphaNum($v, $argName);
}
return true;
}
if (is_int($value)) {
return true;
}
$bValid = preg_match("/^[_0-9a-zA-Z- ]*$/", $value) === 1;
if (!$bValid) {
throw new feException("Bad value for: $argName", true, true, FEX_bad_input_argument);
}
return true;
}
'''

'''function isArg( $argName )'''

This is a useful method when you only want to check if an argument is present or not present in your AJAX request (and don't care about the value).

It returns "true" or "false" according to whether "argName" has been specified as an argument of the AJAX request or not.

== Useful tip: retrieve a list of numbers ==

If your Javascript sends a list of integers separated by ";" (example: "1;2;3;4") as an argument, you can transform them into a PHP array with the following:

<pre>
public function playCards()
{
self::setAjaxMode();

$card_ids_raw = self::getArg( "card_ids", AT_numberlist, true );

// Removing last ';' if exists
if( substr( $card_ids_raw, -1 ) == ';' )
$card_ids_raw = substr( $card_ids_raw, 0, -1 );
if( $card_ids_raw == '' )
$card_ids = array();
else
$card_ids = explode( ';', $card_ids_raw );

$this->game->playCards( $card_ids );
self::ajaxResponse( );
}
</pre>

== Example pass array of Id's ==

If your Javascript sends a list of object denomated by alphanumerical tokenId, you can use AT_alphanum type and space as array separator:

<pre>
// sending 'card_ids' => "card_1 card_23 card_12"
public function playCards() {
self::setAjaxMode();

$card_ids_raw = self::getArg( "card_ids", AT_alphanum, true );
$card_ids_raw = trim($card_ids_raw);

if( $card_ids_raw == '' )
$card_ids = array();
else
$card_ids = explode( ' ', $card_ids_raw );

$this->game->playCards( $card_ids );
self::ajaxResponse( );
}
</pre>

== Retrieving data from ajax call ==

Note that this is not possible to return any result from a player action: it should return nothing (action went fine) or an exception (action unsuccessful).

The typical way to implement this is using games states with game state arguments. Eventually, use player notifications.

== Game action handler ==
This is note on what you should be doing and not doing ggg.game.php action handler vs action.php handler

action.php
* action handler in action.php should very simple and it should ONLY extract arguments from ajax call, pass them down to game handler
* it should not implement any game logic or check for validity beyong the syntax. I.e. DO NOT put checkAction this action.php

game.php
* call checkAction('myAction') first
* check arguments for game validity (i.e. player is not cheating), throw system exceptions if it is (usually this cases where JS side won't be sending it but you still have to check for it)
* perfom action and update database, can do more check if throw user exception if this is not valid move by the rules
* send notifications
* transition to new state

I wish I knew this when I started

2021-03-28T19:09:10Z

Tisaac:

This page contains most "I wish I knew this before..." momentics (in regards to BGA studio game development). One line per statement please with doc references. Docs can be outside of BGA wiki.
Can you add your name at the end of "quote".

* Browser caches images and css, to force re-cache use Ctrl+F5, and sometimes it's not enough so go to the web console > Network > check "disable cache"
* Browser has powerful embeded dev tools for inspection of dom, css and js, you can debug js right in browser
* You don't have to login with another dev account to play test the game under development, little colored arrows on studio panel switch between test accounts
* You can run PHP functions from chat

Pre-release checklist

2020-11-18T20:19:01Z

Tisaac:

{{Studio_Framework_Navigation}}

If you think your game is ready to be reviewed by by BGA admins and/or Publisher please consult this checklist first

* Metadata and graphics
** [[Game_meta-information: gameinfos.inc.php]] has correct and up to date information about the game
** Game box graphics is 3D version of the game box (if available) and publisher icon is correct (see [[Game art: img directory]]). Space around the box has to be transparent, not white.
** You have added a game_banner.jpg and some game_displayX.jpg images to make the game page pretty (NB: on the studio, you have to create a build for these images to appear on the studio game page)
** There is no images in img directory which are not needed anymore
** Multiple images (i.e. cards) are compressed in "Sprite" (see [[Game art: img directory]])
** Each image should not exceed 4M
** Total size should not exceed 10M, image compression should be used otherwise
* Server side
** When giving their turn to a player, you give them some extra time with the giveExtraTime() function
** Game progression is implemented (getGameProgression() in php)
** Zombie turn is implemented (zombieTurn() in php). Note: it can only be tested if you explicitly click on the quit button to create a zombie. If you are expelled it does not generated a Zombie.
** You have defined and implemented some meaningful statistics for your game (i.e. total points, point from source A, B, C...)
** Game has meaningful notification messages (but don't overkill it, more user logs will slow down the loading)
** You implemented tiebreaking (using aux score field) and updated tiebreaker description in meta-data
* Special testing
** Game is tested with spectator (non player observer): change the testuser in the URL to see the game as another user (same URL as when clicking on red arrow)
** Game is tested with in-game replay from last move feature (by clicking on notification log items)
** Game works in Chrome and Firefox browsers at least. Also very recommended to test in IE 11 and Edge.
** Game works on mobile device (if you don't have mobile device to test at least test in Chrome with smaller screen, they have a mode for that)
** Test your game in realtime mode. Usually people will run out of time if you use default times unless you add call giveExtraTime($active_player_id) before each turn
** Test your game in 3D mode (if it makes sense; 3D mode can also be disabled through the 'enable_3d' parameter for gameinfos.inc.php, but if it "mostly works", it can be nice to keep it activated even if 2D is more appropriate for the game, just because it's fun to look at)
* Cleanup
** Remove all extra console.log from your js code
** Remove all unnecessary debug logging from your php code
** Copyright headers in all source files have your name
* User Interface
** Review BGA UI design Guidelines [[BGA_Studio_Guidelines]]
** Check all your english message for proper use of punctuation, capitalization, usage of present tense in notification (not past) and gender nuturality. See [[Translations]] for English rules.
** If the elements in your game zone don't occupy all the available horizontal space, '''they should be centered'''.
** If your game elements become blurry or pixellated when using the browser zoom, you may want to consider [[Game_art:_img_directory#Use_background-size | higher resolution images with background-size]]
** Non-self explanatory graphic elements should have tooltips
** If graphic elements appear in notification log they should have titles (i.e. title attribute of div) so can be read in non rendered form (i.e. as text only)
** Strings in your source code are ready for translation. See [[Translations]]. You can generate dummy translations for checking that everything is ready for translation from your "Manage game" page.
** A prefix for example a trigram for your game that you append to all the css classes to avoid namespace conflicts, i.e. vla_selected vs selected
** If you are looking for advice on design and some 3rd party testing you can post a message on the developers forum, and ask other developers, there are a lot of people who will gladly do it.
* Finally move to Alpha status
** If possible (meaning if there is not already a project with that name) copy your project to a new project '''matching exactly the name of the game''' (no prefix or suffix). If not possible move on to the next steps, admin will have to retrieve the other project and overwrite it.
** Create a build for your game from the "manage game" page (using the '''Build a new release version''' section) and check the log to make sure that everything builds fine (after a successful build, you should see a new version in "Versions available for production").
** Send an e-mail to studio@boardgamearena.com asking to move the project forward for review. You cannot deploy yourself from the "manage game" page until a first deploy has been done by the admins. Please note that '''everything must be OK on the licensing''' side for a project to be moved to production.
** When admins publish (push to alpha) they will send an email to the developer with all relevant information about the next steps.

Tools and tips of BGA Studio

2020-11-18T20:16:11Z

Tisaac: /* Switching between users */

{{Studio_Framework_Navigation}}

== Server Tools and Tips ==
=== Starting a game in one click ===

To start a game:
* Go to Play now and configure game type: Simple game -> Turn-based -> Manual
* Select your game and click on "Create".
* If you want to play a game with 3 players, specify that you want a maximum of 3 players at this table.
* Click on "Express Start".

=== Stopping a game in one click ===

* Click on the "quit" icon on the top right of the screen.
* Click on "Express Stop".

=== Switching between users ===

When running a game on Studio, you can use the little red arrow near each player's name to open a new tab with this player's perspective.
You can also modify the URL to view the table as any user you want (changing &testuser=myid in the URL), allowing to easily test as a spectator.

=== Access to game database and Logs ===

At the bottom of the game area, there is section without a title containing 3 useful links:

Go to game database • BGA request&SQL logs • BGA unexpected exceptions logs

* "Go to game database" link is an immediate access to the PhpMyAdmin tool to view/edit the tables of the current game
* BGA request&SQL logs - link to your studio PHP log - all tables, all severities. Anything you print using debugging and tracing functions from PHP and some framework logs
* BGA unexpected exceptions logs - same log as above but only severity warning and higher

See [[Practical debugging]] for more info about it.

=== Save & restore state ===

Using links of this section, you can save the complete current (database) state of your game, then restore it later.

This is particularly useful when you want to develop a part of the game that is difficult to reproduce: you just have to save the situation just before, and then restore it until this part works fine.

We provide you 3 "slots": 1, 2 and 3. This way, you can save 3 different game situations.

Limits:
* the "restore" function does not work anymore when the game is over.
* a saved situation from a given table cannot be restored in another table.
* when you "restore" a situation, the current browser page is refreshed to reflect the updated game situation, but you have to refresh you other tabs/pages manually.

=== Input/Output debugging section ===

This section shows you:
* The AJAX calls made by your game interface to the game server. AJAX calls (outputs) begins with ">"
* The notifications received by your game interface. Notifications (inputs) begins with "<".

Note: if you click on some notification title, you can resend it immediately to the user interface.

=== Run PHP functions from the chat ===

On BGA Studio, you can directly run a PHP method from the table chat.

For example, if on your PHP you have this method:

function giveMoneyToPlayer($player_id, $amount) { ... }

You can call this method directly from the chat like this:

giveMoneyToPlayer(2564,2)

Note: this is not a real php statement, you cannot use self::, you cannot use ";" at the end and you cannot use quotes,
if you need to pass a string skip the quotes, like this

giveToActivePlayer(money,2)

=== Stopping Hanging Game ===

If game is hanging and you cannot enter it to stop you can type this URL (replace 12345 with your table number),
which should bring you to a place where you can stop it without entering:

<nowiki>http://en.studio.boardgamearena.com/#!table?table=12345</nowiki>

== Desktop and Web Tools ==
=== Code Editors and IDEs ===
==== Eclipse For PHP Developers ====

Eclipse PHP package can be starting point for development you need. You may also want to
install Tern JS plugins to understand dojo style JS. All desktops.
https://projects.eclipse.org/projects/tools.pdt

==== Visual Studio Code ====

Microsoft Visual Studio Code is light weight IDE/Editor. All desktops.
https://code.visualstudio.com

==== Gedit (Ubuntu) ====
'''Edit TPL'''
To edit TPL with HTML code highlightings in Gedit under Ubuntu:

find gtksourceview directory in /usr/share, depending on your version (2.0, 3.0,...).
 
Here it's 3.0, then type in a terminal window:
<pre>
sudo gedit /usr/share/gtksourceview-3.0/language-specs/html.lang
</pre>

then find 'globs' section, and change:

<pre>
<property name="globs">*.html;*.htm;*.tpl</property>
</pre>

=== File Sync ===

==== File Sync on Windows ====

Install [http://winscp.net/ WinSCP]. Map a remote directory to a local one and enable continuous sync (one way). You need SFTP password you get when you registered dev account.

==== File Sync on Linux ====

===== Option 1 - Nautilus (file manager) =====
You can just use Nautilus "connect to a server" function with URL sftp://1.studio.boardgamearena.com
Then you'll get a mounted local folder mapping your studio folder and you can use any editor you like without further need for sync. Downside - if connection goes down you cannot work on source code, no local copy.

===== Option 2 - sftp and rsync =====
<pre>
#!/bin/bash
BASEDIR=`dirname $0`
REMOTE=$BASEDIR/remote
LOCAL=$BASEDIR/workspace
GAME=mygamenamehere

#mount remote
fusermount -u $REMOTE #this unmounts dir
echo LongDevPassword | sshfs -o password_stdin myusernamehere@1.studio.boardgamearena.com: $REMOTE

#this starts auto-sync from local to remote mount
killall lsyncd
lsyncd -delay 1 -rsync $LOCAL/$GAME/ $REMOTE/$GAME
</pre>

This can be able run on startup, so you don't have to do anything manually. However sshfs is not very stable you
have to kill and restart it sometimes. And remote goes away sometimes due to connection issues with studio.
In this case its handy to have a local copy, which is what lsyncd for.

You can also sync on demand (from a build script or editor command) using
rsync -vlrt $LOCAL/$GAME/ $REMOTE/$GAME

===== Option 3 - lftp =====

[https://lftp.yar.ru/ lftp] is a fast command-line file transfer program. It's a much better choice than rsync for BGA Studio since it supports parallel threads, transferring multiple files at a time.

* Linux: Install using your package manager, for example: '''sudo apt-get install lftp'''
* Mac: Install [https://brew.sh/ Homebrew], then install lftp using '''brew install lftp'''

To upload your project to BGA studio, use the "mirror" command like this:

'''lftp sftp://myuser:mypassword@1.studio.boardgamearena.com/ -e "mirror --reverse --parallel=10 --delete /local/path/to/myproject/ myproject/; exit"

Be sure to include the trailing '''/''' after both directory names.

By default, if a file already exists on BGA Studio with the same time + size it assumed to be the same and won't be transferred. This makes the transfer process much quicker after the first time. If you're working with multiple developers on the same project and you find that it is transfers all files every time, you may want to add the option '''--ignore-time''' (if a file already exist on BGA Studio with the same size it is assumed to be the same and won't be transferred). Read [https://lftp.yar.ru/lftp-man.html the manual] for more details.

==== File Sync using VSCode ====
You might rely on your IDE to sync the files with the SFTP server. Each time you "save" a file with your modifications, the IDE will also submit it to the sFTP server. These are instructions for VS Code

* '''Install this extension''' https://marketplace.visualstudio.com/items?itemName=liximomo.sftp (File->Preferences->Extensions ... type SFTP and Install)

* '''Open VSCode on an empty folder''' that will be the local root of your project.

* Execute Ctrl+Shift+P on Windows/Linux or Cmd+Shift+P on Mac to open the command palette, and the type/run : '''"SFTP: config"''' - the edit will open with json config

* '''Update the json''' as below:

<pre>
{
"name": "BGA",
"host": "1.studio.boardgamearena.com",
"protocol": "sftp",
"port": 22,
"username": "<your SFTP username>",
"password": "<your SFTP password>",
"remotePath": "/<your project name>/",
"uploadOnSave": true,
"ignore": [
".vscode",
".git",
".DS_Store"
]
}
</pre>

- Execute Ctrl+Shift+P on Windows/Linux or Cmd+Shift+P on Mac to open the command palette, and the type/run : '''"SFTP: Download Project"'''.

This will download all the files locally, and each time you modify/save a file in VSCode, it will upload it to the SFTP Server.

=== Debuggers ===

Browser is the best tool for JS/HTML5 debugging, see [[Practical debugging]] for details.

=== Version Control ===
Studio provides svn for you code on server, there are some limited abilities there to see history and restore. I recommend to also keep your code in another repository, which allows keeping more fine-grained history and can simplify collaboration.

A quick option is to use a local repo, which you can sync to cloud or backup.

Other option is to host source code on github. If you do, the convention is to use github.com/<yourname>/bga-<yourgame>. It is recommended to add the [https://github.com/topics/boardgamearena boardgamearena] tag and add your repo to the list on the [[BGA_Code_Sharing]] page.

If you publish the source somewhere externally, make sure you '''don't post high-res publisher graphics''', only web resources, and post a separate license for graphics files. Also, '''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 also configure github to automatically deploy to BGA whenever you push to a branch. See [https://forum.boardgamearena.com/viewtopic.php?f=12&t=13370&start=10#p59537 this forum post] for instructions.

=== PHP CLI ===
Its handy to have php cli (command line) tools install to run php locally, so you can test some stuff without deployment cycle, or create some scripts that generate code or markup.

=== Image Manipulation ===
==== ImageMagick ====
Handy set of image manipulation '''command line''' tools, useful to for example to stitch together bunch of images and re-size, to use as sprite (in Stock component for example). I.e. you got a graphics file from publisher where every tile is 600x600 PNG file in separate file. You want .jpg instead of .png to make it not like 20Mb, and combine all images in one column and re-size to 128x128:

(Linux example)
/usr/bin/montage `ls Tiles*.png` -tile 1 -geometry 128x128+0+0 out/tiles128.jpg

https://www.imagemagick.org/script/download.php

==== Gimp ====

GUI tool, very complex but will do ALL what you possibly need to do with game graphics

https://www.gimp.org/

==== Shrinking ====

Shrink images without loss of quality https://tinypng.com/ or http://www.iloveimg.com/

==== PDF Scrapper ====
extract images from PDF file (i.e. game rulebook) :

https://www.ilovepdf.com/

http://www.extractpdf.com/

==== Rename/Copy project ====

Edit: there is project override command now available on control panel on studio

There is a script available in sharedcode project to do the renaming which can be called in command line if you have php command line installed.
You need to have php clt (command line interface) installed, then you can download script and run it.

https://github.com/elaskavaia/bga-sharedcode/blob/master/misc/bgaprojectrename.php

Usage:
php bgaprojectrename.php <originalProjectPath> <copyOfProjectRenamedPath>

Example on how to call it in command line if you project name is "heartsmyproject"

php7.0 git/bga-sharedcode/tools/bgaprojectrename.php remote/hearts/ remote/heartsmyproject/

==== BGA Workbench ====

PHP library providing tools to help manage BGA Studio projects including deployment and test utilities. https://github.com/danielholmes/bga-workbench

== Client Tips ==

=== Speed up game re-loading by disabling Input/Output debug section ===

Development UI have few sections for debugging only, such as 'Input/Output debugging section'. Loading this data will significantly slow down
your reload. I did some profiling and my reloading (i.e. F5) took 14 seconds, 12 of which it was dealing with loading this section.
If you not using it you can disable it. In your JavaScript code, in the begging of 'setup' method add this code

dojo.destroy('debug_output');

That should get rid of this section and overhead associated with loading it (it may have some other side-effects, I have not explored all of them)

=== Speed up CSS development and layout ===

Syncing files to server and refreshing is relative fast but still can take up to 20 seconds which is annoying.
If you working
a lot on css/images/layout you can speed it up by coping html in some state of the game to your local folder.
I.e. in your project folder create directory misc/ and save your html as misc/test.html and changing path to css to load from local disk (and it will load your images to from local disk as well).
I.e. find something like

<link rel="stylesheet" type="text/css" href="http://1.studio.boardgamearena.com:8081/data/themereleases/151226-1240/games/mygame/999999-9999/mygame.css"/>

and replace with
<link rel="stylesheet" type="text/css" href="../mygame.css"/>

You project structure will look like this

mygame
img/ <-- your images
mygame.css <-- your original css
...
misc/
test.html <-- your test html

It is a bit tricky to save html exact state, if you do save as it also pulls all resources sometimes.

Translations

2020-11-12T14:42:01Z

Tisaac:

{{Studio_Framework_Navigation}}

Using BGA Studio, the game you create is ready to be translated to each language by the BGA community. To make this possible, you only need to specify which string must be translated and how to combine them.

== How translation works? ==

When developing your game, all strings must be in English. Strings must be coherent with the English version of the game.

Before the release of the game, BGA team will do the French translation of the game.

After the release of the game, the BGA players community will translate the game in every language.

== What should be translated? ==

Every text that can be visible by the player when the game is running normally. This includes tooltips, texts on cards, error messages, ...

This does NOT include error messages that are not supposed to happen (unexpected errors).

== What rules should I follow for the original English strings? ==

For a coherent and homogeneous interface, here are some rules about ending a sentence with a final dot '.'

* As a general rule:
** If a sentence is displayed isolated in the interface => no final dot
** If a sentence is followed or could be followed by another sentence in the same interface space => final dot.

* In detail:
** No final dot:
*** button labels
*** section titles
*** menu elements
*** links triggering an isolated action
*** anything that is not a full sentence
*** current action in the status bar
** Final dot:
*** complete explanation sentence, that can be chained with another sentence
** We can tolerate a dot or no dot (but it should be consistent inside the game) for:
*** isolated tooltip / isolated small sentence
*** game log (no dot is usually preferable)
*** error messages (except if more than one sentence in the error message => final dot mandatory in this case)

Otherwise, you should try to follow as closely as possible the general style and format (including capitalization) used in the English rulebook and game material of the game.

== Focus on translating notifications ==

Usually, translating a website is simple: you just call a function on every string you have to translate, and the string is translated in the player's language. On Board Game Arena, this is exactly the same with the "_( string )" function.

However, there is one difference on BGA: notifications. The server is sending notifications to players, and most of the time the notifications are the same for every players, no matter what language each player is using. This is why notifications are translated on client side in the proper language, even if the strings are defined on server side.

== WARNING: how to make sure your strings will be translated ==

For each game, our translation tool is doing a full scan of the code, looking for translator markers like "_()" or "clientranslate()"... (see below the list of translation markers).

If your original string is not "physically" inside one of this marker, it won't be translated.

<pre>
// Examples: the following strings will be translated:
var mystring_translated = _("my string"); // JS
$mystring_translated = self::_("my string"); // PHP
$mystring_translated = sprintf( self::_("my string with an %s argument"), $argument ); // PHP

// Examples: the following strings WILL NOT be translated:
$my_string = "my string";
$not_translated = self::_( $my_string ); // The original string is not bordered by a translator marker => no translation
$not_translated = self::_( sprintf( "my string with a %s argument", $argument ) ); // Same thing
</pre>

== How to not make translators crazy ;) ==

* When you need the same string twice, try to reuse exactly the same string (with the same case) to minimize the number of strings.
* Do not mark as translatable a game element that does not have to be translated (ex: if the name of a monster on a card is "Zzzzz", maybe there's no need to translate it).
* Words does not come in the same order in each language. Thus, when you have to translate a string with an argument, do not write something like:
<pre>self::_("First part of the string, ").$argument.' '.self::_("second part of the string")</pre>
Write instead:
<pre>sprintf( self::_("First part of the string, %s second part of the string"), $argument )</pre>
(or the equivalent "dojo.string.substitute" in Javascript)
* When translators are going to translate your game, the most difficult task for them is to get the context of the string to be translated. The more the string is a short insignificant string, the more difficult is the task for them. As a rule of thumb, try to avoid insignificant short strings. You can also leave a comment on what is the context of the string in the translation program (English to English) if you are the developer of the game.
* The BGA translation policy is to be flexible on grammar... We prefer to write "player gets 1 coin(s)" than write two versions of the same string for plural and singular - it reduces the number of strings to translate.
* Instead of writing nice strings like "With the effect of ZZZ, player XXX gets a new YYY", which is very difficult to translate, write strings like "ZZZ: XXX gets YYY".
* Use present tense instead of past, i.e. "player gets wood" instead of "player got wood"
* Avoid using gender specific pronouns, i.e. instead of "player returns card to *his* hand" use "player returns card to *their* hand" or just avoid using it, i.e. "player picks up the card"

== On client side (Javascript) ==

On client side, things are quite simple: you just have to use the "_()" function for all strings you want to translate.

Examples:
<pre>
// Get a string in player's language:
var translated = _("original english string");

// Get a string in player's language with parameter:
var translated = dojo.string.substitute( _("You can pick ${p} cards and discard ${d}"), {
p: 2,
d: 4
} );
</pre>

'''WARNING:''' in Javascript strings to translate, you should never use '\n', '\t' or such, as it will break the translation bundle and result in all the Javascript translation to fail. In any case, the strings will result in HTML code, and such character codes won't have any impact on the HTML rendering. You should use HTML markup instead.

'''ANOTHER WARNING:''' you cannot use this function _() in the javascript object constructor, but you can achieve the same if you use it the setup method

== On server side (PHP) ==

On PHP side, you can use 3 different functions to specify that a string must be translated.

'''clienttranslate( "my string to translate" ):'''

This function is '''transparent''': it will return the original English string without any change. It's only purpose is to mark this string as "must be translated", and to make sure the translated version of the string will be available on client side.

In general, you use clienttranslate:
* On your states.inc.php, for field "description" and "descriptionmyturn".

<pre>
"description" => clienttranslate('${card_name}: ${actplayer} must discard 4 identical energies'),
</pre>

* On "material.inc.php", when defining texts for game material that must be displayed on client side.
<pre>
$this->card_types = array(

1 => array(
'name' => clienttranslate("Amulet of Air"), // Thus, we can use "_( card_name )" on Javascript side.
</pre>

* When sending a notification with "notifyAllPlayers" or "notifyPlayer", for the game log string and all game log arguments that need a translation.

<pre>
// A game log string with no argument:
self::notifyAllPlayers( 'pickLibraryCards', clienttranslate("Everyone draw cards from his library"), array() );
</pre>

As a consequence there is no point passing variables to this function, i.e.
<pre>
notif="foo"; self::notifyAllPlayers( 'log', clienttraslate(notif)); // BAD
notif=clienttranslate("foo"); self::notifyAllPlayers( 'log', notif); // GOOD
</pre>

Translating arguments is a little bit more complex. It is using the "i18n" special argument as below:

<pre>
// In the following example, we translate the game log itself, but also the "card_name" argument:

self::notifyAllPlayers( 'winPoints', clienttranslate('${card_name}: ${player_name} gains ${points} point(s)'), array(
'i18n' => array( 'card_name' ), // <===== We specify here that "card_name" argument must be translated
'player_id' => $player_id,
'player_name' => self::getActivePlayerName(),
'points' => $points,
'card_name' => $this->card_types[8]['name'] // <==== Here, we provide original English string.
) );
</pre>

To ensure the translation of the i18n argument will be made, clienttranslate must have been used somewhere, for instance:

<pre>
$this->card_types = array(
...
8 => array(
'name' => clienttranslate("Amulet of Fire"),
...
</pre>

Pay attention when using 'i18n' argument when translating argument for client : do NOT use same argument for both translation AND key code for client side action (like using 'card_name' to move it on player board as described in the example). It's pretty obvious in the example, but it can be very tricky when translation is made at the end of the development (which is often the case). Use explicit argument name like 'card_name_translated' by example.

'''WARNING:''' you should NEVER use concatenation with clienttranslate, as it would result in a different string to translate at runtime than the one retrieved statically in the translation system, and so translation would not be applied. If you need to compose a string, use substitution and the i18n parameter (but you also have to pay attention not to compose sentences in a way that is dependent upon the English language specific syntax, or it may be impossible to translate correctly in another language: sometimes, you need multiple full sentences rather than relying on substitution).

'''self::_( "my string to translate" ):'''

This function returns a string translated in the language of CURRENT user (i.e. player who send the request to the server) (be careful, this is NOT the active player).

Most of the time, you don't need to translate strings on server side, except on the following 3 situations:
* When throwing an exception because the player did a forbidden move.

<pre>
// This will display a translatable red message to the player that just did some wrong action:
throw new BgaUserException( self::_('You must choose 3 cards') );

// ... notice the use of BgaUserException that signals that this exception is "expected". In theory, all exception that are expected should be translated.
</pre>

* In "yourgame.view.php", when creating the labels for the game interface used in your template (.tpl) file.

<pre>
$this->tpl['CARDS_FOR_YEAR_2'] = self::_("Your cards for year II");
</pre>

* Eventually, in your material.inc.php, if for example you need to use some string elements in your exceptions.

<pre>
// In material.inc.php, $this->energies[n]['nametr'] has been created with the self::_() method. Now we can do this:
throw new BgaUserException( self::_("To execute this action you need more: ").' '.$this->energies[$resource_id]['nametr'] );
</pre>

* Eventually, in your "getAllDatas" PHP method, as the data return by this method is used only by current user.

'''totranslate( "my string to translate" ):'''

This function works exactly like 'clienttranslate', except it tells BGA that the string is not needed on client side.

You should not use this function, except on the following cases:
* Statistics name in stats.inc.php
* Option names and option values name in gameoptions.inc.php

== On server side - advanced (PHP) ==

If you want to use translation system in your custom static modules, you will first need to expose the _() function :
<pre>
class mygame extends Table
{
// Exposing protected method translation
public static function totranslate($text){
return self::_($text);
}
}
</pre>

Then you'll be able to use this directly in other modules by doing
<pre>
throw new BgaUserException(mygame::totranslate("Translated error from my awesome module file"));
</pre>

Notice how the "totranslate" is also used by the static analysis to detect your string. So the following will not work :
<pre>
$msg = "Translated error from my awesome module file";
throw new BgaUserException(mygame::totranslate($msg));
</pre>

Gamehelpkingdombuilder

2020-09-22T19:14:25Z

Tisaac:

== Rules overview ==
Place three settlements per turn on the same terrain type shown on your card with the following constraint : if possible you '''must''' build adjacent to your existing settlements. Never forget this, managing adjacency is the key of this game.

By building next to a castle, the player will earn gold at the end of the game, but the most gold will be earned by meeting the conditions of the three Kingdom Builder cards; these three cards (from a total of ten in the game) specify the conditions that must be met in order to earn the much-desired gold, such as earning gold for your settlements built next to water hexes or having the majority of settlements in a sector of the board.

Building next to a location will grant you a corresponding tile (if there are any left, and if you did not already obtained a tile from this precise location) that you will be able to activate it from next turn on.
These extra actions can be activated at each turn either before or after your mandatory build of three settlements, and here is the action each location grants you :
- Oracle : build one settlement on a hex of the same type as your played card, build adjacent if possible
- Farm : build one settlement on grass, build adjacent if possible
- Oasis : build one settlement on a desert hex, build adjacent if possible
- Tower : build one settlement at the edge on the board, build ajacent if possible
- Tavern : build one settlement at the end of a string of at least 3 of your own settlements. The orientation of the string does not matter. The chosen hex must be suitable for building.
- Barn : move any one of your existing settlements to a hex of the same type as your played terrain card. Build ajacent if possible.
- Harbor : move any one of your existing settlements to a water hex. Build ajacent if possible. This is the only way to build settlements on water hexes.
- Paddock : move any one of your existing settlements two hexes in a straight line in any direction to an elligible hex. You may jump accross any terrain type hex, even moutain, water, castle, location and/or your own and other players' settlement. The target must *not necessarily* be adjacent to one of your own settlements

== Losing a tile ==
The player keeps a location tile as long as at least one of their settlements is adjacent to the corresponding location.
If they move their last settlement away from such a location by using an extra action (Barn, Harbor or Paddock), they must discard this location tile and remove it from the game.
Notice that after losing a tile from a location, a player cannot reobtain the tile from the same location since '''a player may seize only one location tile from a given location'''

Gamehelpkingdombuilder

2020-09-22T19:10:09Z

Tisaac:

== Rules overview ==
Place three settlements per turn on the same terrain type shown on your card with the following constraint : if possible you *must* build adjacent to your existing settlements. Never forget this, managing adjacency is the key of this game.

By building next to a castle, the player will earn gold at the end of the game, but the most gold will be earned by meeting the conditions of the three Kingdom Builder cards; these three cards (from a total of ten in the game) specify the conditions that must be met in order to earn the much-desired gold, such as earning gold for your settlements built next to water hexes or having the majority of settlements in a sector of the board.

Building next to a location will grant you a corresponding tile (if there are any left, and if you did not already obtained a tile from this precise location) that you will be able to activate it from next turn on.
These extra actions can be activated at each turn either before or after your mandatory build of three settlements, and here is the action each location grants you :
- Oracle : build one settlement on a hex of the same type as your played card, build adjacent if possible
- Farm : build one settlement on grass, build adjacent if possible
- Oasis : build one settlement on a desert hex, build adjacent if possible
- Tower : build one settlement at the edge on the board, build ajacent if possible
- Tavern : build one settlement at the end of a string of at least 3 of your own settlements. The orientation of the string does not matter. The chosen hex must be suitable for building.
- Barn : move any one of your existing settlements to a hex of the same type as your played terrain card. Build ajacent if possible.
- Harbor : move any one of your existing settlements to a water hex. Build ajacent if possible. This is the only way to build settlements on water hexes.
- Paddock : move any one of your existing settlements two hexes in a straight line in any direction to an elligible hex. You may jump accross any terrain type hex, even moutain, water, castle, location and/or your own and other players' settlement. The target must *not necessarily* be adjacent to one of your own settlements

== Losing a tile ==
The player keeps a location tile as long as at least one of their settlements is adjacent to the corresponding location.
If they move their last settlement away from such a location by using an extra action (Barn, Harbor or Paddock), they must discard this location tile and remove it from the game.
Notice that after losing a tile from a location, a player cannot reobtain the tile from the same location since *a player may seize only one location tile from a given location*

Gamehelpkingdombuilder

2020-09-22T19:04:00Z

Tisaac:

Place three settlements per turn on the same terrain type shown on your card with the following constraint : if possible you *must* build adjacent to your existing settlements. Never forget this, managing adjacency is the key of this game.

By building next to a castle, the player will earn gold at the end of the game, but the most gold will be earned by meeting the conditions of the three Kingdom Builder cards; these three cards (from a total of ten in the game) specify the conditions that must be met in order to earn the much-desired gold, such as earning gold for your settlements built next to water hexes or having the majority of settlements in a sector of the board.

Building next to a location will grant you a corresponding tile (if there are any left, and if you did not already obtained a tile from this precise location) that you will be able to activate it from next turn on.
These extra actions can be activated either before or after your mandatory build of three settlements, and here is the action each location grants you :
- Oracle : build one settlement on a hex of the same type as your played card, build adjacent if possible
- Farm : build one settlement on grass, build adjacent if possible
- Oasis : build one settlement on a desert hex, build adjacent if possible
- Tower : build one settlement at the edge on the board, build ajacent if possible
- Tavern : build one settlement at the end of a string of at least 3 of your own settlements. The orientation of the string does not matter. The chosen hex must be suitable for building.
- Barn : move any one of your existing settlements to a hex of the same type as your played terrain card. Build ajacent if possible.
- Harbor : move any one of your existing settlements to a water hex. Build ajacent if possible. This is the only way to build settlements on water hexes.
- Paddock : move any one of your existing settlements two hexes in a straight line in any direction to an elligible hex. You may jump accross any terrain type hex, even moutain, water, castle, location and/or your own and other players' settlement. The target must *not necessarily* be adjacent to one of your own settlements

Fullguidesantorini

2020-09-08T11:09:45Z

Tisaac: /* About Us */

==About Us==
Hi everyone. I (shcowcow) and my team is now developing a full guide of all gods in Santorini.

[[Image:Santorini-Apollo.jpeg]]

==Link to Strategies==
Here are all the links to the strategies of each god.
* [[Tips santorini|Santorini Strategies]]

===Simple Gods===
* [[SantoriniPowerApollo|Apollo: God of Music]]
* [[SantoriniPowerArtemis|Artemis: Goddess of the Hunt]]
* [[SantoriniPowerAthena|Athena: Goddess of Wisdom]]
* [[SantoriniPowerAtlas|Atlas: Titan Shouldering the Heavens]]
* [[SantoriniPowerDemeter|Demeter: Goddess of the Harvest]]
* [[SantoriniPowerHephaestus|Hephaestus: God of Blacksmiths]]
* [[SantoriniPowerHermes|Hermes: God of Travel]]
* [[SantoriniPowerMinotaur|Minotaur: Bull-headed Monster]]
* [[SantoriniPowerPan|Pan: God of the Wild]]
* [[SantoriniPowerPrometheus|Prometheus: Titan Benefactor of Mankind]]

===Advanced Gods===
* [[SantoriniPowerAphrodite|Aphrodite: Goddess of Love]]
* [[SantoriniPowerAres|Ares: God of War]]
* [[SantoriniPowerBia|Bia: Goddess of Violence]]
* [[SantoriniPowerChaos|Chaos: Primordial Nothingness]]
* [[SantoriniPowerCharon|Charon: Ferryman to the Underworld]]
* [[SantoriniPowerChronus|Chronus: God of Time]]
* [[SantoriniPowerCirce|Circe: Divine Enchantress]]
* [[SantoriniPowerDionysus|Dionysus: God of Wine]]
* [[SantoriniPowerEros|Eros: God of Desire]]
* [[SantoriniPowerHera|Hera: Goddess of Marriage]]
* [[SantoriniPowerHestia|Hestia: Goddess of Hearth and Home]]
* [[SantoriniPowerHypnus|Hypnus: God of Sleep]]
* [[SantoriniPowerLimus|Limus: Goddess of Famine]]
* [[SantoriniPowerMedusa|Medusa: Petrifying Gorgon]]
* [[SantoriniPowerMorpheus|Morpheus: God of Dreams]]
* [[SantoriniPowerPersephone|Persephone: Goddess of Spring Growth]]
* [[SantoriniPowerPoseidon|Poseidon: God of the Sea]]
* [[SantoriniPowerSelene|Selene: Goddess of the Moon]]
* [[SantoriniPowerTriton|Triton: God of the Waves]]
* [[SantoriniPowerZeus|Zeus: God of the Sky]]

===Golden Fleece Gods===
* [[SantoriniPowerClio|Clio: Muse of History]]
* [[SantoriniPowerEuropa|Europa & Talus: Queen and Guardian Automaton]]
* [[SantoriniPowerGaea|Gaea: Goddess of the Earth]]
* [[SantoriniPowerGraeae|Graeae: The Gray Hags]]
* [[SantoriniPowerHades|Hades: God of the Underworld]]
* [[SantoriniPowerHarpies|Harpies: Winged Menaces]]
* [[SantoriniPowerTerpsichore|Terpsichore: Muse of Dancing]]
* [[SantoriniPowerUrania|Urania: Muse of Astronomy]]

===Promo Gods===
* [[SantoriniPowerAsteria|Asteria: Goddess of Falling Stars]]
* [[SantoriniPowerCastor|Castor & Pollux: Mortal and Divine Brothers]]
* [[SantoriniPowerEris|Eris: Goddess of Discord]]
* [[SantoriniPowerHippolyta|Hippolyta: Queen of the Amazons]]
* [[SantoriniPowerHydra|Hydra: Many Headed Monster]]
* [[SantoriniPowerIris|Iris: Goddess of Rainbow]]
* [[SantoriniPowerMaenads|Maenads: Raving Ones]]
* [[SantoriniPowerNyx|Nyx: Goddess of Night]]
* [[SantoriniPowerPegasus|Pegasus: Winged Horse]]
* [[SantoriniPowerProteus|Proteus: Shapeshifting Sea God]]
* [[SantoriniPowerScylla|Scylla: Menacing Sea Monster]]
* [[SantoriniPowerTyche|Tyche: Goddess of Fortune]]

===Heroes===
* [[SantoriniPowerAchilles|Achilles: Volatile Warrior]]
* [[SantoriniPowerAdonis|Adonis: Devastalingly Handsome]]
* [[SantoriniPowerAtalanta|Atalanta: Swift Huntress]]
* [[SantoriniPowerBellerophon|Bellerophon: Tamer of Pegasus]]
* [[SantoriniPowerHeracles|Heracles: Doer of Great Deeds]]
* [[SantoriniPowerJason|Jason: Leader of the Argonauts]]
* [[SantoriniPowerMedea|Medea: Powerful Sorceress]]
* [[SantoriniPowerOdysseus|Odysseus: Cunning Leader]]
* [[SantoriniPowerPolyphemus|Polyphemus: Gigantic Cyclops]]
* [[SantoriniPowerTheseus|Theseus: Slayer of the Minotaur]]

==Update Log==
* 5th Sept 2020 Update: Apollo
* 8th Sept 2020 Update: Artemis

File:Santorini-Apollo.jpeg

2020-09-08T11:09:28Z

Tisaac:

SantoriniGuide

2020-09-01T09:26:38Z

Tisaac: Guide to play Santorini's power

Hi everyone. I and my team is now developing a full guide of all gods in Santorini. We have done a few simple gods and would like to post it somewhere in BGA.

However, BGAWiki would not be a good place since we have a full description of how to use the god and how to counter it. It would be too lengthy to happen on BGAWiki, since BGAWiki "strategy tips" gonna happen under our gameplay when we are playing.

We would like to ask for some help about this, like can developer create a new page for us to put all the tutorial for all gods? It would be good since it is more user friendly that player can simply press on which god they would like to learn. We have thought of posting on this forum, but this is not really a good idea since it would then be hard for players to find a specific post of a god.

I hope someone (even not developer) can give an advice in doing so! Thanks!

Credit to ArielFriedrichGauss, YTBlueBlueberry