codengine/redloader

Sons Of The Forest Modloader built on top of MelonLoader

---

RedLoader

... is a mod loader and sdk that started as a fork of MelonLoader. It's main purpose is to make mod development for Sons Of The Forest more streamlined by adding some much needed improvements and features. As well as making it a bit more user friendly.

---

📙 Documentation and Wiki 📙

⭐ Star the repo at the top if you like this project ⭐

---

FEATURES:

• Automatic asset bundle loading and mapping to class
• Automatic addressables catalog loading
• A powerful UI framework
• Status screen
• Toggle console at runtime
• Save and set console position
• Directly load into test scene
• Define mod using manifest.json
• Load sounds at runtime
• Quickly setup debug GUIs using attributes
• Bunch of helpers for game features

INSTALLATION:

---

Automatic
Download the RedManager.
The RedManager is a single file (no installation needed) application that can detect your game installation and install/update/remove RedLoader as well as other extras for you.

---

Manual

1. Download the latest release from here (RedLoader.zip)
2. Unpack the zip directly into your game directory (the _RedLoader folder should end up in the same directory as SonsOfTheForest.exe)
3. Make sure you have installed all requirements (listed below)

---

Configuration

Command Line

These can be added through the steam launch options or through a shortcut

Argument	Example	Description
--sdk.loadintomain		Immediately loads the game into a test environment world.
--savegame	--savegame 1440719049	Immediately loads the game into a savegame (specified by savegame id).

Config

These can be changed in the UserData/_RedLoader.cfg file

Entry	Type	Description
Readable Exceptions	bool	Makes the exceptions more readable.
Disable Notifications	bool	Disable the popup notifications.
Auto Fix Reshade	bool	Automatically rename dxgi.dll in the game folder to make Redloader able to load Reshade.
Redirect Debug Logs	bool	Redirect Debug Logs of the game to the console.
Skip Intro	bool	Skip the EndNight intro.
Muted Sounds	List[string]	List of sounds that should be muted.
Toggle Console Key	KeyCode	Key used to toggle the in-game console.
Don't Auto Add Scenes	bool	Indicates whether additional scenes should not be added automatically.
Don't Load Saves	bool	Indicates whether the game should skip the activation process and not load saves.
Activate World Objects	bool	Indicates whether world objects such as trees, bushes, and rocks should be activated or not.
Player Debug Speed	float	Multiplier for the speed of the player in the test world.
Skip Building Animations	bool	Indicates whether building animations should be skipped.
Enable Bow Trajectory	bool	Indicates whether the bow trajectory should be displayed when aiming.
No Consume Animation	bool	Whether to not play any animations when consuming items.
No Auto Equip Stones	bool	Don't automatically equip stones when picking them up.
Instant Inventory Open	bool	Instantly open the inventory without animations.

In-Game Debug Console

These can be invoked through the in-game debug console (open with F1 key)

Command	Example	Description
togglegrass		Toggles the visibility of grass
xfreecam		Freecam mode without "exiting" the player
cancelblueprints		Cancel all blueprints in a radius
noforest		Removes trees, bushes and (including billboards) for debugging purposes
clearpickups		Clears all pickups in a radius
gotopickup		Go to a pickup by name (picks the first one that contains the name). Useful for finding story items.
goto		Go to a coordinate, goto-location or gameobject.
addcharacter		Spawn a new character into the world.
virginiasentiment		Add sentiment to virginia
virginiavisit		Invokes a virginia visit event
dump		Dump various data from the game. dump [items, characters, prefabs]
playcutscene		Play a cutscene by name
toggleshadows		Toggles the shadow rendering (Shadows, Contact Shadows, Micro Shadowing)

Compiling from source

1. Install .NET 6.0 SDK
2. Install Nuke globally with dotnet tool install Nuke.GlobalTool --global
3. Install Rust (tripple:x86_64-pc-windows-msvc nightly)
4. Clone the repository
5. Adjust the game path in .nuke/parameters.json and Directory.Build.props
6. Run nuke pack --configuration Release --restore-packages in the repo directory

REQUIREMENTS:

• .NET 6.0 Desktop Runtime
• Microsoft Visual C++ 2015-2019 Re-distributable [x64]

LICENSING & CREDITS:

RedLoader is a fork of MelonLoader which is licensed under the Apache License, Version 2.0
See LICENSING & CREDITS on the original MelonLoader readme for the full list of credits and licenses.