# kraibse/scavanger architecture

> Architecture diagram of the GitHub repository kraibse/scavanger, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kraibse/scavanger
- Repository: https://github.com/kraibse/scavanger

## Overview

##### Main Components

a) Core Game Engine Components:
- Scene Management System (scene_manager.py)
- Game Loop Controller (start_scavanger.py)
- Global State Management (globals.py)

b) Game Object Components:
- Player System (player.py)
- Environment Objects
- Planets (planet.py)
- Asteroids (asteroids.py)
- Enemy Turrets (enemy_turret.py)
- Resource System (scavengeable.py)
- Projectile System (projectile.py)

c) UI Components:
- Main Menu (main_menu.py)
- Shop System (shop.py)
- Health Bar (health_bar.py)
- Button System (button.py, button_event.py)
- Text Display (text_box.py)
- Game End Scene (game_end_scene.py)

**[Game Entry Point]**

- [Scene Manager]─────────────────────┐

- [Main Menu Scene]         │
- [Game Scene]              │
- [Game End Scene]          │

- [Game Objects]───────────┐          │
- [Player]           │          │
- [Planets]          │          │
- [Asteroids]        │          │
- [Enemy Turrets]    │          │
- [Projectiles]      │          │

- [UI System]─────────────┘          │
- [Shop]                        │
- [Health Bar]                  │
- [Buttons]                     │

- [Asset Management]─────────────────┘

##### Important Relationships to Highlight

- Scene Manager's control flow between different game states
- Player interaction with environment objects (planets, asteroids)
- Enemy turret targeting system with the player
- UI elements' communication with game state
- Resource collection and shop system interaction

##### Technical Details

- Pygame as the underlying game engine
- Asset loading system for sprites and animations
- Event handling system for player input
- Collision detection system
- Resource management system

##### Implementation Notes

- Use clear, descriptive labels for all components
- Brief notes about key gameplay mechanics
- Data flow between major systems

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Core["Core Engine Layer"]
        GE["Game Entry Point"]:::core
        SM["Scene Manager"]:::core
        GS["Global State"]:::core
    end

    subgraph Scenes["Scene Layer"]
        MM["Main Menu"]:::scene
        GScene["Game Scene"]:::scene
        GEnd["Game End Scene"]:::scene
    end

    subgraph GameObjects["Game Objects Layer"]
        Player["Player System"]:::gameobj
        Planets["Planet System"]:::gameobj
        Asteroids["Asteroid System"]:::gameobj
        ET["Enemy Turrets"]:::enemy
        Proj["Projectile System"]:::gameobj
        RS["Resource System"]:::gameobj
    end

    subgraph UI["UI Layer"]
        Shop["Shop System"]:::ui
        HB["Health Bar"]:::ui
        Buttons["Button System"]:::ui
        TB["Text Display"]:::ui
    end

    subgraph Assets["Asset Management"]
        AS["Animation System"]:::asset
        GA["Game Assets"]:::asset
    end

    %% Core relationships
    GE --> SM
    GE --> GS
    SM --> MM
    SM --> GScene
    SM --> GEnd

    %% Game Object relationships
    Player --> Proj
    ET --> Proj
    Player --> RS
    Player --> Planets
    Player --> Asteroids
    ET -.-> Player

    %% UI relationships
    Shop --> Player
    HB --> Player
    Buttons --> SM
    TB --> SM

    %% Asset relationships
    GA --> Player
    GA --> ET
    GA --> Planets
    GA --> Asteroids
    AS --> Player
    AS --> ET

    %% Styling
    classDef core fill:#3498db
    classDef scene fill:#2ecc71
    classDef gameobj fill:#27ae60
    classDef enemy fill:#e74c3c
    classDef ui fill:#f1c40f
    classDef asset fill:#9b59b6

    %% Click events
    click SM "https://github.com/kraibse/scavanger/blob/main/scene_manager.py"
    click GE "https://github.com/kraibse/scavanger/blob/main/start_scavanger.py"
    click GS "https://github.com/kraibse/scavanger/blob/main/globals.py"
    click Player "https://github.com/kraibse/scavanger/blob/main/player.py"
    click Planets "https://github.com/kraibse/scavanger/blob/main/planet.py"
    click Asteroids "https://github.com/kraibse/scavanger/blob/main/asteroids.py"
    click ET "https://github.com/kraibse/scavanger/blob/main/enemy_turret.py"
    click RS "https://github.com/kraibse/scavanger/blob/main/scavengeable.py"
    click Proj "https://github.com/kraibse/scavanger/blob/main/projectile.py"
    click MM "https://github.com/kraibse/scavanger/blob/main/main_menu.py"
    click Shop "https://github.com/kraibse/scavanger/blob/main/shop.py"
    click HB "https://github.com/kraibse/scavanger/blob/main/health_bar.py"
    click Buttons "https://github.com/kraibse/scavanger/blob/main/button.py"
    click TB "https://github.com/kraibse/scavanger/blob/main/text_box.py"
    click GEnd "https://github.com/kraibse/scavanger/blob/main/game_end_scene.py"
    click AS "https://github.com/kraibse/scavanger/blob/main/animated_sprite.py"
    click GA "https://github.com/kraibse/scavanger/tree/main/assets"
```
