Release 4.3.3

* if the save is on the same map, and while in the game.

.github/workflows/build.yml

@@ -0,0 +1,51 @@
+name: Build
+
+on:
+ push:
+  branches:
+  - 'develop'
+  - 'github-action'
+  paths:
+  - '.github/workflows/build.yml'
+  - 'action.yml'
+  - 'sfall/**'
+
+jobs:
+ Build:
+  name:    sfall
+  runs-on: windows-latest
+  steps:
+
+  - name: Clone sfall
+    uses: actions/checkout@v2
+
+  # Action is used twice for self-testing only
+  # DevXP build results are intentionally *not* included in artifact
+
+  - name: ReleaseXP build
+    id:   build
+    uses: ./
+    with:
+     release-xp: true
+
+  - name: DevXP build
+    uses: ./
+    with:
+     dev-xp: true
+
+  - name:  Prepare artifact
+    run:   |
+           :
+           mkdir -p sfall-build
+
+           cp artifacts/ddraw.ini sfall-build
+           cp artifacts/sfall.dat sfall-build
+           cp "${{ steps.build.outputs.release-xp }}" sfall-build
+    shell: bash
+
+  - name: Upload artifacts
+    uses: actions/upload-artifact@v2
+    with:
+     name:           sfall-build
+     path:           sfall-build
+     retention-days: 14

.github/workflows/gh-pages.yml

@@ -0,0 +1,34 @@
+name: github pages
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: |
+          sudo apt -y -qq install bundler python3-pip
+          pip3 install ruamel.yaml --user
+
+      - name: Build
+        run: ./docs/generate.sh
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/_site
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'

.gitignore

@@ -55,8 +55,10 @@ nb-configuration.xml
 # Build results
 [Dd]ebug/
 [Dd]ebugPublic/
+[Dd]evXP
 [Rr]elease/
 [Rr]eleases/
+[Rr]eleaseXP/
 x64/
 x86/
 build/
@@ -222,3 +224,9 @@ FakesAssemblies/
 # Visual Studio 6 workspace options file
 *.opt
 sfall/postbuild.cmd
+
+# jekyll build files
+docs/_site
+docs/.sass-cache
+docs/.jekyll-metadata
+docs/pages/*.md

DebugEditor/DebugEditor.Designer.cs

@@ -23,6 +23,7 @@
         /// the contents of this method with the code editor.
         /// </summary>
         private void InitializeComponent() {
+            this.components = new System.ComponentModel.Container();
             this.dataGridView1 = new System.Windows.Forms.DataGridView();
             this.Column0 = new System.Windows.Forms.DataGridViewTextBoxColumn();
             this.Column1 = new System.Windows.Forms.DataGridViewTextBoxColumn();
@@ -34,6 +35,7 @@
             this.bSGlobals = new System.Windows.Forms.Button();
             this.bArrays = new System.Windows.Forms.Button();
             this.bEdit = new System.Windows.Forms.Button();
+            this.redrawTimer = new System.Windows.Forms.Timer(this.components);
             this.bCrittersLvar = new System.Windows.Forms.Button();
             ((System.ComponentModel.ISupportInitialize)(this.dataGridView1)).BeginInit();
             this.SuspendLayout();
@@ -154,6 +156,11 @@
             this.bEdit.UseVisualStyleBackColor = true;
             this.bEdit.Click += new System.EventHandler(this.bEdit_Click);
             // 
+            // redrawTimer
+            // 
+            this.redrawTimer.Interval = 200;
+            this.redrawTimer.Tick += new System.EventHandler(this.timer1_Tick);
+            // 
             // bCrittersLvar
             // 
             this.bCrittersLvar.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Bottom | System.Windows.Forms.AnchorStyles.Left)));
@@ -202,6 +209,7 @@
         private System.Windows.Forms.DataGridViewTextBoxColumn Column1;
         private System.Windows.Forms.DataGridViewTextBoxColumn Column2;
         private System.Windows.Forms.DataGridViewTextBoxColumn Column3;
+        internal System.Windows.Forms.Timer redrawTimer;
         private System.Windows.Forms.Button bCrittersLvar;
 
     }

DebugEditor/DebugEditor.cs

@@ -137,6 +137,7 @@ namespace FalloutClient {
                 sr.Close();
             }
             Redraw();
+            redrawTimer.Start();
         }
 
         private void DebugEditor_FormClosing(object sender, FormClosingEventArgs e) {
@@ -188,6 +189,7 @@ namespace FalloutClient {
             default:
                 return;
             }
+            redrawTimer.Stop();
             if (e.ColumnIndex == 2) {
                 string str = dataGridView1.Rows[e.RowIndex].Cells[e.ColumnIndex].Value.ToString();
                 int val;
@@ -211,11 +213,13 @@ namespace FalloutClient {
                     connection.WriteInt(converter.GetAsInt(val));
                 }
             }
+            redrawTimer.Start();
         }
 
         private void bEdit_Click(object sender, EventArgs e) {
             if (dataGridView1.SelectedRows.Count == 0) return;
             int i = (int)dataGridView1.SelectedRows[0].Tag;
+            redrawTimer.Stop();
             switch (mode) {
             case Mode.Arrays: {
                     DataType[] types = new DataType[connection.ArrayLengths[i]];
@@ -333,6 +337,7 @@ namespace FalloutClient {
                 }
                 break;
             }
+            redrawTimer.Start();
         }
 
         private void bCrittersLvar_Click(object sender, EventArgs e) {
@@ -381,5 +386,9 @@ namespace FalloutClient {
         private void dataGridView1_RowsAdded(object sender, DataGridViewRowsAddedEventArgs e) {
             dataGridView1.Rows[e.RowIndex].Tag = e.RowIndex;
         }
+
+        private void timer1_Tick(object sender, EventArgs e) {
+            connection.WriteDataType(DataTypeSend.RedrawGame);
+        }
     }
 }

DebugEditor/DebugEditor.resx

@@ -129,4 +129,7 @@
   <metadata name="Column3.UserAddedColumn" type="System.Boolean, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
     <value>True</value>
   </metadata>
+  <metadata name="redrawTimer.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
+    <value>17, 17</value>
+  </metadata>
 </root>

DebugEditor/EditorWindow.cs

@@ -48,8 +48,10 @@ namespace FalloutClient {
         }
 
         public static string[] ShowEditor(DebugEditor form, string[] names, DataType[] types, string[] values, bool isMap = false) {
+            form.redrawTimer.Start();
             EditorWindow editor = new EditorWindow(names, types, values, isMap);
             editor.ShowDialog();
+            form.redrawTimer.Stop();
             if (editor.save) {
                 if (valueInHex) editor.ConvertValues(false);
                 return editor.values;
@@ -70,8 +72,10 @@ namespace FalloutClient {
         }
 
         public static string[] ShowEditor(DebugEditor form, string[] lvalues) {
+            form.redrawTimer.Start();
             EditorWindow editor = new EditorWindow(lvalues);
             editor.ShowDialog();
+            form.redrawTimer.Stop();
             if (editor.save) {
                 if (valueInHex) editor.ConvertValues(false);
                 return editor.values;

DebugEditor/Program.cs

@@ -15,7 +15,8 @@ namespace FalloutClient {
             if (args.Length == 1 && args[0] == "-debugedit") {
                 Application.Run(new DebugEditor(new EditorConnection()));
             } else {
-                MessageBox.Show("The debug editor can only be run from the game.",
+                MessageBox.Show("The debug editor can only be run from the game.\n" +
+                    "Use the key assigned to the DebugEditorKey option in ddraw.ini to run the debugger.",
                     "sfall Debug Editor", MessageBoxButtons.OK, MessageBoxIcon.Stop);
             }
         }
@@ -31,6 +32,7 @@ namespace FalloutClient {
         SetArray = 10,
         GetLocal = 11,
         SetLocal = 12,
-        Exit = 254
+        Exit = 254,
+        RedrawGame = 255
     }
 }

DebugEditor/Properties/AssemblyInfo.cs

@@ -10,7 +10,7 @@ using System.Runtime.InteropServices;
 [assembly: AssemblyConfiguration("")]
 [assembly: AssemblyCompany("")]
 [assembly: AssemblyProduct("sfall")]
-[assembly: AssemblyCopyright("Copyright ©  2019")]
+[assembly: AssemblyCopyright("Copyright (C) 2022")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 
@@ -29,5 +29,5 @@ using System.Runtime.InteropServices;
 //      Build Number
 //      Revision
 //
-[assembly: AssemblyVersion("4.1.9.0")]
-[assembly: AssemblyFileVersion("4.1.9.0")]
+[assembly: AssemblyVersion("4.1.9.1")]
+[assembly: AssemblyFileVersion("4.1.9.1")]

DebugEditor/SfallDebugEditor.csproj

@@ -9,14 +9,13 @@
     <OutputType>WinExe</OutputType>
     <AppDesignerFolder>Properties</AppDesignerFolder>
     <RootNamespace>FalloutClient</RootNamespace>
-    <AssemblyName>FalloutClient</AssemblyName>
+    <AssemblyName>FalloutDebug</AssemblyName>
     <FileUpgradeFlags>
     </FileUpgradeFlags>
     <OldToolsVersion>3.5</OldToolsVersion>
     <UpgradeBackupLocation>
     </UpgradeBackupLocation>
     <TargetFrameworkVersion>v2.0</TargetFrameworkVersion>
-    <IsWebBootstrapper>false</IsWebBootstrapper>
     <PublishUrl>publish\</PublishUrl>
     <Install>true</Install>
     <InstallFrom>Disk</InstallFrom>
@@ -29,6 +28,7 @@
     <MapFileExtensions>true</MapFileExtensions>
     <ApplicationRevision>0</ApplicationRevision>
     <ApplicationVersion>1.0.0.%2a</ApplicationVersion>
+    <IsWebBootstrapper>false</IsWebBootstrapper>
     <UseApplicationTrust>false</UseApplicationTrust>
     <BootstrapperEnabled>false</BootstrapperEnabled>
   </PropertyGroup>
@@ -42,14 +42,14 @@
     <WarningLevel>4</WarningLevel>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
-    <DebugType>pdbonly</DebugType>
+    <DebugType>none</DebugType>
     <Optimize>true</Optimize>
     <OutputPath>bin\Release\</OutputPath>
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
     <CheckForOverflowUnderflow>true</CheckForOverflowUnderflow>
-    <DebugSymbols>true</DebugSymbols>
+    <DebugSymbols>false</DebugSymbols>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="System" />

README.md

@@ -1,4 +1,5 @@
 # sfall
+[![github pages](https://github.com/phobos2077/sfall/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/phobos2077/sfall/actions/workflows/gh-pages.yml)
 
 A set of engine modifications for the classic game Fallout 2 in form of a DLL, which modifies executable in memory without changing anything in EXE file itself.
 

action.yml

@@ -0,0 +1,139 @@
+name:        'sfall'
+description: 'Builds sfall binaries'
+author:      '@wipe2238'
+
+###
+#
+# Example:
+#
+# - name: Build sfall
+#   id:   sfall
+#   uses: phobos2077/sfall@develop
+#   with:
+#    release-xp: true
+#
+# - name: Copy sfall to mod directory
+#   run:  copy "${{ steps.sfall.outputs.release-xp }}" "my/mod/directory/ddraw.dll"
+#
+###
+
+# While both inputs are marked as required, users needs to set only one of them (at minimum) to 'true' for action to work
+inputs:
+
+ release-xp:
+  description: 'Set to true to enable building with ReleaseXP configuration'
+  required:    true
+
+ dev-xp:
+  description: 'Set to true to enable building with DevXP configuration'
+  required:    true
+
+# Outputs are always using Windows directory separator (`\`)
+outputs:
+
+ release-xp:
+  description:  'Full path to ddraw.dll built with ReleaseXP configuration'
+  value:         ${{ steps.build-release-xp.outputs.ddraw-dll }}
+
+ dev-xp:
+  description: 'Full path to ddraw.dll built with DevXP configuration'
+  value:       ${{ steps.build-dev-xp.outputs.ddraw-dll }}
+ dev-xp-pdb:
+  description: 'Full path to ddraw.pdb built with DevXP configuration'
+  value:       ${{ steps.build-dev-xp.outputs.ddraw-pdb }}
+
+runs:
+ using: 'composite'
+ steps:
+
+ # Quick check for things which should never happen
+ - name:  Sanity checks
+   run:   |
+          if   [[ "${{ runner.os }}" != "Windows" ]]; then
+               echo "[ERROR] This action can only be used on Windows"
+               exit 1
+          elif [[ "${{ inputs.release-xp }}" != "true" ]] && [[ "${{ inputs.dev-xp }}" != "true" ]]; then
+               echo "[ERROR] At least one of following inputs must be set to 'true' -- 'release-xp', 'dev-xp'"
+               exit 1
+          #
+          elif [[ ! -d "$(cygpath --unix "$GITHUB_ACTION_PATH/sfall/")" ]]; then
+               echo "[ERROR] Solution directory not found -- 'sfall\\'"
+               exit 1
+          elif [[ ! -f "$(cygpath --unix "$GITHUB_ACTION_PATH/sfall/ddraw.sln")" ]]; then
+               echo "[ERROR] Solution file not found -- 'sfall\\ddraw.sln'"
+               exit 1
+          fi
+          #
+   shell: bash
+
+ # DXSDK directory must be prepared only once, in case action is used N times
+ # Using `.lib` suffix to make sure directory is ignored by git in exotic scenarios
+ # Using `::set-output` to make sure workflow environment remains unchanged
+ - name:  Prepare DXSDK directory
+   id:    dxsdk
+   run:   |
+          DXSDK_DIR="$GITHUB_ACTION_PATH/sfall/DXSDK.lib"
+          if [[ ! -d "$DXSDK_DIR" ]]; then
+             echo "::group::Prepare DXSDK directory"
+             #
+             git clone --quiet https://github.com/NovaRain/DXSDK_Collection.git "$DXSDK_DIR"
+             cp "$DXSDK_DIR/DXSDK_Aug2007/Lib/x86/dinput.lib" "$DXSDK_DIR/DXSDK_Jun2010/Lib/x86/"
+             cp "$DXSDK_DIR/DXSDK_Feb2010/Lib/x86/ddraw.lib" "$DXSDK_DIR/DXSDK_Jun2010/Lib/x86/"
+             #
+             echo "::endgroup::"
+          fi
+          echo "::set-output name=dir::$(cygpath --windows "$DXSDK_DIR/DXSDK_Jun2010/")"
+   shell: bash
+
+ # MSBuild is not in PATH on Windows machines
+ # Using `::set-output` to make sure workflow environment remains unchanged
+ - name:  Prepare MSBuild
+   id:    msbuild
+   run:   |
+          echo "::group::Prepare MSBuild"
+
+          MSBUILD_EXE="$("/c/Program Files (x86)/Microsoft Visual Studio/Installer/vswhere.exe" -latest -requires Microsoft.Component.MSBuild -find MSBuild/**/Bin/MSBuild.exe)"
+          echo "::set-output name=exe::$MSBUILD_EXE"
+
+          echo "::endgroup::"
+   shell: bash
+
+ # Creating empty `PostBuild.cmd` to avoid false-positive build error
+ - name:  Build ReleaseXP
+   id:    build-release-xp
+   run:   |
+          if [[ "${{ inputs.release-xp }}" == "true" ]]; then
+             echo ::group::Build ReleaseXP
+
+             #
+             echo "@echo off" > "$GITHUB_ACTION_PATH/sfall/PostBuild.cmd"
+             "${{ steps.msbuild.outputs.exe }}" "$GITHUB_ACTION_PATH/sfall/ddraw.sln" -p:Configuration=ReleaseXP -p:Platform=Win32 -p:PlatformToolset=v140_xp
+             #
+             echo "::set-output name=ddraw-dll::$(cygpath --windows "$GITHUB_ACTION_PATH/sfall/ReleaseXP/ddraw.dll")"
+
+             echo "::endgroup::"
+          fi
+   env:
+    DXSDK_DIR: ${{ steps.dxsdk.outputs.dir }}
+   shell: bash
+
+ # Creating empty `PostBuild.cmd` to avoid false-positive build error
+ - name: Build DevXP
+   id:   build-dev-xp
+   run:   |
+          :
+          if [[ "${{ inputs.dev-xp }}" == "true" ]]; then
+             echo "::group::Build DevXP"
+
+             #
+             echo "@echo off" > "$GITHUB_ACTION_PATH/sfall/PostBuild.cmd"
+             "${{ steps.msbuild.outputs.exe }}" "$GITHUB_ACTION_PATH/sfall/ddraw.sln" -p:Configuration=DevXP -p:Platform=Win32 -p:PlatformToolset=v140_xp
+             #
+             echo "::set-output name=ddraw-dll::$(cygpath --windows "$GITHUB_ACTION_PATH/sfall/DevXP/ddraw.dll")"
+             echo "::set-output name=ddraw-pdb::$(cygpath --windows "$GITHUB_ACTION_PATH/sfall/DevXP/ddraw.pdb")"
+
+             echo "::endgroup::"
+          fi
+   env:
+    DXSDK_DIR: ${{ steps.dxsdk.outputs.dir }}
+   shell: bash

artifacts/config_files/Perks.ini

@@ -7,22 +7,51 @@
 ; be used to remove their hardcoded effects, and add new stat/skill effects
 
 [PerksTweak]
-;Change the penalty distance and distance bonus for 'Weapon Scope Range' weapon perk
+;Changes the bonus for 'Master Trader' perk (ID 17)
+;25 - default bonus
+MasterTraderBonus=25
+
+;Changes the distance bonus for 'Weapon Long Range' weapon perk (ID 58)
+;2 - no bonus, 4 - default bonus
+WeaponLongRangeBonus=4
+
+;Changes the hit chance bonus for 'Weapon Accurate' weapon perk (ID 59)
+;0 - no bonus, 125 - maximum bonus, 20 - default bonus
+WeaponAccurateBonus=20
+
+;Change the penalty distance and distance bonus for 'Weapon Scope Range' weapon perk (ID 64)
 ;0 - no penalty, 8 - default penalty
 WeaponScopeRangePenalty=8
 ;2 - no bonus, 5 - default bonus
 WeaponScopeRangeBonus=5
 
-;Changes the distance bonus for 'Weapon Long Range' weapon perk
-;2 - no bonus, 4 - default bonus
-WeaponLongRangeBonus=4
+;Changes the resistance bonuses for 'Vault City Inoculations' perk (ID 78)
+;valid range: -100..100, 10 - default bonus
+VaultCityInoculationsPoisonBonus=10
+VaultCityInoculationsRadBonus=10
 
-;Changes the hit chance bonus for 'Weapon Accurate' weapon perk
-;0 - no bonus,  200 - maximum bonus, 20 - default bonus
-WeaponAccurateBonus=20
+;Changes the damage bonus per level for 'Demolition Expert' perk (ID 82)
+;999 - maximum bonus, 10 - default bonus
+DemolitionExpertBonus=10
 
-;Changes the strength bonus for 'Weapon Handling' perk
-;0 - no bonus,  10 - maximum bonus, 3 - default bonus
+;Changes the damage bonus for 'Living Anatomy' perk (ID 97)
+;125 - maximum bonus, 5 - default bonus
+LivingAnatomyBonus=5
+
+;Changes the damage bonus for 'Pyromaniac' perk (ID 101)
+;125 - maximum bonus, 5 - default bonus
+PyromaniacBonus=5
+
+;Changes the skill bonus per level for 'Salesman' perk (ID 103)
+;999 - maximum bonus, 20 - default bonus
+SalesmanBonus=20
+
+;Changes the percent chance for 'Stonewall' perk (ID 104)
+;valid range: 0..100, 50 - default percent
+StonewallPercent=50
+
+;Changes the strength bonus for 'Weapon Handling' perk (ID 106)
+;0 - no bonus, 10 - maximum bonus, 3 - default bonus
 WeaponHandlingBonus=3
 
 ;##############################################################################

artifacts/config_files/Skills.ini

@@ -1,11 +1,22 @@
 ;This file lets you set the formula for calculating skills
 
 [skills]
-BasedOnPoints=0 ;Set to 1 to base skill costs on spent points instead of current level
+;Changes the initial bonus to skill level for tag skills
+;valid range: 0..100, 20 - default bonus
+TagSkillBonus=20
 
-Skill0=s1|i2|l1.5 ;Skill 0 (small guns) is str*1 + int*2 + luck*1.5
-SkillBase1=50     ;Big guns has a base of 50
-SkillMulti2=10    ;Each point spent in energy weapons increases it by 10
-SkillImage1=72
+;Changes the behavior of tag skills
+;Set to 1 to give the initial skill bonus to the fourth tag skill from "Tag!" perk (Fallout 1 behavior)
+;Set to 2 to disable the double bonus of skill points for tag skills
+;Set to 3 to use both modes
+TagSkillMode=0
 
-SkillCost0=0|0|0|0|0|300 ;Each level of small guns costs 6 skill points
+;Set to 1 to base skill costs on the number of additional points in a skill instead of the current level
+BasedOnPoints=0
+
+;Examples
+;Skill0=s1|i2|l1.5 ;Skill 0 (small guns) is str*1 + int*2 + luck*1.5
+;SkillBase1=50     ;Big guns has a base of 50
+;SkillMulti2=10    ;Each point spent in energy weapons increases it by 10
+;SkillImage1=72
+;SkillCost0=0|0|0|0|0|300 ;Each level of small guns costs 6 skill points

artifacts/config_files/Stats.ini

@@ -6,6 +6,10 @@
 ;multi[x] - where x is from 0 to 6, the multiplier of st/pe/en/etc.
 ;shift[x] - shifts the base stat before the multiplication
 
+[Main]
+;Set to 1 to take the bonus values of SPECIAL stats into account when calculating maximum hit points
+;Set to 0 for the Fallout original behavior (bonus stats do not affect maximum hit points)
+HPDependOnBonusStats=0
 
 ;max hp
 [7]