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 git submodule, or a local fork. When you run the project setup script, you will be prompted to choose between the two (the default is as a local fork).
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:
- If you want to use a local fork of CommonLibSF instead of a submodule, create a Windows environment variable called
CommonLibSFPath
that points to your local fork - Run
cd .\CLibSFPluginTemplate\
- Run
py .\project_setup.py
- Enter your project name (in CamelCase)
- Choose how to consume CommonLibSF
- Press
Enter
to use the default of consuming CommonLibSF via a local fork - Enter
n
to consume CommonLibSF as a git submodule instead
- Press
- Select one of the CMake presets (release or debug), configure, and build.
- The .dll and .pdb files will be placed in
contrib\PluginRelease
orcontrib\PluginDebug
depending on your selected preset