# id-software/doom-3 architecture

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

- Interactive diagram: https://gitdiagram.com/id-software/doom-3
- Repository: https://github.com/id-software/doom-3

## Overview

##### Main Components
The system should be divided into these major components:

a. Core Engine Components:
- Renderer System
- Sound System
- Physics System
- Input System
- Network System
- File System
- Memory Management
- Resource Management

b. Game Logic:
- Game Framework
- Entity System
- AI System
- Scripting System
- Animation System

c. Tools:
- Level Editor (Radiant)
- Material Editor
- Particle Editor
- Sound Editor
- GUI Editor

##### Component Relationships

**[Hardware/OS Layer]**
- ↑↓
**[Core Engine Layer]**
- ↑↓
**[Game Logic Layer]**
- ↑↓
**[Tools Layer]**

##### Detailed Component Breakdown

Core Engine Layer:
**[Renderer]←→[Resource Manager]**
- ↑           ↑
**[Sound]     [File System]**
- ↑           ↑
**[Physics]←→[Memory Manager]**
- ↑           ↑
**[Input]     [Network]**

##### Specific Implementation Details

Key subsystems:
**[idLib Base Classes]**
- ↓
**[Common Framework]**
- ↓
**[Game Specific Logic]**

##### External Dependencies

Integration points for:
- OpenGL
- OpenAL
- OggVorbis
- Curl
- zlib

##### Tool Integration

How the tools interact with the engine:
**[Engine Core]←→[Tool Framework]**
- ↓
- [Radiant]←→[Common Tool Utils]←→[Material Editor]

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef core fill:#3498db,stroke:#2980b9,color:white
    classDef game fill:#2ecc71,stroke:#27ae60,color:white
    classDef tools fill:#e67e22,stroke:#d35400,color:white
    classDef external fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef critical fill:#e74c3c,stroke:#c0392b,color:white

    %% Hardware/OS Layer
    subgraph HW["Hardware/OS Layer"]
        OpenGL["OpenGL"]:::external
        OpenAL["OpenAL"]:::external
        OggVorbis["OggVorbis"]:::external
        Curl["Curl"]:::external
        Zlib["zlib"]:::external
    end

    %% Core Engine Layer
    subgraph Core["Core Engine Layer"]
        Renderer["Renderer System"]:::critical
        Sound["Sound System"]:::core
        Physics["Physics System"]:::core
        Input["Input System"]:::core
        Network["Network System"]:::core
        FileSystem["File System"]:::core
        MemoryMgr["Memory Management"]:::core
        ResourceMgr["Resource Management"]:::core
    end

    %% Game Logic Layer
    subgraph Game["Game Logic Layer"]
        GameFW["Game Framework"]:::game
        Entity["Entity System"]:::game
        AI["AI System"]:::game
        Script["Scripting System"]:::game
        Animation["Animation System"]:::game
    end

    %% Tools Layer
    subgraph Tools["Tools Layer"]
        Radiant["Level Editor"]:::tools
        MatEditor["Material Editor"]:::tools
        PartEditor["Particle Editor"]:::tools
        SoundEditor["Sound Editor"]:::tools
        GUIEditor["GUI Editor"]:::tools
    end

    %% Relationships
    OpenGL --> Renderer
    OpenAL --> Sound
    OggVorbis --> Sound
    Curl --> Network
    Zlib --> FileSystem

    Renderer <--> ResourceMgr
    Sound <--> ResourceMgr
    Physics <--> MemoryMgr
    Input --> GameFW
    Network <--> GameFW
    FileSystem <--> ResourceMgr
    MemoryMgr <--> ResourceMgr

    GameFW --> Entity
    Entity --> AI
    Entity --> Script
    Entity --> Animation
    
    ResourceMgr --> Tools
    FileSystem --> Tools

    %% Click events
    click Renderer "https://github.com/id-Software/DOOM-3/tree/master/neo/renderer/"
    click Sound "https://github.com/id-Software/DOOM-3/tree/master/neo/sound/"
    click Physics "https://github.com/id-Software/DOOM-3/tree/master/neo/game/physics/"
    click Input "https://github.com/id-Software/DOOM-3/blob/master/neo/sys/win32/win_input.cpp"
    click Network "https://github.com/id-Software/DOOM-3/tree/master/neo/framework/async/"
    click FileSystem "https://github.com/id-Software/DOOM-3/blob/master/neo/framework/FileSystem.cpp"
    click GameFW "https://github.com/id-Software/DOOM-3/tree/master/neo/game/"
    click Entity "https://github.com/id-Software/DOOM-3/blob/master/neo/game/Entity.cpp"
    click AI "https://github.com/id-Software/DOOM-3/tree/master/neo/game/ai/"
    click Script "https://github.com/id-Software/DOOM-3/tree/master/neo/game/script/"
    click Animation "https://github.com/id-Software/DOOM-3/tree/master/neo/game/anim/"
    click Radiant "https://github.com/id-Software/DOOM-3/tree/master/neo/tools/radiant/"
    click MatEditor "https://github.com/id-Software/DOOM-3/tree/master/neo/tools/materialeditor/"
    click PartEditor "https://github.com/id-Software/DOOM-3/tree/master/neo/tools/particle/"
    click SoundEditor "https://github.com/id-Software/DOOM-3/tree/master/neo/tools/sound/"
    click GUIEditor "https://github.com/id-Software/DOOM-3/tree/master/neo/tools/guied/"
    click MemoryMgr "https://github.com/id-Software/DOOM-3/blob/master/neo/idlib/Heap.cpp"
    click ResourceMgr "https://github.com/id-Software/DOOM-3/blob/master/neo/framework/DeclManager.cpp"

    %% Legend
    subgraph Legend
        L1["Core Components"]:::core
        L2["Game Logic"]:::game
        L3["Tools"]:::tools
        L4["External Dependencies"]:::external
        L5["Critical Path"]:::critical
    end
```
