From: Jaka K. <lyn...@us...> - 2011-06-30 18:25:43
|
gemrb: Infinity Engine emulator The branch master has been updated via b54206724c976f06dbc1736bd2d55d371be5eee0 (commit) via ce30113f2b623aa8e71783e13ba086c7606ac9f5 (commit) via c86e06e0e546124ae62d9c260e4ec7f164a0e434 (commit) via 8491c335af993be34ee19b5732c616b31d6016a3 (commit) via e1851e59051debb021cc25b5841b43d3ef534fe7 (commit) Summary of changes: gemrb.6.in | 291 ++++++++++++++++++++------------ gemrb/docs/en/GUIScript/ApplySpell.txt | 3 +- 2 files changed, 181 insertions(+), 113 deletions(-) from f82a787e57bec4676fd2b1d0dedf8f1a7684ee7c (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://gemrb.git.sourceforge.net/git/gitweb.cgi?p=gemrb/gemrb;a=commitdiff;h=b54206724c976f06dbc1736bd2d55d371be5eee0 commit b54206724c976f06dbc1736bd2d55d371be5eee0 Author: Jaka Kranjc <lyn...@us...> Date: Thu Jun 30 20:22:43 2011 +0200 gemrb.6.in: misc improvements diff --git a/gemrb.6.in b/gemrb.6.in index 1773e94..8dc0fc3 100644 --- a/gemrb.6.in +++ b/gemrb.6.in @@ -69,6 +69,12 @@ 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 @@ -132,7 +138,7 @@ The default is .TP .BR SkipIntroVideos =(0|1) -This parameter is meant for developers. If set to +If set to .IR 1 , the intro and logo videos are skipped to save developer's nerves. The default is .IR 0 . @@ -211,7 +217,7 @@ program found at .BR CD2 =PATH .TP .BR CDn =... -Path to the data files for the game's particular CDs. +Path to the data files for the game's particular CDs or any other data sources. .TP .BR GameOnCD =(0|1) @@ -221,7 +227,7 @@ defaults to .TP .BR CachePath =PATH User-writable directory where the engine caches uncompressed and temporary -files. +files. Defaults to a subdirectory of the current directory. .TP .BR GemRBPath =PATH @@ -229,14 +235,17 @@ 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. +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 . -The original games hardcoded this information in the engine. +The original games hardcoded this information in the engine. (To be obsoleted; 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 @@ -421,17 +430,17 @@ Many. 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 IRC channel +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.sourceforge.net +The GemRB Project development team at http://gemrb.org .\"################################################### .SH COPYING -Copyright (C) 2003-2008 The GemRB Project +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 http://gemrb.git.sourceforge.net/git/gitweb.cgi?p=gemrb/gemrb;a=commitdiff;h=ce30113f2b623aa8e71783e13ba086c7606ac9f5 commit ce30113f2b623aa8e71783e13ba086c7606ac9f5 Author: Jaka Kranjc <lyn...@us...> Date: Thu Jun 30 20:14:32 2011 +0200 gemrb.6.in: added missing cfg parameters diff --git a/gemrb.6.in b/gemrb.6.in index 9e2ac4d..1773e94 100644 --- a/gemrb.6.in +++ b/gemrb.6.in @@ -82,6 +82,19 @@ for various tweaks hardcoded in the GemRB engine. .BR GameName =STRING Arbitrary name of the game. It will be displayed in the window's title bar. +.TP +.BR GUIEnhancements =(0|1) +Set this to 1 to enable a few GUI enhancements, mostly in BG2. 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: @@ -219,6 +232,13 @@ Path to the GemRB installation. (To be obsoleted; preset at build time). Path to the directory with scripts controlling the game's GUI. .TP +.BR GemRBOverridePath =PATH +Path where GemRB looks for its game override directory. +It defaults to +.IR GemRBPath . +The original games hardcoded this information in the engine. + +.TP .BR SavePath =PATH Path to the directory with save games. Note that this directory has to contain @@ -246,11 +266,40 @@ Usually it's Original games use this directory to place last-minute patches. .TP -.BR GemRBOverridePath =PATH -Path where GemRB looks for its game override directory. -It defaults to -.IR GemRBPath . -The original games hardcoded this information in the engine. +.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 . + +.\"################################################### +.SH Input Parameters: + +.TP +.BR DoubleClickDelay =INT +Milisecond treshold for detecting a double click. The default is 250. + +.TP +.BR RepeatKeyDelay =INT +Milisecond treshold for detecting a repeated key press. The default is 250. + .\"################################################### .SH Development parameters: @@ -320,6 +369,19 @@ 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 http://gemrb.git.sourceforge.net/git/gitweb.cgi?p=gemrb/gemrb;a=commitdiff;h=c86e06e0e546124ae62d9c260e4ec7f164a0e434 commit c86e06e0e546124ae62d9c260e4ec7f164a0e434 Author: Jaka Kranjc <lyn...@us...> Date: Thu Jun 30 19:36:08 2011 +0200 gemrb.6.in: removed commented out options; both were put in the ini overrides diff --git a/gemrb.6.in b/gemrb.6.in index 60f9a79..9e2ac4d 100644 --- a/gemrb.6.in +++ b/gemrb.6.in @@ -82,13 +82,6 @@ for various tweaks hardcoded in the GemRB engine. .BR GameName =STRING Arbitrary name of the game. It will be displayed in the window's title bar. - -.\".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. - .\"################################################### .SH Video Parameters: @@ -116,13 +109,6 @@ Color depth of the game window (in bits per pixel). .BR Fullscreen =(0|1) Whether the game should run in fullscreen mode. -.\".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 miliseconds) before tooltips are displayed when the mouse is not moving. http://gemrb.git.sourceforge.net/git/gitweb.cgi?p=gemrb/gemrb;a=commitdiff;h=8491c335af993be34ee19b5732c616b31d6016a3 commit 8491c335af993be34ee19b5732c616b31d6016a3 Author: Jaka Kranjc <lyn...@us...> Date: Thu Jun 30 19:33:03 2011 +0200 gemrb.6.in: added subsections for config groups and reordered them accordingly diff --git a/gemrb.6.in b/gemrb.6.in index c337b85..60f9a79 100644 --- a/gemrb.6.in +++ b/gemrb.6.in @@ -59,7 +59,7 @@ binary and then run instead. .\"################################################### -.SH Configuration File +.SH CONFIGURATION .PD 0 A configuration file consists of pairs .IR PARAMETER=VALUE , @@ -69,7 +69,7 @@ more than once, only the last occurence is used. Empty lines and lines starting with `#' (hash sign) are ignored. -.B Parameters: +.SH General Parameters: .TP .BR GameType =(bg1|bg2|iwd|iwd2|how|pst) @@ -82,22 +82,6 @@ for various tweaks hardcoded in the GemRB engine. .BR GameName =STRING Arbitrary name of the game. It will be displayed in the window's title bar. -.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. .\".TP .\".BR INIConfig =FILE @@ -105,6 +89,8 @@ Path to the data files for the game's particular CDs. .\".IR GamePath . .\"E.g. for Baldur's Gate game it is baldur.ini. +.\"################################################### +.SH Video Parameters: .TP .BR Width =INT @@ -146,6 +132,29 @@ The 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. 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 . @@ -170,58 +179,8 @@ Volume of sound effects in percents. The default is Volume of PC or NPC voices in percents. The 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. 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 FogOfWar =(0|1) -If set to -.IR 1 , -the unexplored parts of an area are blacked out. It is enabled by default. - -.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 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 . +.\"################################################### +.SH Path parameters: .TP .BR CaseSensitive =(0|1) @@ -239,36 +198,26 @@ Set this parameter to on Unix-like systems. .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. +.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 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. - +.BR CD1 =PATH .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. +.BR CD2 =PATH +.TP +.BR CDn =... +Path to the data files for the game's particular CDs. .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. +.BR GameOnCD =(0|1) +defaults to +.IR 0 . .TP .BR CachePath =PATH @@ -298,18 +247,11 @@ defaults to .IR GamePath . .TP -.BR GameOnCD =(0|1) -defaults to -.IR 0 . - - -.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. @@ -324,6 +266,74 @@ It defaults to .IR GemRBPath . The original games hardcoded this information in the engine. +.\"################################################### +.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. + .\"################################################### .SH FILES http://gemrb.git.sourceforge.net/git/gitweb.cgi?p=gemrb/gemrb;a=commitdiff;h=e1851e59051debb021cc25b5841b43d3ef534fe7 commit e1851e59051debb021cc25b5841b43d3ef534fe7 Author: Jaka Kranjc <lyn...@us...> Date: Tue Jun 28 21:53:15 2011 +0200 ApplySpell.txt: mention the casterID parameter diff --git a/gemrb/docs/en/GUIScript/ApplySpell.txt b/gemrb/docs/en/GUIScript/ApplySpell.txt index 7bfc008..edcd308 100644 --- a/gemrb/docs/en/GUIScript/ApplySpell.txt +++ b/gemrb/docs/en/GUIScript/ApplySpell.txt @@ -1,5 +1,5 @@ -Prototype: GemRB.ApplySpell(PartyID, resref) +Prototype: GemRB.ApplySpell(PartyID, resref[, casterID]) Description: Applies a spell on the actor marked by PartyID. This function can be used to add abilities that are stored as spells (eg. innates) @@ -7,6 +7,7 @@ This function can be used to add abilities that are stored as spells (eg. innate Parameters: PartyID - the player character's index in the party resref - spell resource reference +casterID - global id of the desired caster Return value: N/A ----------------------------------------------------------------------- This is an automated email from the git hooks/post-receive script. -- gemrb: Infinity Engine emulator |