src/client-conf.h

   1 /***************************************
   2 ** Tsunagari Tile Engine              **
   3 ** client-conf.h                      **
   4 ** Copyright 2011-2013 PariahSoft LLC **
   5 ***************************************/
   6
   7 // **********
   8 // Permission is hereby granted, free of charge, to any person obtaining a copy
   9 // of this software and associated documentation files (the "Software"), to
  10 // deal in the Software without restriction, including without limitation the
  11 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  12 // sell copies of the Software, and to permit persons to whom the Software is
  13 // furnished to do so, subject to the following conditions:
  14 //
  15 // The above copyright notice and this permission notice shall be included in
  16 // all copies or substantial portions of the Software.
  17 //
  18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  24 // IN THE SOFTWARE.
  25 // **********
  26
  27 #ifndef CLIENT_CONF_H
  28 #define CLIENT_CONF_H
  29
  30 #include <string>
  31 #include <vector>
  32
  33 #include "log.h"
  34 #include "vec.h"
  35
  36 /* Release version. */
  37 #define TSUNAGARI_RELEASE_VERSION "Tsunagari Tile Engine AlphaP4 Revision 4"
  38
  39 // === Required Data Paths ===
  40         /* Tsunagari config file. */
  41         #define CLIENT_CONF_PATH "./client.ini"
  42
  43         /* Base data file. */
  44         #define BASE_ZIP_PATH "../data/base.zip"
  45 // ===
  46
  47 // === Client.ini Default Values ===
  48         #define DEF_ENGINE_VERBOSITY  "verbose"
  49         #define DEF_ENGINE_HALTING    "fatal"
  50         #define DEF_WINDOW_WIDTH      640
  51         #define DEF_WINDOW_HEIGHT     480
  52         #define DEF_WINDOW_FULLSCREEN false
  53         #define DEF_CACHE_ENABLED     true
  54         #define DEF_CACHE_TTL         300
  55         #define DEF_CACHE_SIZE        100
  56 // ===
  57
  58 //! Game Movement Mode
  59 enum movement_mode_t {
  60         TURN,
  61         TILE,
  62         NOTILE
  63 };
  64
  65 //! Halting Mode
  66 enum halting_mode_t {
  67         HALT_FATAL,
  68         HALT_SCRIPT,
  69         HALT_ERROR
  70 };
  71
  72 //! Engine-wide user-confurable values.
  73 struct Conf {
  74         Conf();
  75
  76         /**
  77          * Check for missing required configuration variables.
  78          */
  79         bool validate(const std::string& filename);
  80
  81         std::string worldFilename;
  82         typedef std::vector<std::string> StringVector;
  83         StringVector dataPath;
  84         verbosity_t verbosity;
  85         movement_mode_t moveMode;
  86         halting_mode_t halting;
  87         icoord windowSize;
  88         bool fullscreen;
  89         bool audioEnabled;
  90         int musicVolume;
  91         int soundVolume;
  92         bool cacheEnabled;
  93         int cacheTTL;
  94         int cacheSize;
  95         int persistInit;
  96         int persistCons;
  97 };
  98 extern Conf conf;
  99
 100 bool parseConfig(const std::string& filename);
 101 bool parseCommandLine(int argc, char* argv[]);
 102
 103 #endif
 104