Skip to content

Start with OpenVinc

Documented releasev0.2.0/Stable main branch

OpenVinc is a C++23 framework for applications assembled from independent module processes. This documentation describes v0.2.0.

  • C++: inherit BaseModule and register a module type. Your module is a plugin library; the App launches itself in a separate Host process to load it.
  • Python: export a Module class derived from vinc.BaseModule. The central process launches an installed CPython interpreter; it does not embed or install Python.

For C++, start with the build guide. For Python, start with Prepare the Python examples. Then complete Your first running module, selecting the matching language tab.

The release contains C++ and Python user examples. They illustrate framework APIs and ownership. Review their README before launching them.

After running one module, follow Your first cross-process message to send and receive a counter between two modules. The lessons share one independent examples repository; the Python examples use the same build entry point.

Next, follow Define your own message to define numeric and string fields in one .msg file for C++ and Python.

Then read Give your module its own commands to add receiver reset to the counter example.

Continue with Configure and save module parameters to adjust the sender’s counter increment and keep the setting after restarting.

Then follow Your first RPC: ask another module to have the sender request the received count and handle the reply.

Next, use Start modules with a script to launch both modules from one Tcl file.

Then follow Write logs from your modules to record module activity and filter logs in Vinc Shell.