Creating a Rhino Plug-In Package
This is a step by step guide to creating a package for a Rhino plug-in.
First, let’s assume you have a folder on your computer which contains all the files that you would like to distribute in your package. Something like this…
C:\Users\Bozo\dist ├── Tamarin.rhp ├── Tamarin.dll └── misc\ ├── README.md └── LICENSE.txt
We’re going to use the Yak CLI tool to create the package, so open up a Command Prompt and navigate to the directory above.
> cd C:\Users\Bozo\dist
Now, we need a
manifest.yml file! You can easily create your own by studying
the reference. Alternatively, you can use the
command to generate a skeleton file. We’ll do the latter here.
> "C:\Program Files\Rhino WIP\System\Yak.exe" spec Inspecting content: Tamarin.rhp --- name: tamarin version: 1.0.0 authors: - <author> description: An example RhinoCommon plug-in url: http://example.com secret: id: 78959099-8b36-4c5d-bc57-10a6415745f6 Saved to C:\Users\Bozo\dist\manifest.yml
spec command takes a look at the current directory and, if present, will
glean useful information from the
.rhp assembly and use it generate a
manifest.yml with name, version, description etc. pre-populated. If you haven’t
added this information, then placeholders will be used.
The RhinoCommon plug-in inspector extracts the assembly attributes that you set
when creating your plug-in. The
AssemblyInformationalVersion attribute is used
to populate the version field, since this attribute isn’t bound to the Microsoft
four-digit version spec and can contain a SemVer-compatible version string.
You might notice your plug-in’s GUID lurking in the
secret/id key. The GUID is stored in case we need to identify a
plug-in package whose package name/version doesn’t match the plug-in
Next, open the manifest file with your favourite editor and fill in the gaps.
Afterwards, you should have something that looks a little like this…
--- name: tamarin version: 1.0.0 authors: - Will Pearson description: > This plug-in does something. I'm not really sure exactly what it's supposed to do, but it does it better than any other plug-in. url: example.com secret: id: c9beedb9-07ec-4974-a0a2-44670ddb17e4
Now that we have a manifest file, we can build the package!
> "C:\Program Files\Rhino WIP\System\Yak.exe" build Building package from contents of C:\Users\Bozo\dist Found manifest.yml for package: tamarin (1.0.0) Inspecting content: Tamarin.rhp Creating tamarin-1.0.0.yak --- name: tamarin version: 1.0.0 authors: - Will Pearson description: > This plug-in does something. I'm not really sure exactly what it's supposed to do, but it does it better than any other plug-in. url: example.com secret: id: c9beedb9-07ec-4974-a0a2-44670ddb17e4 C:\Users\Bozo\dist\tamarin-1.0.0.yak ├── Tamarin.dll ├── Tamarin.rhp ├── manifest.yml └── misc/ ├── LICENSE.txt └── README.md
Congratulations! 🙌 You’ve just created a Yak package for your Rhino plug-in.
Now that you’ve created a package, why not push it to the Yak server to make it available to everyone else!