• CMake v3.27+
• Visual Studio 2022 with C++ workload
• Python
• LLVM v17.0.0+

This template uses CommonLibSF's GPLv3 with exceptions. Per the license, you must share the source code of your mod if you use CommonLibSF. Violation of the license will result in your mod being taken down from the Nexus.

This template consumes CommonLibSF as a CPM package, a git submodule, or a local fork. When you run the project setup script, you will be prompted to choose between the three (the default is as a CPM package).

A python script, project_setup.py, is provided which automates several housekeeping steps required to get the template development-ready (requires Python). To run the script:

1. Run cd .\CLibSFPluginTemplate\
2. Run py .\project_setup.py
3. Choose how to consume CommonLibSF
   1. Press Enter to use the default of consuming CommonLibSF via CPM
   2. Enter y to consume CommonLibSF as a git submodule instead
4. To use a local fork of CommonLibSF instead of the vcpkg port or a git submodule:
   1. Create a Windows environment variable called CommonLibSFPath that points to your local fork of CommonLibSF
   2. Enter y when the setup script asks if you'd like to use a local fork
5. Enter your project name (in CamelCase)

• Visual Studio should prompt you to generate a CMake cache. Click on Generate and wait
• One the CMake cache is generated, build your project
• The .dll and .pdb files will be placed in contrib\PluginRelease or contrib\PluginDebug depending on your build configuration

• Two build configs are provided:
  • Release: Optimized release build, produces small and fast DLLs with associated PDBs
  • Debug: Debug build, produces DLLs and PDBs with full debug info, allowing the use of an interactive debugger

Variants of both of the above configs are provided which use MSVC (cl/link) and Clang (clang-cl/lld-link) respectively.

Many CommonLib plugins expose settings through configuration files so that the user can control plugin behavior. This template includes simpleini which allows you to read settings from the ini file in contrib\config (see Settings.cpp).