Replace readme with full rewrite

README.md

@@ -1,34 +1,66 @@
 # 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,
+Sons of the Forest gives you a random appearance out of eight every time you join
-and only remembers it if the world gets saved. This mod lets you choose, and
+a server, and there is no way to choose. This mod lets you pick the one you want
-reapplies your choice every time you spawn.
+and automatically reapplies it every time your player spawns, 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
+your choice even if they do not have the mod installed.
-change their own appearance without it.
-
-## Requirements
-
-RedLoader
 
 ## Installation
 
-1. Download the latest release
+### Step 1: Install RedLoader
-2. Extract into your Sons of the Forest folder so you end up with:
+
-   - `Mods/CharacterSelect.dll`
+[RedLoader](https://github.com/ToniMacaroni/RedLoader/releases/latest) is the mod
-   - `Mods/CharacterSelect/manifest.json`
+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
+```
 
 ## Usage
 
-Press F9 to cycle through the eight appearances. Your choice is saved to
+Once you are in the world, press F9 to cycle through the eight appearances. The
-`_RedLoader/UserData/CharacterSelect.txt` and applied automatically on every spawn.
+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 +75,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
+Requires the [.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0) and a
-the interop assemblies exist. The script offers to install both if they are missing.
+[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.