Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 2.6 KB

README.md

File metadata and controls

56 lines (37 loc) · 2.6 KB
Raw

📑 SFSE Plugin Template

Native dll plugin for starfield script extender.

Create a new plugin project from this template and wait for the first workflow action to finish, it will setup project automatically.

⚙ Requirements

  • CMake 3.26+
    • Add this to your PATH
  • PowerShell
  • Vcpkg
    • Add the environment variable VCPKG_ROOT with the value as the path to the folder containing vcpkg
    • Make sure your local vcpkg port is up-to-date by pulling the latest and do vcpkg integrate install
  • 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

These two dependencies can be setup either via git submodule (by executing update-submodule.bat) or through a local git repo (by specifying environment variable CommonLibSFPath and DKUtilPath pointing to local git repo path).

If having multiple projects, to avoid having copies of CommonLibSF and DKUtil in each of them, it's suggested to use the local fork and environment path approach, so all projects share the same package.

.\make-sln-msvc.bat
cmake --build build

📦 Deployment

This plugin template has auto deployment rules for easier build-and-test, build-and-package features, using simple json rules. Read more here!

➕ DKUtil addon

This project bundles DKUtil.

📖 License

GPL-3.0-or-later WITH Modding Exception AND GPL-3.0 Linking Exception (with Corresponding Source). Specifically, the Modded Code is Starfield (and its variants) and Modding Libraries include Starfield Script Extender and DKUtil (and variants).

❓ Credits