> ## Documentation Index
> Fetch the complete documentation index at: https://docs.speckle.systems/llms.txt
> Use this file to discover all available pages before exploring further.

# How to use Speckle for Archicad

> Step-by-step guide for using the Archicad connector

export const app_4 = "Archicad"

export const app_3 = "Archicad"

export const app_2 = "Archicad"

export const app_1 = "Archicad"

export const app_0 = "Archicad"

export const versions_0 = "27, 28, 29"

export const os_0 = "Windows"

<Info>
  Speckle currently supports {app_0} versions: **{versions_0}**.
  The {app_0} connector works on **{os_0}** only.
</Info>

## Setup

<Steps>
  <Step title="Install the connector">
    Install your [{app_1} connector](/connectors/installation)
  </Step>

  <Step title="Open the Archicad connector">
    1. In Archicad, select **Speckle** from the menu.

    <Frame>
      <img src="https://mintcdn.com/speckle/YrJFGLA1qDYoqsMd/images/connectors/archicad_toolbar.jpg?fit=max&auto=format&n=YrJFGLA1qDYoqsMd&q=85&s=71562cdd380ad3342b7a38292f251ffa" alt="Archicad toolbar" width="2592" height="1728" data-path="images/connectors/archicad_toolbar.jpg" />
    </Frame>

    2. Select **Speckle** to open the Archicad connector.

    3) Select **Sign in** if you haven't linked your Speckle account.

    <Frame>
      <img src="https://mintcdn.com/speckle/YrJFGLA1qDYoqsMd/images/connectors/dui_login.jpg?fit=max&auto=format&n=YrJFGLA1qDYoqsMd&q=85&s=86fa2dc39cdfb61ed5472ba570e40b87" alt="Login" width="1296" height="864" data-path="images/connectors/dui_login.jpg" />
    </Frame>
  </Step>
</Steps>

<AccordionGroup>
  <Accordion title="What is addon registration? What can I do if it fails?">
    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](https://help.graphisoft.com/AC/28/INT/_AC28_Help/140_UserInterfaceDialogBoxes/140_UserInterfaceDialogBoxes-32.htm) for assistance.

    If the connector installation was successful, you can find the addon file at:

    * **Archicad 29**: `C:\Users\{username}\AppData\Roaming\Speckle\Archicad\v3\29\Add-Ons\Speckle.apx`
    * **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`
  </Accordion>

  <Accordion title="Why is the Speckle plugin not showing up after I installed the connector?">
    1. Make sure your version of {app_2} is one of the supported versions.
    2. Uninstall and [reinstall your connector](/connectors/installation).

    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](https://speckle.community/c/help) and include the following information:

    * Your application version
    * Your Speckle connector version
  </Accordion>

  <Accordion title="What should I do if the plugin UI is empty or unresponsive, or if my application crashes?">
    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](https://speckle.community/c/help) and include the following information:

    * Your application version
    * Your Speckle connector version
    * A copy of the log
  </Accordion>

  <Accordion title="Why can't I add a new account?">
    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.
  </Accordion>

  <Accordion title="How do I uninstall my connector?">
    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.
  </Accordion>

  <Accordion title="How do I update my connector to the latest version?">
    You can always download the latest version of the connector [in the web app](https://app.speckle.systems/connectors).
    If a new version of the connector is available, you will also see a notification in your connector UI.
  </Accordion>
</AccordionGroup>

## Publishing a Model

<Steps>
  <Step title="Select Publish">
    <Frame>
      <img src="https://mintcdn.com/speckle/YrJFGLA1qDYoqsMd/images/connectors/dui_publish_1.jpg?fit=max&auto=format&n=YrJFGLA1qDYoqsMd&q=85&s=b2dad23a5271dadba35ee52b880c00af" alt="Publish" width="1296" height="864" data-path="images/connectors/dui_publish_1.jpg" />
    </Frame>
  </Step>

  <Step title="Choose a project">
    * Select an existing project
    * or select **New Project** to create one

    <Frame>
      <img src="https://mintcdn.com/speckle/YrJFGLA1qDYoqsMd/images/connectors/dui_publish_2.jpg?fit=max&auto=format&n=YrJFGLA1qDYoqsMd&q=85&s=0857c7878df8d5931bc9b6dacaeda8f9" alt="Publish" width="1296" height="864" data-path="images/connectors/dui_publish_2.jpg" />
    </Frame>
  </Step>

  <Step title="Choose a model">
    * Select an existing model
    * or select **New Model** to create one

    <Frame>
      <img src="https://mintcdn.com/speckle/YrJFGLA1qDYoqsMd/images/connectors/dui_publish_3.jpg?fit=max&auto=format&n=YrJFGLA1qDYoqsMd&q=85&s=99565734d02032e77db685dde97bf7b5" alt="Publish" width="1296" height="864" data-path="images/connectors/dui_publish_3.jpg" />
    </Frame>
  </Step>

  <Step title="Select objects to publish">
    1. In your application viewport, select the elements you want to publish.
    2. Select **Publish**.

    <Frame>
      <img src="https://mintcdn.com/speckle/YrJFGLA1qDYoqsMd/images/connectors/dui_publish_4.jpg?fit=max&auto=format&n=YrJFGLA1qDYoqsMd&q=85&s=918d1db7fb1605dd7365b66a70455af3" alt="Publish" width="1296" height="864" data-path="images/connectors/dui_publish_4.jpg" />
    </Frame>

    <Frame>
      <img src="https://mintcdn.com/speckle/YrJFGLA1qDYoqsMd/images/connectors/dui_publish_5.jpg?fit=max&auto=format&n=YrJFGLA1qDYoqsMd&q=85&s=d0f1dff98af5354bdac9758c6acd04df" alt="Publish" width="1296" height="864" data-path="images/connectors/dui_publish_5.jpg" />
    </Frame>

    3. Your model is now published to Speckle and is available to the rest of your team.
  </Step>
</Steps>

<AccordionGroup>
  <Accordion title="What types of Archicad elements can I publish to Speckle?">
    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`

    <Note> Elements that aren't visible in the 3D view won't be published. </Note>
  </Accordion>

  <Accordion title="How do I publish models from Archicad views?">
    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.
  </Accordion>

  <Accordion title="How do I publish models by Archicad element type?">
    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.
  </Accordion>

  <Accordion title="How do I see custom properties on my published Archicad elements?">
    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

    <Note> For IFC properties, the property mapping of the default IFC translator determines what gets exported.</Note>
  </Accordion>

  <Accordion title="Publishing my model takes a long time. Can I speed it up?">
    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.
       <Note> Disabling property extraction can significantly reduce publish time. </Note>
  </Accordion>

  <Accordion title="What doesn't get published with the Archicad connector?">
    The following items don't get published:

    * 2D documentation: floor plans, sections, elevations
    * 2D elements: lines, hatches, dimensions
    * Surface textures
  </Accordion>

  <Accordion title="Which element properties aren't published with the Archicad connector?">
    Some built-in properties under **Element Properties** > **Dimensional Properties** aren't published. This optimization improves publishing speed and avoids redundancy in the published data.
  </Accordion>

  <Accordion title="Why does my model have the wrong colors in the web browser viewer?">
    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](https://speckle.community/c/help)
  </Accordion>

  <Accordion title="Are bitmap or image-based material textures supported?">
    **Image texture files are not supported.** Speckle does **not** transfer bitmaps or other image maps (such as JPG or PNG files) embedded in materials from the source application.

    Speckle **does** carry [PBR-style material data](/developers/sdks/python/guides/understanding-speckle-mesh#render-materials) in general—where a connector maps to it, materials can include properties such as base colour, opacity, metalness, roughness, and emissive colour. That is not the same as shipping texture images: you get numeric material parameters, not image assets used for wood grain, brick patterns, and similar in the authoring tool.

    Different materials can still appear separately in the destination with distinct colours and PBR fields. What you see may look closer to a consistent shaded or PBR preview than to the full render-appearance with image maps in tools such as Revit or SketchUp. To use image textures in your target application, apply or remap them locally after you publish or load.
  </Accordion>

  <Accordion title="Why are some objects that I published missing from my model?">
    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.
  </Accordion>
</AccordionGroup>

## Loading a Model

<Steps>
  <Step title="Select Load">
    <Frame>
      <img src="https://mintcdn.com/speckle/YrJFGLA1qDYoqsMd/images/connectors/dui_load_1.jpg?fit=max&auto=format&n=YrJFGLA1qDYoqsMd&q=85&s=cc1cbb8e550c960e5f7db8564db64076" alt="Load" width="1296" height="864" data-path="images/connectors/dui_load_1.jpg" />
    </Frame>
  </Step>

  <Step title="Choose a project">
    <Frame>
      <img src="https://mintcdn.com/speckle/YrJFGLA1qDYoqsMd/images/connectors/dui_load_2.jpg?fit=max&auto=format&n=YrJFGLA1qDYoqsMd&q=85&s=378f2ebc915f0c05fb0e6eefae862c2c" alt="Load" width="1296" height="864" data-path="images/connectors/dui_load_2.jpg" />
    </Frame>
  </Step>

  <Step title="Choose a model">
    <Frame>
      <img src="https://mintcdn.com/speckle/YrJFGLA1qDYoqsMd/images/connectors/dui_load_3.jpg?fit=max&auto=format&n=YrJFGLA1qDYoqsMd&q=85&s=a2fdf0c0be1b0ca2d2793a0a12938f19" alt="Load" width="1296" height="864" data-path="images/connectors/dui_load_3.jpg" />
    </Frame>
  </Step>

  <Step title="Choose a version to load">
    * Latest version is always first.
    * To load a specific version, select it from the UI.

    <Frame>
      <img src="https://mintcdn.com/speckle/YrJFGLA1qDYoqsMd/images/connectors/dui_load_4.jpg?fit=max&auto=format&n=YrJFGLA1qDYoqsMd&q=85&s=476ac28321e59d239da6061ba79db9b0" alt="Load" width="1296" height="864" data-path="images/connectors/dui_load_4.jpg" />
    </Frame>

    <Frame>
      <img src="https://mintcdn.com/speckle/YrJFGLA1qDYoqsMd/images/connectors/dui_load_5.jpg?fit=max&auto=format&n=YrJFGLA1qDYoqsMd&q=85&s=15971bcfb1aeea9a897d907fb7adb7b8" alt="Load" width="1296" height="864" data-path="images/connectors/dui_load_5.jpg" />
    </Frame>

    Your selected model is now loaded in {app_3}.
  </Step>
</Steps>

<AccordionGroup>
  <Accordion title="How are Speckle models loaded in Archicad?">
    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

    <Note> The loaded GDL objects are organized in folders in Archicad's embedded library. The folder name is: ´Project Name - Model Name´ </Note>
  </Accordion>

  <Accordion title="How are the loaded GDL objects displayed on floor plan views in Archicad?">
    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.
  </Accordion>

  <Accordion title="Can I load custom properties in Archicad?">
    Currently, you can't load any custom properties on your Speckle model objects into Archicad.
  </Accordion>

  <Accordion title="Why was my Speckle model was loaded in an incorrect position?">
    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](https://speckle.community/c/features).
  </Accordion>

  <Accordion title="Why are some objects that I loaded missing from my model?">
    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 {app_4}.
  </Accordion>

  <Accordion title="Are bitmap or image-based material textures supported?">
    **Image texture files are not supported.** Speckle does **not** transfer bitmaps or other image maps (such as JPG or PNG files) embedded in materials from the source application.

    Speckle **does** carry [PBR-style material data](/developers/sdks/python/guides/understanding-speckle-mesh#render-materials) in general—where a connector maps to it, materials can include properties such as base colour, opacity, metalness, roughness, and emissive colour. That is not the same as shipping texture images: you get numeric material parameters, not image assets used for wood grain, brick patterns, and similar in the authoring tool.

    Different materials can still appear separately in the destination with distinct colours and PBR fields. What you see may look closer to a consistent shaded or PBR preview than to the full render-appearance with image maps in tools such as Revit or SketchUp. To use image textures in your target application, apply or remap them locally after you publish or load.
  </Accordion>

  <Accordion title="Why can't I select a project in the UI—it's disabled?">
    This happens when you don't have permissions to load a project. Contact the project owner to change your role.
  </Accordion>

  <Accordion title="Can I load a model via URL?">
    Yes. Next to the search box in the project selection dialog, there's an **Add model by URL** option. Paste the model URL there.
  </Accordion>
</AccordionGroup>
