sotf-fullauto/README.md

# FullAuto

[![Downloads](https://img.shields.io/github/downloads/JustinOros/sotf-fullauto/total?label=downloads)](https://github.com/JustinOros/sotf-fullauto/releases) [![Latest](https://img.shields.io/github/v/release/JustinOros/sotf-fullauto?label=latest)](https://github.com/JustinOros/sotf-fullauto/releases/latest)

Hold the fire button to shoot guns full-auto in Sons of the Forest.

Works with the pistol, revolver, shotgun and rifle. The fire rate is
adjustable and your settings are saved between sessions.

## Multiplayer

Client side only. Nothing gets installed on a dedicated server, and other
players do not need the mod.

## Installation

### Easy install

Close the game, open PowerShell and paste:

```powershell
irm https://raw.githubusercontent.com/JustinOros/sotf-fullauto/main/Install.ps1 | iex
```

It finds your game, installs RedLoader if needed, and installs the latest
FullAuto. Run it again any time to update.

### Manual install

#### Step 1: Install RedLoader

[RedLoader](https://github.com/ToniMacaroni/RedLoader/releases/latest) is the mod
loader for Sons of the Forest. The game cannot load any mod without it, so
install it first. You only have to do this once.

1. Download `RedLoader.zip` from the
   [latest RedLoader release](https://github.com/ToniMacaroni/RedLoader/releases/latest)
2. Extract it into your Sons of the Forest folder, the one containing
   `SonsOfTheForest.exe`, usually
   `C:\Program Files (x86)\Steam\steamapps\common\Sons Of The Forest`
3. Launch the game once and wait until you reach the main menu. The first launch
   takes a few minutes while RedLoader processes the game files
4. Check that `MODS` appears on the main menu, then quit

#### Step 2: Install FullAuto

1. Download `FullAuto.zip` from the
   [latest release](https://github.com/JustinOros/sotf-fullauto/releases/latest)
2. Extract it into the `Mods` folder inside your game folder
3. You should end up with:

```
Mods\FullAuto.dll
Mods\FullAuto\manifest.json
```

## Usage

Equip a gun and hold the fire button.

With a gun equipped, click the middle mouse button to cycle fire modes:

| Mode | Behavior |
| --- | --- |
| Full-automatic | Fires while the button is held |
| Semi-automatic | Normal game behavior, one shot per click |
| 3-Round Burst | Fires 3 shots, then release and press again for the next 3 |

Each gun remembers its own fire mode, even after you restart the game. Guns
start in full-automatic until you change them.

Press F to turn a flashlight attached to your gun or crossbow on or off.
The key can be changed with the `flashlightkey=` line in `UserData\FullAuto.txt`.

Press F1 to open the console, then use these commands:

| Command | Action |
| --- | --- |
| `fullauto` | Show current settings |
| `fullauto on` | Enable |
| `fullauto off` | Disable until the game restarts |
| `fullauto rpm 1200` | Set the fire rate, 60 to 3000 rounds per minute |
| `fullauto fastreload on` | Reload guns twice as fast, `off` to turn it back off |
| `fullauto autoreload on` | Reload automatically when the gun is empty, `off` to turn it back off. It presses your reload key for you, so if you changed it from R in the game settings, set `reloadkey=` in `FullAuto.txt` to match |
| `fullauto debug` | Log every shot to `_RedLoader\Latest.log` |

The default is 900 rpm. The rpm also sets how fast burst shots fire.

The rpm, fast reload, auto reload, flashlight key, reload key and each gun's fire
mode are saved to
`UserData\FullAuto.txt` in your game folder.

## Supported weapons

Only the pistol, revolver, shotgun and rifle are affected. Bows, the crossbow,
slingshot, flare gun, stun gun, rope gun and thrown items keep their normal
behavior.

## Building from source

Requires the .NET 8 SDK and RedLoader installed with its game assemblies
generated.

```powershell
.\build.ps1 -Install
```

Use `-Package` to build `FullAuto.zip` for a release. Pass `-GameDir "path"` if
the game is not found automatically.

## Troubleshooting

Check `_RedLoader\Latest.log` in your game folder. FullAuto logs a line when it loads and a line for each weapon showing whether it is full-auto or
ignored.