# openvoiceos/ovos-workshop architecture

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

- Interactive diagram: https://gitdiagram.com/openvoiceos/ovos-workshop
- Repository: https://github.com/openvoiceos/ovos-workshop

## Overview

##### Main Components

a) Core Framework Components:
- Skill Base Classes (in ovos_workshop/skills/)
- Decorator System (in ovos_workshop/decorators/)
- Resource Management (ovos_workshop/resource_files.py)
- Internationalization System (ovos_workshop/locale/)
- Permission Management (ovos_workshop/permissions.py)
- Application Management (ovos_workshop/app.py)

b) Skill Types:
- Active Skills
- Passive Skills
- Fallback Skills
- Common Play Skills
- Common Query Skills
- Game Skills
- Idle Display Skills
- Intent Provider Skills

##### Component Relationships

- Inheritance relationships between skill types
- Data flow between components
- Dependency relationships

##### Detailed Component Breakdown

- Skill Launcher
- Resource Files Manager
- Permission Manager
- Settings Handler
- Intent Service Interface

- Converse Decorators
- Fallback Handlers
- Killable Decorators
- Layer Decorators
- OCP Decorators

- Active Skills
- Passive Skills
- Fallback Skills
- Common Play Skills
- Game Skills
- Idle Display Skills
- Intent Provider Skills

##### Additional Elements

Include:
- Version Management
- Test Infrastructure
- CI/CD Pipeline Components
- External Dependencies

## Diagram (Mermaid)

```mermaid
graph TB
    classDef core fill:#2374AB,color:white
    classDef skill fill:#FF8C42,color:white
    classDef decorator fill:#41B3A3,color:white
    classDef service fill:#4CAF50,color:white
    classDef infra fill:#607D8B,color:white

    subgraph Core["Core Framework"]
        SB["Skill Base Classes"]:::core
        RM["Resource Management"]:::core
        PM["Permission Manager"]:::core
        AM["Application Manager"]:::core
        IH["Intent Handler"]:::core
        FSI["File System Interface"]:::core
        SL["Skill Launcher"]:::core
        SH["Settings Handler"]:::core
        API["API Interface"]:::core
        LM["Layer Management"]:::core
    end

    subgraph Decorators["Decorator System"]
        CD["Converse Decorators"]:::decorator
        FH["Fallback Handlers"]:::decorator
        KD["Killable Decorators"]:::decorator
        LD["Layer Decorators"]:::decorator
        OD["OCP Decorators"]:::decorator
    end

    subgraph Skills["Skill Types"]
        AS["Active Skills"]:::skill
        PS["Passive Skills"]:::skill
        FS["Fallback Skills"]:::skill
        CPS["Common Play Skills"]:::skill
        CQS["Common Query Skills"]:::skill
        GS["Game Skills"]:::skill
        IDS["Idle Display Skills"]:::skill
        IPS["Intent Provider Skills"]:::skill
    end

    subgraph Infrastructure["Infrastructure Components"]
        I18N["Internationalization"]:::infra
        RS["Resource System"]:::infra
        IS["Intent System"]:::infra
    end

    %% Core relationships
    SB --> AS
    SB --> PS
    SB --> FS
    SB --> CPS
    SB --> CQS
    SB --> GS
    SB --> IDS
    SB --> IPS

    %% Decorator relationships
    CD --> SB
    FH --> SB
    KD --> SB
    LD --> SB
    OD --> SB

    %% Infrastructure relationships
    I18N --> RM
    RS --> RM
    IS --> IH

    %% Service relationships
    SL --> AM
    SH --> AM
    API --> SB
    LM --> LD

    %% Click events for component mapping
    click SB "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/skills/__init__.py"
    click RM "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/resource_files.py"
    click PM "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/permissions.py"
    click AM "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/app.py"
    click IH "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/intents.py"
    click FSI "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/filesystem.py"
    click CD "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/decorators/converse.py"
    click FH "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/decorators/fallback_handler.py"
    click KD "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/decorators/killable.py"
    click LD "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/decorators/layers.py"
    click OD "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/decorators/ocp.py"
    click AS "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/skills/active.py"
    click PS "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/skills/passive.py"
    click FS "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/skills/fallback.py"
    click CPS "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/skills/common_play.py"
    click CQS "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/skills/common_query_skill.py"
    click GS "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/skills/game_skill.py"
    click IDS "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/skills/idle_display_skill.py"
    click IPS "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/skills/intent_provider.py"
    click SL "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/skill_launcher.py"
    click SH "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/settings.py"
    click API "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/skills/api.py"
    click LM "https://github.com/OpenVoiceOS/ovos-workshop/blob/dev/ovos_workshop/skills/layers.py"
    click I18N "https://github.com/OpenVoiceOS/ovos-workshop/tree/dev/ovos_workshop/locale/"
```
