docs: Update docs for effects

1 year ago · 95cbed08b8
parent a800b54a13
commit 95cbed08b8
1 changed files with 3 additions and 2 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -37,8 +37,9 @@ Most window management stuff (layouting, movement, properties, communication bet

 ### Window Effects

-Window effects are located in the `effects` folder in `src`, with one folder per effect.
-Not everything here is an effect as exposed in the configuration UI, such as the colour picker in `src/effects/colorpicker`.
+Window effects are located in `src/plugins`, one effect plugin per folder.  Folder `src/plugins/private` contains the plugin (`org.kde.kwin.private.effects`) that exposes layouting properties and `WindowHeap.qml` for QML effects.  Not everything here is an effect as exposed in the configuration UI, such as the colour picker in `src/plugins/colorpicker`.
+
+Of note, the Effects QML engine is shared with the Scripting components (see `src/scripting`).

 ### Scripting API