Command293-LocalFlashlight icon

LocalFlashlight

Adds a light to the local player which can be configurated

Last updated 4 days ago
Total downloads 10209
Total rating 4 
Categories Mods Misc BepInEx Client-side
Dependency string Command293-LocalFlashlight-1.3.0
Dependants 11 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2100
Rune580-LethalCompany_InputUtils-0.7.4 icon
Rune580-LethalCompany_InputUtils

API/Library for creating Unity InputActions with in-game re-binding support. Provides an alternative UI that allows for supporting mods to have in-game re-bindable keybinds.

Preferred version: 0.7.4

README

LocalFlashlight

A LC mod which adds a flashlight that has a recharging battery, with visual indicators, custom colors, and multiple recharge options.

Mod capabilities

The mod adds a flashlight that uses a battery system which recharges when not in use. It also adds an indicator that has multiple styles, and custom colors for both the HUD and light. Some values for the light and battery are also configurable.

Installation and configuration

The mod can be installed through either Thunderstore Mod Manager or r2modman, or it can be installed manually by installing BepInEx for the game, downloading the mod manually (either from the Thunderstore page of the mod or the release on GitHub), 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 (Thunderstore Mod Manager or r2modman) or by opening the command.localFlashlight.cfg file made by the mod in the in BepInEx/config. Alternatively, you could use LethalConfig if you want to change some config values while in-game.

Mod configs

-Intensity, range and spot angle of the light can be configured

-The battery's max time and recharge multiplier can also be configured

-The HUD has six different styles (Low battery warning, Bar, Percentage, Circular Bar, Vertical Bar, All)

-Custom colors can be set for the light and HUD

-The light's shadows can be enabled or disabled

-Option to prioritize in-game flashlights before the local flashlight

-Multiple recharge options for the flashlight, each with their own upsides and downsides

Indicator config styles

-Bar

bar style

-Percentage

percent style

-Circular bar

circular style

-Vertical bar

vertical style

-Full info

full style

-Low battery warning (can be disabled in config)

low battery warning

[!NOTE] The mod's keybinds are now in Settings -> Change keybinds, as I've added LCInputUtils as a dependency to make setting custom keybinds easier.

[!IMPORTANT] This mod is CLIENT-SIDED, so everyone who wants to use these features must have the mod installed. This also means that other players will not be able to see your light, nor you will be able to see other players' lights if they use the mod (hence the mod being called LocalFlashlight).

If you found a bug, then feel free to open a new issue on the Github page to report it.