Getting started with Plugins

Here is a step by step guide on how to take an existing plugin, compile it and use it as a starting point for a new plugin.

Prerequisites

You need to install Visual Studio 2017. The free Community edition is fine. Make sure .NET Framework 4.6.1 or newer is installed too.

Some moderate knowledge of C# is necessary.

Download a plugin source code

Go to the YourDyno plugin library and download the source code of for example the “Brake and Gear ratio” plugin. Uncompress the source code in your Visual Studio projects folder.

Open the .csproj project file in Visual Studio. You will get a whole host of errors if you try to compile, so don’t do that yet.

Linking up the libraries

The YourDyno .dll files are in the YourDyno installation directory. Link them up in the References section in the Solutions Explorer.

You can see that DataConnection and PluginContracts have an error. Delete these references, and add the references again by right-clicking on References and selecting Add Reference. Select Browse, and navigate to the .dll file in the YourDyno installation directory.

Do the same for all missing references. The code should be ready for compilation now.

Compilation and installation

It is practical to compile straight into the directory where YourDyno looks for plugin .dlls, so you only need to start up YourDyno to test your plugin. Go to Properties and Build and set the output path:

The plugin should now compile.

Test the plugin

Start up YourDyno. The plugin should load and appear in the Plugin menu.

Debugging a plugin

It is possible to debug the plugin. You need to add an executable project which includes yourdyno.exe to the solution. Like this:

Right-click on the Solution in the Solution Explorer and click Add Existing Project.

Select an Exe Project File:

And navigate to YourDyno.exe in your installation directory. Your Solution Explorer window should now look like this:

Set the YourDyno .exe project as the “Startup project”. You are now able to set break points and debug as normal.

Now you are all set to create your own plugin!

 

Last updated byadmin on March 11, 2019

Leave a Reply

Your email address will not be published. Required fields are marked *