LocalFlashlight
Gives the player a flashlight that is very configurable
| Last updated | 4 hours ago |
| Total downloads | 39649 |
| Total rating | 7 |
| Categories | Mods Misc BepInEx Client-side Server-side |
| Dependency string | Command293-LocalFlashlight-1.5.1 |
| Dependants | 30 other packages depend on this package |
This mod requires the following mods to function
BepInEx-BepInExPack
BepInEx pack for Mono Unity games. Preconfigured and ready to use.
Preferred version: 5.4.2100
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
AinaVT-LethalConfig
Provides an in-game config menu for players to edit their configs, and an API for other mods to use and customize their entries.
Preferred version: 1.4.2
README
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
The mod adds a "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 also need to download the dependencies for the mod, which are InputUtils, LethalConfig and TerminalAPI), 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 BepInEx/config folder.
Alternatively, you could edit the settings with LethalConfig in the game, as it is now 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 your liking
-
Some battery settings can also be modified
-
The indicator has six different styles (Low battery warning, Bar, Text, Circular Bar, Vertical Bar, All) and four different text info styles (Percentage, Accurate percentage, Time, All)
-
Custom colors can be set for the light and indicator with hex codes
-
The light can also be configurated 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. (unfortunately, laser pointers also count as flashlights)
-
Multiple recharge options for the flashlight (with some being a little too good, but they all have their upsides and downsides depending on how you set up the mod)
-
Multiple options for the sounds of your flashlight
-
Networking 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 if you've used up the entire battery or not. Affected by the recharge multiplier, intended for decently 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 shorter flashlight battery spans.
-
Dynamo: The battery recharges over time, but only while you're winding it! Slowly builds up more energy (up to 1.5 times the normal drain multiplier), however you walk, run and crouch slower while winding the flashlight, and your stamina does not regenerate as fast as usual. Affected by the recharge multiplier, intended for decently 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, i guess). Not affected by the recharge multiplier, can ONLY be fully recharged while in the ship and intended for longer flashlight battery spans.
-
Facility Powered: Cuts your light's intensity in half (depending on the configs) if you use it, however it is affected by the facility's power managed via the breaker box, 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 when the battery runs out
-
recharged_custom: Flashlight's fully recharged sound when using the
Timerecharge option -
reloadlight_custom: "Shake" sound when using the
Shakerecharge option -
dynamo_custom: Dynamo use sound when using the
Dynamorecharge option -
flashDown_custom:
Facility powered's "power disabled" warning sound -
changepos_custom: Sound when changing the light's position
-
denytoggle_custom: Sound when denying powering the flashlight on
[!IMPORTANT] The mod supports networking, however it is still being worked on and has some bugs, and you will also not be able to join other lobbies that do not have this mod alongside its networking.
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.
