# kawieki/be-my-kitty architecture

> Architecture diagram of the GitHub repository kawieki/be-my-kitty, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-24). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kawieki/be-my-kitty
- Repository: https://github.com/kawieki/be-my-kitty

## Overview

##### Project type and purpose
- This is a single‐player desktop simulation game (“BE-MY-KITTY”) written in Python (likely using Pygame or similar).
- The aim is to let the player care for a virtual pet, manage its food, customize characters, and save/load game state.

##### File structure
- Top-level:
- README.md, requirements.txt → project description and dependencies
- assets/ → audio, character sprites, fonts
- docs/ → auto-generated Sphinx documentation
- src/ → all game code
- src/ subdivisions:
- main.py & launch_logic.py → entry point and initialization
- logic/ → game rules, state updates (food_manager, game_logic, special modes)
- entities/ → core data models (Animal, FoodItem)
- managers/ → services (audio, font, save, scene)
- scenes/ → individual screens (menu, game, pause, save/load, character creation/settings)
- ui/ → rendering primitives (buttons, bars, background, HUD)
- utils/ → helpers for loading assets, parsing, animation

##### README and docs
- README confirms it’s a pet simulation game
- docs/source/api/* contain Sphinx RST files mapping exactly to the src package structure

##### Detailed capturing of essential elements
- How SaveManager interacts with FoodItem & Animal entities.
- Settings.py config parameters linking into LaunchLogic.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Entry & Initialization"
        EP["EntryPoint<br>(main.py)"]:::entry
        LL["LaunchLogic<br>(launch_logic.py)"]:::logic
        CS["Configuration Settings<br>(settings.py)"]:::config
    end
    EP --> LL
    CS --> LL

    subgraph "Managers / Services"
        SM["SceneManager<br>(scene_manager.py)"]:::managers
        AM["AudioManager<br>(audio_manager.py)"]:::managers
        FM["FontManager<br>(font_manager.py)"]:::managers
        SAVM["SaveManager<br>(save_manager.py)"]:::managers
    end
    LL --> SM
    LL --> AM
    LL --> FM
    LL --> SAVM

    subgraph "Core Loop & Logic"
        GL["GameLogic<br>(game_logic.py)"]:::logic
        CM["CupcakeMode<br>(cupcake_mode.py)"]:::logic
        FMG["FoodManager<br>(food_manager.py)"]:::logic
    end
    SM --> GL
    GL --> FMG
    GL --> CM

    subgraph "Scenes (State Machine States)"
        BS["BaseScene<br>(base_scene.py)"]:::scenes
        MS["MenuScene<br>(menu_scene.py)"]:::scenes
        GS["GameScene<br>(game_scene.py)"]:::scenes
        CCS["CharacterCreationScene<br>(character_creation_scene.py)"]:::scenes
        CSS["CharacterSettingsScene<br>(character_settings_scene.py)"]:::scenes
        SMS["SaveMenuScene<br>(save_menu_scene.py)"]:::scenes
        LSS["LoadSaveScene<br>(load_save_scene.py)"]:::scenes
        PMS["PauseMenuScene<br>(pause_menu_scene.py)"]:::scenes
    end
    SM --> BS
    BS --> MS
    BS --> GS
    BS --> CCS
    BS --> CSS
    BS --> SMS
    BS --> LSS
    BS --> PMS

    subgraph "Entities / Models"
        AN["Animal<br>(animal.py)"]:::entities
        FI["FoodItem<br>(food_item.py)"]:::entities
    end
    FMG --> AN
    FMG --> FI
    SAVM -.->|load/save| AN
    SAVM -.->|load/save| FI

    subgraph "UI / View"
        BTN["Button<br>(button.py)"]:::ui
        BAR["Bar<br>(bar.py)"]:::ui
        BG["BackgroundRenderer<br>(background_renderer.py)"]:::ui
        HUD["GameUI<br>(game_ui.py)"]:::ui
    end
    MS --> BTN
    CSS --> BTN
    CSS --> BAR
    GS --> HUD
    GS --> BG
    SM -->|"update/render"| GS
    GS -->|"render"| BTN
    GS -->|"render"| BAR
    GS -->|"render"| BG
    GS -->|"render"| HUD
    GL -->|"state update"| AN
    GL -->|"state update"| FI
    SM -.->|play sound| AM
    GL -.->|notify sound| AM
    FM --> BTN
    FM --> BAR
    FM --> HUD

    subgraph "Utils / Asset Loading"
        AL["AssetLoader<br>(asset.py)"]:::utils
        AA["AnimatedAsset<br>(animated_asset.py)"]:::utils
        FA["FunctionalAsset<br>(functional_asset.py)"]:::utils
        PR["Parser<br>(parser.py)"]:::utils
        AD["Assets Directory"]:::assets
    end
    LL --> AL
    AL --> AD
    AL --> AA
    AL --> FA
    AL --> PR

    Docs["Documentation"]:::misc
    LL --> Docs

    click EP "https://github.com/kawieki/be-my-kitty/blob/main/src/main.py"
    click LL "https://github.com/kawieki/be-my-kitty/blob/main/src/logic/launch_logic.py"
    click GL "https://github.com/kawieki/be-my-kitty/blob/main/src/logic/game_logic.py"
    click CM "https://github.com/kawieki/be-my-kitty/blob/main/src/logic/cupcake_mode.py"
    click FMG "https://github.com/kawieki/be-my-kitty/blob/main/src/logic/food_manager.py"
    click AN "https://github.com/kawieki/be-my-kitty/blob/main/src/entities/animal.py"
    click FI "https://github.com/kawieki/be-my-kitty/blob/main/src/entities/food_item.py"
    click SM "https://github.com/kawieki/be-my-kitty/blob/main/src/managers/scene_manager.py"
    click AM "https://github.com/kawieki/be-my-kitty/blob/main/src/managers/audio_manager.py"
    click FM "https://github.com/kawieki/be-my-kitty/blob/main/src/managers/font_manager.py"
    click SAVM "https://github.com/kawieki/be-my-kitty/blob/main/src/managers/save_manager.py"
    click BS "https://github.com/kawieki/be-my-kitty/blob/main/src/scenes/base_scene.py"
    click MS "https://github.com/kawieki/be-my-kitty/blob/main/src/scenes/menu_scene.py"
    click GS "https://github.com/kawieki/be-my-kitty/blob/main/src/scenes/game_scene.py"
    click CCS "https://github.com/kawieki/be-my-kitty/blob/main/src/scenes/character_creation_scene.py"
    click CSS "https://github.com/kawieki/be-my-kitty/blob/main/src/scenes/character_settings_scene.py"
    click SMS "https://github.com/kawieki/be-my-kitty/blob/main/src/scenes/save_menu_scene.py"
    click LSS "https://github.com/kawieki/be-my-kitty/blob/main/src/scenes/load_save_scene.py"
    click PMS "https://github.com/kawieki/be-my-kitty/blob/main/src/scenes/pause_menu_scene.py"
    click BTN "https://github.com/kawieki/be-my-kitty/blob/main/src/ui/button.py"
    click BAR "https://github.com/kawieki/be-my-kitty/blob/main/src/ui/bar.py"
    click BG "https://github.com/kawieki/be-my-kitty/blob/main/src/ui/background_renderer.py"
    click HUD "https://github.com/kawieki/be-my-kitty/blob/main/src/ui/game_ui.py"
    click AL "https://github.com/kawieki/be-my-kitty/blob/main/src/utils/asset.py"
    click AA "https://github.com/kawieki/be-my-kitty/blob/main/src/utils/animated_asset.py"
    click FA "https://github.com/kawieki/be-my-kitty/blob/main/src/utils/functional_asset.py"
    click PR "https://github.com/kawieki/be-my-kitty/blob/main/src/utils/parser.py"
    click CS "https://github.com/kawieki/be-my-kitty/blob/main/src/settings.py"
    click AD "https://github.com/kawieki/be-my-kitty/tree/main/assets/"
    click Docs "https://github.com/kawieki/be-my-kitty/tree/main/docs/source/api"

    classDef managers fill:#AEDFF7,stroke:#1F77B4,stroke-width:1px
    classDef logic fill:#C7F7A7,stroke:#2E8B57,stroke-width:1px
    classDef entities fill:#FFF799,stroke:#DAA520,stroke-width:1px
    classDef ui fill:#E8E8E8,stroke:#808080,stroke-width:1px
    classDef utils fill:#FFD8A7,stroke:#FF8C00,stroke-width:1px
    classDef assets fill:#FFD8A7,stroke:#FF8C00,stroke-width:1px
    classDef entry fill:#D3D3F7,stroke:#4B0082,stroke-width:1px
    classDef config fill:#D3D3F7,stroke:#4B0082,stroke-width:1px
    classDef scenes fill:#F7D7F7,stroke:#C71585,stroke-width:1px
    classDef misc fill:#F0F0F0,stroke:#A9A9A9,stroke-width:1px
```
