Plugin Installers (Windows)
This guide explains how to create a plugin installer for Rhino for Windows.
Creating a plugin installer is very easy. You simply add your compiled plugin to a zip archive and change the extension from .zip to .rhi. Once this is done, you can double-click the archive and the Rhino Installer Engine will begin to install your plugin. That’s all there is to it!
A Complex Example
Imagine you have a more complex plugin and want to support multiple versions of Rhino. For example, you want to:
- Install an older version of the plugin for Rhino 4.0
- Install a new version of the plugin for 32-bit Rhino 5
- Install another version of the plugin for 64-bit Rhino 5
- Include a custom toolbar file (e.g. MyToolbar.rui)
This is possible. You need to…
Create a “Installer Image” folder (In this example, the folder is the name of the product: Marmoset.) This folder will contain only the files you want to install on the user’s system.
Marmoset/ ├── Rhino 4.0/ │ ├── Marmoset.rhp │ └── required_v4.dll ├── Rhino 5.0/ │ ├── x86/ │ │ ├── Marmoset.rhp │ │ └── required_v5_x86.dll │ └── x64/ │ ├── Marmoset.rhp │ └── required_v5_x64.dll ├── Marmoset.rui └── Marmoset.chm
- Copy the appropriate files into the folders. Note that all three versions of the plugin can have the same name, so long as they are in different folders.
- Compress the three plugin versions and any additional files you wish to distribute using zip1 compression.
- Change the extension from .zip to .rhi
Everything but the kitchen sink
Because the Rhino Plugin Installer Engine unzips your .rhi file into a directory specific to your plugin, you can include anything you want: help files, documentation, etc. These files will end up inside your plugin directory; The Rhino Installer Engine cannot be used to install files to other parts of the hard drive.
Currently other compression algorithms are not supported. ↩