CommonLibSSE-NG Plugin Template

Template for building SKSE plugins using the NG branch of CommonLibVR.

Requirements

• Any terminal of your choice (e.g., PowerShell)
• Visual Studio Community 2022
  • Desktop development with C++
• CMake
  • Edit the PATH environment variable and add the cmake.exe install path as a new value
  • Instructions for finding and editing the PATH environment variable can be found here
• Git
  • Edit the PATH environment variable and add the Git.exe install path as a new value
• Vcpkg
  • Install vcpkg using the directions in vcpkg's Quick Start Guide
  • After install, add a new environment variable named VCPKG_ROOT with the value as the path to the folder containing vcpkg

User Requirements

• Address Library for SKSE
  • Needed for SSE/AE
• VR Address Library for SKSEVR
  • Needed for VR

Register Visual Studio as a Generator

• Open x64 Native Tools Command Prompt
• Run cmake
• Close the cmd window

Clone and Build

Open terminal (e.g., PowerShell) and run the following commands:

git clone https://github.com/ponzipyramid/CommonLibSSE-NG-Template.git --recursive
cd CommonLibSSE-NG-Template
.\BuildRelease.bat SE/AE
.\BuildRelease.bat VR

CMAKE Options (optional)

If you want an example CMakeUserPreset to start off with you can copy the CMakeUserPresets.json.template -> CMakeUserPresets.json

AUTO_PLUGIN_DEPLOYMENT

• This option is default "OFF"
• Make sure "AUTO_PLUGIN_DEPLOYMENT" is set to "ON" in CMakeUserPresets.json
• Change the "SamplePluginOutputDir" value to match your desired outputs, if you want multiple folders you can separate them by ; is shown in the template example

When using custom preset you can call BuildRelease.bat with an parameter to specify which preset to configure eg: .\BuildRelease.bat ALL-WITH-AUTO-DEPLOYMENT

When switching between different presets you might need to remove the build folder