From 3e744a9a7483ba8902f3990fad703f8202582229 Mon Sep 17 00:00:00 2001 From: Justin Oros Date: Sun, 13 Sep 2026 11:15:31 -0700 Subject: [PATCH] Link the dotnet SDK and RedLoader in the building section --- README.md | 70 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 53 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 56a79cf..22d35ca 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,50 @@ # Character Select -Pick your player appearance in Sons of the Forest and keep it across sessions. +Choose your player appearance in Sons of the Forest and keep it across sessions. -The game assigns one of eight player appearances at random when you join a server, -and only remembers it if the world gets saved. This mod lets you choose, and -reapplies your choice every time you spawn. +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. -## Notes +## Multiplayer -Client side only. Nothing needs to be installed on a dedicated server. +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. They will not be able to -change their own appearance without it. +your choice even if they do not have the mod installed. ## Requirements -RedLoader +[RedLoader](https://github.com/ToniMacaroni/RedLoader/releases/latest) ## Installation -1. Download the latest release -2. Extract into your Sons of the Forest folder so you end up with: - - `Mods/CharacterSelect.dll` - - `Mods/CharacterSelect/manifest.json` +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 +``` + +The `Mods` folder is created by RedLoader, so install RedLoader first if it is +not there. ## Usage -Press F9 to cycle through the eight appearances. Your choice is saved to -`_RedLoader/UserData/CharacterSelect.txt` and applied automatically on every spawn. +Once you are in the world, press F9 to cycle through the eight appearances. The +current one is shown on screen as you cycle. + +Your choice is saved to `_RedLoader/UserData/CharacterSelect.txt` and applied +automatically every time you spawn. | Value | Name | | --- | --- | @@ -43,5 +59,25 @@ Press F9 to cycle through the eight appearances. Your choice is saved to ## Building -Requires the .NET 8 SDK and a RedLoader install that has been launched once, so -the interop assemblies exist. The script offers to install both if they are missing. +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.