> For the complete documentation index, see [llms.txt](https://dorreal-art.gitbook.io/dorreal_art_docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dorreal-art.gitbook.io/dorreal_art_docs/documentation/documentation.md). # Documentation *** ### **Adding Echoluma Controller and Echoluma Lights to the Scene** * Open Content Browser. * Find `BP_EcholumaLightController` and your preferred Echoluma Light:
Echoluma BeatSync Folder view
Echoluma Light Controller Blueprint
Echoluma Light Blueprints
* Drag\&Drop `BP_EcholumaLightController` and Echoluma Lights into the scene. * All required settings are located in the **Details Panel** of the controller.
### **Playback Control** These control when and how the system runs.
Echoluma Light Controller Details Panel Playback Control UI
Controlled Lights Defines which lights are controlled by this Echoluma Light Controller. Add lights to this array by pressing :circle-plus: and then selecting an Echoluma Light in the scene with :eye-dropper: to include them in the sequence.
{% hint style="info" %} Offsets are applied based on the order in **Controlled Lights**. The first light in the list receives the first offset, followed sequentially. {% endhint %}
BPM Short for Beats Per Minute. Sets the tempo of the system by defining how many beats the system will execute in a minute. The entire system is driven by this value, making accurate BPM setup essential for proper synchronization. You can use the free online tool below to calculate the BPM of your music:
Mode This setting defines whether the system uses a constant pulse, a single step, or a full sequence of steps. * **Auto** Automatically selects the most appropriate mode based on available data. Uses All Echoluma Steps if valid sequence data exists \ Falls back to Single Step if only one step is defined \ Defaults to Mono if no pattern data is available Recommended for general use. *** * **Mono** Executes a beat constantly based on BPM value. All beats are treated as active, creating a constant rhythmic pulse. Useful for: Testing timing and intensity \ Continuous strobe or uniform motion \ Simple, consistent lighting setups *** * **Single Step** Executes beats based on a single boolean pattern of chosen Step index. True → Beat is triggered \ False → Beat is skipped Useful for testing steps individually. *** * **Step Sequence** Executes a series of steps, each with its own pattern and light configuration. Each step can contain: Unique pattern data \ Movement settings \ Light FX and look values Steps are played in order, forming a complete timed performance.
Preview Step Lets you preview a specific single step without playing the full sequence. Requires **Mono** or **Single Step** mode.
Start On Begin Play? Automatically starts the light show when the scene begins. {% hint style="warning" %} If it turned off, light show should be started manually by using the "Begin Light Show" Blueprint node. ![](/files/gIep0qK5nfgi3TEg8TuJ) Check out [Starting Light Show Manually](/dorreal_art_docs/documentation/advanced/starting-light-show-manually.md) to learn how. {% endhint %}
Loop? * [x] Repeats the sequence indefinitely. * [ ] Stops after executing all beats.
### **Echoluma Steps** These steps define what happens over time.
Adding Echoluma Steps Steps can be added through the :circle-plus: icon next to "Echoluma Steps". Each step index contains: * Pattern (beat execution) * Envelope (timing) * Light Look (appearance) * Movement (motion) * Light FX (effects)
### **Step Pattern** Defines beat execution for the step.
True → Beat is triggered \ False → Beat is skipped
Adding Pattern Indexes Pattern Indexes can be added through the :circle-plus: icon next to Step Pattern. Then making the index true will make the system to execute that beat.
Duplicate Pattern Duplicate Pattern button extends the current pattern by duplicating the existing one, preserving the original rhythm.
### **Envelope** Defines the intensity envelope applied per beat.
Attack Controls how quickly the light intensity rises from dim value to hit value after a beat is triggered.
Peak Determines how long the light stays at hit value before transitioning to release.
Release Controls how quickly the light fades from hit value back to its dim value.
{% hint style="info" %} If the sum of **Attack + Peak + Release** exceeds the duration of a **beat**, the values are automatically scaled at runtime. > Keeps the envelope within the available time window. > {% endhint %} Together, these settings allow you to shape the energy and feel of the lighting behavior, from sharp electronic pulses to smoother cinematic transitions. ### **Light Look** Defines the visual appearance of the light during active beats and its resting state. Controls intensity, color, and beam shape for both Hit (active) and Dim (idle) phases.
Lights Offset Beats Shifts activation timing relative to the main beat. The amount of shift depends on the light’s order in the Controlled Lights array.
Hit Intensity, Color & Cone Angle Defines the maximum light intensity, color and cone angle reached during an active beat.
Dim Intensity, Color & Cone Angle Defines the base intensity, color and cone angle of the light when no beat is active. Acts as the resting state between hits.
Auto Color Behaviour Auto Color Behavior controls how colors are distributed across multiple lights.
* **Group**\ Assigns one color per beat to the entire group of lights. *** * **Individual**\ Assigns different colors to each light on every beat.
Auto Color Assignment When enabled, the system automatically assigns colors per beat based on internal color variation logic. Overrides manually set Hit Color values while active.
* **Off** Auto Color off. Uses the user defined Hit and Dim colors. *** * **Dim Only** Dim Only applies automatic colors for when the beat is inactive. *** * **Hit Only** Hit Only activates automatic color assignment only when beats fire. *** * **Always** Always enables both Hit and Dim auto color assignment.
### **Movement** Defines how controlled lights move in space over time. Includes rotation, preset based motion, target references, timing, and speed controls.
Pan, Tilt & Roll Pan, Tilt, and Roll control the rotational pivots of the light. Unlike static axis rotation systems, these axes are evaluated relative to the light’s current world rotation, allowing movement behavior to adapt naturally based on orientation.
Movement Selects the predefined movement preset applied to the controlled lights.
* **Relative Movements** * **Default:** Basic Pan, Tilt and Roll move. * **Offset:** Sets Gradual Offsets to Pan, Tilt and Roll values. * **Randomize:** Random movements within specified Pan, Tilt and Roll values.
*** * **Continuous Motion Movements** * **Additive:** Accumulative motion. * **Pendulum:** Symmetrical back and forth. * **Sine Wave:** Creates smooth, rhythmic oscillation using a sine wave function.
*** * **Targeted Movements** * **Merge:** Merge Lights to the Target/Controller Location. * **Seperate:** Push Lights outward from the Target/Controller Location. * **Orbit:** Lights move in an orbital pattern around the Target/controller root.
*** * **Sequencer Driven** Disables system's procedural movement. Rotation is controlled entirely by Sequencer keyframes using Movement Sequencer section.
Movement Behaviour Determines how the selected movement is executed over time.This setting controls whether motion is continuously evaluated, performed once and held, or repeated in cycles. * **Continuous** Movement is evaluated every cycle and continuously updated over time. Typically used for:
Additive motion \ Procedural or flowing movement patterns *** * **Move & Hold** Movement is executed once over the defined duration, then holds its final position. The duration is controlled by Move In (Beats). Useful for:
Directed transitions \ Positioning lights to a target state *** * **Looping** Movement repeats in cycles based on the defined duration. Each cycle completes over Move In (Beats) and then restarts. Useful for:
Repeating spatial patterns \ Rhythmic motion loops
Focus Actor Specifies the target actor used as a spatial reference for certain movement presets. {% hint style="info" %} If no **Focus Actor** is assigned, focus dependent movements will use the **controller as Focus Target** by default. {% endhint %}
Move In (Beats) Determines how many beats it takes for the movement to complete one full cycle or reach its target position.
Speed Multiplier Scales the base movement speed.
Focused Target Radius Defines the distance from the Focus Actor when using radius based movement presets.
### **Light FX** Controls dynamic visual effects applied to the light output. Includes strobing, masking (gobo), and texture-based transformations such as tiling, offset, and rotation.
Strobe Enables rapid intensity pulsing. {% hint style="info" %} High **Strobe** values can introduce visual artifacts. Keeping the value at **5 or below** is recommended for clean results. {% endhint %}
Mask Intensity Controls the visibility of the applied mask.
Mask Texture Specifies the texture used as the projection mask for the light. Defines the projected pattern shape applied to the beam. {% hint style="info" %} **Mask** effects use the **alpha channel** of the assigned texture. {% endhint %}
Texture Control * **Invert Mask?:** Reverses the light and dark areas of the selected mask texture. * **Tiling:** Controls how many times the mask texture repeats across the projection surface. * **Offset:** Adjusts the mask texture’s position within the projection space. * **Rotation:** Controls the angular rotation of the mask texture. Rotates the projected pattern around its center axis. * **Speed:** Animates mask texture by rotating it continuously.
### **Movement Sequencer** Stores the reference used for Sequencer Driven movement. Holds the Level Sequence that can be used to drive custom movement for the current step.
Movement Sequencer Reference to the Level Sequence used for Sequencer Driven movement.This sequence defines the animation that will override preset movement for the current step.
**Check Sequencer Movement Page for more info.** {% content-ref url="/pages/wtLOSS06M5sAvgULLypt" %} [Sequencer Movement](/dorreal_art_docs/documentation/advanced/sequencer-movement.md) {% endcontent-ref %} ### **Isolate Group** Toggles visibility of other lights in the scene. This helps you evaluate the contribution of a single control group in complex setups.
### **Auto Assigned Indicators** These indicators are calculated automatically based on your patterns. They provide **visual feedback**, not manual control.
Step Start Beat Displays the beat at which the step begins within the sequence.
Step Length Shows how many beats a step runs before moving to the next step or ending.
### **Advanced**
Preserve Initial Look Preserve Initial Look determines how lights behave before the first active beat. When enabled, lights keep their original scene appearance until the controller activates them for the first time. When disabled, Dim values are applied immediately when the show begins.
Isolated Lights Displays which lights are currently disabled due to isolation.
### :circle-chevron-right: Learn About Rotation Meshes & Fixtures {% content-ref url="/pages/qSRrEeXe8onF7fLJLwTA" %} [Rotation Meshes & Fixtures](/dorreal_art_docs/documentation/advanced/rotation-meshes-and-fixtures.md) {% endcontent-ref %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://dorreal-art.gitbook.io/dorreal_art_docs/documentation/documentation.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.