# SketchUp

## Supported SketchUp Versions

Cityweft is compatible with SketchUp 2019 and all later versions, including SketchUp 2020, 2021, 2022, 2023, 2024, 2025, and 2026. Both macOS and Windows are fully supported.

#### Supported Operating Systems

* **Windows**
* **macOS**

## Activating Plugin

A **valid Cityweft API key** is required to use the plugin.

API keys can be generated and managed from your **Cityweft API Dashboard**.

For detailed instructions on how to obtain and manage your API key, see the section:

{% content-ref url="getting-your-api-key" %}
[getting-your-api-key](https://cityweft.gitbook.io/docs/plugins/getting-your-api-key)
{% endcontent-ref %}

## **Getting Started**

Before getting started, ensure you have followed the instructions for both installation and API key access.

### 🔑 **Activating your API Key**

To activate the plugin the first time, you need to enter your API key. If you do not have this, please visit the **‘Getting your API Key’** page

1. Once you have retrieved your API key, simply go to the usage tab and find the ‘Set API Key’ button<br>

   <figure><img src="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2FFsplIq4kjPeAeUP1pAPu%2FScreenshot%202026-03-10%20at%2013.07.41.png?alt=media&#x26;token=05665ff5-c478-4f6d-9742-ffabd4a798ff" alt=""><figcaption><p>Press "Set API Key"</p></figcaption></figure>

2. Paste your API Key into the field and press ‘OK’

   <figure><img src="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2FdVBYLKCmPCulcc8oWQUP%2FScreenshot%202026-03-10%20at%2014.24.59.png?alt=media&#x26;token=8e67d5ff-f7cc-4154-ab94-34595e155254" alt=""><figcaption></figcaption></figure>

3. Once input correctly, you will see your account and subscription status, which means you are ready to go!

### 🏢 **Getting Your Model**

1. In the Cityweft window, **navigate or search** for your desired site location.<br>

   <figure><img src="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2FpyVDc0nwyd6z8KBI0uFF%2FScreenshot%202026-03-10%20at%2014.25.47.png?alt=media&#x26;token=19ce2623-530a-45c2-a948-774e6a82b9d1" alt=""><figcaption></figcaption></figure>

2. **Select an area** on the map using the polygon selection tool.<br>

   <figure><img src="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2FmZBkoixXno6jLqdMJrxr%2FScreenshot%202026-03-10%20at%2014.26.07.png?alt=media&#x26;token=9f7372dc-0ff0-4f5c-a209-1fdbb3aebad6" alt=""><figcaption></figcaption></figure>

3. **Press the ‘Import to SketchUP’ button**\
   \
   The model will automatically appear in the viewport\
   If you are selecting a large area with dense geometry, this process can take up to 1-2 minutes.<br>

   <figure><img src="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2F9yDnxWdvo7OisPfxQlfH%2FScreenshot%202026-03-10%20at%2014.28.12.png?alt=media&#x26;token=24d5ff31-80e9-4bb9-aa8d-e7d8914f2107" alt=""><figcaption></figcaption></figure>

4. **View all the model layers in the tags window**<br>

   <figure><img src="https://2449447963-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2ahel6HN9zgEzJ1vY9kr%2Fuploads%2FWBVY7qkQCQfkXJOWuPMQ%2FScreenshot%202026-03-10%20at%2014.43.30.png?alt=media&#x26;token=5011cafe-7581-40d1-adf8-e75e97aeeea4" alt=""><figcaption></figcaption></figure>

### ⚙️ Plugin **Settings Overview**

The Cityweft SketchUp plugin includes several settings that control what data is included and how it is processed when generating models.

These are grouped into two main categories:

***

#### **1. Layers to import**

*(Check boxes — choose which layers to include in your model)*

These options let you define which geometry types to include when downloading the model.

| **Option**         | **Description**                                                        |
| ------------------ | ---------------------------------------------------------------------- |
| **Buildings**      | Imports buildings and roof geometry.                                   |
| **Surface**        | Includes ground surfaces such roads, green space, or base mesh.        |
| **Barriers**       | Adds physical boundaries like fences, retaining walls, or embankments. |
| **Topography**     | Imports detailed elevation data and terrain contours.                  |
| **Infrastructure** | Adds infrastructure layers such as trees, bus stops, or benches        |

> 💡 Tip: If you only need building geometry, uncheck other layers to speed up processing.

***

#### **2. Default building settings**

*(Adjustable fields — define defaults for missing data)*

| **Setting**          | **Description**                                                                                                                  |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **Roof Types**       | Sets a default roof geometry type for buildings that lack roof data. This does **not** override existing roof shape information. |
| **Levels**           | Specifies how many building levels to assign when no height data is available.                                                   |
| **Level Height (m)** | Defines the assumed height of each building level in meters. Used to estimate total building height when no data exists.         |

> 🏗️ These settings ensure that all buildings generate correctly, even when data is incomplete.