Paulov.Bepinex.Framework 2025.5.6.1806

There is a newer version of this package available.
See the version list below for details.
dotnet add package Paulov.Bepinex.Framework --version 2025.5.6.1806
                    
NuGet\Install-Package Paulov.Bepinex.Framework -Version 2025.5.6.1806
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Paulov.Bepinex.Framework" Version="2025.5.6.1806" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Paulov.Bepinex.Framework" Version="2025.5.6.1806" />
                    
Directory.Packages.props
<PackageReference Include="Paulov.Bepinex.Framework" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Paulov.Bepinex.Framework --version 2025.5.6.1806
                    
#r "nuget: Paulov.Bepinex.Framework, 2025.5.6.1806"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Paulov.Bepinex.Framework@2025.5.6.1806
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Paulov.Bepinex.Framework&version=2025.5.6.1806
                    
Install as a Cake Addin
#tool nuget:?package=Paulov.Bepinex.Framework&version=2025.5.6.1806
                    
Install as a Cake Tool

Paulov's Bepinex Framework

<div align="center">

<strong>A small library that can be used to quicky create BepInEx 5 plugins for Unity</strong>

NuGet Version

</div>

About The Project

This project is designed to allow developers to quickly create BepInEx 5 plugins for Unity games. It provides a simple way to create a plugin that can be easily loaded into the game.

Installation

  • Use the NuGet package manager to install the package

Usage

  • Ensure that Paulov.Bepinex.Framework.dll is in the game's BepinEx/plugins folder
  • In your Plugin class, Awake method, add the following code to load the Framework.
    var assembly = Assembly.LoadFile(Path.Combine(ReflectionHelpers.GetBaseDirectory(), "BepInEx", "plugins", "Paulov.Bepinex.Framework.dll"));
    if (Assembly.UnsafeLoadFrom(assembly.Location) != null)
        Logger.LogInfo("Loaded Paulov.Bepinex.Framework.dll");
  • Create a new class that inherits from IPaulovHarmonyPatch or NullPaulovHarmonyPatch
  • Patch your desired method using the correct method (i.e. Prefix, Postfix, etc.)
  • In your Plugin class, Awake method, Instantiate the HarmonyPatchManager class and call the EnablePatches method with the class you created
    var harmonyPatchManager = new Paulov.Bepinex.Framework.HarmonyPatchManager("Paulov's Main Harmony Manager");
    harmonyPatchManager.EnablePatches();

To learn more about patching using Harmony, visit the Harmony Wiki

License

Distributed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International Public License. See LICENSE for more information.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.