[2bb5de]: gemrb.1 Maximize Restore History

Download this file

gemrb.1    345 lines (281 with data), 8.0 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
.\"Title and section
.TH GEMRB 1
.\"###################################################
.SH NAME
.B gemrb
\- emulator for Infinity Engine-based games
.\"###################################################
.SH SYNOPSIS
.B gemrb
[-c config-file]
.br
.B torment
.br
.\"###################################################
.SH DESCRIPTION
.I gemrb
is an emulator for Infinity Engine-based games, fine RPGs like Baldur's Gate,
Icewind Dale or Planescape: Torment.
.I gemrb
is only an engine; to actually play anything you have to have
data from the original games installed where they can be found by
.IR gemrb .
.\"###################################################
.SH OPTIONS
.TP
.B \-c
.I FILE
.br
use other configuration file than default
.IR gemrb.cfg .
.B Note:
You can also use 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
.I gemrb
binary and run
.IR torment .
.\"###################################################
.SH Configuration File
.PD 0
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.
.B Parameters:
.TP
.BR GameType =(bg1|bg2|tob|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 GemRB engine.
.TP
.BR GameName =STRING
Name of the game, as it appears in the window title-bar.
.TP
.BR GamePath =PATH
Path to directory where the original game is installed. If you can't
install the game under MS Windows, you can try to unpack the data files
with
.I unshield
program found at
.IR http://synce.sourceforge.net .
.TP
.BR CD1 =PATH
.TP
.BR CD2 =PATH
.TP
.BR CDn =....
Path to data files from game's particular CDs.
.\".TP
.\".BR INIConfig =FILE
.\"Name of the game's INI file, relative to
.\".IR GamePath .
.\"E.g. for Baldur's Gate game it is baldur.ini.
.TP
.BR Width =INT
Game window width (in pixels).
.TP
.BR Height =INT
Game window height (in pixels).
.TP
.BR Bpp =INT
Color depth of game window, (in bits per pixel).
.TP
.BR Fullscreen =(0|1)
Whether the game should run in fullscreen mode. Note that fullcreen mode is
currently buggy.
.\".TP
.\".BR ForceStereo =(0|1)
.\"Some older games such as BG1 and PST need this parameter to be
.\".IR 1 .
.\"For other game types set it to
.\".IR 0 .
.TP
.BR TooltipDelay =INT
Delay (in ms) before tooltips are displayed when mouse is not moving.
Reasonable number for this option is e.g.
.IR 500 .
.TP
.BR VolumeAmbients =INT
Volume of ambient sounds, in percents. Default is
.IR 100 .
.TP
.BR VolumeMovie =INT
Volume during movie playback, in percents. Default is
.IR 100 .
.TP
.BR VolumeMusic =INT
Volume of background music, in percents. Default is
.IR 100 .
.TP
.BR VolumeSFX =INT
Volume of sound effects, in percents. Default is
.IR 100 .
.TP
.BR VolumeVoices =INT
Volume of PC or NPC voices, in percents. Default is
.IR 100 .
.TP
.BR SkipIntroVideos =(0|1)
This parameter is meant for developers. If set to
.IR 1 ,
the intro and logo videos are skipped to save developer's nerves. Default is
.IR 0 .
.TP
.BR DrawFPS =(0|1)
This parameter is meant for developers. If set to
.IR 1 ,
current FPS (Frames per Second) value is drawn in top left window corner. Default is
.IR 0 .
.TP
.BR FogOfWar =(0|1)
This parameter is meant for developers. If set to
.IR 1 ,
unexplored parts of an area are blacked out. Since the unexplored bitmap is
not updated by actors yet, it's set to
.I 0
by default.
.TP
.BR EnableCheatKeys =(0|1)
This parameter is meant for developers. If set to
.IR 1 ,
certain keys allow you to inspect internal state of objects, do forbidden things, etc. The keys are listed in
.I CheatKeys.txt
file. Do NOT use this option unless you want to make your hands dirty :-). 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.
Default is
.IR 0 .
.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 SaveAsOriginal =(0|1)
Set this parameter to
.IR 1 ,
if you want to keep the save game compatible with the original engine.
.TP
.BR CachePath =PATH
User-writable directory where the engine caches uncompressed and temporary
files.
.TP
.BR GemRBPath =PATH
Path to GemRB installation. Soon to be obsoleted.
.TP
.BR GUIScriptsPath =PATH
Path to directory with scripts controlling game's GUI.
.TP
.BR SavePath =PATH
Path to directory with save games. Note that this directory has to
contain
.I save/
and/or eventually
.I mpsave/
subdirectories and only these subdirectories contain the actual
saved games.
.I SavePath
defaults to
.IR GamePath .
.TP
.BR GameOnCD =(0|1)
.TP
.BR GameDataPath =PATH
Path to original game's installed data files, relative to GamePath.
Usually it's
.IR data .
???
.TP
.BR GameOverridePath =PATH
Path to original game's override dir, relative to GamePath.
Usually it's
.IR override .
Original games use this directory to place last-minute patches.
.\"###################################################
.SH FILES
.PD 0
.TP 20
.B /usr/local/etc/gemrb.cfg
system-wide configuration file
.TP
.B /usr/local/share/gemrb/override/
directory with
.IR gemrb -distributed
data files. These used to be hardcoded in the original engine. The files
are sorted into directories for specific games.
.TP
.B /usr/local/share/gemrb/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.
.I 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 ...... or come to IRC channel
.I #GemRB
at FreeNode.
.\"###################################################
.SH AUTHOR
The GemRB Project development team at http://gemrb.sourceforge.net
.\"###################################################
.SH COPYING
Copyright (C) 2003 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
.\"###################################################
.\"End of file gemrb.man