# gbzenobi/csharp-nt8-orderflowkit architecture

> Architecture diagram of the GitHub repository gbzenobi/csharp-nt8-orderflowkit, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gbzenobi/csharp-nt8-orderflowkit
- Repository: https://github.com/gbzenobi/csharp-nt8-orderflowkit

## Overview

##### Project type and purpose
- This is a C#-based collection of NinjaTrader8 plugins (indicators and AddOns) for volume analysis in futures markets.
- It provides multiple charting tools (BookMap, Order Flow, Volume Profile, Volume Filter, Market Volume) plus generic AddOns (SE.cs, WyckoffRender.cs).

##### File structure
- Top level:
- AddOns/ (SE.cs, WyckoffRender.cs) – general-purpose rendering or calculation helpers
- Bookmap.cs, OrderFlow.cs, VolumeAnalysisProfile.cs, VolumeFilter.cs, MarketVolume.cs – the five main indicator modules
- README.md – project description
- several image folders – for documentation only
- There are no separate “backend” or “frontend” projects: everything is built as a NinjaTrader plugin DLL.
- The “Book Map Database” feature writes .db files (likely SQLite) to disk for session saving and offline analysis.

##### README for additional insights
- The BookMap component also implements real-time session saving (.db) for offline ML or statistical work.
- The AddOns directory contains general utilities that all indicators can leverage (custom rendering logic, Wyckoff calculations).

##### Elements
- Clear labels:
- “Market Data Feed”
- “NinjaTrader8 Host”
- “Plugin Loader / AddOn Framework”
- “BookMap Indicator”, “OrderFlow Indicator”, etc.
- “Common Utilities (SE, WyckoffRender)”
- “Chart Renderer API”
- “Session DB (.db)”
- “Offline ML Analysis”
- Data flow: Market Data → NinjaTrader → Indicators
- Control flow: Indicators → Chart Renderer
- Persistence flow: BookMap → Session DB → Offline Tools

##### Final advice
- Be very detailed: show every indicator block, utilities block, and data store.
- Event flows explicitly: mark “OnMarketData” and “OnRender” callbacks.
- Don’t overthink: treat each .cs module as its own component.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Systems
    MarketData["Market Data Feed"]:::external
    OfflineML["Offline ML Analysis"]:::optional

    %% Host Layer
    NinjaTrader["NinjaTrader8 Host"]:::host
    PluginLoader["Plugin Loader / AddOn Framework"]:::host

    %% Indicator Modules
    subgraph "Indicator Modules"
        direction TB
        BookMap["BookMap Indicator"]:::plugin
        OrderFlow["OrderFlow Indicator"]:::plugin
        VolumeProfile["VolumeAnalysisProfile Indicator"]:::plugin
        VolumeFilter["VolumeFilter Indicator"]:::plugin
        MarketVolume["MarketVolume Indicator"]:::plugin
    end

    %% Common Utilities
    subgraph "Common Utilities"
        direction TB
        SEUtil["SE Utility"]:::util
        WyckoffUtil["WyckoffRender Utility"]:::util
    end

    %% Rendering & Persistence
    ChartRenderer["Chart Renderer API"]:::renderer
    SessionDB["Session DB (.db)"]:::db

    %% Data Flows
    MarketData -->|"tick events"| NinjaTrader
    NinjaTrader --> PluginLoader

    PluginLoader -->|loads| BookMap
    PluginLoader -->|loads| OrderFlow
    PluginLoader -->|loads| VolumeProfile
    PluginLoader -->|loads| VolumeFilter
    PluginLoader -->|loads| MarketVolume

    BookMap -->|"OnMarketData / OnRender"| ChartRenderer
    OrderFlow -->|"OnMarketData / OnRender"| ChartRenderer
    VolumeProfile -->|"OnMarketData / OnRender"| ChartRenderer
    VolumeFilter -->|"OnMarketData / OnRender"| ChartRenderer
    MarketVolume -->|"OnMarketData / OnRender"| ChartRenderer

    BookMap -->|uses| SEUtil
    OrderFlow -->|uses| SEUtil
    VolumeProfile -->|uses| SEUtil
    VolumeFilter -->|uses| SEUtil
    MarketVolume -->|uses| SEUtil

    BookMap -->|uses| WyckoffUtil
    OrderFlow -->|uses| WyckoffUtil
    VolumeProfile -->|uses| WyckoffUtil
    VolumeFilter -->|uses| WyckoffUtil
    MarketVolume -->|uses| WyckoffUtil

    BookMap -->|writes session data| SessionDB
    SessionDB -->|reads| OfflineML

    %% Click Events
    click BookMap "https://github.com/gbzenobi/csharp-nt8-orderflowkit/blob/main/Bookmap.cs"
    click OrderFlow "https://github.com/gbzenobi/csharp-nt8-orderflowkit/blob/main/OrderFlow.cs"
    click VolumeProfile "https://github.com/gbzenobi/csharp-nt8-orderflowkit/blob/main/VolumeAnalysisProfile.cs"
    click VolumeFilter "https://github.com/gbzenobi/csharp-nt8-orderflowkit/blob/main/VolumeFilter.cs"
    click MarketVolume "https://github.com/gbzenobi/csharp-nt8-orderflowkit/blob/main/MarketVolume.cs"
    click SEUtil "https://github.com/gbzenobi/csharp-nt8-orderflowkit/blob/main/AddOns/SE.cs"
    click WyckoffUtil "https://github.com/gbzenobi/csharp-nt8-orderflowkit/blob/main/AddOns/WyckoffRender.cs"

    %% Styles
    classDef external fill:#e0f7fa,stroke:#006064,stroke-width:2px
    classDef host fill:#e8eaf6,stroke:#283593,stroke-width:2px
    classDef plugin fill:#fff3e0,stroke:#e65100,stroke-width:2px
    classDef util fill:#e8f5e9,stroke:#2e7d32,stroke-width:2px,stroke-dasharray: 5 5
    classDef renderer fill:#f3e5f5,stroke:#6a1b9a,stroke-width:2px
    classDef db fill:#ede7f6,stroke:#4527a0,stroke-width:2px,stroke-dasharray: 5 5
    classDef optional fill:#fafafa,stroke:#9e9e9e,stroke-width:1px,stroke-dasharray: 2 2
```
