gemrb.6.in

.\"Title and section
.TH GEMRB 6

.\"###################################################
.SH NAME 
GemRB
\- emulator for Infinity Engine-based games

.\"###################################################
.SH SYNOPSIS
.B gemrb
[\-c
.IR CONFIG-FILE ]
.br
.B torment
.br

.\"###################################################
.SH DESCRIPTION
.B GemRB
is an emulator for Infinity Engine-based games, fine RPGs like Baldur's Gate,
Icewind Dale and Planescape: Torment.

.B GemRB
reimplements only the game engine. To actually play anything, you have to have
the data from the original game(s), installed or unpackaged where GemRB can find it.
See the
.I GamePath
and
.I CDn
settings in the engine configuration file below. A full install is recommended.

.\"###################################################
.SH OPTIONS
.TP
.BI \-c " FILE"
Use the specified configuration file
.IR FILE " instead"
of the default
.IR gemrb.cfg .  

.B Note:
You can also use the program's name as a mean to select the configuration file.
For example, if the program's name is 
.I torment 
instead of
.IR gemrb ,
the engine first seaches for 
.I torment.cfg 
and only if it's not found it searches for 
.IR gemrb.cfg .

To use this feature, just create a symbolic link
.I torment
pointing to the
.I gemrb
binary and then run
.IR torment
instead.

.\"###################################################
.SH CONFIGURATION
.PD 0
A configuration file consists of pairs
.IR PARAMETER=VALUE ,
each on its own line. The case of PARAMETER is not significant, 
GameType is the same as GAMETYPE. If the same PARAMETER is defined 
more than once, only the last occurence is used.

Empty lines and lines starting with `#' (hash sign) are ignored.

At least the
.I GameType
and 
.I GamePath
parameters need to be changed. That is often enough, so do not fiddle with the other paths too much.

.SH General Parameters:

.TP
.BR GameType =(auto|bg1|bg2|iwd|iwd2|how|pst)
Type of the game. The value is a name of subdirectory in override/ 
and GUIScripts/ directories
with game type-specific files and scripts. It is at present also used
for various tweaks hardcoded in the GemRB engine. To autodetect the game
type, use "auto".

.TP
.BR GameName =STRING
Arbitrary name of the game. It will be displayed in the window's title bar.

.TP
.BR Encoding =(default|polish|czech)
Specify language used in the game data. Except of polish version of BG1, it's
safe to leave it commented out.

.TP
.BR GUIEnhancements =INT
The value is a bitfield. Setit to 1 to enable a few GUI enhancements, mostly in BG2. 
Set to 2 or 3 to try to autoidentify items on transfer (if the character has enough lore). 
Disabled by default.

.TP
.BR EndianSwitch =(0|1)
Set this to 1 if you are running GemRB on a big-endian machine. Disabled by default.

.TP
.BR MultipleQuickSaves =(0|1)
EXPERIMENTAL. Set this to 1 if you want GemRB to keep multiple quicksaves around. Disabled by default.


.\"###################################################
.SH Video Parameters:

.TP
.BR Width =INT
Game window width (in pixels).

.B WARNING:
This is not arbitrary but depends on the game data. For custom resolutions
the widescreen mod needs to be used.

.TP
.BR Height =INT
Game window height (in pixels).

.B WARNING:
This is not arbitrary but depends on the game data. For custom resolutions
the widescreen mod needs to be used.

.TP
.BR Bpp =INT
Color depth of the game window (in bits per pixel).

.TP
.BR Fullscreen =(0|1)
Whether the game should run in fullscreen mode.

.TP
.BR TooltipDelay =INT
Delay (in miliseconds) before tooltips are displayed when the mouse is not moving.
A reasonable number for this option is e.g.
.IR 500 .
The default is
.IR 100 .

.TP
.BR SkipIntroVideos =(0|1)
If set to
.IR 1 ,
the intro and logo videos are skipped to save developer's nerves. The default is
.IR 0 .

.TP
.BR FogOfWar =(0|1)
If set to
.IR 1 ,
the unexplored parts of an area are blacked out. It is enabled by default.


.\"###################################################
.SH Audio Parameters:

.TP
.BR AudioDriver =(openal|sdlaudio|none)
Use the specified plugin as the audio driver. The default is openal, while
.I none
will disable all audio.

.TP
.BR VolumeAmbients =INT
Volume of ambient sounds in percents. The default is
.IR 100 .

.TP
.BR VolumeMovie =INT
Volume during movie playback in percents. The default is
.IR 100 .

.TP
.BR VolumeMusic =INT
Volume of background music in percents. The default is
.IR 100 .

.TP
.BR VolumeSFX =INT
Volume of sound effects in percents. The default is
.IR 100 .

.TP
.BR VolumeVoices =INT
Volume of PC or NPC voices in percents. The default is
.IR 100 .

.\"###################################################
.SH Path parameters:

.TP
.BR CaseSensitive =(0|1)
When 
this parameter is set to 
.IR 1 ,
the engine will try to find files regardless of their names' case at the cost
of a slight speed penalty. This is especially important when using
game files on CD-ROMs, where the files can't be renamed. Like 
many Windows programs, the original games use inconsistent mix
of lower/upper case letters for naming and referencing their files. 

Set this parameter to 
.I 1
on Unix-like systems.

.TP
.BR GamePath =PATH
Path to the directory where the original game is installed. If you can't
install the game under MS Windows or with WINE, you can try to unpack the data files
with the
.I unshield
program found at 
.IR http://synce.sourceforge.net .

.TP
.BR CD1 =PATH
.TP
.BR CD2 =PATH
.TP
.BR CDn =...
Path to the data files for the game's particular CDs or any other data sources.

.TP
.BR CachePath =PATH
User-writable directory where the engine caches uncompressed and temporary
files. Defaults to a subdirectory of the current directory.

.TP
.BR GemRBPath =PATH
Path to the GemRB installation. (To be obsoleted; preset at build time).

.TP
.BR GUIScriptsPath =PATH
Path to the directory with scripts controlling the game's GUI. (To be obsoleted; preset at build time).

.TP
.BR GemRBOverridePath =PATH
Path where GemRB looks for its game override directory.
It defaults to
.IR GemRBPath .
GemRB reuses some of the unused files from the original or replaces them
and this is the where they can be found. The path is preset at build time.
This directory has the highest priority when searching, so putting files in
the game override will not affect them. Use another directory and add it as
.IR ModPath
to the GemRB config.

.TP
.BR GemRBUnhardcodedPath =PATH
Path where GemRB looks for its unhardcoded engine data.
It defaults to
.IR GemRBPath .
The original games hardcoded this information in the engine. 
The path is preset at build time.

.TP
.I The following variables do not need to be altered, unless you are doing something really special!

.TP
.BR SavePath =PATH
Path to the directory with save games. Note that this directory has to
contain 
.I save/
and/or eventually
.I mpsave/
subdirectories and that only these subdirectories contain the actual
saved games.

.I SavePath
defaults to
.IR GamePath .

.TP
.BR GameDataPath =PATH
Path to the original game's installed data files, relative to GamePath.
Usually it's 
.IR data .

.TP
.BR GameOverridePath =PATH
Path to the original game's override dir, relative to GamePath.
Usually it's 
.IR override .
Original games use this directory to place last-minute patches.

.TP
.BR GameCharactersPath =PATH
Path to the original game's installed data files, relative to GamePath.
Usually it's 
.IR characters .

.TP
.BR GamePortraitsPath =PATH
Path to the original game's installed data files, relative to GamePath.
Usually it's 
.IR portraits .

.TP
.BR GameScriptsPath =PATH
Path to the original game's installed data files, relative to GamePath.
Usually it's 
.IR scripts .

.TP
.BR GameSoundsPath =PATH
Path to the original game's installed data files, relative to GamePath.
Usually it's 
.IR sounds .

.TP
.BR ModPath =PATH
Path where GemRB looks for additional engine override files.
It is not set by default. This directory has precedence over
.IR GemRBOverridePath .

.TP
.BR CustomFontPath =PATH
Path where GemRB looks for additional font files. It is meant to be used
with the TTF font plugin and fonts.2da as a way to specify where to look for
system or other external fonts. Check the online documentation for the details.
It is not set by default.

.\"###################################################
.SH Input Parameters:

.TP
.BR DoubleClickDelay =INT
Milisecond threshold for detecting a double click. The default is 250.

.TP
.BR RepeatKeyDelay =INT
Milisecond threshold for detecting a repeated key press. The default is 250.

.TP
.BR UseSoftKeyboard =(0|1)
Toggles use of software keyboard on devices that support one. It pops up when
text input is required. Disabled by default.

.TP
.BR NumFingScroll =(2|3|4)
Number of fingers for multitouch to trigger scrolling. The default is 2.

.TP
.BR NumFingKboard =(2|3|4)
Number of fingers for multitouch to open up the software keyboard. The default is 3.
The value should not be equal to
.IR NumFingScroll " above."

.TP
.BR NumFingInfo =(2|3|4)
Number of fingers for multitouch to emulate a special keypress (alt, tab). The default is 2.

.TP
.BR MouseFeedback =(0-3)
Bitfield with reserved bits for disabling the mouse.
  Show mouse+tooltips = 0 (default)
  Hide mouse          = 1
  Hide tooltips       = 2
  Hide mouse+tooltips = 3

.\"###################################################
.SH Development parameters:

.TP
.BR EnableCheatKeys =(0|1)
This parameter is meant for developers. If set to
.IR 1 ,
certain keys allow you to inspect the internal state of objects, do forbidden things, etc.
The keys are listed in the
.I CheatKeys.txt
file. Do NOT use this option unless you want to make your hands dirty :-). The default is
.IR 0 .

.TP
.BR DrawFPS =(0|1)
This parameter is meant for developers. If set to
.IR 1 ,
the current FPS (Frames per Second) value is drawn in the top left window corner. The default is
.IR 0 .

.TP
.BR ScriptDebugMode =(n)
This parameter is meant for developers. It is a combination of bit values

.IR 1
- count references,

.IR 2
- display cutscene warnings,

.IR 4
- display variable warnings,

.IR 8
- display action warnings,

.IR 16
- display trigger warnings.

The default is
.IR 0 .

.TP
.BR DelayPlugin =FILENAME
Named plugin will be loaded after other (nondelayed) plugins were loaded.
.IR FILENAME 
is a name without path, but with extension, for example
.IR libNullSound.so 
or
.IR libNullSound.dll .
You can use this parameter more than once.

.TP
.BR SkipPlugin =FILENAME
Named plugin will not be loaded.
.IR FILENAME 
is a name without path, but with extension, for example
.IR libNullSound.so 
or
.IR libNullSound.dll .
You can use this parameter more than once.

.TP
.BR SaveAsOriginal =(0|1)
Set this parameter to
.IR 1 ,
if you want to keep the save game compatible with the original engine. It is enabled by default.

.TP
.BR KeepCache =(0|1)
Set this parameter to
.IR 1 ,
if you want to keep the cache after exiting GemRB. It is disabled by default.

.TP
.BR IgnoreOriginalINI =(0|1)
Set this parameter to
.IR 1 ,
if you want to ignore the settings from the original configuration files - baldur.ini
/ icewind.ini / torment.ini. It is disabled by default.


.\"###################################################
.SH FILES
.PD 0
.TP
.B @SYSCONF_DIR@/gemrb.cfg
system-wide configuration file

.TP
.B @DATA_DIR@/override/
directory with 
.BR GemRB -distributed
data files. These used to be hardcoded in the original engine. The files
are sorted into directories for specific games.

.TP
.B @DATA_DIR@/GUIScripts/
directory with Python scripts providing GUI setup and interaction. The files
are sorted into directories for specific games.

.TP
.B ~/.gemrb/gemrb.cfg
.TP
.B ~/.gemrb/override/
.TP
.B ~/.gemrb/GUIScripts/
user's own configuration and data files.
.TP
.B ~/.gemrb/cache/
cache directory
.PD

.\"###################################################
.SH BUGS
Many.
.B GemRB
is still in an early development stage and not nearly complete. 

If you stumble over something which is supposed to work, either make a bug report
at http://sourceforge.net/projects/gemrb or come to the official IRC channel 
.I #GemRB
at FreeNode.

.\"###################################################
.SH AUTHOR
The GemRB Project development team at http://gemrb.org

.\"###################################################
.SH COPYING
Copyright (C) 2003-2011 The GemRB Project

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

.\"###################################################
.\"End of file gemrb.man