📑 SFSE Plugin Template

Native dll plugin template (in-draft) for starfield script extender.

⚙ Requirements

CMake
- Add this to your PATH
DKUtil
- Init & update with git submodule
SFSE
- Init & update with git submodule
PowerShell
Vcpkg
- Add the environment variable VCPKG_ROOT with the value as the path to the folder containing vcpkg
Visual Studio Community 2022
- Desktop development with C++
Starfield Steam Distribution
- Add the environment variable SFPath with the value as the path to the game installation

Get started

💻 Register Visual Studio as a Generator

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

🔨 Building

Create a new github repo from this template or (unrecommended):

git clone https://github.com/gottyduke/SF_PluginTemplate.git Plugin
cd Plugin
git submodule init
git submodule update --remote
.\build-release.ps1

Don't forget to change project name within Plugin/CMakeLists.txt and update vcpkg.json accordingly.

📦 Deployment

This plugin template comes with a simple custom deployer script to enable custom distribution rules fitting most use cases.
To get started on adding custom deploy rules, check out the default examples.

action	usage
`base`	set variable `params[0]` with value `params[1]`
`copy`	copy `params[0]` to `params[1]`
`copy_if`	do `copy` if file exists
`package`	add `params[0..-1]` list of sources to zip file `params[-1]`
`remove`	remove `params` list of sources
`script`	execute raw powershell script

The following base variables are provided by default:

cmake_output    // this is the binary output path
dist            // this is the dist folder path, also the working directory of deployer script
project_name    // project name same as CMakeLists
project_version // project version same as CMakeLists

Deploy actions can be enabled by build configuration(debug, release, relwithdebinfo, etc)

➕ DKUtil addon

This project bundles DKUtil.

📖 License

MIT

❓ Credits

Ryan for his commonLibSSE code which was referenced in DKUtil.
ianpatt's starfield script extender.
Original plugin template

grazz/AchievementEnablerSFSE