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 DelayPlugin =FILENAME
 231 Named plugin will be loaded after other (nondelayed) plugins were loaded.
 232 .IR FILENAME
 233 is a name without path, but with extension, for example
 234 .IR libNullSound.so
 235 or
 236 .IR libNullSound.dll .
 237 You can use this parameter more than once.
 238
 239 .TP
 240 .BR SkipPlugin =FILENAME
 241 Named plugin will not be loaded.
 242 .IR FILENAME
 243 is a name without path, but with extension, for example
 244 .IR libNullSound.so
 245 or
 246 .IR libNullSound.dll .
 247 You can use this parameter more than once.
 248
 249 .TP
 250 .BR SaveAsOriginal =(0|1)
 251 Set this parameter to
 252 .IR 1 ,
 253 if you want to keep the save game compatible with the original engine.
 254
 255 .TP
 256 .BR CachePath =PATH
 257 User-writable directory where the engine caches uncompressed and temporary
 258 files.
 259
 260 .TP
 261 .BR GemRBPath =PATH
 262 Path to the GemRB installation. (To be obsoleted).
 263
 264 .TP
 265 .BR GUIScriptsPath =PATH
 266 Path to the directory with scripts controlling the game's GUI.
 267
 268 .TP
 269 .BR SavePath =PATH
 270 Path to the directory with save games. Note that this directory has to
 271 contain
 272 .I save/
 273 and/or eventually
 274 .I mpsave/
 275 subdirectories and that only these subdirectories contain the actual
 276 saved games.
 277
 278 .I SavePath
 279 defaults to
 280 .IR GamePath .
 281
 282 .TP
 283 .BR GameOnCD =(0|1)
 284 defaults to
 285 .IR 0 .
 286
 287
 288 .TP
 289 .BR GameDataPath =PATH
 290 Path to the original game's installed data files, relative to GamePath.
 291 Usually it's
 292 .IR data .
 293
 294
 295 .TP
 296 .BR GameOverridePath =PATH
 297 Path to the original game's override dir, relative to GamePath.
 298 Usually it's
 299 .IR override .
 300 Original games use this directory to place last-minute patches.
 301
 302 .TP
 303 .BR GemRBOverridePath =PATH
 304 Path where gemrb looks for its game override directory.
 305 It defaults to
 306 .IR GemRBPath .
 307 The original games hardcoded this information in the engine.
 308
 309
 310 .\"###################################################
 311 .SH FILES
 312 .PD 0
 313 .TP 20
 314 .B /usr/local/etc/gemrb.cfg
 315 system-wide configuration file
 316
 317 .TP
 318 .B /usr/local/share/gemrb/override/
 319 directory with
 320 .IR gemrb -distributed
 321 data files. These used to be hardcoded in the original engine. The files
 322 are sorted into directories for specific games.
 323
 324 .TP
 325 .B /usr/local/share/gemrb/GUIScripts/
 326 directory with Python scripts providing GUI setup and interaction. The files
 327 are sorted into directories for specific games.
 328
 329 .TP
 330 .B ~/.gemrb/gemrb.cfg
 331 .TP
 332 .B ~/.gemrb/override/
 333 .TP
 334 .B ~/.gemrb/GUIScripts/
 335 user's own configuration and data files.
 336 .TP
 337 .B ~/.gemrb/cache/
 338 cache directory
 339 .PD
 340
 341 .\"###################################################
 342 .SH BUGS
 343 Many.
 344 .I gemrb
 345 is still in an early development stage and not nearly complete.
 346
 347 If you stumble over something which is supposed to work, either make a bug report
 348 at http://sourceforge.net/projects/gemrb or come to IRC channel
 349 .I #GemRB
 350 at FreeNode.
 351
 352 .\"###################################################
 353 .SH AUTHOR
 354 The GemRB Project development team at http://gemrb.sourceforge.net
 355
 356 .\"###################################################
 357 .SH COPYING
 358 Copyright (C) 2003-2008 The GemRB Project
 359
 360 This program is free software; you can redistribute it and/or
 361 modify it under the terms of the GNU General Public License
 362 as published by the Free Software Foundation; either version 2
 363 of the License, or (at your option) any later version.
 364
 365 This program is distributed in the hope that it will be useful,
 366 but WITHOUT ANY WARRANTY; without even the implied warranty of
 367 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 368 GNU General Public License for more details.
 369
 370 You should have received a copy of the GNU General Public License
 371 along with this program; if not, write to the Free Software
 372 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 373
 374 .\"###################################################
 375 .\"End of file gemrb.man