summaryrefslogtreecommitdiffstats
path: root/doc/packages
diff options
context:
space:
mode:
authorlelgenio <lelgenio@disroot.org>2024-02-07 15:12:22 -0300
committerlelgenio <lelgenio@disroot.org>2024-04-07 02:12:36 -0300
commit1816172445bb714c9b4766f93c90aeb7f9b7e58f (patch)
tree1c4df68351315cac7a05290d6cd5a2ebf909b5a2 /doc/packages
parentd4bb486c8df40b44acf6909c0a7ce9f875c1d933 (diff)
doc: add krita plugins section
Diffstat (limited to 'doc/packages')
-rw-r--r--doc/packages/index.md1
-rw-r--r--doc/packages/krita.section.md37
2 files changed, 38 insertions, 0 deletions
diff --git a/doc/packages/index.md b/doc/packages/index.md
index 1f45018ffc4a..38dba5b3498f 100644
--- a/doc/packages/index.md
+++ b/doc/packages/index.md
@@ -14,6 +14,7 @@ fish.section.md
fuse.section.md
ibus.section.md
kakoune.section.md
+krita.section.md
linux.section.md
locales.section.md
etc-files.section.md
diff --git a/doc/packages/krita.section.md b/doc/packages/krita.section.md
new file mode 100644
index 000000000000..ba427bd62ba1
--- /dev/null
+++ b/doc/packages/krita.section.md
@@ -0,0 +1,37 @@
+# Krita {#sec-krita}
+
+## Python plugins {#krita-python-plugins}
+
+"pykrita" plugins should be installed following
+[Krita's manual](https://docs.krita.org/en/user_manual/python_scripting/install_custom_python_plugin.html).
+This generally involves extracting the extension to `~/.local/share/krita/pykrita/`.
+
+## Binary plugins {#krita-binary-plugins}
+
+Binary plugins are Dynamically Linked Libraries to be loaded by Krita.
+
+_Note: You most likely won't need to deal with binary plugins,
+all known plugins are bundled and enabled by default._
+
+### Installing binary plugins {#krita-install-binary-plugins}
+
+You can choose what plugins are added to Krita by overriding the
+`binaryPlugins` attribute.
+
+If you want to add plugins instead of replacing, you can read the
+list of previous plugins via `pkgs.krita.binaryPlugins`:
+
+```nix
+(pkgs.krita.override (old: {
+ binaryPlugins = old.binaryPlugins ++ [ your-plugin ];
+}))
+```
+
+### Example structure of a binary plugin {#krita-binary-plugin-structure}
+
+```
+/nix/store/00000000000000000000000000000000-krita-plugin-example-1.2.3
+└── lib
+ └── kritaplugins
+ └── krita_example.so
+```