# icosa-foundation/open-brush-toolkit architecture

> Architecture diagram of the GitHub repository icosa-foundation/open-brush-toolkit, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/icosa-foundation/open-brush-toolkit
- Repository: https://github.com/icosa-foundation/open-brush-toolkit

## Overview

##### Main Components

a. Core Components:
- Python Command-Line Tools Module
- Unity SDK Module
- Data Processing Pipeline
- File Format Handlers

b. Sub-Components:
- Brush System
- Audio Reactivity System
- Import/Export System
- Visualization Tools

- Open Brush Toolkit                                      |

- Python Tools  |      |   Unity SDK    |        | Data Handlers |

##### Detailed Component Breakdown

Python Tools Section:

- Python Tools    |

- dump_tilt.py    |
- unpack_tilt.py  |
- tilt.py         |
- export.py       |

- Data Processing

Unity SDK Section:

- Unity SDK       |

- Brush System       |
- Shaders           |
- Audio Reactivity  |
- Import/Export     |

- Visualization

##### Data Flow Indicators

- .tilt file processing flow
- Unity import/export pipeline
- Audio reactivity data flow
- Brush data processing

##### Integration Points

Highlight:
- File format conversion points
- Unity integration interfaces
- Python toolkit integration points
- Audio system connections

##### Real-time processing systems (audio, visualization)

- Component types
- Data flow types
- Integration points
- File format indicators

Remember to include version information and supported render pipeline indicators, as mentioned in the README's final notes about render pipeline support.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph OpenBrushToolkit["Open Brush Toolkit"]
        direction TB
        
        subgraph PythonTools["Python Command-Line Tools"]
            direction TB
            DumpTilt["dump_tilt.py"]
            UnpackTilt["unpack_tilt.py"]
            TiltPy["tilt.py"]
            ExportPy["export.py"]
        end

        subgraph UnitySDK["Unity SDK"]
            direction TB
            
            subgraph BrushSystem["Brush System"]
                BrushDesc["Brush Descriptor"]
                BrushManifest["Brush Manifest"]
            end
            
            subgraph AudioSystem["Audio Reactivity System"]
                Reaktion["Reaktion"]
                VisManager["Visualizer Manager"]
                AudioInput["Audio Input"]
            end
            
            subgraph ImportExport["Import/Export System"]
                Glb1Import["GLB1 Importer"]
                Glb2Import["GLB2 Importer"]
                GltfConv["GLTF Converter"]
            end
        end

        subgraph DataHandling["Data Handlers"]
            direction TB
            GlbParser["GLB Parser"]
            Gltf1Schema["GLTF1 Schema"]
            Gltf2Schema["GLTF2 Schema"]
            DataProc["Data Processing"]
        end
    end

    %% Relationships
    PythonTools --> DataHandling
    UnitySDK --> DataHandling
    BrushSystem --> ImportExport
    AudioSystem --> VisManager
    ImportExport --> DataHandling
    
    %% Click Events
    click PythonTools "https://github.com/icosa-foundation/open-brush-toolkit/tree/main//bin/"
    click TiltPy "https://github.com/icosa-foundation/open-brush-toolkit/blob/main//Python/tiltbrush/tilt.py"
    click ExportPy "https://github.com/icosa-foundation/open-brush-toolkit/blob/main//Python/tiltbrush/export.py"
    click BrushSystem "https://github.com/icosa-foundation/open-brush-toolkit/tree/main//UnitySDK/Assets/TiltBrush/Assets/Brushes/"
    click BrushDesc "https://github.com/icosa-foundation/open-brush-toolkit/blob/main//UnitySDK/Assets/TiltBrush/Scripts/BrushDescriptor.cs"
    click BrushManifest "https://github.com/icosa-foundation/open-brush-toolkit/blob/main//UnitySDK/Assets/TiltBrush/Scripts/BrushManifest.cs"
    click AudioSystem "https://github.com/icosa-foundation/open-brush-toolkit/tree/main//UnitySDK/Assets/ThirdParty/Reaktion/"
    click VisManager "https://github.com/icosa-foundation/open-brush-toolkit/blob/main//UnitySDK/Assets/TiltBrush/Scripts/VisualizerManager.cs"
    click AudioInput "https://github.com/icosa-foundation/open-brush-toolkit/blob/main//UnitySDK/Assets/TiltBrush/Scripts/VisualizerAudioInput.cs"
    click ImportExport "https://github.com/icosa-foundation/open-brush-toolkit/tree/main//UnitySDK/Assets/TiltBrush/Scripts/Gltf/"
    click Glb1Import "https://github.com/icosa-foundation/open-brush-toolkit/blob/main//UnitySDK/Assets/TiltBrush/Scripts/Editor/Glb1Importer.cs"
    click Glb2Import "https://github.com/icosa-foundation/open-brush-toolkit/blob/main//UnitySDK/Assets/TiltBrush/Scripts/Editor/Glb2Importer.cs"
    click GltfConv "https://github.com/icosa-foundation/open-brush-toolkit/blob/main//UnitySDK/Assets/TiltBrush/Scripts/Gltf/GltfMaterialConverter.cs"
    click GlbParser "https://github.com/icosa-foundation/open-brush-toolkit/blob/main//UnitySDK/Assets/TiltBrush/Scripts/Gltf/GlbParser.cs"
    click Gltf1Schema "https://github.com/icosa-foundation/open-brush-toolkit/blob/main//UnitySDK/Assets/TiltBrush/Scripts/Gltf/Gltf1Schema.cs"
    click Gltf2Schema "https://github.com/icosa-foundation/open-brush-toolkit/blob/main//UnitySDK/Assets/TiltBrush/Scripts/Gltf/Gltf2Schema.cs"

    %% Styling
    classDef default fill:#f9f9f9,stroke:#333,stroke-width:2px
    classDef python fill:#4B8BBE,stroke:#333,color:white
    classDef unity fill:#44B78B,stroke:#333,color:white
    classDef data fill:#FF6B6B,stroke:#333,color:white
    classDef system fill:#845EC2,stroke:#333,color:white

    class PythonTools python
    class UnitySDK unity
    class DataHandling data
    class BrushSystem,AudioSystem,ImportExport system
```
