gameoptions.inc.php

<?php

/**
 *------
 * BGA framework: © Gregory Isabelli <gisabelli@boardgamearena.com> & Emmanuel Colin <ecolin@boardgamearena.com>
 * ForestShuffle implementation : © Emmanuel Albisser <emmanuel.albisser@gmail.com>
 *
 * This code has been produced on the BGA studio platform for use on http://boardgamearena.com.
 * See http://en.boardgamearena.com/#!doc/Studio for more information.
 * -----
 *
 * gameoptions.inc.php
 *
 * ForestShuffle game options description
 * 
 * In this file, you can define your game options (= game variants).
 *   
 * Note: If your game has no variant, you don't have to modify this file.
 *
 * Note²: All options defined in this file should have a corresponding "game state labels"
 *        with the same ID (see "initGameStateLabels" in forestshuffle.game.php)
 *
 * !! It is not a good idea to modify this file when a game is running !!
 *
 */

require_once 'modules/php/constants.inc.php';

$game_options = [
    OPTION_SCORE => [
        'name' => totranslate('Score visible'),
        'values' => [
            OPTION_VISIBLE_SCORE => [
                'name' => totranslate('Yes'),
                'description' => totranslate('Play with live scoring'),
                'tmdisplay' => totranslate('Visible score'),
            ],
            OPTION_HIDDEN_SCORE => [
                'name' => totranslate('No'),
                'description' => totranslate('Play without live scoring'),
                'tmdisplay' => totranslate('Hidden score'),
            ],
        ],
        'default' => OPTION_VISIBLE_SCORE,
    ],
    OPTION_DRAFT_VARIANT => [
        'name' => totranslate('Draft variant'),
        'values' => [
            OPTION_NO_DRAFT => [
                'name' => totranslate('No Draft'),
                'description' => totranslate('Play normal game'),
                'tmdisplay' => totranslate('No Draft'),
            ],
            OPTION_DRAFT => [
                'name' => totranslate('Draft'),
                'description' => totranslate('Play draft during setup'),
                'tmdisplay' => totranslate('Draft game'),
            ],
        ],
        'default' => OPTION_NO_DRAFT
    ],
    OPTION_ALPINE_VARIANT => [
        'name' => totranslate('Alpine Shuffle expansion'),
        'values' => [
            OPTION_ALPINE => [
                'name' => totranslate('Yes'),
                'description' => totranslate('Play with alpine expansion'),
                'tmdisplay' => totranslate('With Alpine cards'),
            ],
            OPTION_NO_ALPINE => [
                'name' => totranslate('No'),
                'description' => totranslate('Play normal game'),
                'tmdisplay' => totranslate('Without Alpine cards'),
            ],
        ],
        'default' => OPTION_NO_ALPINE,
    ],
    // OPTION_EDGE_VARIANT => [
    //     'name' => totranslate('On the Edge expansion'),
    //     'values' => [
    //         OPTION_EDGE => [
    //             'name' => totranslate('Yes'),
    //             'description' => totranslate('Play with On the Edge expansion'),
    //             'tmdisplay' => totranslate('With the Edge cards'),
    //         ],
    //         OPTION_NO_EDGE => [
    //             'name' => totranslate('No'),
    //             'description' => totranslate('Play normal game'),
    //             'tmdisplay' => totranslate('Without On the Edge cards'),
    //         ],
    //     ],
    //     'default' => OPTION_EDGE, //TODO modify for prod
    // ],
];

/*
    
    // note: game variant ID should start at 100 (ie: 100, 101, 102, ...). The maximum is 199.
    100 => array(
                'name' => totranslate('my game option'),    
                'values' => array(

                            // A simple value for this option:
                            1 => array( 'name' => totranslate('option 1') )

                            // A simple value for this option.
                            // If this value is chosen, the value of "tmdisplay" is displayed in the game lobby
                            2 => array( 'name' => totranslate('option 2'), 'tmdisplay' => totranslate('option 2') ),

                            // Another value, with other options:
                            //  description => this text will be displayed underneath the option when this value is selected to explain what it does
                            //  beta=true => this option is in beta version right now (there will be a warning)
                            //  alpha=true => this option is in alpha version right now (there will be a warning, and starting the game will be allowed only in training mode except for the developer)
                            //  nobeginner=true  =>  this option is not recommended for beginners
                            //  firstgameonly=true  =>  this option is recommended only for the first game (discovery option)
                            3 => array( 'name' => totranslate('option 3'), 'description' => totranslate('this option does X'), 'beta' => true, 'nobeginner' => true )
                        ),
                'default' => 1
            ),*/



$game_preferences = [];