xentara-plugin v1.2.1
The Xentara Plugin Framework
No Matches
Plugin Manifests

For Xentara to be able to use your plugin, you must provide a plugin manifest. A plugin manifest is a JSON file with the following format:

"name": "<plugin name>",
"path": "<path to the plugin library>"

plugin name Replace this with the your plugin's name. You can freely choose a name for your plugin, and the name can contain any UTF-8 characters.
path to the plugin library

Replace this with the path to the shared library or DLL that contains your plugin code. The path can either be an absolute path, or a path relative to the plugin manifest file.

On Windows, please remember that backslashes must be escaped in JSON files. Do not forget to double all the backslashes contained in the plugin library path.

Like all JSON files, the file should be encoded in UFT-8 (without a BOM).

Here is an example for a plugin manifest for a Linux plugin:

"name": "My Linux Plugin",
"path": "../../../lib/aarch64-linux-gnu/libmy-linux-plugin.so"

Here is an example for a plugin manifest for a Windows plugin:

"name": "My Windows Plugin",
"path": "..\\..\\Plugin Files\\my-windows-plugin.dll"

The plugin manifest must be places in a location where Xentara will find it. See Plugin Manifest Search Path in the Xentara user manual for details.

If you are using CMake to build your plugin, you can have cmake generate a plugin manifest for you. Please see CMake Integration for details.

See also
Plugin Manifests in the Xentara user manual