You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/moonbase/module/effects.md
+36-30Lines changed: 36 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,55 +6,58 @@
6
6
7
7
The Effects module defines effects and modifiers. They run in a 'layer'.
8
8
9
-
* Effect 🔥: An animation running in a coordinate space, e.g. a graphical equalizer or game of life. Effects can run in 1D, 2D or 3D coordinate spaces.
9
+
* Effect 🔥: An animation running in a layer, e.g. a graphical equalizer or game of life. Effects can run in 1D, 2D or 3D coordinate spaces.
10
10
* Modifier 💎: An effect on an effect e.g. mirror, multiply or rotate. See [Modifiers](https://moonmodules.org/MoonLight/modifiers/)
11
11
* Layer: An area on a (LED) display. Effects and modifier run in this area. Each layer maps a coordinate space to the display
12
12
13
-
!!! info
13
+
!!! info "One layer"
14
14
15
15
Until v0.6.0 there is only one layer, projected on the whole display. Multiple layers is planned after v0.6.0
16
16
17
-
!!! info
17
+
!!! info "3D"
18
18
19
-
Traditionally effects where mostly 1D running on LED strips, when LED matrices became available 2D effects where created. More and more LED art installations have a 3D shape so also support for 3D is desirable. MoonLight is build from the ground to support 3D. Basic idea is that a 1D effect is 3D where y and z is 0, 2D has z is 0. This means modifiying an effect to run in 3D is possible. This can be done using modifiers, but also the source code of an effect can be changed to support more dimensions (see development).
20
-
21
-
!!! tip
22
-
23
-
Livescripts... A node can be precompiled in the firmware or defined by a live script loaded onto the File System (See File Manager).
19
+
MoonLight is build from the ground to support 3D. First there where LED strips, later LED matrices and now also 3D shapes like spheres or cubes, making it suitable for art-installations. 1D and 2D objects can be seen as 3D objects where some dimensions have a width of 1. Most effects are 1D or 2D, they will slowly be adapted to support also 3D, furthermore modifiers can be used to project 1D on 2D or 2D on 3D layouts.
24
20
25
21
## Controls
26
22
27
23
* Layer: Choose the layer - currently only one layer supported
28
24
* Start, End and Brightness: read only for now, when multiple layers are implemented (>v0.6.0), these can be set per layer
29
-
* Nodes: effects and modifiers will be shown as nodes with controls
30
-
* Reorder: Nodes can be reordered, defining the order of executions (effects: which effect on top of the other effect. Modifiers: which modifier is done first, e.g. circle then multiply will yield to a different result than multiply then circle)
25
+
* Effects and modifiers will be shown as nodes with controls
26
+
* Reorder: Nodes can be reordered, defining the order of executions
27
+
* effects: which effect on top of the other effect.
28
+
* Modifiers: which modifier is done first, e.g. circle then multiply will yield to a different result than multiply then circle
31
29
* Controls. A node can be switched on and off and has custom controls, which defines the parameters of the node (e.g. effect speed).
32
30
33
31
## Effect 🔥 Nodes
34
-
🚧
35
-
Precompiled effects can be found in [effects](https://github.com/MoonModules/MoonLight/blob/main/src/MoonLight/Nodes/Effects/Effects.h)
32
+
33
+
Below is a list of effects in MoonLight
36
34
37
35
### MoonLight effects
38
36
37
+
These effects are first created in MoonLight
38
+
39
39
| Name | Preview | Controls | Remarks
40
40
| ---- | ----- | ---- | ---- |
41
-
| Lines ||||
42
-
| MoonMan ||| if USE_M5UNIFIED |
41
+
| Lines ||| To test a layout |
| MoonMan ||| only on devices supporting M5 library, e.g. AtomS3R |
43
44
| Particles ||||
44
45
| Rainbow ||||
45
46
| Random ||||
46
47
| Ripples ||||
47
-
|RubiksCube||||
48
-
|ScrollingText|| Speed: scrolling speed if the text is wider then the display width, Font: Different font sizes, Preset: one of the following: Auto, IP (.ddd), FPS (ddds), Time (HHMM), Uptime (s/m/h), Status 🛜 (AP/STA), Clients 🛜 (dC), Connected 🛜 (dCC) | Shows system info on leds. You need at least 16*6 pixels for that (Panel 16x16 recommended) |
48
+
|Rubiks Cube||||
49
+
|Scrolling Text|| Speed: scrolling speed if the text is wider then the display width, Font: Different font sizes, Preset: one of the following: Auto, IP (.ddd), FPS (ddds), Time (HHMM), Uptime (s/m/h), Status 🛜 (AP/STA), Clients 🛜 (dC), Connected 🛜 (dCC) | Shows system info on leds. You need at least 16*6 pixels for that (Panel 16x16 recommended) |
49
50
| Sinus ||||
50
-
|SphereMove||||
51
+
|Sphere Move||||
51
52
| StarField ||||
52
53
| Praxis ||||
53
54
| Wave ||||
54
-
|FixedRectangle ||||
55
+
|Fixed Rectangle ||| To test a layout|
55
56
56
57
### MoonModules effects
57
58
59
+
The followingg effects are created by the MoonModules team, mostly first in WLED-MM and ported to MoonLight
60
+
58
61
| Name | Preview | Controls | Remarks
59
62
| ---- | ----- | ---- | ---- |
60
63
| GEQ3D ||||
@@ -64,32 +67,35 @@ Precompiled effects can be found in [effects](https://github.com/MoonModules/Moo
64
67
65
68
### WLED effects
66
69
70
+
The following effects originated from WLED, most have been enhanced in WLED-MM and ported to MoonLight
71
+
67
72
| Name | Preview | Controls | Remarks
68
73
| ---- | ----- | ---- | ---- |
69
74
| Solid || <imgwidth="320"src="https://github.com/user-attachments/assets/844bdbf1-b42b-4b5c-94f9-d1334bce2b10" /> | Sends a solid RGB to all lights. Can be used as background to other effects, order it before other effects |
0 commit comments