Merge pull request #41 from sourcehold/feature/builds-polyfill-and-constants

Prepare main branch for building using the exports

Author: TheRedDaemon

.gitignore

@@ -1,11 +1,20 @@
 ### OpenSHC
+# Ignore build artifacts
 build-*/
 build/
 _build/
 build.bat
 build.ps1
 build.py
 dist/
+# Ignore scratch files
+tmp/
+# Ignore binary files and export files created from reverse engineering programs
+/*.7z
+/*.sarif
+/*.bin
+# Ignore the reccmp results overview
+/reccmp/**/*.json
 
 # Softlink to game installation
 _original

CMakeLists.txt

@@ -144,6 +144,7 @@ target_file_copy_if_different(OpenSHC.exe "${CRUSADER_DIR}/shfolder.dll" "$<TARG
 
 
 
+# Place the dll and its pdb in the OpenSHC module folder for live testing
 set(OPEN_SHC_DLL_DEST "${CRUSADER_DIR}/ucp/modules/${OPEN_SHC_NAME}-${OPEN_SHC_VERSION}" CACHE PATH "Path for OpenSHC.dll and OpenSHC.pdb")
 
 add_library(OpenSHC.dll SHARED src/entry.cpp ${CORE_SOURCES} ${OPENSHC_SOURCES})

README.md

@@ -50,12 +50,15 @@ Because the original game was compiled using an old compiler, you have to compil
 ### Setup
 
 1. Clone the repository. Make sure to also pull the submodules to have the compiler included:
+
    ```sh
    git clone --recursive https://github.com/sourcehold/OpenSHC.git
    ```
+
    - Should NET Framework 3.5 be required, it can be easily installed on Windows 11 by running `mt.exe` (from the MSVC1400 repo), Windows 11 will ask to install the right version.
+
 2. Create a softlink to the original game executable with the name `_original` by running [softlink.bat](softlink.bat). It will request the full path to the game folder.
-3. Setup the needed Python environment to run `reccmp` for binary comparison by running [setup.bat](reccmp/setup.bat) in the reccmp folder.
+3. Setup the needed Python environment to run `reccmp` for binary comparison by running [setup.bat](reccmp/dll/setup.bat) in the reccmp/dll folder (or the `setup.bat` in the reccmp/exe folder if binary comparison on the reimplemented .exe file is preferred)
 
 ### Development
 
@@ -72,9 +75,9 @@ If the scripts are preferred, the following triggers a build using the scripts:
    ```sh
    build.bat RelWithDebInfo
    ```
-4. Compare a function byte by byte to check compilation:
+4. Compare a function byte by byte to the OpenSHC.dll to check compilation:
    ```sh
-   reccmp/run reccmp-reccmp --target STRONGHOLDCRUSADER --verbose 0x401000
+   reccmp/dll/run reccmp-reccmp --target STRONGHOLDCRUSADER --verbose 0x401000
    ```
 
 If CMake is installed and not in PATH, for example if installed via Visual Studio, `cmakew.bat` can be used instead. It tries to detect a CMake installation and uses it.

reccmp/dll/reccmp-build.yml

@@ -0,0 +1,5 @@
+project: .
+targets:
+  STRONGHOLDCRUSADER:
+    path: ../../_original/ucp/modules/OpenSHC-1.41.0/OpenSHC.dll
+    pdb: ../../_original/ucp/modules/OpenSHC-1.41.0/OpenSHC.pdb

reccmp/reccmp-project.yml reccmp/dll/reccmp-project.ymlreccmp/reccmp-project.yml renamed to reccmp/dll/reccmp-project.yml

@@ -1,7 +1,7 @@
 targets:
   STRONGHOLDCRUSADER:
     filename: Stronghold Crusader.exe
-    source_root: ../src
+    source_root: ../../src
     hash:
       sha256: 3bb0a8c1e72331b3a30a5aa93ed94beca0081b476b04c1960e26d5b45387ac5a
     data_sources: []

reccmp/dll/reccmp-user.yml

@@ -0,0 +1,3 @@
+targets:
+  STRONGHOLDCRUSADER:
+    path: ../../_original/Stronghold Crusader.exe

reccmp/requirements.txt reccmp/dll/requirements.txtreccmp/requirements.txt renamed to reccmp/dll/requirements.txt

@@ -0,0 +1,5 @@
+project: .
+targets:
+  STRONGHOLDCRUSADER:
+    path: ../../build-RelWithDebInfo/OpenSHC.exe
+    pdb: ../../build-RelWithDebInfo/OpenSHC.pdb