User plugins

[toyboot4e]

Background

• Revisiting Exposing buildPythonPackage or the nixpkgs #234 with three different scenarios.

Details

We should at least document workarounds for the following cases.

[WIP] Case 1. Add your own plugin

Step 1. Override the nixpkgs for plover-flake to match the package versions:

inputs.plover-flake.inputs.nixpkgs.follows = “nixpkgs”;

Step 2. Use plover-flake.packages.plover to build your own plugin.

TODO: write a working example here

For now, please refer to this comment as an example.

Case 2. Overwrite a broken package that comes with plover-full

This case can be resolved in the same way as Case 1.

broken packages are marked like this:

plover-flake/overrides.nix

Line 112 in 08472c2

meta.broken = true;

[WIP] Case 3. Overwrite a non-broken package that comes with plover-full

Currently, plover-full is not flexible enough for this. Change withPlugins to overwrite packages?

[WIP] Case 4. Dictionary plugins

Future ideas

• Option A. Expose makePloverPlugin.
  • We should support GUI plugins, too, but that's not easy.
  • Keeping the current state also makes sense.