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

Game options and preferences: gameoptions.inc.php

From Board Game Arena
Revision as of 20:59, 18 June 2016 by Victoria la (talk | contribs) (Created page with "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: game variant ID sho...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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: 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:
                           //  beta=true => this option is in beta version right now.
                           //  nobeginner=true  =>  this option is not recommended for beginners
                           3 => array( 'name' => totranslate('option 3'),  'beta' => true, 'nobeginner' => true ),) )
                       )
           )


Note²: All options defined in this file should have a corresponding "game state labels" with the same ID (see "initGameStateLabels" in yourgame.game.php)


            self::initGameStateLabels ( array (
                       ...
                       "my_first_game_variant" => 100,
             ) );