https://github.com/openstenoproject/plover-flake
plover-plugin-flake
https://github.com/openstenoproject/plover-flake
Last synced: about 1 year ago
JSON representation
plover-plugin-flake
- Host: GitHub
- URL: https://github.com/openstenoproject/plover-flake
- Owner: openstenoproject
- Created: 2022-12-28T17:01:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-13T20:10:12.000Z (about 1 year ago)
- Last Synced: 2025-04-13T21:19:00.414Z (about 1 year ago)
- Language: Nix
- Size: 374 KB
- Stars: 13
- Watchers: 3
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A flake for plover with support for plugins
## Usage
Add this flake to your flake inputs, e.g. `inputs.plover-flake.url = "github:dnaq/plover-flake";`
Then a plover derivation containing the plugins you want can be built with
```nix
plover-flake.packages.${system}.plover.with-plugins (ps: with ps; [
plover-dict-commands
plover-console-ui
];
```
where `ps` is an attribute set containing all plugins from the plugin registry
as well as some extra plugins.
> [!NOTE]
> The plugin names were recently changed to be the same as in the [plugins registry](https://github.com/openstenoproject/plover_plugins_registry). This means that they will now consistently use dashes `-` in the names.
## Troubleshooting
If a specific plugin fails to build it is most likely because of a missing
dependency. In that case that dependency can be added to overrides.nix,
any pull requests doing so are welcome.
## Updating the plugin list from the registry
At some point this will be added to CI and done automatically, but in
the meantime it is possible to do the following:
```
nix develop
bash update.sh
```
## Current Issues
In order to support plover2cat the pyqt derivation is overriden with `withMultimedia = true;`.
This holds even if plover2cat isn't installed, which might entail a bit of a waste of disk space.
If anyone figures out a good way for plugins to additively add qt features when depended on, please let me know.