- add window builder

- update windows build steps in readme

Author: cen1

.github/workflows/cmake.yml

@@ -7,6 +7,7 @@ env:
 
 jobs:
   build-debian-system-reproducible:
+    if: true
     runs-on: ubuntu-latest
     container:
       image: debian:bookworm
@@ -39,6 +40,7 @@ jobs:
         [ "$hash1" = "$hash2" ] && exit 0 || exit 1
 
   build-debian-conan:
+    if: true
     runs-on: ubuntu-latest
     container:
       image: debian:bookworm
@@ -67,6 +69,7 @@ jobs:
       run: cmake --build .
 
   build-fedora-system:
+    if: true
     runs-on: ubuntu-latest
     container:
       image: fedora:latest
@@ -82,3 +85,32 @@ jobs:
 
     - name: Build
       run: cmake --build ./build
+
+  build-windows-conan:
+    if: true
+    runs-on: windows-latest
+   
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: TheMrMilchmann/setup-msvc-dev@v3
+      with:
+        arch: x64
+
+    - name: Install Conan
+      id: conan
+      uses: turtlebrowser/get-conan@main
+
+    - name: Init conan
+      run: conan profile detect
+
+    - name: Install dependencies
+      shell: cmd 
+      run: conan install . -of build -s build_type=Release -o *:shared=False --build=missing
+    
+    - name: Build
+      shell: cmd
+      working-directory: ./build
+      run: .\conanbuild.bat && cmake .. -G "Visual Studio 17 2022" -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake -DBUILD_SHARED_LIBS=1 && cmake --build . --config Release
+
+ 

CMakeLists.txt

@@ -1,5 +1,5 @@
+cmake_minimum_required(VERSION 3.25)
 project(bncsutil)
-cmake_minimum_required(VERSION 3.2)
 
 set(CMAKE_MODULE_PATH ${CMAKE_BINARY_DIR} "${PROJECT_SOURCE_DIR}/CMake/Modules")
 message(${CMAKE_BINARY_DIR})
@@ -65,13 +65,15 @@ else()
 endif()
 
 if (USE_SYSTEM_LIBS)
+    message("Using system dependencies")
     find_package(GMP REQUIRED)
     target_include_directories(bncsutil PRIVATE src ${GMP_INCLUDE_DIR})
     target_link_libraries(bncsutil ${GMP_LIBRARIES})
 else()
+    message("Using conan dependencies")
     find_package(gmp REQUIRED)
-    target_include_directories(bncsutil PRIVATE src gmp:gmp)
-    target_link_libraries(bncsutil PRIVATE gmp:gmp)
+    target_include_directories(bncsutil PRIVATE src gmp::gmp)
+    target_link_libraries(bncsutil PRIVATE gmp::gmp)
 endif()
 
 set_target_properties(bncsutil PROPERTIES OUTPUT_NAME bncsutil)

README.md

@@ -13,52 +13,60 @@ of game versions, keys, and passwords.
 BNCSUtil was originally written by Eric Naeseth (shadypalm88) and has since
 been maintained over the course of several years by the open source Battle.net community.
 
-## Usage
+# Usage
 Add `bncsutil.h` to your include directory and link against `bncsutil.lib` or `libbncsutil.so`.
 
-## Building
+# Building
 
-To force a specific build (32bit or 64bit) add `-DCMAKE_GENERATOR_PLATFORM=x86` or `-DCMAKE_GENERATOR_PLATFORM=x64` to CMake flags. 
+To force a specific build (32bit or 64bit) add `-DCMAKE_GENERATOR_PLATFORM=x86` or `-DCMAKE_GENERATOR_PLATFORM=x64` to CMake flags.
 
-### Windows Visual Studio 2019
+Change `BUILD_SHARED_LIBS` to build the library as static or shared.
 
-Version 2019 has compiler version 16, 2015 has compiler version 14.
+## Windows Visual Studio 2022
 
-Change `-o *:shared` option if you want to link static or dynamic dependencies.
+Conan is used to install dependencies. GMP can't be installed as a shared library due to a bug. Mpir dependency option will be re-introduced once it is uploaded to conan index v2 (MR pending).
 
-Change `BUILD_SHARED_LIBS` to build the library as static or shared.
+In `cmd` or Visual Studio dev console run:
 
 ```
-conan install . -if ./build -s compiler.version=16 -s arch=x86_64 -o *:shared=True
-cmake -G "Visual Studio 16 2019" -B./build -DBUILD_SHARED_LIBS=1 -DCMAKE_GENERATOR_PLATFORM=x64
+"C:/Program Files/Microsoft Visual Studio/2022/Community/VC/Auxiliary/Build/vcvarsall.bat" x64
+conan install . -of build -s build_type=Release -o *:shared=False --build=missing
+cd build
+.\conanbuild.bat
+cmake .. -G "Visual Studio 17 2022" -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake -DBUILD_SHARED_LIBS=1
+cmake --build . --config Release
 ```
 
-### Linux
+Alternatively open `build/bncsutil.sln` and build from Visual Studio.
+
+## Linux
 
-#### Using system dependencies
-Instead of using conan you can link against system provided gmp. Install `libgmp-dev` on deb distros or `gmp-devel` on rpm distros. For 32bit builds, CMake will not warn you if you are missing 32bit glibc and GMP, you must install them manually first (CentOS/Fedora: `glibc-devel.i686` and `gmp-devel.i686`).
+### Using system dependencies
+Install `libgmp-dev` on deb distros or `gmp-devel` on rpm distros. For 32bit builds, CMake will not warn you if you are missing 32bit glibc and GMP, you must install them manually first (CentOS/Fedora: `glibc-devel.i686` and `gmp-devel.i686`).
 
 ```
 cmake -G "Unix Makefiles" -B./build
-cd build && make && make install
+cd build
+cmake --build . --target install --config Release
 ```
 
-#### Using conan
-If you are using pyenv or building python3 from source, make sure you have the following packages installed first:
-```
-sudo apt-get install libbz2-dev liblzma-dev
-```
+### Using conan
+If you are using pyenv or building python3 from source, make sure you have `libbz2-dev` and `liblzma-dev` installed first or conan will fail to unpack dependencies.
 
 ```
 conan install . -of build -s build_type=Release --build=missing
-cmake -G "Unix Makefiles" -B./build -DUSE_SYSTEM_LIBS=0
-cd build && make && make install
+cd build
+./conanbuild.sh
+cmake .. -G "Unix Makefiles" -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake -DUSE_SYSTEM_LIBS=0
+cmake --build . --target install --config Release
 ```
 
-## Building .deb and .rpm packages
+## .deb and .rpm packages
 After invoking CMake, cd to build folder and generate them with `cpack -G "DEB"` and `cpack -G "RPM"`.
 You can then use `gdebi` to do a local install of .deb with automatic dependency resolution or `yum localinstall` on rpm distros. For dnf it's `dnf install <name>.rpm`.
 
 Note that this is a "devel" package which also includes header files.
 
-Library installs go to `/usr/lib`, include files in `/usr/include/bncsutil`. 
+Library installs to `/usr/lib`, include files in `/usr/include/bncsutil`.
+
+Packages are also avaialble for download from github releases built on Debian Bookworm and Fedora latest.