Skip to content

Creating a Plugin

Jump to bottom
Gabriel Enrico edited this page Feb 9, 2021 · 2 revisions

Creating a DropMeter Plugin is quite easy! Follow the steps below to begin your awesome new plugin: Notice: This Guide assumes familiarity with basic C# and NuGet Package Installation.

Development

Requirements:

  1. Create a .NET 5 Class Library project. That can be done through you IDE or via the dotnet command with: dotnet new classlib inside your project folder.

  2. Install the DropMeter Plugin SDK to your project. That can be done through you IDE by searching for the NuGet package DropMeter.PluginInterface or via the dotnet command with: dotnet add package DropMeter.PluginInterface inside your project folder.

  3. Create a new Class that Extends DropMeter.PluginInterface.DMPlugin Your IDE should automatically implement all necessary methods and properties.

  4. Unleash your creativity! If you'd like an example, check out the WebNowPlaying Plugin

Packaging

SDK Version Range Manifest Documentation Final File Extension
1.0.0 -> Present The Universal Manifest .dmx

  1. Write a JSON Manifest File. Documentation is available on the table above. Make sure your manifest is set to be copied to your build output.

    • Don't forget to run a build after doing it, to copy the file.

  2. Zip your build output. NOTE: make sure your files are at the root of the zip file. The final structure should look like:

    • MyPlugin.zip/manifest.json
    • MyPlugin.zip/myplugin.dll (Build Output)
    • MyPlugin.zip/myplugin.deps.json (Build Output)
    • MyPlugin.zip/{AdditionalDlls}.dll (Optional, consider this to be the dependencies your plugin may need)

  3. Rename your ZIP file to have the Final File Extension, shown in the table above.

Clone this wiki locally