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

​
Setup

1

Install the connector

Install your connector
2

Open the Archicad connector

  1. In Archicad, select Speckle from the menu.
Archicad toolbar
  1. Select Speckle to open the Archicad connector.
  1. Select Sign in if you haven’t linked your Speckle account.
Login
If the Speckle addon doesn’t appear in Archicad’s Add-On Manager, or if a warning icon appears next to it, try unloading the addon and then loading it manually. You can refer to the Archicad Add-On Manager Help for assistance.If the connector installation was successful, you can find the addon file at:
  • Archicad 28: C:\Users\{username}\AppData\Roaming\Speckle\Archicad\v3\28\Add-Ons\Speckle.apx
  • Archicad 27: C:\Users\{username}\AppData\Roaming\Speckle\Archicad\v3\27\Add-Ons\Speckle.apx
  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.
You can publish all 3D elements that include a mesh, including:
  • Wall, slab, beam, column
  • Door, window, curtain wall, skylight, object
  • Roof, shell, morph, mesh
  • Stair, railing
Elements that aren’t visible in the 3D view won’t be published.
  1. Set the Filter setting to Views while publishing a new version to your Speckle model.
  2. Select the view you want to publish from.
  1. Set the Filter setting to Element Types while publishing a new version to your Speckle model.
  2. Select the element types you want to publish.
All custom properties appear under the properties field when you select and view an Archicad object in your browser. Custom properties vary depending on the type of Archicad element, and can include:
  • Element ID, element type, element name, level
  • Classifications
  • Dimensional properties
  • Material quantities
  • User-defined properties
  • IFC properties
For IFC properties, the property mapping of the default IFC translator determines what gets exported.
Yes. If element properties aren’t required, you can disable property extraction to speed up the publishing process. To disable property extraction
  1. Open the Send Settings.
  2. Turn off the Include Object Properties option.
    Disabling property extraction can significantly reduce publish time.
The following items don’t get published:
  • 2D documentation: floor plans, sections, elevations
  • 2D elements: lines, hatches, dimensions
  • Surface textures
Some built-in properties under Element Properties > Dimensional Properties aren’t published. This optimization improves publishing speed and avoids redundancy in the published data.
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 GDL objects (generic models) in Archicad. If your model contains block instances, each instance will be loaded as its own generic model. Each object will be loaded with:
  • Render material (if any)
  • Mesh geometry
The loaded GDL objects are organized in folders in Archicad’s embedded library. The folder name is: ´Project Name - Model Name´
Currently, the 2D script of the GDL object generates only cut lines at the floor plan cut plane on each level. Projection lines aren’t shown.
Currently, you can’t load any custom properties on your Speckle model objects into Archicad.
If you’re loading models published from Revit, ask the author of the model to publish again using the correct reference point from their Revit file. For models from other applications, please request a reference coordination feature in our Community Forum.
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