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.
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)
Currently Unturned is the only supported game. More games might follow in the future.
A RocketMod 4 bridge plugin is also planned which allows to run legacy RM4 plugins.
OpenMod is currently work-in-progress, hence a downloadable version does not exist.
Development will be fast since most of the code already exists in RocketMod 5. However, RocketMod 5 code is not ported 1:1, instead it gets refactored.
framework | standalone | unityengine | unturned |
---|---|---|---|
- IoC
- Logging
- Yaml Configurations
- Runtime
- Dynamic bootstrapping
- Projects
- Unturned Module
- Unitask integration
- Plugins (dll / NuGet)
- Plugin configurations & translations
- Standalone console implementation
- GitHub actions (auto releases & nuget deployments)
- Eventing
- Persistent Datastore
- Permissions implementations
- Command framework
- Unturned Command Wrappers
- Built-in OpenMod Commands
- Framework events implementation
- RM 4 Bridge
- Documentation
- Release
- RCON Plugin
- Scripting Plugin