Navz.Plugin.Core 0.1.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Navz.Plugin.Core --version 0.1.0
                    
NuGet\Install-Package Navz.Plugin.Core -Version 0.1.0
                    
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="Navz.Plugin.Core" Version="0.1.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Navz.Plugin.Core" Version="0.1.0" />
                    
Directory.Packages.props
<PackageReference Include="Navz.Plugin.Core" />
                    
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 Navz.Plugin.Core --version 0.1.0
                    
#r "nuget: Navz.Plugin.Core, 0.1.0"
                    
#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 Navz.Plugin.Core@0.1.0
                    
#: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=Navz.Plugin.Core&version=0.1.0
                    
Install as a Cake Addin
#tool nuget:?package=Navz.Plugin.Core&version=0.1.0
                    
Install as a Cake Tool

Getting Started

Reference Navz.PluginCore.dll to your client project

  1. Create your first plugin interface and base it to IPluginBase:

        public interface ICommandPlugin : IPluginBase
        {
            int Execute();
        }
    
  2. Initialize the pluginHost with the locations of plugins to enable the loader to find the assemblies:

    var pluginHost = new PluginHost("Plugins", new List<PluginSettings> {
        new PluginSettings {
            ProjectName = "<PluginFolderName>",
            DllName = "<PluginDllName>"
        }
    });
    

    or using json

    IConfiguration configuration = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("plugins.json", optional: false, reloadOnChange: true)
    .Build();
    
    var pluginHost = new PluginHost(configuration);
    

    plugin.json

    {
        "PluginConfiguration": {
            "RootPath": "Plugins",
            "Plugins": [
            {
                "ProjectName": "<PluginFolderName>",
                "DllName": "<PluginDllName>"
            }
            ]
        }
    }
    
  3. Load the plugins using the pluginHost:

    var commandPlugins = pluginHost.LoadPlugins<ICommandPlugin>();
    
    foreach (var commandPlugin in commandPlugins)
    {
        await commandPlugin.Execute();
    }
    
  4. Creating the Plugin:

    public class HelloWorldPlugin : CommandPlugin
    {
        public override string Name => "HelloWorld";
    
        public override string Description => "Displays \"Hello World\" message.";
    
        public override async Task<int> Execute()
        {
            await Task.Run(() => Console.WriteLine("Hello World!"));
    
            return 0;
        }
    }
    
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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. 
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.

Version Downloads Last Updated
1.0.0 99 1/17/2025
0.5.0 114 1/17/2025 0.5.0 is deprecated.
0.3.0 131 1/17/2025
0.1.0 108 1/12/2025