Dev ‐ Getting Started - ArthurHub/F4VRComfortSwim GitHub Wiki

Runtime Requirements

Development Requirements

  • CMake
  • Vcpkg
    • git clone https://github.com/microsoft/vcpkg.git
    • run bootstrap-vcpkg.bat. Example: C:\github\vcpkg\bootstrap-vcpkg.bat
    • Set environment variable VCPKG_ROOT. Example: setx VCPKG_ROOT "C:\github\vcpkg"
  • Visual Studio Community 2022
    • Desktop development with C++

Building

Clone repo and setup CommonLibF4 submodule:

git clone https://github.com/ArthurHub/F4VRComfortSwim.git
cd F4VRComfortSwim
git submodule update --init --recursive

Create VS2022 solution:

cmake --preset default
  • Open .../F4VRComfortSwim/build/F4VRComfortSwim.sln in VS2022.
    • Build and debug in VS as usual
    • Any project changes should be done in CMakeLists.txt
  • see CMakeUserPresets.json.template to customize presets by providing path for post-build event.
    • Use cmake --preset custom

Build and package:

cmake --preset default
cmake --build buildvr --config Release
  • Will automatically create a 7zip package of the mod in F4VRComfortSwim/build/package