# shifterbit/fraymakers-special-modes architecture

> Architecture diagram of the GitHub repository shifterbit/fraymakers-special-modes, 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/shifterbit/fraymakers-special-modes
- Repository: https://github.com/shifterbit/fraymakers-special-modes

## Overview

##### Main Components

a) Core Template Structure
- Entity System
- Script System
- Asset Management System
- Sound System
- Visual Effects System

b) Development Tools Integration
- FrayTools Integration
- Plugin System
- Export System

**┌─ Development Environment ─────────────────────┐**
- ┌─ FrayTools IDE ──────────────────────────┐ │
- ┌─ Template Core ─────────────────────┐  │ │

- ┌─────────┐  ┌─────────────────┐  │  │ │
- Entity  │  │ Script System   │  │  │ │
- System  │◄─►│ (Haxe Scripts) │  │  │ │
- ┘  └─────────────────┘  │  │ │
- ▲              ▲             │  │ │

- ┌─────────────────────────────┐   │  │ │
- Asset Management System   │   │  │ │
- ┘   │  │ │
- ▲           ▲           │  │ │
- ┘  │ │

- ┌──────────┘    ┌─────┘              │ │

- ┌─────────┐  ┌────────┐  ┌─────────┐   │ │
- Sprites │  │ Sounds │  │   VFX   │   │ │
- ┘  └────────┘  └─────────┘   │ │
- ┘
- ┘

##### Key Components Detail

a) Entity System (library/entities/):
- Different entity types (assist, coin, controller, etc.)
- Relationships between entities

b) Script System (library/scripts/):
- Haxe script architecture
- Script categories (assist, coin, mission, etc.)
- Animation and hitbox stats connections

c) Asset Management:
- Organization of sprites, sounds, and VFX
- Asset loading and management flow

d) Resource Components:
- Organization of game assets
- Relationship with the asset management system

##### Integration Points

- FrayTools plugin connections
- Export pathways
- Metadata integration points

##### Data Flow

- Script execution flow
- Asset loading paths
- Entity interaction patterns
- Export processes

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph DevEnv["Development Environment"]
        subgraph FrayTools["FrayTools IDE"]
            subgraph Core["Template Core"]
                EntitySystem["Entity System"]:::core
                ScriptSystem["Script System"]:::core
                AssetManagement["Asset Management System"]:::core

                EntitySystem <--> ScriptSystem
                EntitySystem --> AssetManagement
                ScriptSystem --> AssetManagement
            end

            subgraph Resources["Resource Components"]
                SpriteSystem["Sprite System"]:::resource
                SoundSystem["Sound System"]:::resource
                VFXSystem["VFX System"]:::resource
                NineSlice["Nine-Slice System"]:::resource
                UIAssets["UI Assets"]:::resource
            end

            AssetManagement --> SpriteSystem
            AssetManagement --> SoundSystem
            AssetManagement --> VFXSystem
            AssetManagement --> NineSlice
            AssetManagement --> UIAssets
        end
    end

    %% Component Details
    subgraph Scripts["Script Components"]
        AnimStats["Animation Stats"]:::script
        HitStats["Hitbox Stats"]:::script
        AssistScripts["Assist Scripts"]:::script
    end

    ScriptSystem --> Scripts

    %% Resource Details
    subgraph GameAssets["Game Assets"]
        AssistSprites["Assist Sprites"]:::asset
        CoinSprites["Coin Sprites"]:::asset
        ShieldSprites["Shield Sprites"]:::asset
    end

    SpriteSystem --> GameAssets

    %% Style Definitions
    classDef core fill:#3498db,stroke:#2980b9,color:white
    classDef resource fill:#f1c40f,stroke:#f39c12,color:black
    classDef script fill:#9b59b6,stroke:#8e44ad,color:white
    classDef asset fill:#2ecc71,stroke:#27ae60,color:white

    %% Click Events
    click EntitySystem "https://github.com/shifterbit/fraymakers-special-modes/tree/master/library/entities/"
    click ScriptSystem "https://github.com/shifterbit/fraymakers-special-modes/tree/master/library/scripts/"
    click AssetManagement "https://github.com/shifterbit/fraymakers-special-modes/blob/master/library/manifest.json"
    click SoundSystem "https://github.com/shifterbit/fraymakers-special-modes/tree/master/library/sounds/"
    click VFXSystem "https://github.com/shifterbit/fraymakers-special-modes/tree/master/library/sprites/kirbyzazVfx/"
    click UIAssets "https://github.com/shifterbit/fraymakers-special-modes/tree/master/library/sprites/ui/"
    click AssistSprites "https://github.com/shifterbit/fraymakers-special-modes/tree/master/library/sprites/game/assist/"
    click NineSlice "https://github.com/shifterbit/fraymakers-special-modes/tree/master/library/nineslices/"
    click AnimStats "https://github.com/shifterbit/fraymakers-special-modes/blob/master/library/scripts/assist/AnimationStats.hx"
    click HitStats "https://github.com/shifterbit/fraymakers-special-modes/blob/master/library/scripts/assist/HitboxStats.hx"
    click AssistScripts "https://github.com/shifterbit/fraymakers-special-modes/tree/master/library/scripts/assist/"
```
