CommonLibSF Plugin Template

This is a basic plugin template using CommonLibSF.

Requirements

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

Getting Started

git clone https://github.com/Starfield-Reverse-Engineering/commonlibsf-template-xmake
cd commonlibsf-template-xmake

Building

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.

Deploy

To deploy the project, run the following command: (Replace OUTPUT_PATH with your desired output path)

xmake build
xmake install -o OUTPUT_PATH

Note: This will generate a sfse/plugins/ directory in the specified output path with the dll and pdb.

Project Generation (Optional)

Visual Studio

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.

Visual Studio Code

If you want to enable intellisense in Visual Studio Code, install the clangd extension and run the following command:

xmake project -k compile_commands --lsp=clangd

Note: This will generate a compile_commands.json file in the project's root directory

Documentation

Please refer to the Wiki for more advanced topics.