phogue / potato-documentation Goto Github PK

1. Create your plugin
2. See http://docs.nuget.org/docs/creating-packages/creating-and-publishing-a-package
3. Include "Procon" as a tag in your package. Only packages tagged with "Procon" will appear in the UI.

Myrcon does not host your packages. There are numerous nuget repository hosts.

The main solution of Procon contains examples and unit tests for these examples. Simply clone the project at https://github.com/Myrcon/Procon-2 and open up the solution.

You should see examples in the "Examples" solution directory. There are corresponding unit tests for each example, though most of the tests are designed to help you step through working examples quickly.

The examples are included in the main solution so we can ensure each outgoing release has working examples and so plugin developers have to download the entire source of Procon. You might be able to help us :)

Naming changed to simply say "Procon" and "Procon UI".

Instructions are pretty similar to those found at http://docs.nuget.org/docs/creating-packages/hosting-your-own-nuget-feeds

1. Install NuGet
   http://docs.nuget.org/docs/start-here/installing-nuget
2. Create a new Class Library project
   For Procon to pickup the plugin you are required to follow the naming convention "[Owners].Plugins.[PluginName]" like
   -- "Myrcon.Plugins.Autobalancer"
   -- "PapaCharlie.Plugins.Autobalancer.Balancer"
   -- "PapaCharlie.Plugins.Autobalancer.Scrambler"
3. Add https://repo.myrcon.com/procon to your NuGet repositories
4. Include NuGet package "Myrcon.Procon.Shared" from the myrcon repository
5. Create a source file "Program.cs". Procon will look for the type "[PackageId].Package" to load.

using System;
using Procon.Core.Shared.Events;
using Procon.Core.Shared.Plugins;

namespace /* Your Package ID as the Namespace */ {
    public class Program : PluginController {

        public override void GenericEvent(GenericEventArgs e) {
            base.GenericEvent(e);

            if (e.GenericEventType == GenericEventType.PluginsPluginEnabled) {
                Console.WriteLine("Hello World!");
            }
        }
    }
}

1. Done, next you'll want to look at publishing your plugin as a NuGet package.