Skip to main content

Configuring the settings

GLights come with two kinds of settings: global settings and per-panel settings. Global settings are more basic and contain a few settings shared across the entire GLights model, while per-panel settings allow you to tweak that specific set of lights to your liking.

Global settings

The global settings contain the primary whitelist as well as two additional settings explained below.

CheckForUpdates

When set to true, GLights will attempt to check for possible updates to the system. You can set it to false if you do not wish to receive update notifications.

FadeReset

When set to true, the lights will fade off while being reset instead of turning off instantly.

Per-panel settings

Every panel has its own Settings script with settings relating to fixtures in the folder that the panel is in. You can open the settings by double clicking the Settings script.

Here's each setting explained:

BaseModel

This setting controls which fixture model is used with that panel. You'll learn about model templates and custom models later, but for now you need to know that by default you can use Head, Wash, Bar, LineBar, Strobe and LED

AddBeams, AddMotors, AddLight, AddGobo

Those settings control what should be generated when the game starts. For example, if the AddBeams setting is set to true, then beams will be added to the model. If you know you don't need something in models controlled by that panel, you can set that setting to false to improve performance.

CastShadow

This setting controls whether or not lights will cast shadows. Setting it to false will improve performance.

Whitelist

You can use this setting to override the global whitelist, it uses the same format as the global whitelist (just without the return).

MaxBrightness

This setting overrides how bright the lights can get. It's disabled by default. To enable it, uncomment it (remove the -- before it).

LightRange

This setting overrides the range of the lights. It can go up to 120. It's disabled by default. To enable it, uncomment it (remove the -- before it).

BeamLength

This setting overrides how long the beam of the light can be. It's disabled by default. To enable it, uncomment it (remove the -- before it).

StartTilt, StartPan

Deprecated

These settings have been replaced with the DefaultState setting.

Those settings control the start tilt and pan of the motors inside the lights. 0 tilt always points "up".

ClientSided

By default, all light actions happen on the client (in a local script, individual for each player). This makes the lights appear smoother, but might lower performance a bit. It's recommended to keep this setting set to true, but in extreme cases you might want to set it to false to improve performance.

ServerPhysics

This setting allows you to force physics to run on the server even if ClientSided is set to true. Set this to true for lights that are on moving trusses.

FadeTime

The amount of time in seconds it takes to fade on/off or between colours

FadeFPS

How many times a second the brightness / colour of a light should update when fading. Setting this setting to a lower number will increase performance.

StrobeRate

How many times a second the lights turn on and off when the Strobe cue is enabled

MatchAngle

Experimental

This setting is experimental. It might change in the future.

When set to true, the angle of the light will be matched to the width of the beam. This doesn't affect gobo beams or follow beams. This setting works best with Realistic lighting and might affect performance.

UseLensTransparency

When this setting is set to true, the lens will change its transparency instead of its colour while turning on/off and fading. Keeping this setting set to false is better for performance.

OffColor

This setting controls the color of lights when they're turned off. You can edit it by pressing on the numbers and pressing the color picker icon that pops up. This setting is used only when UseLensTransparency is set to false.

You can set this setting to "Darken" (example below) to make the lights darker when they're off, based on their current colour (for example lights set to pink will still be pink when off). If you wish to enable this functionality, the setting should look like this:

OffColor = "Darken",

GradientSpeed

This setting decides whether the cue speed or fade speed modifier is used for animated gradient speed. By default it is set to FadeSpeed, but you can set it to CueSpeed if that works better for you.

Keybinds

See the Keybinds page for more details on how to set up keybinds.

DefaultState

See the Default state page for more details.