Replace readme with full rewrite

This commit is contained in:
Justin Oros
2026-09-13 11:30:51 -07:00
parent f186743171
commit 66f3398455
+27 -14
View File
@@ -1,8 +1,11 @@
# Character Select
Choose your player appearance in Sons of the Forest and keep it across sessions.
Sons of the Forest gives you a random appearance out of eight every time you join
a server, and there is no way to choose. This mod lets you pick the one you want
and puts it back on every spawn, so you stay the same character.
and automatically reapplies it every time your player spawns, so you stay the
same character.
## Multiplayer
@@ -11,12 +14,30 @@ Client side only. Nothing gets installed on a dedicated server.
Your appearance replicates through normal game networking, so other players see
your choice even if they do not have the mod installed.
## Requirements
[RedLoader](https://github.com/ToniMacaroni/RedLoader/releases/latest)
## Installation
### 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, including
this one, 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. You should now see `version.dll` and a `_Redloader` folder sitting next to
`SonsOfTheForest.exe`
4. 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
5. Check that `MODS` appears on the main menu, then quit
Ignore `RedManager.exe` if you see it. It is only a convenience installer and
you do not need it.
### Step 2: Install Character Select
1. Download `CharacterSelect.zip` from the
[latest release](https://github.com/JustinOros/sotf-character-select/releases/latest)
2. Open the `Mods` folder inside your Sons of the Forest install, usually
@@ -33,9 +54,6 @@ Sons Of The Forest/
manifest.json
```
The `Mods` folder is created by RedLoader, so install RedLoader first if it is
not there.
## Usage
Once you are in the world, press F9 to cycle through the eight appearances. The
@@ -78,9 +96,4 @@ To produce a release zip:
## Credits
Built against RedLoader by Toni Macaroni. The player race system was found by
reading the source of ArmorMod by clairenheit.
reading the source of ArmorMod by clairenheit.