Creating Plugin Project

All examples created in Visual Studio 2022

Libraries

Creating Plugin require Unity Engine libraries and main game library. You can download libraries archive here: Link to archive

Creating Solution

We recommend to use .NET Framework 4.7.2(because only this version tested).

1. Create C# .NET Framework Library.

2. Connect downloaded libraries to your project.

3. Create Plugin Information class.

4. You are ready to go!

Plugin Information Class

Each plugin must contain plugin information, otherwise it will not be loaded. There no rules of naming this class. Here is example of plugin information class(we named it "Info").

public class Info : Akequ.Plugins.PluginInfo
{
    public override string Name => "Test Plugin";

    public override string Id => "com.akequ.test";

    public override string Version => "0.0.1";

    public override ushort BundleVersion => 1;

    public Info() { }
}

We will not Name, Id, Version, BundleVersion. We will not consider filling out these fields, since it should be clear to everyone why they are needed. We will only check "MustSpawnClasses", this property contain class names, that must spawn after successfull map generation and will also be spawned on clients, to send messages between server/client. Example Solution can be downloaded here: Link to archive

Testing

Now we can compile this plugin and move library to server plugins folder according to Folder Structure After starting server we must see this message: