Files
sotf-riflescope/README.md
T

207 lines
3.7 KiB
Markdown
Raw Permalink Normal View History

2026-09-27 13:23:59 -07:00
\# Rifle Scope
2026-09-27 13:11:23 -07:00
A stronger rifle scope for Sons of the Forest. Aiming down the rifle scope zooms
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
5x further than the vanilla scope and shows a full screen scope view with a
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
crosshair reticle, mil dots and a rangefinder instead of the red dot.
2026-09-27 13:23:59 -07:00
\## Multiplayer
2026-09-27 13:11:23 -07:00
Client side only. Nothing gets installed on a dedicated server, and other players
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
do not need the mod.
2026-09-27 13:23:59 -07:00
\## Installation
\### Easy install
2026-09-27 13:11:23 -07:00
Close the game, open PowerShell and paste:
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
```powershell
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
irm https://raw.githubusercontent.com/JustinOros/sotf-riflescope/main/Install.ps1 | iex
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
```
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
It finds your game, installs RedLoader if needed, and installs the latest
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
RifleScope. Run it again any time to update.
2026-09-27 13:23:59 -07:00
\### Manual install
\#### Step 1: Install RedLoader
\[RedLoader](https://github.com/ToniMacaroni/RedLoader/releases/latest) is the mod
2026-09-27 13:11:23 -07:00
loader for Sons of the Forest. The game cannot load any mod without it, so
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
install it first. You only have to do this once.
2026-09-27 13:23:59 -07:00
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 RifleScope
1\. Download `RifleScope.zip` from the
  \[latest release](https://github.com/JustinOros/sotf-riflescope/releases/latest)
2\. Extract it into the `Mods` folder inside your game folder
3\. You should end up with:
2026-09-27 13:11:23 -07:00
```
2026-09-27 13:23:59 -07:00
Mods\\RifleScope.dll
Mods\\RifleScope\\manifest.json
2026-09-27 13:11:23 -07:00
```
2026-09-27 13:23:59 -07:00
\## Usage
2026-09-27 13:11:23 -07:00
Equip the rifle and aim. Once zoomed in, the rifle model is hidden and the scope
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
view is shown. Your shot goes where the crosshair is.
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
The red number at the bottom left of the scope is the range in meters to whatever
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
is under the crosshair.
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
The reticle has 10 mil dots in each direction. At 5x each dot is 2 mils, which
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
covers 20 cm at 100 m. At 10x and higher each dot is 1 mil. Use them to hold over
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
or to the side at long range.
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
Press F1 to open the console, then use these commands:
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
| Command | Action |
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
| --- | --- |
2026-09-27 13:23:59 -07:00
| `scope` | Show whether the mod is on or off |
| `scope off` | Turn the mod off and go back to the vanilla scope |
| `scope on` | Turn the mod back on |
2026-09-27 13:11:23 -07:00
| `scopezoom` | Show the current zoom |
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
| `scopezoom 5` | Set the zoom as a multiple of the vanilla scope, 1 to 50. The default is 5 |
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
| `scopetrim` | Show the current vertical trim |
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
| `scopetrim 50` | Set the vertical trim, -200 to 200. Positive moves hits down, negative moves hits up. The default is 50 |
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
| `scopewind` | Show the current windage |
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
| `scopewind 20` | Set the windage, -200 to 200. Positive moves hits right, negative moves hits left. The default is 0 |
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
| `scopedebug` | Toggle a debug readout above the range |
2026-09-27 13:23:59 -07:00
Trim and windage are angle adjustments, so a setting that is right at one range
2026-09-27 13:23:59 -07:00
stays right at every range.
2026-09-27 13:23:59 -07:00
The on or off setting, zoom, trim and windage are saved to `UserData\\RifleScope.txt` in your game
2026-09-27 13:11:23 -07:00
folder. Setting the zoom to 1 keeps vanilla zoom and the normal scope view,
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
without the red dot.
2026-09-27 13:23:59 -07:00
\## Building from source
2026-09-27 13:11:23 -07:00
Requires the .NET 8 SDK and RedLoader installed with its game assemblies
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
generated.
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
```powershell
2026-09-27 13:23:59 -07:00
.\\build.ps1 -Install
2026-09-27 13:11:23 -07:00
```
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
Use `-Package` to build `RifleScope.zip` for a release. Pass `-GameDir "path"` if
2026-09-27 13:23:59 -07:00
2026-09-27 13:11:23 -07:00
the game is not found automatically.
2026-09-27 13:23:59 -07:00
\## Troubleshooting
Check `\_RedLoader\\Latest.log` in your game folder. RifleScope logs a line when it
2026-09-27 13:11:23 -07:00
loads.
2026-09-27 13:23:59 -07:00