Site Tools


Creating Plug-ins for Zoo

Developer: Zoo 5
Summary: Discusses how to create plug-ins for Zoo 5.

Overview

Zoo 5 allows 3rd party plug-in developers to add licensing support for their products to the Zoo.

When a customer attempts to add a product license to the Zoo, the product's plug-in is called to validate the user's request. Upon valuation, the plug-in will return the product's licensing information back to the Zoo. The Zoo will, in turn, serialize, maintain, and distribute this license.

Requirements

Zoo plug-ins are .NET Framework 4.0 assemblies. Thus, to create a plug-in for Zoo 5, you will need one of the following development tools:

  1. Microsoft Visual C# 2010.
  2. Microsoft Visual Basic .NET 2010.

Also, all plug-ins that use the Zoo license system must be signed with an Authenticode certificate issued by McNeel Plugin Security. These certificates are free, but must be requested by each developer. Developers must agree to the Terms of Use before a certificate is issued. For more information on plug-in signing, see the following

Digitally Signing Plug-ins

Writing a Zoo Plug-in

The following are the general steps required to create a Zoo plug-in.

  1. Make sure you have Zoo 5 installed.
  2. Launch Microsoft Visual Studio 2010.
  3. Create a new Class Library project using either Visual C# or Visual Basic .NET.
  4. Add a reference to ZooPlugin.dll, which is found in the Zoo installation folder. Make sure to set the reference's Copy Local property to False.
  5. Create a new public class that inherits from the IZooPlugin interface.
  6. Implement the interface members. (For detailed information about the interface members, see the sample Zoo plug-ins listed below.)
  7. Build your plug-in.

Installing a Zoo Plug-in

Once you have built your Zoo plug-in, you can install it and test it as follow:

  1. Run ZooAdmin.exe and make sure the Zoo licensing service has been stopped.
  2. Copy your plug-in assembly (.DLL) and any dependent support libraries to the Zoo's plug-in's folder (i.e. C:\Program Files\Zoo 5.0\Plugins).
  3. Restart the Zoo license service.
  4. When the service has restarted, click the Add License button. Your product should be one of the available products for which to add a license.

Zoo Plugin Samples

developer/zooplugin.txt ยท Last modified: 2014/06/26 (external edit)