Draconis++ Plugin Template #

A starter repository for external Draconis++ plugins.

This template demonstrates:

• a self-contained plugin directory with plugin.json
• a simple IInfoProviderPlugin
• a Nix flake that exposes plugin-root packages
• optional per-plugin precompiled config via example_status/config.hpp

Layout #

example_status/
  example_status.cpp
  plugin.json
flake.nix

Draconis++ discovers plugins from directories that contain direct children with a plugin.json manifest. This repository root is therefore a plugin root.

Build With Draconis++ #

From a Draconis++ core checkout:

meson setup build -Dplugin_dirs=/path/to/draconisplusplus-plugin-template
meson compile -C build

To compile the plugin statically into Draconis++:

meson setup build -Dplugin_dirs=/path/to/draconisplusplus-plugin-template -Dstatic_plugins=example_status
meson compile -C build

Nix #

The flake exposes plugin-root packages:

• packages.${system}.default
• packages.${system}.all
• packages.${system}.example_status

For precompiled plugin config, use lib.${system}.mkPluginRoot to generate a configured copy of this plugin root. The generated header is written to example_status/config.hpp, where the plugin includes it in DRAC_PRECOMPILED_CONFIG builds.

programs.draconisplusplus = {
  enable = true;
  configFormat = "hpp";
  pluginPackages = [
    (inputs.my-draconis-plugin.lib.${pkgs.system}.mkPluginRoot {
      exampleStatus = {
        message = "Built into Draconis++";
      };
    })
  ];
  staticPlugins = ["example_status"];
};

For a non-configured plugin root:

programs.draconisplusplus = {
  enable = true;
  pluginPackages = [
    inputs.my-draconis-plugin.packages.${pkgs.system}.all
  ];
  staticPlugins = ["example_status"];
};

Customizing #

Rename example_status to your plugin name, then update:

• example_status/plugin.json
• the C++ class and DRAC_PLUGIN(...) registration
• pluginNames in flake.nix
• any generated config header logic in flake.nix

Manifest notes:

• name should match the plugin directory and the implicit source file name.
• class must match the C++ class passed to DRAC_PLUGIN(...).
• platforms uses Meson host_machine.system() names such as linux, darwin, and windows; use ["all"] for portable plugins.
• deps lists external dependencies resolved by Meson, for example { "name": "libcurl", "include_type": "system", "static": true }.

Keep plugin-specific Nix config in this repository. The core Draconis++ module should only receive plugin roots through pluginPackages or pluginDirs.