Freecam/README.md

# Freecam

An SPT-AKI module mod that allows you to detach the camera and fly around freely in Escape From Tarkov.

### Controls

The default controls are as follows:
- Keypad Plus - toggle free camera mode
- Keypad Enter - teleport player to camera position
- Keypad Multiply - toggle UI

If you need to change them, press F12 in-game and expand the `Freecam #.#.#` section and configure your keybinds there.
Alternatively, you can find the `com.terkoiz.freecam.cfg` file in your `BepInEx/config/` folder after you've started up the game at least once with Freecam installed, and change the keybinds there.


### How to install

1. Download the latest release here: [link](https://dev.sp-tarkov.com/Terkoiz/Freecam/releases) -OR- build from source (instructions below)
2. Simply extract the zip file contents into your root SPT-AKI folder (where EscapeFromTarkov.exe is).
3. Your `BepInEx/plugins` folder should now contain a `Terkoiz.Freecam.dll` file inside.

### Known issues

1. Your weapon doesn't turn invisible when you enter freecam mode
2. When teleporting to camera position, the camera rotation gets copied exactly, potentially causing the player model to tilt
3. Game version UI element is not hidden when toggling UI
4. When flying to distant parts of the map in freecam mode, LODs are not triggered (these seem to follow the player)

### How to build from source

1. Download/clone this repository
2. Re-import dependencies. I recommend you do this from the SPT-AKI/Modules project's `Shared/Managed` folder, if you have the Modules project fully setup.
3. Rebuild the project in the Release configuration.
4. Grab the `Terkoiz.Freecam.dll` file from the `bin/Release` folder and use it wherever. Refer to the "How to install" section if you need help here.
Initial commit 2021-06-02 20:43:13 +02:00			`# Freecam`

Tiny README adjustment 2021-06-02 23:46:33 +03:00			`An SPT-AKI module mod that allows you to detach the camera and fly around freely in Escape From Tarkov.`
Initial mod file commit 2021-06-02 23:05:01 +03:00
			`### Controls`

Updated Freecam to support the new BepInEx plugin loader for SPT-AKI 2022-02-20 00:39:32 +02:00			`The default controls are as follows:`
Darn Markdown formatting 2021-06-02 23:08:31 +03:00			`- Keypad Plus - toggle free camera mode`
			`- Keypad Enter - teleport player to camera position`
			`- Keypad Multiply - toggle UI`
Initial mod file commit 2021-06-02 23:05:01 +03:00
Updated Freecam to support the new BepInEx plugin loader for SPT-AKI 2022-02-20 00:39:32 +02:00			If you need to change them, press F12 in-game and expand the `Freecam #.#.#` section and configure your keybinds there.
			Alternatively, you can find the `com.terkoiz.freecam.cfg` file in your `BepInEx/config/` folder after you've started up the game at least once with Freecam installed, and change the keybinds there.


Initial mod file commit 2021-06-02 23:05:01 +03:00			`### How to install`

			`1. Download the latest release here: [link](https://dev.sp-tarkov.com/Terkoiz/Freecam/releases) -OR- build from source (instructions below)`
Updated Freecam to support the new BepInEx plugin loader for SPT-AKI 2022-02-20 00:39:32 +02:00			`2. Simply extract the zip file contents into your root SPT-AKI folder (where EscapeFromTarkov.exe is).`
			3. Your `BepInEx/plugins` folder should now contain a `Terkoiz.Freecam.dll` file inside.
Initial mod file commit 2021-06-02 23:05:01 +03:00
			`### Known issues`

			`1. Your weapon doesn't turn invisible when you enter freecam mode`
			`2. When teleporting to camera position, the camera rotation gets copied exactly, potentially causing the player model to tilt`
			`3. Game version UI element is not hidden when toggling UI`
Updated Freecam to support the new BepInEx plugin loader for SPT-AKI 2022-02-20 00:39:32 +02:00			`4. When flying to distant parts of the map in freecam mode, LODs are not triggered (these seem to follow the player)`
Initial mod file commit 2021-06-02 23:05:01 +03:00
			`### How to build from source`

			`1. Download/clone this repository`
Updated Freecam to support the new BepInEx plugin loader for SPT-AKI 2022-02-20 00:39:32 +02:00			2. Re-import dependencies. I recommend you do this from the SPT-AKI/Modules project's `Shared/Managed` folder, if you have the Modules project fully setup.
			`3. Rebuild the project in the Release configuration.`
			4. Grab the `Terkoiz.Freecam.dll` file from the `bin/Release` folder and use it wherever. Refer to the "How to install" section if you need help here.