https://github.com/legendaryb/calamity

A (mini) plugin framework for .NET applications.
https://github.com/legendaryb/calamity

Last synced: 5 days ago
JSON representation

A (mini) plugin framework for .NET applications.

• Host: GitHub
• URL: https://github.com/legendaryb/calamity
• Owner: LegendaryB
• License: mit
• Created: 2021-04-15T23:32:18.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-13T13:36:59.000Z (12 months ago)
• Last Synced: 2024-12-29T21:51:10.618Z (9 days ago)
• Language: C#
• Homepage:
• Size: 60.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        

Calamity


[![forthebadge](https://forthebadge.com/images/badges/fuck-it-ship-it.svg)](https://forthebadge.com)

[![forthebadge](https://forthebadge.com/images/badges/made-with-c-sharp.svg)](https://forthebadge.com)

[![GitHub license](https://img.shields.io/github/license/LegendaryB/Calamity.svg?longCache=true&style=flat-square)](https://github.com/LegendaryB/Calamity/blob/master/LICENSE.md)

[![Nuget](https://img.shields.io/nuget/v/Calamity.svg?style=flat-square)](https://www.nuget.org/packages/Calamity/)

A (mini) plugin framework for .NET applications.







Built with ❤︎ by Daniel Belz




## Getting started

### Configuration

The static `PluginLoaderOptions` class contains properties for the configuration of Calamity. The table should be self explaining.

|Property|Description|Default value|

|---|---|---|

|LoggerFactory|Factory to provide a logger for the internal library types.|NullLogger|

|TypeActivator|The default `ITypeActivator` which is used to create object instances. |.NET Framework Activator|

|PreferAssembliesFromHost|Flag to indicate if the plugin should prefer assemblies from the host.|true|

### Loading a plugin from a assembly

To load a plugin from a assembly you need to use the static `PluginLoaderFactory` class. The method `CreateLoaderFor<>` will return a generic `IPluginLoader` instance to you. This instance holds all metadata which is then required to create a instance of the plugin. After setting several properties on your `IPluginLoader` instance you can finally use the `Build` method. If you don't specify an alternate `ITypeActivator` implementation the default one from the `PluginLoaderOptions` will be used instead.

```csharp

class Program

{

    static void Main()

    {

        var path = @"C:\MyPluginAssembly.dll";

        

        // Will create a instance of a type which implements ITestPlugin and uses the default ITypeActivator.

        var instance = PluginLoaderFactory

            .CreateLoaderFor(path)

            .Build();

            

        // Will create a instance of a type which implements ITestPlugin and uses the specified ITypeActivator.

        var instance = PluginLoaderFactory

            .CreateLoaderFor(path)

            .Build(new MyTypeActivator());  

            

        // Will create a instance of a type which implements ITestPlugin and uses the default ITypeActivator in combination with constructor parameters.

        var instance = PluginLoaderFactory

            .CreateLoaderFor(path)

            .AddConstructorParameters("param1", "param2")

            .Build();

    }

}

```

### Creating a ITypeActivator implementation

A `ITypeActivator` instance is used to create a instance of an object from a type. To use a custom `ITypeActivator` you can set it global via the `PluginLoaderOptions.TypeActivator` property or give a instance as a parameter into the `IPluginLoader.Build` method.

```csharp

class Program

{

    // Inherit from ITypeActivator interface and implement it

    public class MyTypeActivator : ITypeActivator

    {

        public TInterface CreateInstance(Type implementationType, object[] args) 

            where TInterface : class

        {

            // Create the instance of the object

            return Activator.CreateInstance(implementationType, args) as TInterface;

        }

    }

    static void Main()

    {

        var path = @"C:\MyPluginAssembly.dll";

        

        var myTypeActivator = new MyTypeActivator();

        // Will create a instance of a type which implements ITestPlugin and uses the custom ITypeActivator.

        var instance = PluginLoaderFactory

            .CreateLoaderFor(path)

            .Build(myTypeActivator);

        // .. or set it global

        PluginLoaderOptions.TypeActivator = myTypeActivator;

        // Will create a instance of a type which implements ITestPlugin and uses the custom ITypeActivator specified in the options.

        var instance = PluginLoaderFactory

            .CreateLoaderFor(path)

            .Build();

    }

}

```

## Contributing

__Contributions are always welcome!__  

When you send me a pull request please make sure to add some information regarding your changes, improvements or bugfixes.

## License

This project is licensed under the MIT license - see the [LICENSE](LICENSE) file for details