Package Introduction
Last updated
Last updated
Dynamo offers a vast number of features out of the box and also maintains an extensive package library that can significantly extend Dynamo’s capability. A package is a collection of custom nodes or additional functionality. The Dynamo Package Manager is a portal for the community to download any package that has been published online. These toolsets are developed by third parties to extend Dynamo's core functionality, accessible to all, and ready to download at the click of the button.
An open-source project such as Dynamo thrives on this type of community involvement. With dedicated third-party developers, Dynamo is able to extend its reach to workflows across a range of industries. For this reason, the Dynamo team has made concerted efforts to streamline package development and publishing (which will be discussed in more detail in the following sections).
The easiest way to install a package is by using the Packages menu option in your Dynamo interface. Let's jump right into it and install a package now. In this quick example, we'll install a popular package for creating quad panels on a grid.
In Dynamo, go to Packages > Package Manager...
In the search bar, let's search for "quads from rectangular grid". After a few moments, you should see all of the packages which match this search query. We want to select the first package with the matching name.
Click Install to add this package to your library, then accept the confirmation. Done!
Notice that we now have another group in our Dynamo library called "buildz". This name refers to the developer of the package, and the custom node is placed in this group. We can begin to use this right away.
Use Code Block to quickly define a rectangular grid, output the result to a Polygon.ByPoints Node, subsequently a Surface.ByPatch Node to view the list of rectangular panels you have just created.
The example above focuses on a package with one custom node, but you use the same process for downloading packages with several custom nodes and supporting data files. Let's demonstrate that now with a more comprehensive package: Dynamo Unfold.
As in the example above, begin by selecting Packages > Package Manager...
This time, we'll search for "DynamoUnfold", one word. When we see the packages, download by clicking on Install to add Dynamo Unfold to your Dynamo Library.
In the Dynamo Library, we have a DynamoUnfold Group with multiple categories and custom nodes.
Now, let's take a look at the package's file structure.
First, go to Packages > Package Manager > Installed Packages.
Then, click Show Root Directory to open the root folder for this package.
This will take us to the package's root directory. Notice that we have 3 folders and a file.
The bin folder houses .dll files. This Dynamo package was developed using Zero-Touch, so the custom nodes are held in this folder.
The dyf folder houses the custom nodes. This package was not developed using Dynamo custom nodes, so this folder is empty for this package.
The extra folder houses all additional files, including our example files.
The pkg file is a basic text file defining the package settings. We can ignore this for now.
Opening the "extra" folder, we see a bunch of example files that were downloaded with the install. Not all packages have example files, but this is where you can find them if they are part of a package.
Let's open up "SphereUnfold".
After opening the file and hitting "Run" on the solver, we have an unfolded sphere! Example files like these are helpful for learning how to work with a new Dynamo package.
In the Package Manager, you can browse for packages by using the sorting and filtering options in the Search for Packages tab. There are several filters available for host program, status (new, deprecated, or undeprecated), and whether or not the package has dependencies.
By sorting the packages, you can identify highly rated or most downloaded packages, or find packages with recent updates.
You can also access more detail on each package by clicking View Details. This opens a side panel in the Package Manager, where you can find information such as versioning and dependencies, website or repository URL, license information, etc.
Another way to discover Dynamo packages is to explore the Dynamo Package Manager website. Here, you can find stats on packages and author leaderboards. You can also download the package files from the Dynamo Package Manager, but doing so directly from Dynamo is a more seamless process.
If you would like to see where your package files are kept, in the top navigation click on Dynamo > Preferences > Package Settings > Node and Package File Locations, you can find your current root folder directory from here.
By default, packages are installed in a location similar to this folder path: C:/Users/[username]/AppData/Roaming/Dynamo/[Dynamo Version].
The Dynamo community is constantly growing and evolving. By exploring the Dynamo Package Manager from time to time, you'll find some exciting new developments. In the following sections, we'll take a more in-depth look at packages, from the end-user perspective to authorship of your own Dynamo Package.
Next to DynamoUnfold, select the options menu .
