Merge pull request #26 from sourcehold/python-add-setup-scripts-and-structures

[PYTHON/RECCMP] Create setup script and re-structure reccmp setup

Author: TheRedDaemon

CMakeLists.txt

@@ -58,6 +58,9 @@ message("CMAKE_CXX_FLAGS_RELWITHDEBINFO is ${CMAKE_CXX_FLAGS_RELWITHDEBINFO}")
 # Handled by path, but explicitly included to support IntelliSense
 include_directories(${CMAKE_SOURCE_DIR}/MSVC1400/VC/include ${CMAKE_SOURCE_DIR}/MSVC1400/VC/PlatformSDK/Include)
 
+# Handle Windows dependencies that need explicit linking
+link_libraries(winmm)
+
 # Handle dependencies without source files
 include_directories(${CMAKE_SOURCE_DIR}/dependencies/recreated/include)
 link_directories(${CMAKE_SOURCE_DIR}/dependencies/recreated/lib)

README.md

@@ -47,11 +47,8 @@ Because the original game was compiled using an old compiler, you have to compil
     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. Install the needed Python dependencies, mainly `reccmp` for binary comparison
-    ```sh
-    python -m pip install -r requirements.txt
-    ```
-3. 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.
+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.
 
 ### Development
 The build can be run using the dev tools of the preferred IDE or via the build scripts. Regardless, a CMake installation is required.
@@ -69,7 +66,7 @@ If the scripts are preferred, the following triggers a build using the scripts:
     ```
 5. Compare a function byte by byte to check compilation:
     ```sh
-    reccmp-reccmp --target STRONGHOLDCRUSADER --verbose 0x401000
+    reccmp/run reccmp-reccmp --target STRONGHOLDCRUSADER --verbose 0x401000
     ```
 
 Note that any code needs to be formatted properly using the provided `clang-format`. The way to do so it up to the developer. Many IDEs support it out of the box.

cmake/core-sources.txt

@@ -2,4 +2,3 @@ src/core/MainImplementation.cpp
 src/core/Resolver.cpp
 src/core/ViewportRenderState.cpp
 src/core/entry.cpp
-src/core/windowslib.cpp

compare.bat

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

reccmp-build.yml

@@ -1,12 +1,14 @@
 targets:
   STRONGHOLDCRUSADER:
-    filename: StrongholdCrusader.exe
-    source_root: .
+    filename: Stronghold Crusader.exe
+    source_root: ../src
     hash:
       sha256: 3bb0a8c1e72331b3a30a5aa93ed94beca0081b476b04c1960e26d5b45387ac5a
+    data_sources: []
     ghidra:
       ignore_types: []
       ignore_functions: []
       name_substitutions: []
+      allow_hash_mismatch: false
     report:
       ignore_functions: []

reccmp-user.yml

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