# dylancyclone/vmf2obj architecture

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

- Interactive diagram: https://gitdiagram.com/dylancyclone/vmf2obj
- Repository: https://github.com/dylancyclone/vmf2obj

## Overview

##### Main Components

a. Input Processing Layer:
- VMF File Parser
- VPK File Handler
- Custom Resource Directory Handler

b. Core Processing Components:
- Geometry Processing
- Brush Converter
- Displacement Converter
- Entity Processor
- Model Processor (prop_*)

c. Material/Texture Processing:
- VMT Parser
- Texture Processor (VTF handling)
- Material Mapping System

d. Output Generation:
- OBJ File Generator
- Material File Generator

e. User Interfaces:
- GUI Component
- CLI Component

##### Component Relationships

**[Input Sources] → [Input Processing Layer] → [Core Processing] → [Output Generation] → [Output Files]**
- ↑

**[User Interfaces] --------------------------------------------------------→ [File Output]**

##### Detailed Component Breakdown

a. Input Sources (Blue rectangles):
- VMF Files
- VPK Archives
- Custom Content Folders

b. Processing Components (Green rectangles):
- Data Structure Components (from dataStructure package)
- File Structure Handlers (from fileStructure package)
- External Tools Integration (VTFCmd, CrowbarCommandLine)

c. User Interface Components (Purple rectangles):
- GUI (VMF2OBJFrame)
- CLI (VMF2OBJCLI)

d. Output Components (Orange rectangles):
- OBJ Files
- Material Files
- Texture Files

##### Architecture Patterns to Highlight

- Command Pattern (Job.java implementation)
- Factory Pattern (for file handling)
- Strategy Pattern (for different conversion processes)

##### Implementation Details

Relationship between key classes:
**VMF2OBJLauncher → VMF2OBJ → Job**
- ↓
- Data Structures
- (VMF, Entity, Solid, etc.)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef input fill:#a8d1f0,stroke:#000
    classDef processing fill:#90EE90,stroke:#000
    classDef ui fill:#DDA0DD,stroke:#000
    classDef output fill:#FFA07A,stroke:#000
    classDef external fill:#FFE4B5,stroke:#000

    %% Legend
    subgraph Legend
        L1[Input Components]:::input
        L2[Processing Components]:::processing
        L3[User Interface]:::ui
        L4[Output Components]:::output
        L5[External Tools]:::external
    end

    %% User Interfaces
    subgraph UI
        GUI[GUI Interface]
        CLI[Command Line Interface]
    end
    click GUI "https://github.com/dylancyclone/vmf2obj/blob/master/src/main/java/com/lathrum/VMF2OBJ/gui/VMF2OBJFrame.java"
    click CLI "https://github.com/dylancyclone/vmf2obj/blob/master/src/main/java/com/lathrum/VMF2OBJ/cli/VMF2OBJCLI.java"

    %% Input Sources
    subgraph InputSources
        VMF[VMF Files]:::input
        VPK[VPK Archives]:::input
        CustomContent[Custom Content]:::input
    end

    %% Input Processing
    subgraph InputProcessing
        VMFParser[VMF Parser]:::processing
        VPKHandler[VPK Handler]:::processing
        ResourceHandler[Resource Handler]:::processing
    end
    click VMFParser "https://github.com/dylancyclone/vmf2obj/blob/master/src/main/java/com/lathrum/VMF2OBJ/dataStructure/map/VMF.java"
    click VPKHandler "https://github.com/dylancyclone/vmf2obj/blob/master/src/main/java/com/lathrum/VMF2OBJ/fileStructure/VPK.java"
    click ResourceHandler "https://github.com/dylancyclone/vmf2obj/blob/master/src/main/java/com/lathrum/VMF2OBJ/fileStructure/Directory.java"

    %% Core Processing
    subgraph CoreProcessing
        direction TB
        GeometryProcessor[Geometry Processor]:::processing
        BrushConverter[Brush Converter]:::processing
        DisplacementConverter[Displacement Converter]:::processing
        EntityProcessor[Entity Processor]:::processing
    end
    click GeometryProcessor "https://github.com/dylancyclone/vmf2obj/tree/master/src/main/java/com/lathrum/VMF2OBJ/dataStructure/map/"
    click BrushConverter "https://github.com/dylancyclone/vmf2obj/blob/master/src/main/java/com/lathrum/VMF2OBJ/dataStructure/map/Solid.java"
    click DisplacementConverter "https://github.com/dylancyclone/vmf2obj/blob/master/src/main/java/com/lathrum/VMF2OBJ/dataStructure/map/Displacement.java"
    click EntityProcessor "https://github.com/dylancyclone/vmf2obj/blob/master/src/main/java/com/lathrum/VMF2OBJ/dataStructure/map/Entity.java"

    %% Material Processing
    subgraph MaterialProcessing
        VMTParser[VMT Parser]:::processing
        TextureProcessor[Texture Processor]:::processing
        TextureReader[Texture Reader]:::processing
    end
    click VMTParser "https://github.com/dylancyclone/vmf2obj/blob/master/src/main/java/com/lathrum/VMF2OBJ/dataStructure/texture/VMT.java"
    click TextureProcessor "https://github.com/dylancyclone/vmf2obj/blob/master/src/main/java/com/lathrum/VMF2OBJ/dataStructure/texture/Texture.java"
    click TextureReader "https://github.com/dylancyclone/vmf2obj/blob/master/src/main/java/com/lathrum/VMF2OBJ/dataStructure/texture/TargaReader.java"

    %% External Tools
    subgraph ExternalTools
        VTFCmd[VTF Converter]:::external
        Crowbar[Crowbar Decompiler]:::external
    end
    click VTFCmd "https://github.com/dylancyclone/vmf2obj/blob/master/src/lib/VTFCmd.exe"
    click Crowbar "https://github.com/dylancyclone/vmf2obj/blob/master/src/lib/CrowbarCommandLineDecomp.exe"

    %% Core Application
    subgraph CoreApp
        MainConverter[VMF2OBJ Converter]:::processing
        JobHandler[Job Handler]:::processing
        AppEntry[Application Entry]:::processing
    end
    click MainConverter "https://github.com/dylancyclone/vmf2obj/blob/master/src/main/java/com/lathrum/VMF2OBJ/VMF2OBJ.java"
    click JobHandler "https://github.com/dylancyclone/vmf2obj/blob/master/src/main/java/com/lathrum/VMF2OBJ/Job.java"
    click AppEntry "https://github.com/dylancyclone/vmf2obj/blob/master/src/main/java/com/lathrum/VMF2OBJ/VMF2OBJLauncher.java"

    %% Output
    subgraph Output
        OBJFile[OBJ Files]:::output
        MTLFile[Material Files]:::output
        TextureFiles[Texture Files]:::output
    end

    %% Relationships
    UI --> AppEntry
    InputSources --> InputProcessing
    InputProcessing --> CoreProcessing
    CoreProcessing --> MaterialProcessing
    MaterialProcessing --> ExternalTools
    ExternalTools --> Output
    CoreProcessing --> Output
    CoreApp --> Output
```
