gottyduke / PluginTemplate

Generic native dll plugin template for various games.

📑 PluginTemplate

Generic native dll plugin template for various games.

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 during installtion/updating
• PowerShell
• Vcpkg
  • Set the VCPKG_ROOT environment variable to the path of the vcpkg folder
  • 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++
• [Auto Deployment Target Path]
  • Set the GamePath environment variable to the path the plugin should install to; read here

⬇️ Get started

💻 Register Visual Studio as a Generator

• Open x64 Native Tools Command Prompt
• Run cmake
• Close the cmd window

📦 Dependencies

• DKUtil

These dependencies can be configured through the git submodule by running update-submodule.bat. Alternatively, the dependencies can also use a local git repository, by setting the DKUtilPath environment variable to the path of the local git repository.

In order to enable local git repository lookup, existing folders within extern should be removed.

To prevent duplicating submodules in multiple local projects, it's recommended to clone the DKUtil repositories locally. Then, set the environment path accordingly, this ensures all projects share the same package.

🔨 Building

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

A Visual Studio solution will be generated inside build folder.

➕ Addon

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

Both enabled by default. To override log path (process directory by default), set the macro value in PCH.h. To override config file lookup path (process directory by default), set the macro value in PCH.h.

📖 License

This branch is licensed under MIT.

❓ Credits

• Ryan for his commonLibSSE code which was referenced in DKUtil.