Skip to content

Build the framework

Documented releasev0.2.0/Stable main branch

Use Git, CMake 3.20 or newer, Ninja, a C++23 compiler and standard library, and Python 3.11 or newer for App configuration. Building the included Web UI requires Node.js and npm. Windows requires MSVC 19.44 or newer. See the project README for platform tools.

Terminal window
git clone --recurse-submodules https://github.com/JayTDawgzone1994/open-vinc.git
cd open-vinc
npm ci --prefix src/vinc/ui/web
cmake -S src -B build/debug -G Ninja -DCMAKE_BUILD_TYPE=Debug
cmake --build build/debug

On Windows, run framework builds in an MSVC developer environment. Tcl uses NMAKE. On POSIX, read the Tcl build requirements before configuring.

main is the stable branch. For an existing checkout, run git submodule update --init --recursive after updating its source.

v0.2.0 composes applications with vinc_add_app() and selects modules through an App configuration file, vinc.conf. Official Web UI and Recorder modules start with the App. Python modules are optional: enable CONFIG_VINC_APP_PYTHON=y in the App configuration and select their interpreter. See the Python SDK.

Start the built App. It launches native module subprocesses using the same executable, with no separate ModuleHost.exe deployment. Python modules continue to use the selected CPython interpreter.

Continue with Your first running module to create your own module in a minimal independent project. It uses its own App, configuration file and build directory.