/openmod

OpenMod .NET Plugin Framework

Primary LanguageC#OtherNOASSERTION

OpenMod Discord

OpenMod is a plugin framework for .NET.

It supports authorization, plugin configurations, internalization, command handling and much more. OpenMod can be used for games, bot frameworks, web servers or anything else and has official implementations for Unturned, Rust (WIP) and a standalone console.

For a list of available plugins, visit openmod-plugins.

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
  • Configure OpenMod and plugins with yaml configurations, environment variables, commandline arguments, etc.
  • Serilog for logging, including rich configuration options via logging.yml

Getting Started

To get started, visit the OpenMod Documentation.

If you would like to install OpenMod, installation guides for the following platforms are available:

If you want to make plugins for OpenMod, you can get started by reading the Making your first plugin page.

Supported Games

Currently Unturned is the only supported game. More games might follow in the future. OpenMod can work side-by-side with RocketMod.

License

See LICENSE file for more information.

Build Status

Framework

OpenMod.API OpenMod.Bootstrapper OpenMod.NuGet OpenMod.Core OpenMod.Runtime OpenMod.Analyzers OpenMod.Templates OpenMod.EntityFrameworkCore

Extensions

OpenMod.Extensions.Games.Abstractions OpenMod.Extensions.Economy.Abstractions

Standalone

OpenMod.Standalone

UnityEngine

OpenMod.UnityEngine.Redist OpenMod.UniTask OpenMod.UnityEngine

Unturned

OpenMod.Unturned.Redist OpenMod.Unturned OpenMod.Unturned.Module

Rust

OpenMod.Rust.Redist OpenMod.Rust OpenMod.Rust.Oxide.Redist OpenMod.Rust.Oxide OpenMod.Rust.Oxide.Extension OpenMod.Rust.Oxide.PermissionLink

Code of Conduct

This project uses the .NET Foundation Code of Conduct.

.NET Foundation

This project is supported by the .NET Foundation.