/SkyrimRadarAE

Primary LanguageC++MIT LicenseMIT

CommonLibSSE-NG Plugin Template

This is a basic plugin template using CommonLibSSE-NG.

Requirements

  • XMake [2.7.8+]
  • C++20 Compiler (MSVC, Clang?)

Getting Started

git clone https://github.com/Qudix/template-commonlibsse-ng
cd template-commonlibsse-ng

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(s) to a Skyrim install folder: SKYRIM_PATH

  • Path(s) to a Mod Manager mods folder: SKYRIM_MODS_PATH

Note: Both variables support semicolon (;) seperated paths for multiple game installs or mods folders.

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.