Code cleanup and correction

Changed the default graphics mode back to 0 (now DD7).

.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/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);
             }
         }

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,8 +1,9 @@
 # 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.  
+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.
 
-Engine modifications include:   
+**Engine modifications include:**
 - Better support for modern operating systems
 - Externalizing many settings like starting map and game time, skills, perks, critical hit tables, books, etc.
 - Bug fixes
@@ -10,7 +11,7 @@ Engine modifications include:
 - Extended scripting capabilities for modders (many new opcodes to control sfall features as well as previously unavailable vanilla engine functions)
 
 
-Original author: timeslip  
+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.
 

action.yml

@@ -0,0 +1,138 @@
+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/"
+             #
+             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/Drugs.ini

@@ -13,18 +13,25 @@ Count=0
 [1]
 ; drug item PID
 PID=0
+
 ; set a limit on the count of first and second delayed effects when using the drug, i.e. if the queue has delayed effects from the drug,
 ; and their count is greater or equal to NumEffects, it is not possible to obtain new effects from using the drug
-; this count is 4 for Buffout/Mentats/Psycho/Jet
+; e.g. this count is 4 for Buffout/Mentats/Psycho/Jet
 ; set -1 to leave this parameter unchanged
 NumEffects=-1
+
 ; the duration of the addiction effect in game minutes (i.e. 1440 = 24 game hours)
-; set to 0 to use the default time (7 days for all drugs except Jet)
+; set to 0 to use the default time of 7 days (as all drugs except Jet)
 AddictTime=0
+
 ; the number of the global variable from vault13.gam responsible for displaying addiction in the character screen
+; if you set GvarID with numbers: 21-26, 295, 296, or variable numbers that have already been declared in previous sections,
+; the TextID and FrmID options in this section will be ignored
 ; set to 0 if the addiction is not required
 GvarID=0
+
 ; the index number from editor.msg to display the title of the addiction (the description uses the index number of TextID + 100)
 TextID=-1
+
 ; the line number (0-indexed) of the corresponding FRM in skilldex.lst
 FrmID=-1

artifacts/config_files/Perks.ini

@@ -1,67 +1,93 @@
 ;This file handles modifications to perks and traits
-;When adding extra perks to a mod, it's advisable to use
-; the fake perk scripting functions rather than make modifications
-; in this file, as some perks have hardcoded effects which may
-; catch you out
-;Since traits need to be picked before any scripts run, they
-; have an additional NoHardcode option in this file which can
+
+;When adding extra perks to a mod, it's advisable to use the fake perk scripting functions rather than make modifications
+; in this file, as some perks have hardcoded effects which may catch you out
+
+;Since traits need to be picked before any scripts run, they have an additional NoHardcode option in this file which can
 ; 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
 
 ;##############################################################################
-;Name=The name of the perk (max 63 characters)
-;Desc=The description of the perk (max 255 characters)
-;Image=The line number (0-indexed) of the corresponding FRM in skilldex.lst
-;Ranks=The number of perk levels
-;Level=The minimum required level
-;Type=If 0, the perk checks only Skill1 for skill requirements; if 1, it checks
-; Skill1 or Skill2; if 2, it checks both Skill1 and Skill2
-;Stat=The modified stat or -1 if you don't want to change any stats
-;StatMag=The increased/decreased value to the modified stat
-;Skill1=The first skill (or -1 for none) to check, but if you set a specific bit
-; (67108864 or 0x4000000), it checks GVAR. For example, if Skill1=67108864, then
-; the perk will check GVAR_PLAYER_REPUTATION (67108864 + 0) on Skill1Mag value
-;Skill1Mag=Positive value is used as the minimum requirements of the first
-; skill/GVAR, and a negative value is interpreted as the maximum requirement.
-; For example, with Skill1=0 and Skill1Mag=100, if player has small guns skill
-; >= 100 and meets all other requirements, the perk will be available in the
-; selection window; with Skill1=1 and Skill1Mag=-120, the perk will not be
-; available if player has big guns skill >= 120
-;Skill2=The second skill/GVAR (or -1 for none) to check
-;Skill2Mag=Same as Skill1Mag, but for Skill2
-;STR-LCK=Positive values are used as minimum requirements of SPECIAL stats, and
-; negative values are interpreted as maximum requirements. For some special
-; perks processed by the engine (e.g. PERK_armor_powered and PERK_armor_combat),
-; the values are not used as requirements but to add to corresponding SPECIAL
-; stats
+[Perks]
+;Set to 1 to enable the modifications for perks
+Enable=0
+
+;Name: The name of the perk (max 63 characters)
+;Desc: The description of the perk (max 255 characters)
+;Image: The line number (0-indexed) of the corresponding FRM in skilldex.lst
+;Ranks: The number of perk levels
+;Level: The minimum required level
+;Type: If 0, the perk checks only Skill1 for skill requirements; if 1, it checks Skill1 or Skill2; if 2, it checks both Skill1 and Skill2
+;Stat: The modified stat or -1 if you don't want to change any stats
+;StatMag: The increased/decreased value to the modified stat
+
+;Skill1/Skill2: The first/second skill (or -1 for none) to check, but if you set a specific bit 0x4000000 (67108864), it checks GVAR.
+; For example, if Skill1=0x4000004, then the perk will check GVAR_BAD_MONSTER (0x4000000 + 4) on Skill1Mag value
+
+;Skill1Mag/Skill2Mag: Positive value is used as the minimum requirements of the first/second skill/GVAR, and a negative value is interpreted as the maximum requirement.
+; For example, with Skill1=0 and Skill1Mag=100, if player has small guns skill >= 100 and meets all other requirements, the perk will be available in the
+; selection window; with Skill1=1 and Skill1Mag=-120, the perk will not be available if player has big guns skill >= 120
+
+;STR-LCK: Positive values are used as minimum requirements of SPECIAL stats, and negative values are interpreted as maximum requirements.
+; For some special perks processed by the engine (e.g. PERK_armor_powered and PERK_armor_combat), the values are not used as requirements
+; but to add to corresponding SPECIAL stats
 
 ;If the value is set to -99999, the variable will be ignored (similar to comment out that line)
 
 ;You can add simple extra perks with ID numbers from 119 to 255
 ; that do not require using scripting functions to change player stats, and can also be used for Armor perks
 ;These parameters are only for extra perks
-;Stat1-Stat2 = same as Stat
-;Stat1Mag-Stat2Mag = same as StatMag
-;Skill3-Skill5 = The skill to be modified (or -1 for none)
-;Skill3Mod-Skill5Mod = The increased/decreased value to the modified skill
+;Stat1/Stat2: same as Stat
+;Stat1Mag/Stat2Mag: same as StatMag
+;Skill3-Skill5: The skill to be modified (or -1 for none)
+;Skill3Mod-Skill5Mod: The increased/decreased value to the modified skill
 
 ;##############################################################################
 ;This is a modification to vanilla perk 0
@@ -119,6 +145,11 @@ Skill4Mod=0
 Skill5=-1
 Skill5Mod=0
 
+;##############################################################################
+[Traits]
+;Set to 1 to enable the modifications for traits
+Enable=0
+
 ;This is a modification to trait 0
 [t0]
 NoHardcode=0

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