EmpyrionPrime.ModFramework 1.0.0

There is a newer version of this package available.
See the version list below for details.

dotnet add package EmpyrionPrime.ModFramework --version 1.0.0

NuGet\Install-Package EmpyrionPrime.ModFramework -Version 1.0.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="EmpyrionPrime.ModFramework" Version="1.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add EmpyrionPrime.ModFramework --version 1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: EmpyrionPrime.ModFramework, 1.0.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.

// Install EmpyrionPrime.ModFramework as a Cake Addin
#addin nuget:?package=EmpyrionPrime.ModFramework&version=1.0.0

// Install EmpyrionPrime.ModFramework as a Cake Tool
#tool nuget:?package=EmpyrionPrime.ModFramework&version=1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

EmpyrionPrime.ModFramework

Extended interfaces and apis for developing EmpyrionPrime plugins.

Examples

You can find some example plugins in at the Example Plugin repository.

Basic Plugin

Below is an extremely simple plugin example.

public class BasicPlugin : IEmpyrionPlugin
{
    private readonly ILogger _logger;
    private readonly IApiRequests _apiRequests;

    public string Name => "Basic Plugin";
    public string Author => "Author";
    public Version Version => new(1, 0);
    public ModInterface ModInterface { get; } = null;

    public BasicPlugin(ILogger logger, IApiRequests apiRequests, IApiEvents apiEvents)
    {
        _logger = logger;
        _apiRequests = apiRequests;

        // Access events and make requests via interface
        apiEvents.PlayerConnected += async id =>
        {
            var playerInfo = await _apiRequests.PlayerInfo(id);
            var playfieldStats = await _apiRequests.PlayfieldStats(playerInfo.playfield.ToPString());

            _logger.LogInformation("'{PlayerInfo}' loaded into '{PlayfieldName}' (pid {PlayfieldProcessId})",
                playerInfo.playerName, playfieldStats.playfield, playfieldStats.processId);
        };
    }
}

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.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 was computed.
.NET Framework	net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. 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.

.NETStandard 2.0
- EmpyrionPrime.Plugin (>= 1.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 7.0.0)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.