Subscribe to download
Configurable Slow Motion

TL;DR: Toggle Slow Motion with the Home key, adjust speed with PgUp and PgDn keys
- keys and speeds configurable in config.txt (relevant parameters start with ddu_ or key[ddu_)
- config.txt is in Documents\Wolfire\Overgrowth\Data

===========================================================
Contents (So you can scroll through the wall of text to what you want to know!)
===========================================================
[FEATURES]
[NEW USER INSTALLATION AND BASIC USAGE]
[IMPORTANT NOTE]
[EXISTING USER UPGRADE]
[ADVANCED USAGE]
[TROUBLESHOOTING FAQ]
===========================================================

[FEATURES]
Toggle slow motion at any time during a level (paused, during dialogue, while fighting etc)
- configurable key (defaults to the Home key)

Change slow motion speed at any time during a level
- configurable keys (defaults to PgUp/PgDn)
- configurable increment for each key press (defaults to 0.05)

Works on any level (campaign, arena, custom)
- always starts level toggled off

Configurable min/max speed range
- defaults to between 0.1 (normal slow motion) and 2.0 (double speed)

Saves configuration in config file

[NEW USER INSTALLATION AND BASIC USAGE]
1. Ensure the game speed slider in the settings menu is set to the desired default speed
2. Activate mod in mod menu (steps 1 & 2 can be reversed so long as a level has not yet been opened)
3. Open a level
- MOD IS NOW INSTALLED TO THE CONFIG
- DEFAULT SPEED WILL BE SET TO CURRENT GAME SPEED
- SLOW MOTION SPEED WILL BE SET TO HALF SPEED
4. Hit Home key to activate slow motion
5. Tap PgUp or PgDn to increase or decrease speed by 0.05 (suggest multiple taps for smooth transitions)
6. Hit Home to deactivate slow motion

[IMPORTANT NOTE]
Mod operates by changing the game speed multiplier, and temporarily resets it to the default value any time the game is paused.
Therefore, if a level is exited without first pausing (e.g. alt-f4, editor quit or a crash), the default value will not be restored.
This will only cause an issue if the mod is then deactivated prior to the next time a level is loaded (since the mod resets the speed to default when loading a level). In this case, if slow motion was enabled when the game was abnormally exited,this speed will now be the default speed until the mod is re-enabled and a level started, at which point everything will return to normal. Alternatively, setting the speed using the game slider will also work, but note that when the mod is re-enabled, the installed default will be used rather than the new current speed.

The mod will override the game speed slider while activated since it saves the game speed when installed and uses that as the default. This is discussed further in the advanced usage and troubleshooting sections.

[EXISTING USER UPGRADE]
0. If sure that current game speed is the desired default then skip to step 3
1. Deactivate the mod in the mod menu
2. Load a level and ensure that the game speed is the desired default speed
- if not then adjust it using the game speed slider or manually setting global_time_scale_mult in the config
3. Activate the mod in the mod menu and load a level
- MOD IS NOW UPGRADED TO VERSION 0.0.3
- DEFAULT SPEED WILL BE SET TO CURRENT GAME SPEED
- DEFAULT KEYS WILL BE DEFINED (Home, PgUp/PgDn)
- SLOW MOTION SPEED AND INCREMENT WILL BE SET TO 0.5 AND 0.05 RESPECTIVELY
- MIN SPEED WILL BE SET TO 0.1, MAX TO 2.0
- DEPRECATED CONFIG PARAMETERS WILL HAVE THEIR VALUE SET TO "deprecated"
4. (optional) open the config and delete the following lines if they exist (make sure exact match)
ddu_time_scale_init : deprecated
ddu_toggle_custom_timescale : deprecated
ddu_increase_custom_timescale : deprecated
ddu_decrease_custom_timescale : deprecated

[ADVANCED USAGE]
[Custom Keys]
Set desired keys using the following config variables (shown with default values):
key[ddu_toggle_custom_timescale]: home
key[ddu_increase_custom_timescale]: pageup
key[ddu_decrease_custom_timescale]: pagedown
- be sure to check for any conflicts since the mod does not
- key names are defined in the wiki at: https://wiki.wolfire.com/index.php/Scripting

[Custom Min/Max and Increment]
MODIFY THESE AT YOUR OWN RISK!
The amount by which the speed will change per key press can be changed with this config param:
ddu_custom_global_time_scale_inc: 0.05
And min and max speeds with:
ddu_custom_global_time_scale_min: 0.1
ddu_custom_global_time_scale_max: 2
- These values work well, but if you change them please consider this:
- the mod checks if the current speed is <= (max - increment) when deciding to allow an increase
- and checks speed is >= (min + increment) when deciding to allow a decrease
- therefore it is best if increment is significantly smaller than (max - min)
- some sensible divisibility should be applied
- values any smaller than the default min and inc may well simply not work

[Remaining Config Variables]
These are the 2 main variables for the speed
ddu_default_global_time_scale_mult - the default speed used when the mod is active but not in slow motion
ddu_custom_global_time_scale_mult - the slow motion speed

[TROUBLESHOOTING FAQ]
[My game is always in slow motion / always at a weird speed]
1. Reset the speed using the game speed slider in the settings menu

[My game is still in slow motion / at a weird speed]
1. Reset the default in the config by setting ddu_default_global_time_scale_mult to the desired value
- standard game speed slider values are between 0.5 and 1.0 (50% to 100%)
2. Start a level and the default should be restored

[Everything is screwed up]
1. Delete the line in the config which contains the parameter ddu_time_scale_version
2. BEFORE STARTING A LEVEL, either:
- a: set the game speed slider in the settings to the desired default speed (50% to 100%)
- b: set config parameter global_time_scale_mult to the desired default speed (suggest between 0.1 and 2.0)
3. Start a level and the default should be restored and the mod should be set to its defaults (keys, speeds etc)

[Still got problems]
1. Please leave a comment and i will try and help! :-)

This is my first mod for Overgrowth (had the game less than a week when i made it) so feel free to bash my code if i have made some newb errors :-)

Thanks to Wolfire for hooking me with Receiver so that years later i eventually found this wonderful game. And thanks to all of the modders who ensured that by the time i found the game it included so much additional great stuff straight out of the box, and a workshop full of exciting variety, showing a wealth of passion, talent and skill. Hopefully i can add something fun to the mix.

Enjoy!