Skip to content

ThirdEyeSqueegee/CLibNGPluginTemplate

Repository files navigation

CommonLibSSE-NG Plugin Template

Setup

  • Clone the repository
  • Run cd CLibNGPluginTemplate
  • Run py project_setup.py (requires Python 3.12+)
  • If using Visual Studio, set the formatter path to the clang-format.exe included in your LLVM install:
    • Open Visual Studio settings
    • Navigate to Tools > Options > Text editor > C++ > Formatting
    • Set the path to clang-format.exe (Usually C:\Program Files\LLVM\bin\clang-format.exe)
  • If your CMake install is not located at C:\Program Files\CMake\bin\, fix the path in the "cmakeExecutable" key in CMakePresets.json

NOTE: You should run vcpkg x-update-baseline (in the project's root directory) often to make sure that vcpkg is fetching the latest versions of CommonLibSSE-NG and other dependencies

Building your project

  • Select one of the CMake presets (release or debug), configure, and build.
  • The .dll and .pdb files will be placed in contrib\PluginRelease or contrib\PluginDebug depending on your selected preset

Requirements

  • vcpkg
    • Create a new environment variable called VCPKG_ROOT which points to your vcpkg install directory
  • CMake
  • LLVM (for clang-format and clang-tidy)
  • Visual Studio 2022 build tools

Resources