/OpenMod

OpenMod .NET Plugin Framework

Primary LanguageC#European Union Public License 1.2EUPL-1.2

OpenMod Discord

OpenMod is a modding framework for .NET. It is the successor of RocketMod 5.

It's main purpose is to add plugin functionality to Unity games, but it could be used with any .NET host.

Features

OpenMod is based on modern C# code and best practices.

  • Modern API for plugin development with C# and Unity best practices
  • Plugin installation with NuGet
  • Can self update with NuGet
  • Based on .NET Generic Host
  • IoC and Dependency Injection using Autofac
  • UniTask integration for Unity based games
  • Configure OpenMod and plugins with yaml configurations, environment variables, commandline arguments, etc.
  • Serilog for logging, including rich configuration options via logging.yml
  • Scripting (todo)
  • RCON (todo)

Supported Games

Currently Unturned is the only supported game. More games might follow in the future.

A RocketMod 4 bridge has been made, which allows to run legacy RM4 plugins. The configs for RM4 are yet to be decided to be separate, or to be proxied.

Build Status

framework standalone unityengine unturned
OpenMod.Bootstrapper OpenMod.Standalone OpenMod.UnityEngine OpenMod.Unturned
OpenMod.API OpenMod.Unturned.Module
OpenMod.Core OpenMod.Rocket.API
OpenMod.NuGet OpenMod.Rocket.Core
OpenMod.Runtime OpenMod.Rocket.Unturned