# ghallman/maya-pipeline-distributable-template architecture

> Architecture diagram of the GitHub repository ghallman/maya-pipeline-distributable-template, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ghallman/maya-pipeline-distributable-template
- Repository: https://github.com/ghallman/maya-pipeline-distributable-template

## Overview

gTools is a Maya pipeline template: an installer places a Maya module descriptor, and Maya startup code discovers and boots the required core startup before optional startup modules. The core startup initializes core paths and creates a Maya menu; the repository also includes reusable file/UI helpers and a startup template for extension. The README documents the install and boot pattern; unsampled plugin/resource directories are not represented as implemented features.

Main entry points: [`gTools/setup/userSetup.py`](https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/setup/userSetup.py) (Boot entry point), [`gTools/setup/startup/gTools_startup.py`](https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/setup/startup/gTools_startup.py) (Core startup), [`gTools/setup/startup/__init__.py`](https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/setup/startup/__init__.py) (Startup registry), [`gTools/install.py`](https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/install.py) (Drag-drop installer)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_install["Installation"]
  node_installer["Drag-drop installer<br/>[install.py]"]
  node_descriptor["Maya module descriptor<br/>[gTools.mod]"]
end

subgraph group_boot["Maya Startup"]
  node_user_setup["Boot entry point<br/>[userSetup.py]"]
  node_path_helper["Pipeline path helper<br/>[returnpath.py]"]
  node_startup_registry["Startup registry<br/>[__init__.py]"]
  node_core_startup["Core startup<br/>[gTools_startup.py]"]
end

subgraph group_core["Core Utilities"]
  node_core_paths["Core paths<br/>[__init__.py]"]
  node_file_utils["File utilities<br/>[file_utils.py]"]
  node_ui_utils["UI utilities<br/>[ui_utils.py]"]
end

subgraph group_extend["Extension"]
  node_startup_template["Startup template"]
end

node_artist(("Pipeline user"))
node_maya["Maya runtime"]

node_artist -->|"drops into Maya"| node_installer
node_installer -->|"writes module file"| node_descriptor
node_descriptor -->|"enables startup"| node_user_setup
node_maya -->|"runs at boot"| node_user_setup
node_user_setup -->|"gets pipeline path"| node_path_helper
node_user_setup -->|"imports startup"| node_startup_registry
node_user_setup -->|"dispatches core"| node_core_startup
node_user_setup -->|"dispatches modules"| node_startup_registry
node_startup_registry -->|"selects core"| node_core_startup
node_core_startup -->|"imports core"| node_core_paths
node_core_startup -->|"creates menu"| node_maya

click node_installer "https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/install.py"
click node_descriptor "https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/gTools.mod"
click node_user_setup "https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/setup/userSetup.py"
click node_path_helper "https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/setup/returnpath.py"
click node_startup_registry "https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/setup/startup/__init__.py"
click node_core_startup "https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/setup/startup/gTools_startup.py"
click node_startup_template "https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/setup/startup/template_startup.py"
click node_core_paths "https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/core/__init__.py"
click node_file_utils "https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/core/utils/file_utils.py"
click node_ui_utils "https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/core/utils/ui_utils.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_installer,node_descriptor,node_artist toneBlue
class node_user_setup,node_path_helper,node_startup_registry,node_core_startup toneAmber
class node_core_paths,node_file_utils,node_ui_utils toneMint
class node_startup_template toneRose
class node_maya toneIndigo
```

## Components

### Installation

- [Drag-drop installer](https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/install.py): `gTools/install.py`
- [Maya module descriptor](https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/gTools.mod): `gTools/gTools.mod`

### Maya Startup

- [Boot entry point](https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/setup/userSetup.py): `gTools/setup/userSetup.py`
- [Pipeline path helper](https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/setup/returnpath.py): `gTools/setup/returnpath.py`
- [Startup registry](https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/setup/startup/__init__.py): `gTools/setup/startup/__init__.py`
- [Core startup](https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/setup/startup/gTools_startup.py): `gTools/setup/startup/gTools_startup.py`

### Core Utilities

- [Core paths](https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/core/__init__.py): `gTools/core/__init__.py`
- [File utilities](https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/core/utils/file_utils.py): `gTools/core/utils/file_utils.py`
- [UI utilities](https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/core/utils/ui_utils.py): `gTools/core/utils/ui_utils.py`

### Extension

- [Startup template](https://github.com/ghallman/maya-pipeline-distributable-template/blob/main/gTools/setup/startup/template_startup.py): `gTools/setup/startup/template_startup.py`

### Other components

- **Pipeline user**
- **Maya runtime**

## Connections

- Pipeline user → Drag-drop installer: drops into Maya (evidence: `README.md`)
- Drag-drop installer → Maya module descriptor: writes module file (evidence: `README.md`)
- Maya module descriptor → Boot entry point: enables startup (evidence: `README.md`)
- Maya runtime → Boot entry point: runs at boot (evidence: `gTools/setup/userSetup.py`)
- Boot entry point → Pipeline path helper: gets pipeline path (evidence: `gTools/setup/userSetup.py`)
- Boot entry point → Startup registry: imports startup (evidence: `gTools/setup/userSetup.py`)
- Boot entry point → Core startup: dispatches core (evidence: `gTools/setup/userSetup.py`)
- Boot entry point → Startup registry: dispatches modules (evidence: `gTools/setup/userSetup.py`)
- Startup registry → Core startup: selects core (evidence: `gTools/setup/startup/__init__.py`)
- Core startup → Core paths: imports core (evidence: `gTools/setup/startup/gTools_startup.py`)
- Core startup → Maya runtime: creates menu (evidence: `gTools/setup/startup/gTools_startup.py`)
