Skip to main content
Speckle currently supports versions: . The connector works on only.

Setup

The Rhino and Grasshopper connectors are bundled, so if you installed one, you don’t need to install the other.
1

Install the connector

Install your connector
2

Open the Rhino connector

  1. Type Speckle in the command line, or 2. Select Speckle in the Speckle Toolbar to open the Rhino connector.
Rhino toolbar
  1. Select Sign in if you haven’t linked your Speckle account.
Login
After installation, if you don’t see the Speckle Rhino toolbar, you can manually load it:
  1. Type the Toolbar command in Rhino.
  2. Select File > Open and navigate to your Rhino UI folder: AppData\Roaming\McNeel\Rhinoceros\7.0\UI\Plug-ins
  3. Select the Speckle.Connectors.Rhino.rui file and press Enter.
You should now see the toolbar in Rhino.
Early versions of Rhino 8 may not have propery framework compatibility for plugins. We advise you to upgrade to Rhino 8.9 and above if you are using an earlier version. You can also change your Rhino runtime:
  1. Type the SetDotNetRuntime command in Rhino
  2. Select the NETFramework option
  3. Restart Rhino
  1. Make sure your version of is one of the supported versions.
  2. Uninstall and reinstall your connector.
Note: Make sure you are not selecting Run as administrator when installing - this will install for the administrator user, and not your own user. Instead, double-click the .exe or right-clicking and then selecting Open to run the installer. Installation issues can also be caused by conflicting plugins.If you’re still experiencing problems, please report it in our Community Forum and include the following information:
  • Your application version
  • Your Speckle connector version
If your connector window is floating, try docking it to your application to fix blank UI issues.For major issues, you can sometimes find a log file in your directory at AppData\Roaming\Speckle\Logs. Please report your problem in our Community Forum and include the following information:
  • Your application version
  • Your Speckle connector version
  • A copy of the log
This can happen if our desktop service isn’t running. Desktop Service is used for authenticating new accounts. If it’s not running, search for Speckle Desktop Services in Windows search and run it.
All Speckle connectors are installed like any other program. You can uninstall them directly from your system’s Applications. For a full uninstall, you should also remove Speckle Desktop Services as well as your Speckle connector.
You can always download the latest version of the connector in the web app. If a new version of the connector is available, you will also see a notification in your connector UI.

Publishing a Model

1

Select Publish

Publish
2

Choose a project

  • Select an existing project
  • or select New Project to create one
Publish
3

Choose a model

  • Select an existing model
  • or select New Model to create one
Publish
4

Select objects to publish

  1. In your application viewport, select the elements you want to publish.
  2. Select Publish.
Publish
Publish
  1. Your model is now published to Speckle and is available to the rest of your team.
All types of visible geometry can be published, as well as hatch, text, and blocks. Each published object contains the following information:
  • Name
  • Color
  • Render material
  • User strings
  1. Click the blue filter field at the top of Select objects dialog while publishing a new version.
Rhino filters
  1. Select Layers, and then click on any number of layers you would like to add to the filter.
All custom properties can be found under the properties field when you select and view a Rhino object in your browser.
Rhino settings - Add Visualization Properties
When publishing a model, you’ll see a setting called “Add visualization properties (will increase model size)”. This setting is turned off by default.
  • With the setting OFF: Vertex normals, vertex colors, and texture coordinates are not included on meshes, resulting in smaller model sizes.
  • With the setting ON: All visualization data is extracted and included.
When to enable this:
  • You want the highest visual fidelity in the Speckle viewer
  • You need full interoperability with rendering tools (e.g., Blender, other Rhino instances)
When to keep it disabled:
  • You want the smallest data sizes possible (e.g., for Power BI or other data-focused workflows)
In the viewer, select the View Modes button in the side bar, and switch the view mode to Shaded. If you still don’t see your object colors, let us know in our Community Forum
After you publish a Speckle model, click on the Report button to see any errors that may have occurred. Click on any item in the report to highlight that item in your application. Some objects may not be supported for publishing.

Loading a Model

1

Select Load

Load
2

Choose a project

Load
3

Choose a model

Load
4

Choose a version to load

  • Latest version is always first.
  • To load a specific version, select it from the UI.
Load
Load
Your selected model is now loaded in .
All objects in Speckle models are loaded as geometry, text, or blocks in Rhino. They’re created in the same layer structure as what you see when viewing your model in your browser. Each object will be loaded with:
  • Render material (if any)
  • Color (if any)
  • Name (if set)
  • Custom properties as user strings
Yes, all custom properties found under the properties field will be created as user strings in Rhino.
After you load a Speckle model, click on the Report button to see any errors that may have occurred. Click on any item in the report to highlight that item in your application. Some objects may not be supported for loading in .
This happens when you don’t have permissions to load a project. Contact the project owner to change your role.
Yes. Next to the search box in the project selection dialog, there’s an Add model by URL option. Paste the model URL there.
I