RealLoader is early in development and not fully implemented/functional yet.

Branch	Status
Master
Testing
Poofy Feature Branch

RealLoader 🎷🐛

Tip

Remember to launch your game with -modded flag (usualy done in steam), otherwise the mod framework will run in bypass-mode allowing you to play un modded by default.

Join our discord Discord Link

Unreal Engine Modding Framework

RealLoader is a powerful framework for loading and orchestrating mods created in various languages for Unreal Engine. It primarily supports C# for developing mods and provides a streamlined modding SDK with essential tools.

Key Features

• Multi-Language Mod Support

  • Primarily designed for C# mod development.
  • Provides extensibility for integrating mods written in other languages.

• Function Hooking & Unreal Engine API Calls

  • Allows mods to hook into Unreal Engine functions dynamically.
  • Enables calling Unreal Engine functions by name for seamless interaction.

• Source-Generated SDK for Installed Games

  • Automatically generates a full SDK of the game RealLoader is installed to.
  • Ensures modders have access to the necessary game-specific APIs.

• Dependency Injection for C# Mods

  • Handles mod dependencies efficiently using DI (Dependency Injection).
  • Allows for modular and scalable mod development.

• Mod Orchestration & Management

  • Provides a framework for managing mods, ensuring compatibility and execution order.
  • Supports enabling, disabling, and configuring mods dynamically.

Building from Source

Note

The following required dependencies must be met in order to compile from source. Dotnet runtime is required to run the mod framework on every location.

Dependencies

• .NET 9+ Runtime

How to Build

Tip

All build symbols are configured to go to /bin in the root directory.

1. Clone the repo

   git clone https://github.com/Realynx/RealLoader

---

• 

1. Install Visual Studio 2022+ with the Desktop development with C++ package.
   You can install this using the visual studio installer
   For Cli-only Based Builder (like windows core) you can use these installers from Installer Packages Page or use Direct Link

   .\vs_buildtools.exe --add Microsoft.VisualStudio.Workload.VCTools --includeRecommended --quiet --wait
   

2. Open the solution in IDE and build.

---

• 

1. Install the .NET 9+ SDK
2. Install CMake 3.22+
3. Run Cmake from root directory.

   cmake ./
   cmake --build ./Build

Resources

Tip

You can view example mods under Client Mod Ex, Server Mod Ex, and DI Mod Ex

Please read the following articles before contributing.

• Contributing
• Code of Conduct
• Editorconfig Style Rules
• Roadmap