There are a few housekeeping tasks to do before you get started developing your plugin.
A python script, project_setup.py
, is provided which automates the steps in the section below (requires Python 3.12+)*. To run the script:
cd .\CLibSFPluginTemplate\
py .\project_setup.py
*NOTE: If you're using Python 3.11 or below, change onexc=onexc
to onerror=onexc
in lines 31 and 33 in project_setup.py
"name"
and "version-semver"
fields in vcpkg.json
"baseline"
entries to the latest commits in both registries in vcpkg.json
"repository"
fields and copy-paste the hash of the latest commit in each repositoryCMakeLists.txt
"AuthorName"
in CMakeLists.txt
to your namecontrib/Config/PluginName.ini
to the name of your pluginini.LoadFile()
call in src/Settings.cpp
to load the renamed ini from step 6Generate
and wait.dll
and .pdb
files will be placed in contrib\PluginRelease
or contrib\PluginDebug
depending on your build configurationRelease
: Optimized release build, produces small and fast DLLs with associated PDBsDebug
: Debug build, produces DLLs and PDBs with full debug info, allowing the use of an interactive debuggerVCPKG_ROOT
which points to your vcpkg install directory