# harmonyhoney/tiny_crate architecture

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

- Interactive diagram: https://gitdiagram.com/harmonyhoney/tiny_crate
- Repository: https://github.com/harmonyhoney/tiny_crate

## Overview

##### Project type and purpose
- This is a 2D “Precision Puzzle Platformer” game built in Godot 3.6 (“Tiny Crate”).
- It is not a client-server or microservice system but a standalone game application, using Godot’s scene/node architecture, custom GDScript code, and various assets (audio, images, shaders).

##### File structure
- Top-level assets and configuration
- media/ (audio, fonts, images, screens)
- default_bus_layout.tres, default_env.tres (audio & environment presets)
- export_presets.cfg, export/ (build scripts for Windows/Mac/Linux, butler integration)
- .github/workflows/flatpak.yml & godot.yml (CI for packaging)
- Project entry
- project.godot (engine config)
- Source code
- src/map/ (level scenes .tscn)
- src/stage/ (tilemaps, camera, stage logic)
- src/menu/ (UI screens: StartMenu, Options, Creator, AttractMode)
- src/autoload/ (singleton services: Audio, Music, UI, Pause, Shared state, Wipe effect, touch controls)
- src/fx/ (VFX scenes/scripts: Explosions, Slam)
- src/shader/ (custom shaders for palette swap, grayscale, wipe, static)
- src/class/ (reusable GDScript classes: EaseMover, save dict)
- src/circle.gd (utility script)

##### README
- Reinforces that it’s a self-contained Godot game, no external backends.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Godot Runtime
    subgraph "Godot Engine Core" 
        direction TB
        Engine["Godot Engine Core"]:::engine
        Engine -.->|loads| ProjectConfig["project.godot"]:::engine
    end

    %% Project Configuration
    ProjectConfig -->|defines autoload| AutoloadGroup

    %% Autoload Singletons
    subgraph "Autoload Singletons" 
        direction TB
        Audio["Audio"]:::singleton
        Music["Music"]:::singleton
        Pause["Pause"]:::singleton
        Shared["SharedState"]:::singleton
        UIManager["UI Manager"]:::singleton
        WipeEffect["Wipe Effect"]:::singleton
        TouchControls["Touch Controls"]:::singleton
        ButtonHelper["Button Helper"]:::singleton
    end
    ProjectConfig -->|"autoloads"| Audio
    ProjectConfig --> Music
    ProjectConfig --> Pause
    ProjectConfig --> Shared
    ProjectConfig --> UIManager
    ProjectConfig --> WipeEffect
    ProjectConfig --> TouchControls
    ProjectConfig --> ButtonHelper

    %% Scenes and Game Logic
    subgraph "Game Scenes & Logic" 
        direction TB
        Maps["Map Scenes"]:::module
        Actors["Actor Nodes & Controllers"]:::module
        Stage["Stage Management"]:::module
        FX["FX (Visual Effects)"]:::module
        Menu["Menu/UI Screens"]:::module
    end

    Engine -->|runs scenes| Maps
    Engine --> Actors
    Engine --> Stage
    Engine --> FX
    Engine --> Menu

    %% Assets and Shaders
    subgraph "Assets" 
        direction TB
        Media["media/ (Audio, Fonts, Images)"]:::asset
        Presets["Audio Presets"]:::asset
        Shaders["Shaders"]:::asset
    end

    Media -->|used by| Maps
    Media --> Actors
    Media --> Menu
    Presets --> Audio
    Shaders --> FX
    Shaders --> Actors

    %% Utility Classes
    subgraph "Reusable Classes" 
        direction TB
        EaseMover["EaseMover"]:::module
        SaveDict["SaveDict"]:::module
        CircleUtil["circle.gd"]:::module
    end

    Actors --> EaseMover
    Stage --> SaveDict
    FX --> CircleUtil

    %% CI / Packaging Pipeline
    subgraph "CI / Packaging" 
        direction TB
        Workflows["GitHub Actions Workflows"]:::ci
        ExportPresets["export_presets.cfg"]:::ci
        BuildScripts["export/ (Platform Scripts)"]:::ci
        LinuxMeta["linux/ Packaging Metadata"]:::ci
    end

    Workflows -->|trigger export| ExportPresets
    ExportPresets --> BuildScripts
    BuildScripts --> LinuxMeta

    %% Signals and Service Calls
    Actors -->|signals| Stage
    Actors -->|invoke| Audio
    Actors -->|update UI| UIManager
    Stage -->|spawn FX| FX

    %% Click Events
    click ProjectConfig "https://github.com/harmonyhoney/tiny_crate/blob/master2/project.godot"
    click Maps "https://github.com/harmonyhoney/tiny_crate/tree/master2/src/map/"
    click Actors "https://github.com/harmonyhoney/tiny_crate/tree/master2/src/actor/"
    click Stage "https://github.com/harmonyhoney/tiny_crate/tree/master2/src/stage/"
    click FX "https://github.com/harmonyhoney/tiny_crate/tree/master2/src/fx/"
    click Menu "https://github.com/harmonyhoney/tiny_crate/tree/master2/src/menu/"
    click Audio "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/autoload/Audio.gd"
    click Audio "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/autoload/Audio.tscn"
    click Music "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/autoload/Music.gd"
    click Music "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/autoload/Music.tscn"
    click Pause "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/autoload/Pause.gd"
    click Pause "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/autoload/Pause.tscn"
    click Shared "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/autoload/Shared.gd"
    click Shared "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/autoload/Shared.tscn"
    click UIManager "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/autoload/UI.gd"
    click UIManager "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/autoload/UI.tscn"
    click WipeEffect "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/autoload/Wipe.gd"
    click WipeEffect "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/autoload/Wipe.tscn"
    click TouchControls "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/autoload/touch_screen.gd"
    click TouchControls "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/autoload/touch_screen.tscn"
    click ButtonHelper "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/autoload/btn.gd"
    click EaseMover "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/class/EaseMover.gd"
    click SaveDict "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/class/savedict.gd"
    click CircleUtil "https://github.com/harmonyhoney/tiny_crate/blob/master2/src/circle.gd"
    click Shaders "https://github.com/harmonyhoney/tiny_crate/tree/master2/src/shader/"
    click Media "https://github.com/harmonyhoney/tiny_crate/tree/master2/media/"
    click Presets "https://github.com/harmonyhoney/tiny_crate/blob/master2/default_bus_layout.tres"
    click Presets "https://github.com/harmonyhoney/tiny_crate/blob/master2/default_env.tres"
    click Workflows "https://github.com/harmonyhoney/tiny_crate/blob/master2/ .github/workflows/flatpak.yml"
    click Workflows "https://github.com/harmonyhoney/tiny_crate/blob/master2/ .github/workflows/godot.yml"
    click ExportPresets "https://github.com/harmonyhoney/tiny_crate/blob/master2/export_presets.cfg"
    click BuildScripts "https://github.com/harmonyhoney/tiny_crate/tree/master2/export/"
    click LinuxMeta "https://github.com/harmonyhoney/tiny_crate/tree/master2/linux/"

    %% Styles
    classDef engine fill:#f4f4f4,stroke:#333,stroke-width:2px
    classDef singleton fill:#D8BFD8,stroke:#9932CC,stroke-width:1px
    classDef module fill:#ADD8E6,stroke:#4682B4,stroke-width:1px
    classDef asset fill:#98FB98,stroke:#2E8B57,stroke-width:1px
    classDef ci fill:#FFA500,stroke:#CD8500,stroke-width:1px
```
