119 lines
3.9 KiB
Markdown
119 lines
3.9 KiB
Markdown
# Character Select
|
|
|
|
[](https://github.com/JustinOros/sotf-character-select/releases) [](https://github.com/JustinOros/sotf-character-select/releases/latest)
|
|
|
|
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 automatically reapplies it every time your player spawns, so you stay the
|
|
same character.
|
|
|
|
## Multiplayer
|
|
|
|
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.
|
|
|
|
## 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
|
|
`C:\Program Files (x86)\Steam\steamapps\common\Sons Of The Forest\Mods`
|
|
3. Extract the contents of the zip into that `Mods` folder
|
|
|
|
When you are done it should look like this:
|
|
|
|
```
|
|
Sons Of The Forest/
|
|
Mods/
|
|
CharacterSelect.dll
|
|
CharacterSelect/
|
|
manifest.json
|
|
```
|
|
|
|
## Updating
|
|
|
|
Run the installer again. It replaces the old version and keeps your saved
|
|
appearance.
|
|
|
|
## Usage
|
|
|
|
Once you are in the world, press F9 to cycle through the eight appearances. The
|
|
current one is shown on screen as you cycle.
|
|
|
|
If your keyboard has no F keys, or you would rather pick one directly, press F1
|
|
to open the console and use the `character` command:
|
|
|
|
| Command | What it does |
|
|
| --- | --- |
|
|
| `character` | Shows your current appearance and the full list |
|
|
| `character next` | Moves to the next appearance |
|
|
| `character 3` | Switches straight to that appearance |
|
|
|
|
Your choice is saved to `UserData/CharacterSelect.txt` in your Sons of the Forest
|
|
folder and applied automatically every time you spawn.
|
|
|
|
| Value | Name |
|
|
| --- | --- |
|
|
| 0 | White |
|
|
| 1 | Black |
|
|
| 2 | Latin |
|
|
| 3 | Asian |
|
|
| 4 | BlackA |
|
|
| 5 | WhiteA |
|
|
| 6 | BlackB |
|
|
| 7 | LatinA |
|
|
|
|
## Building
|
|
|
|
This section is only for those who want to modify the source or build it
|
|
yourself.
|
|
|
|
Requires the [.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0) and a
|
|
[RedLoader](https://github.com/ToniMacaroni/RedLoader/releases/latest) install
|
|
that has been launched at least once, so the interop assemblies exist. The build
|
|
script offers to install both if they are missing.
|
|
|
|
```
|
|
.\build.ps1 -Install
|
|
```
|
|
|
|
The game folder is found through Steam. Override it with `-GameDir "path"` or the
|
|
`SOTF_PATH` environment variable.
|
|
|
|
To produce a release zip:
|
|
|
|
```
|
|
.\build.ps1 -Package
|
|
```
|
|
|
|
## Credits
|
|
|
|
Built against RedLoader by Toni Macaroni. The player race system was found by
|
|
reading the source of ArmorMod by clairenheit.
|