-----------------------------------------------------------------------
[INSTALL]
-----------------------------------------------------------------------

0. This mod requires ABPML Mod Loader: https://www.nexusmods.com/mods/1
1. First you need to find your game root folder.
   a) On Steam:
      right-click on "Atomic Heart" in Library, click Properties,select "Local Files"
			and click "Browse".
   b) On GamePass/VKplay:
			simply right-click the shortcut on the desktop/start menu, select "Properties"
			and then "Open File location".
   You will see folder containing "AtomicHeart.exe" - this is your GAME ROOT FOLDER.
2. Now you need to extract mod zip archive into the "<game_root_folder\AtomicHeart\Content\Paks\"
   If everything is done correctly, the file "ABPML_UE4_27_VTSpectator_AtomicHeart.pak"
   will be in the aforementioned folder with the rest of the game PAKs
   For Windows Store version you may need Admin rights to copy files.
3. Mod is installed.


-----------------------------------------------------------------------
[UNINSTALL]
-----------------------------------------------------------------------

Delete file "ABPML_UE4_27_VTSpectator_AtomicHeart.pak"


-----------------------------------------------------------------------
[USAGE]
-----------------------------------------------------------------------

-- HOTKEYS
CTRL+BackSpace :: enable fly cam.
Hold LeftShift :: Faster movement
Hold LeftAlt   :: Slower movement
Ctrl+F1        :: Teleport character to cam position
Ctrl+F2        :: Toggle game HUD
Ctrl+F3        :: Toggle game Pause
CTRL+=			   :: Speed game up
CTRL+-				 :: Speed game down
CTRL+0				 :: Reset speed
Shift+ESC			 :: Recover player camera, if it breaks after you return
-
WASD, Gamepad LeftStick  :: movement
Mouse, Gamepad RighStick :: look around


-- OPTIONS
1. Find or create file "Engine.ini" in:
   GamePass - %LOCALAPPDATA%\AtomicHeart\Saved\Config\WinGDK\
   Steam - %LOCALAPPDATA%\AtomicHeart\Saved\Config\WindowsNoEditor\
2. Open with Notepad
3. At the end, add section (don not omit square brackets!!):


- GENERAL OPTIONS:

[/Game/Mods/VTSpectator/ABPML_Mod_VTSpectator.ABPML_Mod_VTSpectator_C]
MovSpeed=1000.0					; flycam movement speed
PitchSpeed=120					; mouse/rstick pitch sensitivty
YawSpeed=150						; mouse/rstick yaw sensitivity
FastMultiplier=3.0			; fast speed mult. by LShift
SlowMultiplier=0.5			; slow speed mult. by LAlt
AxisTolerance=0.01			; if your movement/look behaves odd or sticky, increase this
bRememberLastPos=False  ; remember last used flycam position, instead of using player's?
bForceStickVT=False 	  ; enable this, if a cutscenes forcefully take away the camera
												; only relevant when bViaPosses=False
bViaPosses=False			  ; use different method of flycam mode (if bForceStickVT fails)
bFallbackReposses=False	; troubleshooting if there are issues when bViaPosses=True
bForceBlockInput=True   ; Disable if there are issues with input after returning from flycam
CommandsKey=LeftCtrl    ; this is modifier key (only ALT/SHIFT/CTRL) used for Module commands
ActionMappings=					; SEE BELOW, only add it if you plan to rebind default controls!
AxisMappings=				    ; SEE BELOW, only add it if you plan to rebind default controls!


- MODULE OPTIONS (Atomic Heart module):

[/Game/Mods/VTSpectator/Core/AtomicHeart/AC_VTModule_AH.AC_VTModule_AH_C]
CopyCameraSettings=True  ; when using bViaPosses mode, shall we try mimic game camera?
UseRawTeleport=False     ; alternative teleport mode
TimeDilationStep=0.1		 ; controls the step at which gamespeed is decreased/increased
Commands=								 ; SEE BELOW, only add it if you plan to rebind default controls!


In general, configuration structure is fairly simple:


[Category]
Option=Value ; comment


ALL options have defaults, that means, you only need to add an option you want
to change, the rest will stay at their default values (see defaults above). So,
for example, this is enough if you only want to change movement speed:

[/Game/Mods/VTSpectator/ABPML_Mod_VTSpectator.ABPML_Mod_VTSpectator_C]
MovSpeed=500.0


-----------------------------------------------------------------------
[REBINDING CONTROLS]
-----------------------------------------------------------------------

This is for advanced users. READ CAREFULLY, this is your only source on
how to do so, there is no live support.
List of valid UE keynames:
https://nerivec.github.io/old-ue4-wiki/pages/list-of-keygamepad-input-names.html


- BASIC ACTIONS:

This mod allows you to rebind default controls to either keyboard or 
XPad. This is done via the same config above. Keybind format is split
into 2 categories for basic input: ActionMapping and AxisMapping.
In order to add/replace default, you simply add relevant line to either
"ActionMappings" or "AxisMappings" property in the config, for example:

[/Game/Mods/VTSpectator/ABPML_Mod_VTSpectator.ABPML_Mod_VTSpectator_C]
; some other options here
ActionMappings=(ActionName="VTToggleSpectator",bShift=True,Key=F1)
ActionMappings=(ActionName="VTSpeedUp",Key=RightShift)
AxisMappings=(AxisName="VTMoveForward",Scale=1.000000,Key=O)

This will change the bindings to toggle flycam from CTRL+BACKSPACE
to SHIFT+F1, changes SpeedUp key to RightShift instead and, finally,
changes MoveForward input to "O", instead of "W". Do note that unlike
plain options, the input ones have to be repeated, because they are
additive, i.e. two subsequent "ActionMappings" definitions do NOT
override each other, they complement.

Here is all default values:

;-
ActionMappings=(ActionName="VTToggleSpectator",bCtrl=True,bShift=False,bAlt=False,Key=Backspace)
ActionMappings=(ActionName="VTSpeedUp",Key=LeftShift)
ActionMappings=(ActionName="VTSlowDown",Key=LeftAlt)
ActionMappings=(ActionName="VTRestore",bShift=True,Key=Escape)
;-
AxisMappings=(AxisName="VTMoveForward",Scale=1.000000,Key=W)
AxisMappings=(AxisName="VTMoveForward",Scale=1.000000,Key=Gamepad_LeftStick_Up)
AxisMappings=(AxisName="VTMoveBackwards",Scale=-1.000000,Key=S)
AxisMappings=(AxisName="VTMoveBackwards",Scale=-1.000000,Key=Gamepad_LeftStick_Down)
AxisMappings=(AxisName="VTMoveRight",Scale=1.000000,Key=D)
AxisMappings=(AxisName="VTMoveRight",Scale=1.000000,Key=Gamepad_LeftStick_Right)
AxisMappings=(AxisName="VTMoveLeft",Scale=-1.000000,Key=A)
AxisMappings=(AxisName="VTMoveLeft",Scale=-1.000000,Key=Gamepad_LeftStick_Left)
AxisMappings=(AxisName="VTCamLeftRight",Scale=1.000000,Key=Gamepad_RightX)
AxisMappings=(AxisName="VTCamLeftRight",Scale=1.000000,Key=MouseX)
AxisMappings=(AxisName="VTCamUpDown",Scale=1.000000,Key=Gamepad_RightY)
AxisMappings=(AxisName="VTCamUpDown",Scale=1.000000,Key=MouseY)

So, to put it simply, you can just replace the key name string in the binding
and add it to config. Just make sure to avoid changing "ActioName"!! You can
change axis "Scale", if you desire, for example, to invert mouse-look.
And just like with other


- MODULE COMMANDS

Module rebinding slightly differs from basic actions. First, you need to
define "CommandsKey" in the general config above. By default it is "LeftCtrl",
and this key only accepts keyboard modifier keys: CTRL, ALT, SHIFT
Then, you can change the chord key used for module commands, such as Teleport
or Hide UI. Chord means it has to be used in pair to be triggered, for example,
default binding for "Teleport" is CTRL+F1, which means you have to first press
"LeftCtrl" and then, while keeping it down, press F1.
Here is full config for AH Module (do note that category path is separate for module!):

[/Game/Mods/VTSpectator/Core/AtomicHeart/AC_VTModule_AH.AC_VTModule_AH_C]
Commands=((Equals, "TimeDilationUp"),(Hyphen, "TimeDilationDown"),(Zero, "TimeDilationReset"),(F1, "Teleport"),(F2, "HideUI"),(F3, "TogglePause"))

As you can see, this one can be defined in a single line and only accepts
the final chord key, the first key - modifier - you specify in the base
config for the mod. 


-----------------------------------------------------------------------
[KNOWN ISSUES]
-----------------------------------------------------------------------

 - teleport has a delay and sometimes needs a "warm-up"
 - PS4 Dualshock is not supported by default, you need DS4Win
 - for some reason HUD autohide is broken, do it manually for now


-----------------------------------------------------------------------
[CHANGELOG]
-----------------------------------------------------------------------
v0.1.7
 - fixed default bindings not being used when no custom bindings specified
v0.1.6
 - small fixes
v0.1.5
 - added workaround when cutscence take away camera
 - added controls rebinding, this should have XboxPad support
 - fixed godmode issue when in Limbo
v0.0.5
 - added quick&dirty god mode when in Spectator
v0.0.4
 - input to player is locked by default
 - HUD is hidden by default when entering spectator
v0.0.3
 - added TeleportTo, Pause and SlowMo
v0.0.2:
- added HUD toggle
v0.0.1:
- Initial release

-----------------------------------------------------------------------
[CREDITS]
-----------------------------------------------------------------------
Core: KZ
Testing: Dmgvol