Building the plugin¶

Note

The C++ plugin is currently Windows only.

Setup¶

To install the build dependencies, we use Conan which is a C/C++ package manager.

To install it, use the virtualenv provided by Poetry:

❯ poetry install # Installs Conan
❯ poetry shell # Enter a new venv shell

Then configure your Conan compilation profile:

(venv) ❯ conan profile detect

Windows¶

To compile the project with MSVC, an example configuration would be:

# C:\Users\$USER\.conan2\profiles\default

[settings]
arch=x86_64
build_type=Release
compiler=msvc
compiler.cppstd=17
compiler.runtime=static
compiler.version=193
os=Windows

On MSVC, to check your compiler.version, run the command cl in a Developer Command Prompt for VS and check the C/C++ Optimizing Compiler Version for example 19.35.32215

To check if your profile is correct, use:

(venv) ❯ conan profile show

Install the C++ dependencies¶

Install the dependencies specified in conanfile.txt:

(venv) ❯ conan install . --output-folder=build --build=missing

The above command generates CMake build files that helps finding those libraries.

Build¶

You first need to download the TVPaint C/C++ SDK in a local folder.

Configure the project with CMake and Conan by going into the build folder:

❯ cd build
❯ cmake .. -G "Visual Studio 17 2022" -DCMAKE_TOOLCHAIN_FILE="conan_toolchain.cmake" -DTVPAINT_SDK_FOLDER="/path/to/TVPaint_SDK"

(the above command assumes you are using Visual Studio 17, if not match that with your Conan profile)

Build the project in release mode:

❯ cmake --build . --config Release