Creating a Service

Services are used to build a Dependency Injection (DI) container. Your services will be shared across all plugins, and you can inject other plugins services into your plugin, if needed.

To learn more about DI, see Microsoft DI Documentation.

Registration

Inject DependencyService into your main plugin constructor:

public class MyPlugin(IDependencyService dependencies) : IPlugin
{

}

Register your services with injected DependencyService:

dependencies.Register(services =>
{
    services.AddSingleton<ExampleSingletonService>();
    services.AddScoped<ExampleScopedService>();
    services.AddTransient<ExampleTransientService>();
});

Your services will be automatically activated (instantiated) and subscribed to events, if not delayed explicitly. You can delay your services activation, by providing activate: false parameter to the registration method:

dependencies.Register(services =>
{
    services.AddSingleton<ExampleSingletonService>();
    services.AddScoped<ExampleScopedService>();
    services.AddTransient<ExampleTransientService>();
}, activate: false);

Injection

You can inject your plugin or any other plugins services that are registered in the DI container into your classes.

public class ExampleSingletonService(ExampleTransientService transientService)
{
}

public class ExampleScopedService(ExampleSingletonService singletonService)
{
}

Proxy has a predefined set of services that are registered by default. They are called API services in this documentation book.

public class ExampleScopedService(
    ICommandService commands,
    IConfigurationService configurations,
    ICryptoService crypto,
    IEventService events,
    IPlayerService players,
    IServerService servers,
    ILinkService links)
{

}

Lifetimes

Services in the DI container can have different lifetimes, which determine how long they persist and how often they are created. These lifetimes are:

1. Singleton: A single instance is created and shared throughout the application.
2. Scoped: An instance is created once per player.
3. Transient: A new instance is provided every time it is requested.

See the detailed description of each lifetime in the Microsoft Documentation.

Example

See the ExamplePlugin.cs for services registrations and Services directory for services usage and implementations.