gemrb.6

   1 .\"Title and section
   2 .TH GEMRB 6
   3
   4 .\"###################################################
   5 .SH NAME
   6 .B gemrb
   7 \- emulator for Infinity Engine-based games
   8
   9 .\"###################################################
  10 .SH SYNOPSIS
  11 .B gemrb
  12 [-c config-file]
  13 .br
  14 .B torment
  15 .br
  16
  17 .\"###################################################
  18 .SH DESCRIPTION
  19 .I gemrb
  20 is an emulator for Infinity Engine-based games, fine RPGs like Baldur's Gate,
  21 Icewind Dale or Planescape: Torment.
  22
  23 .I gemrb
  24 is only an engine; to actually play anything you have to have
  25 data from the original games installed where they can be found by
  26 .IR gemrb .
  27
  28 .\"###################################################
  29 .SH OPTIONS
  30 .TP
  31 .B \-c
  32 .I FILE
  33 .br
  34 use other configuration file than default
  35 .IR gemrb.cfg .
  36
  37 .B Note:
  38 You can also use program's name as a mean to select the configuration file.
  39 For example, if the program's name is
  40 .I torment
  41 instead of
  42 .IR gemrb ,
  43 the engine first seaches for
  44 .I torment.cfg
  45 and only if it's not found it searches for
  46 .IR gemrb.cfg .
  47
  48 To use this feature, just create a symbolic link
  49 .I torment
  50 pointing to
  51 .I gemrb
  52 binary and run
  53 .IR torment .
  54
  55 .\"###################################################
  56 .SH Configuration File
  57 .PD 0
  58 Configuration file consists of pairs
  59 .IR PARAMETER=VALUE ,
  60 each on its own line. The case of PARAMETER is not significant,
  61 GameType is the same as GAMETYPE. If the same PARAMETER is defined
  62 more than once, only the last occurence is used.
  63
  64 Empty lines and lines starting with `#' (hash sign) are ignored.
  65
  66 .B Parameters:
  67
  68 .TP
  69 .BR GameType =(bg1|bg2|iwd|iwd2|how|pst)
  70 Type of the game. The value is a name of subdirectory in override/
  71 and GUIScripts/ directories
  72 with game type-specific files and scripts. It is at present also used
  73 for various tweaks hardcoded in GemRB engine.
  74
  75 .TP
  76 .BR GameName =STRING
  77 Arbitrary name of the game. It will be displayed in the window's title bar.
  78
  79 .TP
  80 .BR GamePath =PATH
  81 Path to the directory where the original game is installed. If you can't
  82 install the game under MS Windows or with WINE, you can try to unpack the data files
  83 with the
  84 .I unshield
  85 program found at
  86 .IR http://synce.sourceforge.net .
  87
  88 .TP
  89 .BR CD1 =PATH
  90 .TP
  91 .BR CD2 =PATH
  92 .TP
  93 .BR CDn =...
  94 Path to the data files for the game's particular CDs.
  95
  96 .\".TP
  97 .\".BR INIConfig =FILE
  98 .\"Name of the game's INI file, relative to
  99 .\".IR GamePath .
 100 .\"E.g. for Baldur's Gate game it is baldur.ini.
 101
 102
 103 .TP
 104 .BR Width =INT
 105 Game window width (in pixels).
 106
 107 .TP
 108 .BR Height =INT
 109 Game window height (in pixels).
 110
 111 .TP
 112 .BR Bpp =INT
 113 Color depth of the game window (in bits per pixel).
 114
 115 .TP
 116 .BR Fullscreen =(0|1)
 117 Whether the game should run in fullscreen mode. (Note that fullcreen mode is
 118 currently buggy).
 119
 120 .\".TP
 121 .\".BR ForceStereo =(0|1)
 122 .\"Some older games such as BG1 and PST need this parameter to be
 123 .\".IR 1 .
 124 .\"For other game types set it to
 125 .\".IR 0 .
 126
 127 .TP
 128 .BR TooltipDelay =INT
 129 Delay (in ms) before tooltips are displayed when the mouse is not moving.
 130 Reasonable number for this option is e.g.
 131 .IR 500 .
 132
 133 .TP
 134 .BR VolumeAmbients =INT
 135 Volume of ambient sounds in percents. The default is
 136 .IR 100 .
 137
 138 .TP
 139 .BR VolumeMovie =INT
 140 Volume during movie playback in percents. The default is
 141 .IR 100 .
 142
 143 .TP
 144 .BR VolumeMusic =INT
 145 Volume of background music in percents. The default is
 146 .IR 100 .
 147
 148 .TP
 149 .BR VolumeSFX =INT
 150 Volume of sound effects in percents. The default is
 151 .IR 100 .
 152
 153 .TP
 154 .BR VolumeVoices =INT
 155 Volume of PC or NPC voices in percents. The default is
 156 .IR 100 .
 157
 158
 159 .TP
 160 .BR SkipIntroVideos =(0|1)
 161 This parameter is meant for developers. If set to
 162 .IR 1 ,
 163 the intro and logo videos are skipped to save developer's nerves. The default is
 164 .IR 0 .
 165
 166 .TP
 167 .BR DrawFPS =(0|1)
 168 This parameter is meant for developers. If set to
 169 .IR 1 ,
 170 the current FPS (Frames per Second) value is drawn in the top left window corner. The default is
 171 .IR 0 .
 172
 173 .TP
 174 .BR FogOfWar =(0|1)
 175 This parameter is meant for developers. If set to
 176 .IR 1 ,
 177 the unexplored parts of an area are blacked out. Since the unexplored bitmap is
 178 not updated by actors yet, it's set to
 179 .I 0
 180 by default.
 181
 182 .TP
 183 .BR EnableCheatKeys =(0|1)
 184 This parameter is meant for developers. If set to
 185 .IR 1 ,
 186 certain keys allow you to inspect the internal state of objects, do forbidden things, etc.
 187 The keys are listed in the
 188 .I CheatKeys.txt
 189 file. Do NOT use this option unless you want to make your hands dirty :-). The default is
 190 .IR 0 .
 191
 192 .TP
 193 .BR ScriptDebugMode =(n)
 194 This parameter is meant for developers. It is a combination of bit values
 195
 196 .IR 1
 197 - count references,
 198
 199 .IR 2
 200 - display cutscene warnings,
 201
 202 .IR 4
 203 - display variable warnings,
 204
 205 .IR 8
 206 - display action warnings,
 207
 208 .IR 16
 209 - display trigger warnings.
 210
 211 The default is
 212 .IR 0 .
 213
 214 .TP
 215 .BR CaseSensitive =(0|1)
 216 When
 217 this parameter is set to
 218 .IR 1 ,
 219 the engine will try to find files regardless of their names' case at the cost
 220 of a slight speed penalty. This is especially important when using
 221 game files on CD-ROMs, where the files can't be renamed. Like
 222 many Windows programs, the original games use inconsistent mix
 223 of lower/upper case letters for naming and referencing their files.
 224
 225 Set this parameter to
 226 .I 1
 227 on Unix-like systems.
 228
 229 .TP
 230 .BR SaveAsOriginal =(0|1)
 231 Set this parameter to
 232 .IR 1 ,
 233 if you want to keep the save game compatible with the original engine.
 234
 235 .TP
 236 .BR CachePath =PATH
 237 User-writable directory where the engine caches uncompressed and temporary
 238 files.
 239
 240 .TP
 241 .BR GemRBPath =PATH
 242 Path to the GemRB installation. (To be obsoleted).
 243
 244 .TP
 245 .BR GUIScriptsPath =PATH
 246 Path to the directory with scripts controlling the game's GUI.
 247
 248 .TP
 249 .BR SavePath =PATH
 250 Path to the directory with save games. Note that this directory has to
 251 contain
 252 .I save/
 253 and/or eventually
 254 .I mpsave/
 255 subdirectories and that only these subdirectories contain the actual
 256 saved games.
 257
 258 .I SavePath
 259 defaults to
 260 .IR GamePath .
 261
 262 .TP
 263 .BR GameOnCD =(0|1)
 264 defaults to
 265 .IR 0 .
 266
 267
 268 .TP
 269 .BR GameDataPath =PATH
 270 Path to the original game's installed data files, relative to GamePath.
 271 Usually it's
 272 .IR data .
 273
 274
 275 .TP
 276 .BR GameOverridePath =PATH
 277 Path to the original game's override dir, relative to GamePath.
 278 Usually it's
 279 .IR override .
 280 Original games use this directory to place last-minute patches.
 281
 282 .TP
 283 .BR GemRBOverridePath =PATH
 284 Path where gemrb looks for its game override directory.
 285 It defaults to
 286 .IR GemRBPath .
 287 The original games hardcoded this information in the engine.
 288
 289
 290 .\"###################################################
 291 .SH FILES
 292 .PD 0
 293 .TP 20
 294 .B /usr/local/etc/gemrb.cfg
 295 system-wide configuration file
 296
 297 .TP
 298 .B /usr/local/share/gemrb/override/
 299 directory with
 300 .IR gemrb -distributed
 301 data files. These used to be hardcoded in the original engine. The files
 302 are sorted into directories for specific games.
 303
 304 .TP
 305 .B /usr/local/share/gemrb/GUIScripts/
 306 directory with Python scripts providing GUI setup and interaction. The files
 307 are sorted into directories for specific games.
 308
 309 .TP
 310 .B ~/.gemrb/gemrb.cfg
 311 .TP
 312 .B ~/.gemrb/override/
 313 .TP
 314 .B ~/.gemrb/GUIScripts/
 315 user's own configuration and data files.
 316 .TP
 317 .B ~/.gemrb/cache/
 318 cache directory
 319 .PD
 320
 321 .\"###################################################
 322 .SH BUGS
 323 Many.
 324 .I gemrb
 325 is still in an early development stage and not nearly complete.
 326
 327 If you stumble over something which is supposed to work, either make a bug report
 328 at http://sourceforge.net/projects/gemrb or come to IRC channel
 329 .I #GemRB
 330 at FreeNode.
 331
 332 .\"###################################################
 333 .SH AUTHOR
 334 The GemRB Project development team at http://gemrb.sourceforge.net
 335
 336 .\"###################################################
 337 .SH COPYING
 338 Copyright (C) 2003-2008 The GemRB Project
 339
 340 This program is free software; you can redistribute it and/or
 341 modify it under the terms of the GNU General Public License
 342 as published by the Free Software Foundation; either version 2
 343 of the License, or (at your option) any later version.
 344
 345 This program is distributed in the hope that it will be useful,
 346 but WITHOUT ANY WARRANTY; without even the implied warranty of
 347 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 348 GNU General Public License for more details.
 349
 350 You should have received a copy of the GNU General Public License
 351 along with this program; if not, write to the Free Software
 352 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 353
 354 .\"###################################################
 355 .\"End of file gemrb.man