Release 4.3.8

README.md

@@ -13,12 +13,38 @@ A set of engine modifications for the classic game Fallout 2 in the form of a DL
 - Many additional features for users, such as item highlight button, party member control, etc.
 - Extended scripting capabilities for modders (many new opcodes to control sfall features as well as previously unavailable vanilla engine functions)
 
-
 Original author: **Timeslip**
 
-Original description: A set of engine modifications for the classic game Fallout 2 by Interplay. Includes fixes for bugs in the original engine, allows fallout to run correctly on modern operating systems, and adds additional features for modders.
+Original description: A set of engine modifications for the classic game Fallout 2 by Interplay. Includes fixes for bugs in the original engine, allows Fallout to run correctly on modern operating systems, and adds additional features for modders.
+
+## Installation
+
+- Download `sfall_*.7z` from the [release archive](https://sourceforge.net/projects/sfall/files/).
+
+- Extract `ddraw.dll`, `ddraw.ini`, `sfall-mods.ini`, `sfall.dat`, and `data` folder to Fallout's base directory (i.e. the one that contains `fallout2.exe`).
+
+- __Important Note:__\
+  If you are using a mod that already included sfall (e.g. killap's [Unofficial Patch](https://github.com/BGforgeNet/Fallout2_Unofficial_Patch) or [Restoration Project](https://github.com/BGforgeNet/Fallout2_Restoration_Project)), then that mod has probably included a custom modified `ddraw.ini`. In that case, overwriting it with sfall's vanilla `ddraw.ini` will be likely break your game. Instead, only overwrite `ddraw.dll`, and keep the mod's existing copy of `ddraw.ini`. (Or, if you know what you're doing, you can merge them together by hand.)
+
+- The folder `translations` contains translations of some of the strings that sfall displays in the game. To use a translation, copy this folder to Fallout's base directory too, and then in `ddraw.ini` change the __TranslationsINI__ setting to `.\translations\<your language>.ini`.
+
+## Uninstallation
+
+Delete `ddraw.dll`, `ddraw.ini`, `sfall-mods.ini`, and `sfall.dat` from your Fallout directory. Also, delete `gl_highlighting.int` and `gl_partycontrol.int` from Fallout's `data\scripts\` directory.
+
+## Usage
+
+This mod is configured via the `ddraw.ini` and `sfall-mods.ini` files, which can be opened with any text editor. Details of every configerable option are included in those files. Where a comment refers to a DX scancode, the complete list of codes can be found at the link below:\
+https://kippykip.com/b3ddocs/commands/scancodes.htm
+
+In a default installation using an unmodified copy of `ddraw.ini`, the middle mouse button will be set to switch between weapons and the mouse wheel will be set to scroll through any menus that respond to the up/down arrow keys. Holding Ctrl and hitting numpad keys 0 to 6 (with Num Lock off) will adjust the game speed. Holding left Ctrl will let you move a whole stack of items at once. Pressing left Shift will highlight items on the ground. The script extender and any engine fixes are also enabled. Most of the options that change gameplay in some way not originally intended by the developers are disabled.
+
+For [__Wine__](https://www.winehq.org/) users:\
+You need to set DLL overrides for `ddraw.dll` to __"native, builtin"__ in `winecfg` or use `WINEDLLOVERRIDES="ddraw=n,b"` to run Fallout from the command line. If you want to play alternative sound files, you'll also need to install GStreamer Good 32-bit plugins.
+
+## Additional info
 
----
-#### Fallout Engine IDA Database
-[Download for IDA Pro 6.8](https://www.dropbox.com/s/tm0nyx0lnk4yui0/Fallout_1_and_2_IDA68.rar?dl=1 "Download from Dropbox")
- | [Download for IDA Pro 7.0](https://www.dropbox.com/s/61srq09pn8grfpu/Fallout_1_and_2_IDA70.rar?dl=1 "Download from Dropbox") (comments are in Russian)
+* [Changelog](CHANGELOG.md)
+* [Scripting Documentation](https://sfall-team.github.io/sfall/)
+* Fallout Engine IDA Database: [for IDA Pro 6.8](https://www.dropbox.com/s/tm0nyx0lnk4yui0/Fallout_1_and_2_IDA68.rar?dl=1 "Download from Dropbox") | [for IDA Pro 7.0](https://www.dropbox.com/s/61srq09pn8grfpu/Fallout_1_and_2_IDA70.rar?dl=1 "Download from Dropbox") (comments are in Russian)
+* [Fallout 2 Reference Edition](https://github.com/alexbatalov/fallout2-re)

artifacts/config_files/Translations.ini

@@ -11,6 +11,8 @@ PartyLvlMsg=Lvl:
 PartyACMsg=AC:
 PartyAddictMsg=Addict
 NPCPickupFail=%s cannot pick up the item.
+AmmoInfoGlovz=Div: DR/%d, DT/%d
+AmmoInfoYAAM=DT Mod: %d
 
 PartyOrderAttackHuman=I'll take care of it.|Okay, I got it.|Sounds like a plan.
 PartyOrderAttackCreature=::Growl::

artifacts/ddraw.ini

@@ -1,5 +1,5 @@
 ;sfall configuration settings
-;v4.3.7
+;v4.3.8
 
 [Main]
 ;Set to 1 to enable the built-in High Resolution Patch mode that is similar to the hi-res patch by Mash
@@ -16,18 +16,16 @@ UseCommandLine=0
 
 ;XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 [ExtraPatches]
-;This section allows you to set multiple paths to folders containing mods or patches that will be loaded by the game
-;If DataLoadOrderPatch is enabled, the data load order is:
-;master_patches > critter_patches > [extra patches] > patchXXX.dat > sfall.dat > critter_dat > f2_res_patches > f2_res_dat > master_dat
+;This section allows you to set multiple paths to folders containing mods or patches
 ;Paths to folders and Fallout .dat files are supported
-;The PatchFile## options are available from 0 to 99. Larger numbers take precedence over smaller numbers (same as patchXXX.dat)
+;The PatchFileXX options are available from 0 to 99. Larger numbers take precedence over smaller numbers (same as patchXXX.dat)
+;Starting from 4.2.6, the game will automatically search and load custom .dat files (or folders named as .dat files) from <GameRoot>\mods\
+;The load order of files in the folder will be in reverse alphabetical order of the filenames
+;Autoloaded files will have a higher priority than the files specified in the PatchFileXX options
+;The complete data load order is:
+;master_patches > critter_patches > mods > PatchFile99..PatchFile0 > patchXXX.dat > sfall.dat > critter_dat > f2_res_patches > f2_res_dat > master_dat
 ;PatchFile0=mods\RP_data
-
-;Path to the folder in which the game will automatically search and load custom files (by *.dat mask, including folders)
-;The data load order of the files in the folder will be in reverse alphabetical order of the filenames
-;The files placed in this folder will have higher priority than the PatchFile## options
-;This option has no effect in 4.2.6 or later. The path is fixed to <GameRoot>\mods\
-;AutoSearchPath=mods
+;PatchFile1=
 
 ;XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 [Speed]
@@ -281,7 +279,7 @@ UseFileSystemOverride=0
 
 ;Set to 1 to use the modified data load order for the engine to find game data
 ;Original: patchXXX.dat > critter_patches > critter_dat > f2_res_patches > f2_res_dat > master_patches > master_dat
-;Modified: master_patches > critter_patches > patchXXX.dat > critter_dat > f2_res_patches > f2_res_dat > master_dat
+;Modified: master_patches > critter_patches > extra_patches > patchXXX.dat > sfall.dat > critter_dat > f2_res_patches > f2_res_dat > master_dat
 ;This option is always enabled in 4.3/3.8.30 or later. The information is left for reference only
 DataLoadOrderPatch=1
 
@@ -350,7 +348,7 @@ ExtraKillTypes=0
 ;0 - Fallout default
 ;1 - Glovz's Damage Fix
 ;2 - Glovz's Damage Fix with Damage Multiplier tweak
-;5 - Haenlomal's Yet Another Ammo Mod.
+;5 - Haenlomal's Yet Another Ammo Mod
 DamageFormula=0
 
 ;Prevents you from using 0 to escape from dialogue at any time.
@@ -430,7 +428,7 @@ CorpseDeleteTime=6
 ;Set a number of milliseconds to idle each input loop
 ;Set to -1 to disable
 ;Set to 0 to idle only if other processes are waiting for processor time (WinXP/2000: if processes have equal priority)
-;Set to 1 (or some higher number if needed) to prevent 100% CPU use. The maximum is 30
+;Set to 1 (or some higher number if needed) to prevent 100% CPU use. The maximum is 50
 ProcessorIdle=-1
 
 ;Set to 1 if using the hero appearance mod
@@ -631,9 +629,6 @@ DialogPanelAnimDelay=33
 ;Controls the speed of pipboy alarm clock animations (lower - faster; valid range: 0..127)
 PipboyTimeAnimDelay=50
 
-;Set to 1 to stack empty identical weapons, no matter what type of ammo was loaded before
-StackEmptyWeapons=0
-
 ;Changes the way weapon reloading works when you drag ammo onto a weapon in the inventory
 ;Set to -1 to disable (vanilla behavior with the 'Move Items' window)
 ;Set to 0 to use all the ammo boxes to reload
@@ -701,9 +696,6 @@ SkipLoadingGameSettings=0
 ;The formula for the duration in ticks is: 10 * (value - 3 * EN)
 KnockoutTime=35
 
-;Set to 1 to display sfall built-in credits at the bottom of credits.txt contents instead of at the top
-CreditsAtBottom=0
-
 ;XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 ; Critical modding options - the following options should be changed with caution
 ;XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
@@ -754,7 +746,7 @@ AIBestWeaponFix=1
 AIDrugUsePerfFix=0
 
 ;Set to 1 to fix the bug of using First Aid/Doctor skills when using them on the player
-;This will cause the party member to apply his/her skills when you use First Aid/Doctor skills on the player, but only if
+;This will cause the party member to perform First Aid/Doctor skills when you use them on the player, but only if
 ;the player is standing next to the party member
 ;Note that because the related engine function is not fully implemented, enabling this option without a global script
 ;that overrides First Aid/Doctor functions has very limited usefulness

artifacts/example_mods/AmmoMod/AmmoMod.ini

@@ -0,0 +1,201 @@
+;Example Ammo INI for vanilla damage formula
+
+; PID_EXPLOSIVE_ROCKET
+[1]
+pid=14
+ac_adjust=0
+dr_adjust=-25
+dam_mult=1
+dam_div=1
+
+; PID_10MM_JHP
+[2]
+pid=29
+ac_adjust=0
+dr_adjust=25
+dam_mult=2
+dam_div=1
+
+; PID_10MM_AP
+[3]
+pid=30
+ac_adjust=0
+dr_adjust=-25
+dam_mult=1
+dam_div=2
+
+; PID_44_MAGNUM_JHP
+[4]
+pid=31
+ac_adjust=0
+dr_adjust=20
+dam_mult=2
+dam_div=1
+
+; PID_FLAMETHROWER_FUEL
+[5]
+pid=32
+ac_adjust=-20
+dr_adjust=25
+dam_mult=1
+dam_div=1
+
+; PID_14MM_AP
+[6]
+pid=33
+ac_adjust=0
+dr_adjust=-50
+dam_mult=1
+dam_div=2
+
+; PID_223_FMJ
+[7]
+pid=34
+ac_adjust=-20
+dr_adjust=-20
+dam_mult=1
+dam_div=1
+
+; PID_5MM_JHP
+[8]
+pid=35
+ac_adjust=0
+dr_adjust=35
+dam_mult=2
+dam_div=1
+
+; PID_5MM_AP
+[9]
+pid=36
+ac_adjust=0
+dr_adjust=-35
+dam_mult=1
+dam_div=2
+
+; PID_ROCKET_AP
+[10]
+pid=37
+ac_adjust=-15
+dr_adjust=-50
+dam_mult=1
+dam_div=1
+
+; PID_SMALL_ENERGY_CELL
+[11]
+pid=38
+ac_adjust=0
+dr_adjust=0
+dam_mult=1
+dam_div=1
+
+; PID_MICRO_FUSION_CELL
+[12]
+pid=39
+ac_adjust=0
+dr_adjust=0
+dam_mult=1
+dam_div=1
+
+; PID_SHOTGUN_SHELLS
+[13]
+pid=95
+ac_adjust=-10
+dr_adjust=0
+dam_mult=1
+dam_div=1
+
+; PID_44_FMJ_MAGNUM
+[14]
+pid=111
+ac_adjust=0
+dr_adjust=-20
+dam_mult=1
+dam_div=1
+
+; PID_9MM_BALL
+[15]
+pid=121
+ac_adjust=0
+dr_adjust=0
+dam_mult=1
+dam_div=1
+
+; PID_BBS
+[16]
+pid=163
+ac_adjust=0
+dr_adjust=0
+dam_mult=1
+dam_div=1
+
+; PID_ROBO_ROCKET_AMMO
+[17]
+pid=274
+ac_adjust=0
+dr_adjust=-25
+dam_mult=1
+dam_div=1
+
+; PID_45_CALIBER_AMMO
+[18]
+pid=357
+ac_adjust=0
+dr_adjust=0
+dam_mult=1
+dam_div=1
+
+; PID_2MM_EC_AMMO
+[19]
+pid=358
+ac_adjust=-30
+dr_adjust=-20
+dam_mult=3
+dam_div=2
+
+; PID_4_7MM_CASELESS
+[20]
+pid=359
+ac_adjust=-5
+dr_adjust=-10
+dam_mult=3
+dam_div=2
+
+; PID_9MM_AMMO
+[21]
+pid=360
+ac_adjust=0
+dr_adjust=10
+dam_mult=1
+dam_div=2
+
+; PID_HN_NEEDLER_CARTRIDGE
+[22]
+pid=361
+ac_adjust=-10
+dr_adjust=0
+dam_mult=1
+dam_div=1
+
+; PID_HN_AP_NEEDLER_CARTRIDGE
+[23]
+pid=362
+ac_adjust=-10
+dr_adjust=0
+dam_mult=2
+dam_div=1
+
+; PID_7_62MM_AMMO
+[24]
+pid=363
+ac_adjust=-5
+dr_adjust=-10
+dam_mult=1
+dam_div=1
+
+; PID_FLAMETHROWER_FUEL_MK_II
+[25]
+pid=382
+ac_adjust=-20
+dr_adjust=0
+dam_mult=1
+dam_div=1

artifacts/example_mods/rain/weather.ini

@@ -352,7 +352,7 @@ special=60
 
 
 ;Each map has 2 variables
-; r{index}=region  # corrisponds to a region section above
+; r{index}=region  # corresponds to a region section above
 ; a{index]=type    # set to 0 for no weather or 1 for normal weather
 [Maps]
 
@@ -547,7 +547,7 @@ r70=16 ;cavern encounter 1
 a70=0
 r71=16 ;cavern encounter 2
 a71=0
-r72=16 ;cavern encoutner 3
+r72=16 ;cavern encounter 3
 a72=0
 r73=16 ;cavern encounter 4
 a73=0

artifacts/mods/gl_partycontrol.ssl

@@ -11,14 +11,10 @@
 
 */
 
-#include "..\headers\define.h"
-//#include "..\headers\command.h"
+#include "..\headers\global.h"
+#include "..\headers\critrpid.h"
 #include "main.h"
 
-#define OBJ_DATA_LIGHT_DISTANCE     (0x6C)
-#define OBJ_DATA_LIGHT_INTENSITY    (0x70)
-#define PID_PLAYER                  (16777216)
-
 procedure start;
 procedure AllowControl(variable pid);
 procedure SetLight(variable critter, variable int, variable dist);

artifacts/scripting/README.md

@@ -22,4 +22,4 @@ This folder contains documentation about sfall scripting extensions.
     arrays.md - manual for sfall arrays
 
 If you are/will be using sfall Script Editor, don't forget to check out new compiler documentation in **.\compiler\sslc_readme.md**.
-There are numerious new syntax features and extensions to SSL (Star-Trek Scripting Language).
+There are numerous new syntax features and extensions to SSL (Star-Trek Scripting Language).

artifacts/scripting/README.txt

@@ -22,4 +22,4 @@ This folder contains documentation about sfall scripting extensions.
     arrays.html - manual for sfall arrays
 
 If you are/will be using sfall Script Editor, don't forget to check out new compiler documentation in .\compiler\sslc_readme.html.
-There are numerious new syntax features and extensions to SSL (Star-Trek Scripting Language).
+There are numerous new syntax features and extensions to SSL (Star-Trek Scripting Language).