CommonLibSSE Plugin Template

This is a basic plugin template using CommonLibSSE.

Requirements

• XMake [2.8.2+]
• C++23 Compiler (MSVC, Clang-CL)

Getting Started

git clone --recurse-submodules https://github.com/libxse/commonlibsse-template
cd commonlibsse-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 the following environment variables:

• Path to a Mod Manager mods folder: XSE_TES5_MODS_PATH

  or

• Path to a Skyrim install folder: XSE_TES5_GAME_PATH

Project Generation (Optional)

If you use Visual Studio, 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.

Alternatively, if you do not use Visual Studio, you can generate a compile_commands.json file for use with a laguage server like clangd in any code editor that supports it, like vscode:

xmake project -k compile_commands

Note: You must have a language server extension installed to make use of this file. I recommend clangd. Do not have more than one installed at a time as they will conflict with each other. I also recommend installing the xmake extension if available to make building the project easier.

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.