----------------------------------
SlowMoMod 0.8 by CaptainProton42
----------------------------------

	1. About
	2. Installation
	3. Getting started
	4. Changelog
	5. Help me!
	6. Contact
	7. License / Redistribution
	
----------------------------------
1. About
----------------------------------
The SlowMoMod offers you to explore Los Santos in a whole new dimension: time!
It adds the functionality to freely control the timescale of the game. The interface of
the mod is completely hideable naking room for crazy video captures or simply enjoying
bullets and explosions flying around you in slow motion.

Nearly every aspect of the mod is customizable, from the key bindings even to the beha-
viour of some functions, everything accessible through the in-game menu.

The latest versions also include the so-called "Flash Mode". It allows you to run at
normal speed while time is slowed down (or go super fast while time is normal of course).
You'll also be able to do crazy stunts like running on water or up a skyscraper.
However, this mode still lacks some features and bugs will occur, especially in first
person the Flash Mode is still subject to many issues.

Controllers are supported via XInput.

----------------------------------
2. Installation
----------------------------------
	1. Make sure you have the latest version of Alexander Blade's Script Hook V installed:
	   http://gtaforums.com/topic/788343-script-hook-v/

	2. Copy (or move) the contents of this archive directly into your GTA V installation
	   directory. Keep the folder structure of this archive (SlowMoMod.asi and the SlowMoMod
	   folder should both be in the same directory).
	   
----------------------------------
3. Getting started
----------------------------------
If the mod has been installed properly a messagebox should open after you've loaded into the
singeplayer informing you about your further steps (Make sure to not press any keys during
the loading screen though, that might dismiss the window). Also, an indicator should appear 
in the top of the screen.

The first thing you should do is to open the menu. Given that you haven't touched the config
file yet, press [O] to do so. A menu should appear, titled "SlowMoMod 0.7.1 Menu". Navigate through
it using the numpad (make sure you have numlock activated):
	Numpad 2: navigate down.
	Numpad 8: navigate up.
	Numpad 4 and 6: adjust numeric values.
	Return: Choose a new key / toggle values.
	
If you made a mistake in the config menu or you encounter a bug, simply edit the slowmo.ini
located at C:\Users\<your username>\Documents\SlowMoMod\config. To reset everything to default,
choose the correspinding option in the menu. You can also delete the config file. The mod
will then setup a new one.

Controller settings are currently only accessible through the .ini file. You can find possible
values here:
https://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.reference.xinput_gamepad(v=vs.85).aspx.
Since the SlowMoMod currently only supports XInput make also sure to use a supported controller
or driver.
	
After everything is setup, you're ready to go. Everything from here should be self-explanatory
or easy to find out.

----------------------------------
4. Changelog
----------------------------------
0.8
	[added] the wall-running feature. Run up walls or even skyscrapers! Accessible via the menu.
	Most likely still subject to many bugs. Report them!
	[added] air control. You'll now be able to "run" through the air. However, steering will be
	harder and you'll be affected by gravity (the faster you run, the further you'll fly).
	[added] debug HUD. Shows various information like important variables. Handy for bughunting.
	Currently only accessible by changing 'HUD' in the 'Debug' section of the .ini file to 1.
	[fixed] many nasty bugs.

0.7.2
	[changed/fixed] the mod doesn't depend on your framerate anymore (well, it still does, but
	calculates thing based on frametime now). Especially navigating in the menu will be more
	consistent now.
	[fixed] apparently strafing in first person while in Flash Mode got messed up last update,
	here's the fixe
	[added] a debug hud. Currently only accessible by changing the code, however I *might* add
	an option in the menu later (the hud only shows some variables that can help me during
	development anyway).
	
0.7.1
	[added] direction conrol using the mouse in third person in Flash Mode, activate in the menu
	[changed] the Flash Mode is enabled by standard now
	[fixed] some minor improvements and fixes to the code

0.7
	[changed] improved the menu
	[added] the option to run on water while in Flash Mode
	[fixed] you start running when pressing spacebar in Flash Mode
	
0.6d
	[fixed] conflict with ENT
	
0.6c
	[added] you can modify the menu controls in the .ini file
	
0.6b
	[fixed] now uses XInput 9.1.0. That should get rid of some compatibility issues.

0.6
	[added] adaptive running animation speed in Flash Mode
	[added] spark effect in Flash Mode
	-- Thanks to Kokolaty for providing his Flash Mod sources. I learned a lot from his code, make
	   to also check his awesome mod out: https://www.gta5-mods.com/scripts/flash-mod

0.5.1
	[added] experimental sounds (disable them trough the menu if they're too annoying)
	[added] extended controller support through XInput
	
0.5
	[rewrite] completely rewritten in C++ (.asi instead of .lua)
	[changed] .ini file instead of .cfg
	
0.4.5c
	[fixed] bugfixes
	
0.4.5b
	[fixed] use of menu while closed
	
0.4.5
	[added] sprint-only mode for Flash Mode
	[added] welcome messagebox
	[rewrite] some improvements to the code
	[fixed] numerous
	
0.4.3c
	[fixed] several minor issues

0.4.3b
	[fixed] sounds don't play and result in an error
	
0.4.3
	[added] basic controller support for Flash Mode
	[added] motionblur effect in Flash Mode, adjustable in menu
	[changed] you have to sprint in Flash Mode
	[fixed] tweaks and improvements
	[added] contact (mailto) button in the menu
	
0.4.2
	[changed] better traction on ground while in Flash Mode
	
0.4.1
	[changed] improvements to Flash Mode
	[added] start-up messages in console
	
0.4
	[added] early version of the Flash Mode
	
0.3.4
	[changed] updated for LUA Plugin 10.0
	
0.3.3
	[added] key names instead of numeric values in the menu
	
0.3.2
	[added] menu sounds
	[added] configurable "button sensitivity"
	
0.3
	[added] in-game menu
	
0.2b
	[fixed] embarassing bug with the config file
	
0.2
	[added] simple config file
	
0.1
	[release] initial release
	
----------------------------------
5. Help me!
----------------------------------
Help me to improve my mod by giving feedback or hunting bugs. The new debug HUD and the
"Contact-Button" in the menu are handy tools for reporting and hunting bugs. Feel free to
contact me if you encounter any issues (see below for further information).
	
----------------------------------
6. Contact
----------------------------------
Any feedback, suggestions, critique, bugs to report, support needed or simply kind words?
Feel free to contact me via my email: CptProton42@gmail.com.
Or visit my official mod page on gta5-mods.com: https://www.gta5-mods.com/scripts/slowmomod
as well as the topic on the GTAForums: http://www.gtaforums.com/topic/797272-vrellua-slowmomod
and leave a comment there.

----------------------------------
7. License / Redistribution
----------------------------------
This mod is licensed under... nothing, to be honest. Nothing that would stand in a lawsuit
at least, I guess.

I actually just want you, whoever you are that you are even reading this, to obey some simple
guidelines:

	- First of all, yes, you are allowed to redistribute this mod freely since I'm not earning money
	  with it, anyway. However, I'd like you to mention me, CaptainProton42, as the creator for the mod.
	  Don't claim it as your own work. If possible, leave a link to one of the mod pages above, that would
	  be highly appreciated.
	  
	- Please don't try to earn money with my mod. Okay, it probably won't be the worst of all, if you
	  link my mod through an adf.ly link, but it's also nothing that a gentleman would do. My mod is free
	  and shoudl be treated as such.
	  
	- Make videos of it as much as you want. I don't think I have the right to stop you form that anyway.
	  But you should now that you have my full support in making awesome videos in slowmotion. But always
	  remember to credit the creator of the mod appropriately.
	  
	- Wondering where to find the source code? Momentarily, nowhere. Two reasons for that: firstly, I'm still learning
	  and most of the code is an utter mess, second reason, I don't really have the urge to distribute it
	  somewhere if the need is not there. If you want the sourcecode, feel free to contact me,
	  but keep my warning above in mind. And yes, you may use the sourcecode in your own projects, 
	  given that you don't copy the whole mod. If you have to use large parts of my code
	  credit me appropriately.
	  
Sounds have been taken from the freesound project (freesound.org) and modified to fit better (they're still
awful, I know).
Thanks to nextmaking: https://www.freesound.org/people/nextmaking/sounds/85991/
and Robinhood76 https://www.freesound.org/people/Robinhood76/sounds/135566/ .