# enzyme-apd/tapir-archicad-automation architecture

> Architecture diagram of the GitHub repository enzyme-apd/tapir-archicad-automation, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/enzyme-apd/tapir-archicad-automation
- Repository: https://github.com/enzyme-apd/tapir-archicad-automation

## Overview

##### Project type and purpose
- This is an automation/integration toolkit for Graphisoft Archicad, consisting of:
- A native C++ “Archicad Add-On” that registers a set of custom JSON-RPC commands inside the Archicad host.
- A .NET/C# “Grasshopper Plugin” for Rhino/Grasshopper that connects to Archicad via those JSON commands, exposing them as visual components.
- Supporting pieces (Python examples, docs, branding assets, CI workflows).

##### File structure
- Top-level directories:
- **archicad-addon**: CMake project with Sources, Examples (Python scripts that drive Archicad via JSON commands), Test harness, Tools for build and packaging.
- **grasshopper-plugin**: Visual Studio solution containing the TapirGrasshopperPlugin project, organized into Components (grouped by feature), Data models, Utilities for connecting to Archicad. Also a YakPackage manifest for Rhino Package Manager.
- **docs/archicad-addon**: Generated HTML/JS documentation for all new JSON commands.
- **.github/workflows**: CI jobs to build and test both modules.

##### README for additional insights
- States that the Add-On “registers JSON commands on top of the official Graphisoft API” and that the Grasshopper Plugin “helps non-programmers use those commands visually.”

##### Elements
- **Clear labels**: e.g. “Tapir Add-On (C++)”, “JSON-RPC Server”, “TapirGrasshopperPlugin (C#)”.
- Build/CI tools in a contrasting accent (orange).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Hosts
    subgraph "Hosts"
        ArchicadHost["Archicad Host Application"]:::host
        RhinoHost["Rhino/Grasshopper Host"]:::host
    end

    %% Tapir Add-On
    subgraph "Tapir Archicad Add-On (C++)" 
        AddOnMain["AddOnMain.cpp"]:::plugin
        JSONRPC["JSON-RPC Engine"]:::core
        subgraph "Command Handlers"
            AppCmd["ApplicationCommands"]:::plugin
            ElemCmd["ElementCommands"]:::plugin
            AttrCmd["AttributeCommands"]:::plugin
            IssueCmd["IssueCommands"]:::plugin
        end
        JSONSchema["CommonSchemaDefinitions.json"]:::core
    end

    %% External Clients
    subgraph "External Clients"
        GrassPlugin["TapirGrasshopperPlugin (C#)"]:::plugin
        PythonClient["Python Scripts Client"]:::client
        DocsServer["Docs Server"]:::client
    end

    %% Build & CI
    subgraph "Build & CI Tools"
        BuildTools["Add-On Build Tools"]:::build
        CIPipelines["CI/CD Pipelines"]:::build
        PackagePlugin["Plugin Package Tools"]:::build
    end

    %% Relationships
    ArchicadHost -->|"Loaded at startup via Add-On Manager"| AddOnMain
    AddOnMain -->|"Registers JSON commands"| JSONRPC
    JSONRPC -->|"Dispatch to C++ handlers"| AppCmd
    JSONRPC -->|"Dispatch to C++ handlers"| ElemCmd
    JSONRPC -->|"Dispatch to C++ handlers"| AttrCmd
    JSONRPC -->|"Dispatch to C++ handlers"| IssueCmd
    AppCmd -->|"Invoke Graphisoft API calls"| ArchicadHost
    ElemCmd -->|"Invoke Graphisoft API calls"| ArchicadHost
    AttrCmd -->|"Invoke Graphisoft API calls"| ArchicadHost
    IssueCmd -->|"Invoke Graphisoft API calls"| ArchicadHost

    GrassPlugin -->|"Connect/Authenticate via TCP port"| JSONRPC
    PythonClient -->|"Send JSON command over socket"| JSONRPC
    DocsServer -->|"Hosts generated docs"| JSONSchema

    CIPipelines -->|"Trigger build"| BuildTools
    BuildTools -->|"Produce .apx/.gha packages"| AddOnMain
    CIPipelines -->|"Trigger plugin packaging"| PackagePlugin

    %% Click events
    click AddOnMain "https://github.com/enzyme-apd/tapir-archicad-automation/blob/main/archicad-addon/Sources/AddOnMain.cpp"
    click JSONRPC "https://github.com/enzyme-apd/tapir-archicad-automation/blob/main/archicad-addon/Sources/CommandBase.cpp"
    click AppCmd "https://github.com/enzyme-apd/tapir-archicad-automation/blob/main/archicad-addon/Sources/ApplicationCommands.cpp"
    click ElemCmd "https://github.com/enzyme-apd/tapir-archicad-automation/blob/main/archicad-addon/Sources/ElementCommands.cpp"
    click AttrCmd "https://github.com/enzyme-apd/tapir-archicad-automation/blob/main/archicad-addon/Sources/AttributeCommands.cpp"
    click IssueCmd "https://github.com/enzyme-apd/tapir-archicad-automation/blob/main/archicad-addon/Sources/IssueCommands.cpp"
    click JSONSchema "https://github.com/enzyme-apd/tapir-archicad-automation/blob/main/archicad-addon/Sources/RFIX/Schemas/CommonSchemaDefinitions.json"
    click PythonClient "https://github.com/enzyme-apd/tapir-archicad-automation/blob/main/archicad-addon/Examples/GetAttributesByType.py"
    click BuildTools "https://github.com/enzyme-apd/tapir-archicad-automation/blob/main/archicad-addon/Tools/build_all_win.bat"
    click DocsServer "https://github.com/enzyme-apd/tapir-archicad-automation/blob/main/docs/archicad-addon/index.html"
    click GrassPlugin "https://github.com/enzyme-apd/tapir-archicad-automation/blob/main/grasshopper-plugin/TapirGrasshopperPlugin/TapirGrasshopperPlugin.csproj"
    click PackagePlugin "https://github.com/enzyme-apd/tapir-archicad-automation/blob/main/grasshopper-plugin/YakPackage/manifest.yml"
    click CIPipelines "https://github.com/enzyme-apd/tapir-archicad-automation/blob/main/.github/workflows/archicad_addon.yml"

    %% Styles
    classDef host fill:#dddddd,stroke:#333,stroke-width:1px
    classDef plugin fill:#bbdefb,stroke:#1976d2,stroke-width:1px
    classDef core fill:#f8bbd0,stroke:#c2185b,stroke-width:1px
    classDef client fill:#c8e6c9,stroke:#388e3c,stroke-width:1px
    classDef build fill:#ffe0b2,stroke:#e65100,stroke-width:1px
```
