Colourful Flashlights

Change the colour (color) of your flashlight via the terminal in the company ship! Multiplayer compatible, syncs with other players!

Select from some built-in colours or effects, use any hexadecimal colour code or define presets in a configuration file!

Terminal options

Presets

You can create presets in BepInEx/config/ColourfulFlashlights/UserPresets.json

Note: You do not need to restart the game for your changes to be loaded.

The format is an array of objects defining a name, mode, speed and an array of hexadecimal colours.

name is a string that must be unique from other preset names, case-insensitive, max 15 characters long.

mode is an integer (see table below for options).

speed is an integer 1-20, with 1 being the slowest and 20 the fastest. Can be omitted for modes that don't require it.

colours is an array of strings, which must be hexadecimal colour codes, e.g. ["#FF00BB", "#CC5500"]

To load a preset in game, use cf preset <name> in the terminal.

You can save the current state of your flashlight with the cf save <name> command. If you provide a name of an existing preset, that preset will be overwritten. Preset names are case-insensitive and limited to 15 characters in length.

Modes

Fixed Mode

{
    name: "foo",
    mode: 0,
    colours: ["#3BC4E3"]
}

Even if you have more colours in the array, only the first one is used to make a fixed flashlight.

Cycle and Smooth Cycle Modes

{
    name: "foo",
    mode: 1,
    speed: 8,
    colours: ["#3BC4E3", "#E07EC8", "#FFFFFF", "#ED0057", "#ED7700"]
}

In cycle mode, the flashlight will swap through the colours at a rate determined by the speed option.

Setting mode to 2 will create a smooth cycle, the flashlight will transition smoothly, while blending from one colour to the next.

Random Mode

{
    name: "foo",
    mode: 3,
    colours: ["#3FF707", "#005CFF", "#FF0000", "#FF7C4B"]
}

Random mode will choose a new colour from the provided colours at random, each time the flashlight is turned off and then back on.

If no colours are provided, then a random colour will be generated each time (behaviour of the built in cf random option).

Health Mode

{
    name: "foo",
    mode: 4,
    colours: ["#005CFF", "#FF0000"]
}

In health mode, the flashlight will update based on it's holder's current health.

The first colour in the array is 100% health and the second is 10% health. For health values between 100% and 10%, the colour will be interpolated. In this example, starting with a blue colour and getting more red the more damage the holder takes.

Full UserPresets.json Example

[
    {
        name: "example1",
        mode: 2,
        speed: 4,
        colours: ["#3BC4E3", "#E07EC8", "#FFFFFF", "#ED0057", "#ED7700"]
    },
    {
        name: "example2",
        mode: 0,
        colours: ["#1FFFB4"]
    },
    {
        name: "example3",
        mode: 3,
        colours: ["#3FF707", "#005CFF", "#FF0000", "#FF7C4B"]
    },
]

"example1" slowly and smoothly cycles through the colours in the array (in the order they appear).

"example2" is a fixed colour so only the first colour in the array will be used.

"example3" will choose a random colour from the colours array each time the flashlight is toggled.

To load a preset in game, use cf preset <name> in the terminal. For example: cf preset example1

Configuration

There are 3 configuration options, found in BepInEx/config/ColourfulFlashlights/Config.cfg

Issues and Feedback

If you find any issues, bugs, or just want to provide feedback, feel free to open an issue on GitHub.