diff --git a/Guide.md b/Guide.md index 7d9c352..3a897b5 100644 --- a/Guide.md +++ b/Guide.md @@ -8,7 +8,19 @@ 1. Implement the required members from `DesktopMagicPluginAPI.Plugin` -1. Compile it into a `.dll` file and in the plugin directory create a directory with the same name as the `.dll` file without the file extension and put the `.dll` file with all required dependencies into it. +1. Compile it to a `.dll` file. + +1. In the plugin directory create a directory with the same name as the `.dll` file without the file extension and put the `.dll` file with all required dependencies into it. + +## General information + +### The `Main` method +The `Main` method is where the main processing of the plugin should take place.\ +The method is executed in a different thread, which means you can run things with heavy load there without affecting the main application or other plugins.\ +You must return a `bitmap` from this method to display the output in the plugin window. + +### Event handlers +All events are normally raised in the main thread of the DesktopMagic application, so they should not contain code that blocks the main thread. ## Examples @@ -45,6 +57,8 @@ namespace DesktopMagicPlugin ### Input example +In this example, the user can enter a string that will be displayed on the image. + ```cs using DesktopMagicPluginAPI; using DesktopMagicPluginAPI.Inputs;