LocalFlashlight

A Lethal Company mod which adds a flashlight that has a recharging battery, with visual indicators, custom colors, multiple recharge options for the battery, and more!

Mod capabilities

This mod adds a "pocket flashlight" that uses a battery system which can be recharged in different ways depending on what you choose.

It also adds an indicator for the battery that has multiple styles and settings.

The mod also has a plethora of settings, so you can modify almost everything it does.

Installation and configuration

The mod can be installed using the mod manager of your choice, or it can be installed manually by installing BepInEx for the game, downloading the mod manually from the Thunderstore page of the mod or from the Releases tab in the Github repository (you will also need to download the dependencies for the mod, which are InputUtils and LethalConfig), then extracting the zip file inside the BepInEx/plugins folder after starting the game once with BepInEx installed.

Configuration of the mod can be done after starting up the game with the mod enabled through the Config editor (of the mod manager of your choice) or by opening the command.LocalFlashlight.cfg file made by the mod in the BepInEx/config folder.

Alternatively, you could edit the settings with LethalConfig in the game, as it is one of the mod's dependencies (besides networking, that needs to be set through the config itself, not through LethalConfig).

Mod settings

• Intensity, range and spot angle of the light can be set to (mostly) any value

• Some battery settings can also be modified

• The indicator has five different styles (Low battery warning, Bar, Text, Circular Bar, Vertical Bar, All) and four different information text styles (Percentage, Accurate percentage, Time, All)

• Custom colors can be set for the light and indicator (with hex codes)

• The light can also be configured to have shadows (or not)

• Option to prioritize in-game flashlights before the local flashlight (when they're in the inventory, or when a helmet light is active) when trying to toggle them.

• Multiple recharge options for the flashlight (a little unbalanced, but they all have their upsides and downsides depending on how you set up the mod)

• Multiple options for the sounds of the flashlight

• Flashlight networking, which can be used to play with other people that also have networking enabled, while also being able to see their lights alongside their colors and hearing the sounds they set

Indicator config styles

Indicator styles

• Bar

• Percentage

• Circular bar

• Vertical bar

• Full info

• Low battery warning (can be disabled in config)

Battery recharge options

Recharge options

• Time: The battery recharges whenever you're not using the flashlight, with different cooldowns before starting to recharge depending whether the entire battery was used up or not. Affected by the recharge multiplier. Intended for short flashlight battery spans.

• Shake: The battery ONLY recharges if you shake the flashlight, with it having a short cooldown before you can shake it again; it also takes a bit of stamina to do so. Affected by the recharge multiplier. Intended for very short flashlight battery spans.

• Camera Movement Assisted Recharge: The battery can only be recharged by shaking your camera. Go wild. Intended for very short flashlight battery spans.

• Hand Cranked: The battery recharges over time, but only while you're holding the key to recharge it. Slowly builds up more energy (up to 1.5x the normal drain multiplier), however your stamina regenerates slower and drains faster while winding it. Affected by the recharge multiplier. Intended for short flashlight battery spans.

• Ship Recharge: The battery recharges and stays at full battery whenever you're in the ship, as if you were recharging a normal flashlight in the ship (but faster). Not affected by the recharge multiplier, but can ONLY be fully recharged while in the ship. Intended for very long flashlight battery spans.

• Facility Powered: Cuts your light's set intensity in half if you use it, but it is affected by the facility's power managed via the breaker box and apparatus, so as long as there is power in the facility, the battery will not deplete. There is no way to recharge it other than turning the power back on, so if the Apparatus is taken, good luck! Not affected by the recharge multiplier, and cannot be recharged without the facility power being turned on. Intended for long flashlight battery spans.

Custom sounds and how to change them

Custom sounds are located in the mod's /customsounds folder (../BepInEx/plugins/Command293-LocalFlashlight/customsounds), with the already existing files being the mod's default sounds. The sounds can be changed freely (with the only limitation being that the file needs to be in either .ogg, .wav or .mp3 format for the custom sound to work), however their file name must stay the same.

Custom sound file names and what they're assigned to:

• lighton_custom: Flashlight turning on

• lightoff_custom: Flashlight turning off

• lowtoggle_custom: Flashlight turning off (No battery left)

• recharged_custom: Flashlight full recharge sound (Time recharge option)

• reloadlight_custom: "Shake" sound (Shake recharge option)

• dynamo_custom: Dynamo use sound (Dynamo recharge option)

• flashDown_custom: "power disabled" warning sound (Facility powered recharge option)

• changepos_custom: Light position change

• denytoggle_custom: Flashlight toggle blocked

[!IMPORTANT] The mod supports networking, but you will not be able to join other lobbies that do not have this mod or do not have the Networking config enabled, so make sure to disable it before trying to join random lobbies.

The mod's keybinds are in Settings -> Change keybinds, as this mod uses LCInputUtils to add mouse and controller binds.

If you found a bug, error or encountered something that shouldn't have happened with the mod, then feel free to open a new issue on the Github page or the LC modding discord server to report it.