0 of 0
About this mod
Ingame editor to modify currently set environment parameters in realtime. All values can be logged for later usage in env mods.
- Requirements
- Permissions and credits
- Changelogs
Realtime in-game Environment Parameter UI
The mod is intended for other mod authors: it allows you to interactively change the currently set environment parameters of the env in realtime in the game and log those settings to the scripts log.
The mod is ONLY meant to provide some interactive realtime visual feedback for changing parameters and using the new values outside the game to adjust your custom created/some env. It is compatible with all 1.30+ versions of the game (since it doesn't change any vanilla scripts).
Limitations
The mod basically allows to interactively change the currently used environment settings. It allows to switch between layered envs. The switch is visible as only the values of the layer are active. However upon exit of envui the values should be active with the blend.
(The mod is a byproduct of the work on the storyboard UI and was created as proof-of concept for the reusability of the list menu. So I did test only in some areas!)
The mod provides a console command to unload all layered envs:
envui_disable_envs()
Usage
The default hotkey for opening the env ui is F11 in the exploration state of Geralt and Ciri. If you want to change this you have to adjust the hotkey in the provided input.settings.
The mod has an online help popup with all usable hotkeys (translations are welcome!). The default hotkey for the help is F12 once the env UI is started. Watch the video and/or make sure you make yourself familiar with the hotkeys
The time of day is saved and frozen on opening the env UI. All the interactive time changes you make are discarded once you close the mod and the time before starting the mod is restored again.
Some background info
Most envs parameters are set for a specific time of day (those are time independent). Multiple, different values for different times for the *same* setting create a curve and the engine interpolates the values between the curvepoints for the current gametime. Every curvepoint contains one scalar value (the first one as seen in the video) and a 4 value vector (which is most of the time/always? a color definition).
It doesn't look like scalar *and* the vector of a curvepoint are used at the same time for a setting but I may be wrong. What value (scalar or vector) is used and what value ranges are valid depends (obviously) on the selected setting. However I'm not an expert on envs so if the settings name does not provide the information I don't have it either... The set values are NOT verified by the mod!
How to upgrade from previous versions
1. Delete the mods/modEnvUi folder (and if it exists the dlc/dlcEnvUi folder)
2. Search and remove the section [MOD_EnvUi] and (if it exists) the section [MOD_EnvUi_InteractiveTime] and all its entries from your "Documents/The Witcher 3/input.settings".
3. Install/upgrade all dependencies to the required versions
4. Unzip package into your witcher game directory (so dlc folder content from package goes into witcher 3/dlc folder and mod folder content from package goes into witcher 3/mod folder)
5. Add content from "mods/modEnvUi/modEnvUi.input.settings" from the downloaded package into the input.settings file in your "Documents/The Witcher 3/input.settings" to the end of the file
How to install
1. Install the dependencies (modBootstrap, modSharedImports, modRadishSeeds) first
2. Unzip package into your witcher game directory (so dlc folder content from package goes into witcher 3/dlc folder and mod folder content from package goes into witcher 3/mod folder)
3. Add content from "mods/modEnvUi/modEnvUi.input.settings" from the downloaded package into the input.settings file in your "Documents/The Witcher 3/input.settings" to the end of the file (it will be reordered after startup anyway)
4. activate autostart in modBootstrap by adding the line "add(modCreate_EnvUiMod());" to the function "createMods" in the file bootstrap registry file "mods_registry.ws" so it looks more or less like this:
Important:
- make sure you start the game with "-debugscripts" or otherwise no values will be logged!
- verify that the scriptslog.txt is created in your "Documents/The Witcher 3" directory and contains output after you quit the game
- the scriptslog.txt will be recreated on every game start! Make sure you save your logged values before you start the game again!
How to uninstall
1. Delete the mods/modEnvUi folder and (if it exists) the dlc/dlcEnvUi folder
2. Search and remove the section [MOD_EnvUi] and (if it exists) the section [MOD_EnvUi_InteractiveTime] and all its entries from your "Documents/The Witcher 3/input.settings". Remove also the two lines containing the hotkey for starting the mod ("Action=EUI_OpenMenu")
3. Remove the added line from the bootstrap registry file "mods_registry.ws"
Credits
@SilentM00n for the env resource caching trick required to edit layered envs (see ENV Helper)
The mod is intended for other mod authors: it allows you to interactively change the currently set environment parameters of the env in realtime in the game and log those settings to the scripts log.
It does NOT save / restore ANY changed parameters!
The mod is ONLY meant to provide some interactive realtime visual feedback for changing parameters and using the new values outside the game to adjust your custom created/some env. It is compatible with all 1.30+ versions of the game (since it doesn't change any vanilla scripts).
Limitations
The mod basically allows to interactively change the currently used environment settings. It allows to switch between layered envs. The switch is visible as only the values of the layer are active. However upon exit of envui the values should be active with the blend.
(The mod is a byproduct of the work on the storyboard UI and was created as proof-of concept for the reusability of the list menu. So I did test only in some areas!)
The mod provides a console command to unload all layered envs:
envui_disable_envs()
Usage
The default hotkey for opening the env ui is F11 in the exploration state of Geralt and Ciri. If you want to change this you have to adjust the hotkey in the provided input.settings.
The mod has an online help popup with all usable hotkeys (translations are welcome!). The default hotkey for the help is F12 once the env UI is started. Watch the video and/or make sure you make yourself familiar with the hotkeys
The time of day is saved and frozen on opening the env UI. All the interactive time changes you make are discarded once you close the mod and the time before starting the mod is restored again.
Some background info
Most envs parameters are set for a specific time of day (those are time independent). Multiple, different values for different times for the *same* setting create a curve and the engine interpolates the values between the curvepoints for the current gametime. Every curvepoint contains one scalar value (the first one as seen in the video) and a 4 value vector (which is most of the time/always? a color definition).
It doesn't look like scalar *and* the vector of a curvepoint are used at the same time for a setting but I may be wrong. What value (scalar or vector) is used and what value ranges are valid depends (obviously) on the selected setting. However I'm not an expert on envs so if the settings name does not provide the information I don't have it either... The set values are NOT verified by the mod!
How to upgrade from previous versions
1. Delete the mods/modEnvUi folder (and if it exists the dlc/dlcEnvUi folder)
2. Search and remove the section [MOD_EnvUi] and (if it exists) the section [MOD_EnvUi_InteractiveTime] and all its entries from your "Documents/The Witcher 3/input.settings".
3. Install/upgrade all dependencies to the required versions
4. Unzip package into your witcher game directory (so dlc folder content from package goes into witcher 3/dlc folder and mod folder content from package goes into witcher 3/mod folder)
5. Add content from "mods/modEnvUi/modEnvUi.input.settings" from the downloaded package into the input.settings file in your "Documents/The Witcher 3/input.settings" to the end of the file
How to install
1. Install the dependencies (modBootstrap, modSharedImports, modRadishSeeds) first
2. Unzip package into your witcher game directory (so dlc folder content from package goes into witcher 3/dlc folder and mod folder content from package goes into witcher 3/mod folder)
3. Add content from "mods/modEnvUi/modEnvUi.input.settings" from the downloaded package into the input.settings file in your "Documents/The Witcher 3/input.settings" to the end of the file (it will be reordered after startup anyway)
4. activate autostart in modBootstrap by adding the line "add(modCreate_EnvUiMod());" to the function "createMods" in the file bootstrap registry file "mods_registry.ws" so it looks more or less like this:
- make sure you start the game with "-debugscripts" or otherwise no values will be logged!
- verify that the scriptslog.txt is created in your "Documents/The Witcher 3" directory and contains output after you quit the game
- the scriptslog.txt will be recreated on every game start! Make sure you save your logged values before you start the game again!
How to uninstall
1. Delete the mods/modEnvUi folder and (if it exists) the dlc/dlcEnvUi folder
2. Search and remove the section [MOD_EnvUi] and (if it exists) the section [MOD_EnvUi_InteractiveTime] and all its entries from your "Documents/The Witcher 3/input.settings". Remove also the two lines containing the hotkey for starting the mod ("Action=EUI_OpenMenu")
3. Remove the added line from the bootstrap registry file "mods_registry.ws"
Credits
@SilentM00n for the env resource caching trick required to edit layered envs (see ENV Helper)