Skip to the content.

The icon of the Vertex Lighting Plugin


Supported Engine Versions


đź“‘Limitations


How to Download and Install

  1. Download the Plugin
    • Get the plugin from the GitHub Releases page or by downloading the source code.
  2. Install the Plugin
    • Place the plugin folder into your project’s Plugins directory. (Create a Plugins folder if it doesn’t already exist.)
  3. Enable the Plugin
    • The plugin should be enabled by default. However, double-check that it is enabled in the Plugins menu within Unreal Engine.

    The Vertex Lighting Plugin being enabled

[đź’ˇDependencies] This plugin depends on the MeshPainting plugin. The MeshPainting plugin is only used to paint the icons of the vertex light actors in the editor to match their light color or ambient color. It is NOT used for the actual vertex lighting.


How to Use

  1. Set Up the Plugin
    • In the Content Browser, navigate to the Vertex Lighting Plugin directory.
    • Drag and drop the VertexLighting_Manager into your level. A guide image for the VertexLighting_Manager location in the folder
  2. Configure Materials
    • Locate the VertexLights_MaterialFunction in the Logic folder within the Vertex Lighting Plugin directory. A guide image for the materialfunction location in the folder
    • Open the materials you want to use and multiply your base color/texture (Input A) with the VertexLights_MaterialFunction (Input B). A guide image for the materialfunction in a material
    • Connect the result of the multiplication to the Base Color and/or Emissive Color of your material.
  3. Add Lights
    • Place a VertexLighting_Light or VertexLighting_Light_Animated actor into your level to add lights. A guide image for the VertexLighting_Light and VertexLighting_Light_Animated location in the folder

Demo Level

The plugin includes a demo level showcasing multiple vertex lighting configurations. Experiment with the light settings to get a feel for their functionality and effects. The icon of the VertexLighting_Manager


Plugin Components

VertexLighting_Manager

The VertexLighting_Manager is essential for vertex lighting functionality.

[đź“‘IMPORTANT] Ensure only one manager is present per level.

[‼️CAUTION] Only up to 256 vertex lights can be registered at the same time.

The icon of the VertexLighting_Manager

Default Settings:

Sun Direction:

The sun’s direction is controlled by the rotation of the VertexLighting_Manager and is visually represented by a yellow arrow originating from the manager.

Image of the yellow arrow originating from the manager

Tick Rate:

In-Editor Events:


VertexLighting_Light

The VertexLighting_Light adds a static or dynamic vertex light to your scene.

[🗒️NOTE] VertexLighting_Light is not considered relevant for Level Bounds.

The icon of the VertexLighting_Light

Default Settings:

[⚠️WARNING] Overridden by color curves for VertexLighting_Light_Animated.

[⚠️WARNING] Overridden by color curves for VertexLighting_Light_Animated.

Editor Settings:


VertexLighting_Light_Animated

The VertexLighting_Light_Animated adds a static or dynamic vertex light with a color curve to your scene.

[🗒️NOTE] The VertexLighting_Light_Animated inherits from VertexLighting_Light.

The icon of the VertexLighting_Light_Animated

Animated Light Settings:


Other Components

Color Curve

VertexLighting_Light_Animated uses a color curve for its Light Color and Brightness

Color Channels:


Troubleshooting

I can’t see any vertex lights

Ensure the following:

Crash: AnimSequenceBase error