File information

Last updated

Original upload

Created by

KeinZantezuken

Uploaded by

KZekai

Virus scan

Safe to use

Documentation

Readme

View as plain text

=================================
INFO
=================================
Mod adds ability to tweak headlight/flashlight to your desire.


=================================
SCP
=================================
/Game/Mods/FLCustomizer/BP_MOD_FLCustomizer.BP_MOD_FLCustomizer_C


=================================
INSTALL
=================================
1. Install: https://www.nexusmods.com/stalker2heartofchornobyl/mods/304/
2. STEAM: Go to your Steam Library, find "STALKER 2", right-click, Manage -> Browse Local Files.
This is your game root folder.
3. Extract content of the zip-archive inside root folder. If you did everything correctly,
"Flashlight_Customizer.*"
will be present inside "Stalker2\Content\Paks\".
4. In-game, execute command:
mod add /Game/Mods/FLCustomizer/BP_MOD_FLCustomizer.BP_MOD_FLCustomizer_C

=================================
UNINSTALL
=================================
Either:
mod del /Game/Mods/FLCustomizer/BP_MOD_FLCustomizer.BP_MOD_FLCustomizer_C
Or
delete aforementioned files


=================================
CONFLICTS
=================================
None

=================================
USAGE
=================================

Simply configure the flashlight preset to your liking with commands below
and the execute "fl_state save" - the preset will be automatically loaded
upon restart.

To delete the preset, go to "%LOCALAPPDATA%\Stalker2\Saved\SaveGames\"
and delete the file "fldata.sav"

To share preset, simply share "fldata.sav"

[Hotkeys]:
RightAlt+L :: toggle customizer UI

[Console commands]:
fl_intensity x.x :: adjusts intensity
fl_radius x.x :: adjusts radius
fl_attenuation x.x :: adjusts attenuation radius
fl_sourcelen x.x :: adjusts source length
fl_specular x.x :: adjusts specular scale
fl_indirect x.x :: adjusts indirect intensity
fl_volscatint x.x :: adjusts Volumetric Scattering Intensity
fl_lightfalloff x.x :: adjusts Light Fall-Off Exponent
fl_color (R=x.x,G=x.x,B=x.x) :: adjusts color, normalized used (0.0 to 1.0)
fl_colortemp x.x :: adjusts color temperature
fl_cone inner|outer x.x :: adjusts cone values
-
fl_shadows normal true|false :: enables shadow casting
fl_shadows deep true|false :: enables deep shadows
fl_shadows volume true|false :: enables volumetric shadows
fl_shadows dynamic true|false :: enables dynamic shadows
fl_shadows fg true|false :: enables foreground shadows
fl_shadows rt true|false :: enforces raytracing shadows
-
fl_transform (X=x.x,Y=x.x,Z=x.x) :: manipulates offset
-
fl_lightmat obj_path :: loads custom light material
fl_ies obj_path :: loads custom IES profile
-
fl_state print :: pints current setup or defaults
fl_state save :: saves preset
fl_state load :: loads preset
fl_state delete :: deletes preset
-
fl_ui :: will load UI to configure FL realtime

WARNING: Your shadow and shading quality in options needs to be High at least for shadows to work.


=================================
CONFIG PRESETS
=================================
This section is mostly for GamePass/GOG users. If saving presets does not work
in game, use this config based one.

1. Open or create "Engine.ini" in
Steam: %LOCALAPPDATA%\Stalker2\Saved\Config\Windows\
Gamepass: %LOCALAPPDATA%\Stalker2\Saved\Config\WinGDK\

2. Add following section:

[/Game/Mods/FLCustomizer/GSV_FLData.GSV_FLData_C]
intensity=25
radius=1
attenuation=2000
color=(R=1,G=1,B=0.913009,A=1)
color_temp=5200
sourcelen=0
inner_cone=50
outer_cone=65
specular=1
indirect_int=1
volscatint=0
lfalloff=6
shadows=false
deepshadows=false
volshadows=true
dynshadows=true
fgshadows=false
rtshadows=false
loc=(X=10,Y=0,Z=0)
lightmat=None
ies=/Game/light/textures/IES/T_17_50_65_7.T_17_50_65_7

3. Tweak values to your desire.
4. Save, done. Game will now fallback to these if no save preset found


=================================
ADDON SUPPORT
=================================

Any other developer can create custom light material or IES profile
and it can be loaded by this mod.

1. Create your custom light material or IES profile in UE
2. Package
3. Provide Soft Object Path path to a user to use, or example,
if your asset path is /Game/Mods/ChadLight/MyCoolMaterial
then soft object path (sop) will be Game/Mods/ChadLight/MyCoolMaterial.MyCoolMaterial
(without any "_C" at the end)
4. Now user can load it after installing your mod

-- End users --
Simply execute command like so:

fl_lightmat path

where path is SOP provided by mod author in readme/on mod page


=================================
KNOWN ISSUES
=================================
- GoG/GamePass version is not fully supported and not tested.
Preset saving and autoload will not work, see [CONFIG PRESETS] for workaround
- sometimes preset autoload fails due to race condition - in this case load manually


=================================
HOW TO REPORT ISSUES
=================================
- describe exact steps/what you did that lead to the bug
- provide savegames before and after if possible (%LOCALAPPDATA%\Stalker2\Saved\)


=================================
CHANGELOG
=================================
- v0.1.11 - input fix when closing the menu
- v0.1.10 - added RightAlt+L hotkey for UI
- v0.1.9 - added software cursor
- v0.1.8 - added UI to configure Flashlight
- v0.1.7 - added Color Temperature, Volumetric Scattering and Light Fall-off Exponent
- fixed some small bugs
- v0.1.6 - added Indirect Light Intensity option
- v0.1.5 - addon support: now Customizer can apply custom
Light Function Materials and IES profiles.
- added ability to delete presets
- v0.1.4 - added new way to load presets for gamepass version
- added some console feedback
- fixed cone values being unstable
- v0.1.3 - fixed bugs with some settigns not loading properly (dyn shadows)
- added inner/outer cone saving
- added Ray Tracing shadows enforce
- v0.1.2 - added ability to tweak inner|outer cone
- v0.1.1 - added ability to tweak offset/location
- v0.1.0 - BREAKING CHANGE: rewrote for modloader
- v0.0.4 - small readme update
- v0.0.3 - added autoload, renamed the mod paks
- v0.0.2 - added shadows
- v0.0.1 - Initial release


=================================
CREDITS
=================================
KeinZantezuken