Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.66 KB

README.md

File metadata and controls

34 lines (22 loc) · 1.66 KB
Raw

CommonLibSF Plugin Template

C++23 Platform Game version

License requirements

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.

Setup

  • Clone the repository
  • Run cd CLibSFPluginTemplate
  • Run py project_setup.py (requires Python 3.12+)

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 CommonLibSF 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
  • Visual Studio 2022 build tools

Resources