All Tutorials / DJ Sures / How To Make An EZ-Builder Plugin

How To Make An EZ-Builder Plugin

More Information

Tutorial Source Code
The source code for this tutorial can be downloaded here: MyFirstPlugin.zip


Additional Open-Source Code Examples
Additional open-source code examples can be found by some developers. DJ Sures publishes some plugins open-source and they can be found by clicking here. A plugin template project can also be downloaded by clicking here.


Adding Custom EZ-Builder Icons
Your control will use the default icon if there isn't another specified. To add an icon, include either a transparent PNG in your project output folder named title.png. This file will be used in the Add Control window of EZ-Builder as an icon for your plugin.


Changing EZ-Builder Category
You may wish to change the category of your plugin from BETA to an appropriate category when publishing to the public. The category is specified in the plugin.xml file. The category is must match one of the categories from the EZ-Builder Add Control menu.


Uploading plugin
If you wish to upload your plugin to the website for sharing, the contents of your plugin's output folder must be archived in a ZIP file. Programs such as WinZip can be used for creating ZIP files. I do believe Windows can also generate ZIP files, but I tend to use WinZIP.

The ZIP file can contain directories if your plugin requires resources or additional libraries, etc.. However, your plugin DLL file, plugin.XML and title.png must all be at the root of the ZIP file.

Once you have created a ZIP File following the above instructions, simply upload it to your plugin definition.


Share Unpublished plugin (User Testing)
It is a smart idea to share your newly created plugin with others before publishing to the public. You can copy the URL of the INSTALL option on your plugin Definition page and send to others. The INSTALL option will not display until a valid plugin file has been uploaded to the plugin Definition.

To share the install of the plugin, simply copy the URL of the INSTALL option with your web browser. Send that URL to your testing group.


Publishing plugin
The Publish plugin checkbox is located in the plugin Definition editor on this website. The checkbox will only be displayed when all requirements have been met for a valid plugin. The plugin definition editor will notify you of what changes are necessary to publish a plugin to the public.