From 06a3fbe13d78b87cfe8468f4f88389945a1d84dc Mon Sep 17 00:00:00 2001 From: 4ian <1280130+4ian@users.noreply.github.com> Date: Tue, 4 Aug 2026 11:00:05 +0000 Subject: [PATCH] [Auto] [Improve] Added key-property tuning guidance and animation use cases to visual effect documentation pages --- automated_updates_data.json | 4 ++++ docs/gdevelop5/all-features/effects/color-map/index.md | 2 ++ docs/gdevelop5/all-features/effects/crt/index.md | 2 ++ docs/gdevelop5/all-features/effects/drop-shadow/index.md | 4 +++- docs/gdevelop5/all-features/effects/god-rays/index.md | 2 ++ docs/gdevelop5/all-features/effects/kawase-blur/index.md | 2 ++ docs/gdevelop5/all-features/effects/outline/index.md | 2 ++ docs/gdevelop5/all-features/effects/pixelate/index.md | 2 ++ docs/gdevelop5/all-features/effects/rgb-split/index.md | 2 ++ docs/gdevelop5/all-features/effects/tilt-shift/index.md | 2 ++ 10 files changed, 23 insertions(+), 1 deletion(-) diff --git a/automated_updates_data.json b/automated_updates_data.json index 2fa8e494dbb..287a27a4f8c 100644 --- a/automated_updates_data.json +++ b/automated_updates_data.json @@ -104,6 +104,10 @@ { "date": "2026-07-07", "summary": "Improved keyboard docs: added 'Key just pressed' (held vs one-frame) and 'Any key released' conditions, control-remapping note, and a reference list of valid key names" + }, + { + "date": "2026-08-04", + "summary": "Added configuration guidance to visual effect docs (CRT, drop shadow, god rays, kawase blur, outline, pixelate, RGB split, tilt shift, color map): explained key tunable properties and animation use cases" } ] } diff --git a/docs/gdevelop5/all-features/effects/color-map/index.md b/docs/gdevelop5/all-features/effects/color-map/index.md index b0529016b20..a1fbc8e5957 100644 --- a/docs/gdevelop5/all-features/effects/color-map/index.md +++ b/docs/gdevelop5/all-features/effects/color-map/index.md @@ -22,6 +22,8 @@ Try some ready-to-use color maps - color-map-model-2.png : ![](color-map-model-2.png) - color-map-model-3.png : ![](color-map-model-3.png) +The **Mix** property controls how strongly the color map is applied: at a low value the original colors mostly show through, at the maximum only the remapped colors are used. Animating it with events is a simple way to fade in a color grading (for example a "poisoned" or "night" tint). + ## Reference diff --git a/docs/gdevelop5/all-features/effects/crt/index.md b/docs/gdevelop5/all-features/effects/crt/index.md index de52bffba07..d68fcd6025e 100644 --- a/docs/gdevelop5/all-features/effects/crt/index.md +++ b/docs/gdevelop5/all-features/effects/crt/index.md @@ -4,6 +4,8 @@ Applies a CRT effect, simulating an old cathode-ray tube television. ![](crt-effect.png) +**Curvature** bends the image like a rounded screen, while **Line width** and **Line contrast** control the visible scanlines. **Noise** adds static grain and **Vignetting** darkens the edges of the screen. To make the effect feel alive, raise the **Interlaced lines speed** and **Noise frequency** so the scanlines and static move over time. + ## Reference diff --git a/docs/gdevelop5/all-features/effects/drop-shadow/index.md b/docs/gdevelop5/all-features/effects/drop-shadow/index.md index f9ca072a4c2..87d7c6d9864 100644 --- a/docs/gdevelop5/all-features/effects/drop-shadow/index.md +++ b/docs/gdevelop5/all-features/effects/drop-shadow/index.md @@ -1,9 +1,11 @@ # Drop shadow effect -Add a drop shadow under your object's visible on the layer. +Add a drop shadow under your objects visible on the layer. ![](drop-shadow-effect.png) +**Distance** and **Rotation** set how far the shadow is offset and in which direction, while **Blur** softens its edges and **Alpha** controls how transparent it is. Enable **Shadow only** to hide the object and keep just its shadow, which is handy to build a separate silhouette on another layer. + ## Reference diff --git a/docs/gdevelop5/all-features/effects/god-rays/index.md b/docs/gdevelop5/all-features/effects/god-rays/index.md index 904f9fa64ac..a15fb48f668 100644 --- a/docs/gdevelop5/all-features/effects/god-rays/index.md +++ b/docs/gdevelop5/all-features/effects/god-rays/index.md @@ -4,6 +4,8 @@ Cast rays of light from the top of the screen. **This won't work well if shown o ![](godray-effect.gif) +Use **Center X** and **Center Y** to place the light source, and **Angle** to tilt the rays. Turn on **Parallel** for evenly spread sunlight-style rays, or turn it off to make the rays fan out from the center point (like a spotlight). **Gain** and **Lacunarity** adjust how strong and detailed the beams look, and increasing **Animation speed** makes them shimmer over time. + ## Reference diff --git a/docs/gdevelop5/all-features/effects/kawase-blur/index.md b/docs/gdevelop5/all-features/effects/kawase-blur/index.md index 703917f8251..baee45cabef 100644 --- a/docs/gdevelop5/all-features/effects/kawase-blur/index.md +++ b/docs/gdevelop5/all-features/effects/kawase-blur/index.md @@ -2,6 +2,8 @@ This is a faster version of the traditional "Blur" effect. It's recommended that you use this one rather than the "Gaussian" blur effect. +**Blur** sets the overall strength and **Quality** the number of passes (higher quality is smoother but more costly). To blur more in one direction than the other, use different **Pixelize X** and **Pixelize Y** values, for example to create a horizontal motion-blur look. + ## Reference diff --git a/docs/gdevelop5/all-features/effects/outline/index.md b/docs/gdevelop5/all-features/effects/outline/index.md index aecd08ff547..695719bf30d 100644 --- a/docs/gdevelop5/all-features/effects/outline/index.md +++ b/docs/gdevelop5/all-features/effects/outline/index.md @@ -2,6 +2,8 @@ Add an outline on all objects of the layer having the effect. **This won't work well if shown on top of the background color of the scene**. Be sure to use an object acting as a background or a floor. +Use **Thickness** to set how wide the outline is and **Color** to choose its color. Applied to a single object, this is a common way to highlight a selected or interactive item. + ![](outline-effect.png) diff --git a/docs/gdevelop5/all-features/effects/pixelate/index.md b/docs/gdevelop5/all-features/effects/pixelate/index.md index a6a86e125a9..53a7a7fabea 100644 --- a/docs/gdevelop5/all-features/effects/pixelate/index.md +++ b/docs/gdevelop5/all-features/effects/pixelate/index.md @@ -4,6 +4,8 @@ Applies a pixelated effect, making display objects appear 'blocky'. ![](pixelate-effect.png) +**Size** sets how many screen pixels each block covers: the larger the value, the blockier the result. Animating this value with events is an easy way to create a "pixel dissolve" transition. + !!! note For pixel-perfect or 8-bitgames, you can change the **Scale mode** options in your [game properties](/gdevelop5/interface/project-manager/properties) instead of using this effect. diff --git a/docs/gdevelop5/all-features/effects/rgb-split/index.md b/docs/gdevelop5/all-features/effects/rgb-split/index.md index 966ee01467e..7a519124f52 100644 --- a/docs/gdevelop5/all-features/effects/rgb-split/index.md +++ b/docs/gdevelop5/all-features/effects/rgb-split/index.md @@ -4,6 +4,8 @@ Separate each component's RGB(red, green, blue) colors and display them on the s ![](rgb-effect.png) +Each color channel has its own X and Y offset, so you can shift the red, green and blue parts of the image independently. Small offsets create a chromatic-aberration look, while larger ones give a glitch or old-3D-glasses effect. Animating the offsets with events makes a nice screen-shake or damage feedback. + ## Reference diff --git a/docs/gdevelop5/all-features/effects/tilt-shift/index.md b/docs/gdevelop5/all-features/effects/tilt-shift/index.md index 1a7cbcf3aea..9da0a58f233 100644 --- a/docs/gdevelop5/all-features/effects/tilt-shift/index.md +++ b/docs/gdevelop5/all-features/effects/tilt-shift/index.md @@ -4,6 +4,8 @@ Add blur to the top and bottom of the entire layer or object. Perfect to simulat ![](tilt-shift-effect.png) +**Blur** sets how strong the blur is at the top and bottom, while **Gradient blur** controls how gradually the sharp band in the middle fades into the blurred areas. A larger gradient gives a smoother, more natural transition. + ## Reference