Creating a New Effect
Now that your project is setup, its time to create your first effect! This guide will walk you through the process of creating a new effect, from setting up a player in your scene to designing a custom effect profile with layers.
1. Add a Lumen Effect Player to Your Scene
The Lumen Effect Player is the component that controls and displays your light effects in the scene.
Steps:
Right-click in the Hierarchy or use the top menu:
Go to GameObject → Effects → Empty Lumen Player.
A new GameObject named Lumen Effect Player will appear in your scene.
With the player selected, you’ll see the custom Lumen inspector in the Inspector window.
2. Create a New Lumen Effect Profile
The Effect Profile is a ScriptableObject that stores all the settings and layers for your effect.
Steps:
In the Project window, right-click in your desired folder.
Select Create → Lumen → Effect Profile.
Name your new profile (e.g.,
My Lumen Effect).
3. Assign the Effect Profile to the Player
Select your Lumen Effect Player in the scene.
In the Inspector, find the Profile field.
Drag your new effect profile into this field, or use the object picker to select it.
Effect Profiles are global. Keep this in mind before editing all of your streetlamps into rave lights 🤦♂️
4. Add and Configure Layers in the Effect Profile
Layers define the visual style and behavior of your effect. Each layer can add flares, rays, lights, or other stylized elements.
Steps:
Select your Effect Profile asset in the Project window.
In the Inspector, you’ll see the Lumen Effect Profile Editor.
Click Add Layer to add a new layer.
Configure the properties of each layer. See the documentation for individual layers for a description of what each setting does!
You can add multiple layers and reorder or remove them as needed.
5. Adjust Player Settings
With the Lumen Effect Player selected, you can tweak:
Scale: Overall size of the effect.
Brightness: Intensity of the effect.
Color: Tint of the effect.
Update Frequency: How often the effect updates.
Initialization/Deinitialization Behavior: How the effect appears/disappears.
Fading Time: Duration for fade-in/out (if enabled).
6. Preview and Iterate
As you adjust settings and layers, changes are reflected in real-time in the Scene view.
Use the Inspector to fine-tune each property.
You can duplicate and modify profiles for different effects.
Troubleshooting
If your effect does not appear, ensure the profile is assigned and contains at least one enabled layer.
Check that your project and URP settings meet the Lumen requirements (see the Lumen Setup window for guidance).
Last updated