From 95cbed08b8dc7de2c1f71ad7fd7bd1e608db7f49 Mon Sep 17 00:00:00 2001 From: Mike Noe Date: Tue, 8 Aug 2023 12:01:03 -0400 Subject: [PATCH] docs: Update docs for effects --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 970fad79ed..2ccc0101f9 100644 --- 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