Starfield-Reverse-Engineering/commonlibsf-template

SFSE template using CommonLibSF

CommonLibSF Plugin Template

This is a basic plugin template using CommonLibSF.

Requirements

• XMake [2.8.2+]
• C++23 Compiler (MSVC)

Getting Started

git clone --recurse-submodules https://github.com/qudix/commonlibsf-template
cd commonlibsf-template

Build

To build the project, run the following command:

xmake build

Note: This will generate a build/windows/ directory in the project's root directory with the build output.

Build Output (Optional)

If you want to redirect the build output, set one of or both of the following environment variables:

• Path to a Starfield install folder: XSE_SF_GAME_PATH

• Path to a Mod Manager mods folder: XSE_SF_MODS_PATH

Project Generation (Optional)

If you want to generate a Visual Studio project, run the following command:

xmake project -k vsxmake

Note: This will generate a vsxmakeXXXX/ directory in the project's root directory using the latest version of Visual Studio installed on the system.

Upgrading Packages (Optional)

If you want to upgrade the project's dependencies, run the following commands:

xmake repo --update
xmake require --upgrade

Documentation

Please refer to the Wiki for more advanced topics.