Skip to content

OsuSync/EmberFramework

Repository files navigation

Ember Framework

A lightweight plugin framework.

Usage

Setup infrastructures and plugin-loader in host application

// project: host application
var root = await RootBuilder
    .Boot()
    .Infrastructures((registry, config) => registry.AddSingleton(...))
    .UseLoader<AssemblyPluginLoader>() // load plugins from $cwd/plugins, each plugin in a separate folder
    .UseLoader<TypedPluginLoader>() // use TypedPluginLoader.Register<TPlugin>() to register plugin type
    .UseLoader<CustomLoader>() // support custom plugin loader
    .Build();

await root.RunAsync(cancellationToken);

Setup plugins

// project: plugin

// Register your services into denpendency inject container
class MyPlugin : IPlugin
{
    public ValueTask<IServiceCollection> BuildComponents(CancellationToken cancellationToken = default)
    {
        var serviceCollection = new ServiceCollection();
        serviceCollection.AddSingleton<MyService>();
        serviceCollection.AddSingleton<MyServiceConfigurer, IComponentInitializer>();
        
        return serviceCollection;
    }
}

// Initialize your services
class MyServiceInitializer(MyService myService, ...) : IComponentInitializer
{
    public async ValueTask InitializeAsync(CancellationToken cancellationToken = default)
    {
        await myService.Connect(...);
    }
    ...
}

// Run your service!
class RunningJob(MyService myService) : IExecutable
{
    public async ValueTask RunAsync(CancellationToken cancellationToken = default)
    {
        await myService.ListenAsync(8080, cancenllationToken);
    }
}

About

A lightweight plugin framework.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages