# hisacat/unity-numbercountershader architecture

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

- Interactive diagram: https://gitdiagram.com/hisacat/unity-numbercountershader
- Repository: https://github.com/hisacat/unity-numbercountershader

## Overview

##### Project type and purpose
- This is an open-source Unity “Number Counter Shader” package. It provides a lightweight, optimized shader for rendering multi-digit counters in Unity scenes or Particle Systems. It also includes an Editor extension (com.vrchat.core.vpm-resolver) to streamline package import via VCC.

##### File structure
Top-level directories and key components:
- Assets/
- HisaCat/NumberCounterShader – Sample Scene and placeholder files.
- Packages/
- cat.hisa.number-counter-shader/Runtime – Core assets: Shaders, .cginc logic, Materials, Prefabs, Fonts, Sample Scene, asmdef, package.json.
- com.vrchat.core.vpm-resolver/Editor – Editor UI for packaging/resolving with dependencies.
- manifest.json & packages-lock.json – Unity Package Manager configuration.
- ProjectSettings/ – Unity project configuration.
- Website/ – Static site for documentation (HTML, CSS, JS).

##### README insights
- Core logic in NumberCounter.cginc.
- Usage: apply provided Materials/Shaders on a Quad in your scene.
- Extensibility: custom font textures (via provided PSD).
- Packaging: VCC-based import; no runtime dependencies beyond Unity.

##### Main components
a. Unity Host Environment
- Unity Editor (Package Manager, Inspector, Scene View)
- Unity Runtime (player/GPU)
b. cat.hisa.number-counter-shader Package
- Shader Module (NumberCounterUnlit*.shader & .cginc logic)
- Materials & Prefabs (preconfigured assets)
- Font Textures (default + custom PSD template)
- Sample Scene (Assets/HisaCat/Main Scene & Packages/.../Sample Scene)
c. Editor Extension
- com.vrchat.core.vpm-resolver (PackageMakerWindow, ResolverWindow)
- Dependencies (YamlDotNet, Serilog, SemanticVersioning)
d. External Services
- GitHub (Source, Releases, Issues)
- BuyMeACoffee (support link)
- VCC website for import

##### Relationships & interactions
- Unity Editor ↔ Package Manager ↔ cat.hisa.number-counter-shader (import/resolve)
- Unity Editor → com.vrchat.core.vpm-resolver (UI windows to package/make .tgz)
- Runtime Shader Module → GPU (compiled HLSL/CG) → renders quad digits
- Materials/Prefabs reference Shader Module and Font Textures
- Website files (index.html, app.js) served to end-user for documentation

##### Architectural patterns & principles
- Modular Package Design (separation of Runtime vs. Editor code via asmdef files)
- MVC-style separation:
- View = Sample Scene + Prefab + Material
- Model = Shader parameters (Value, DisplayLength)
- Controller = Unity Inspector & Scripts (none custom, uses Shader properties)
- Extensibility: PSD template for custom fonts, custom shaders via .cginc include

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Unity Host Environment
    subgraph "Unity Host Environment" 
        direction TB
        UnityEditor["Unity Editor"]:::unity
        PackageManager["Package Manager"]:::unity
        Inspector["Inspector"]:::unity
        SceneView["Scene View"]:::unity
        UnityRuntime["Unity Runtime (Player)"]:::unity
        GPU["GPU"]:::unity
    end

    UnityEditor -->|uses| PackageManager
    UnityEditor -->|opens| SceneView
    UnityEditor -->|inspects| Inspector
    UnityRuntime -->|executes shaders on| GPU

    %% Runtime Package
    subgraph "cat.hisa.number-counter-shader (Runtime Package)" 
        direction TB
        subgraph "Shader Module" 
            direction TB
            CGINC["NumberCounter.cginc"]:::runtime
            Shader1["NumberCounterUnlitAlphaBlended.shader"]:::runtime
            Shader2["NumberCounterUnlitAlphaBlendedAlwaysOnTop.shader"]:::runtime
            Shader3["NumberCounterUnlitCutout.shader"]:::runtime
            Shader4["NumberCounterUnlitCutoutAlwaysOnTop.shader"]:::runtime
        end
        subgraph "Materials & Prefabs"
            direction TB
            Material1["Number Counter Unlit Alpha Blended.mat"]:::runtime
            Material2["Number Counter Unlit Cutout.mat"]:::runtime
            Material3["Particle Number Counter Unlit Alpha Blended.mat"]:::runtime
            Prefab1["Number Counter Unlit Alpha Blend.prefab"]:::runtime
            Prefab2["Number Counter Unlit Cutout.prefab"]:::runtime
            Prefab3["Particle - Number Counter Unlit Alpha Blend.prefab"]:::runtime
        end
        FontTemplate["FontTemplate.psd"]:::runtime
        subgraph "Sample Scenes"
            direction TB
            SamplePkgScene["Sample Scene.unity (Package)"]:::runtime
            SampleAssetScene["Main Scene.unity (Assets)"]:::runtime
        end
        ASMDef["cat.hisa.number-counter-shader.asmdef"]:::runtime
        PackageJSON["package.json"]:::runtime
    end

    %% Editor Extension
    subgraph "com.vrchat.core.vpm-resolver (Editor Extension)"
        direction TB
        ResolverWindow["ResolverWindow.cs"]:::editor
        ResolverLogic["Resolver.cs"]:::editor
        PackageMakerWindow["PackageMakerWindow.cs"]:::editor
        PackageMakerData["PackageMakerWindowData.cs"]:::editor
        ResolverASM["com.vrchat.core.vpm-resolver.Editor.asmdef"]:::editor
        subgraph "Dependencies"
            direction TB
            Dep1["YamlDotNet.License.txt"]:::editor
            Dep2["Serilog.Sinks.Unity3D.License.md"]:::editor
            Dep3["SemanticVersioning.License.txt"]:::editor
        end
    end

    %% Website Documentation
    subgraph "Documentation Website"
        direction TB
        Index["index.html"]:::website
        AppJS["app.js"]:::website
        Styles["styles.css"]:::website
    end

    %% External Services
    subgraph "External Services"
        direction TB
        GitHub["GitHub (Source/Releases/Issues)"]:::external
        BuyCoffee["BuyMeACoffee"]:::external
        VCCSite["VCC Import Site"]:::external
    end

    %% Relationships & Flows
    PackageManager -->|imports| CGINC
    PackageManager -->|imports| Shader1
    PackageManager -->|imports| Shader2
    PackageManager -->|imports| Shader3
    PackageManager -->|imports| Shader4
    Inspector -->|sets shader uniforms| CGINC
    CGINC -->|include logic for variants| Shader1
    CGINC -->|include logic for variants| Shader2
    CGINC -->|include logic for variants| Shader3
    CGINC -->|include logic for variants| Shader4
    Shader1 -->|compiled to HLSL/CG| GPU
    Shader2 -->|compiled to HLSL/CG| GPU
    Shader3 -->|compiled to HLSL/CG| GPU
    Shader4 -->|compiled to HLSL/CG| GPU
    Material1 -->|references| Shader1
    Material2 -->|references| Shader3
    Material3 -->|references| Shader1
    Prefab1 -->|uses| Material1
    Prefab2 -->|uses| Material2
    Prefab3 -->|uses| Material3
    SamplePkgScene -->|instantiates| Prefab1
    SamplePkgScene -->|instantiates| Prefab2
    SamplePkgScene -->|instantiates| Prefab3
    SampleAssetScene -->|instantiates| Prefab1
    SampleAssetScene -->|instantiates| Prefab2
    SampleAssetScene -->|instantiates| Prefab3
    UnityEditor -->|opens| ResolverWindow
    UnityEditor -->|opens| PackageMakerWindow
    PackageMakerWindow -->|uses| ResolverLogic
    ResolverWindow -->|resolves| ResolverLogic
    ResolverLogic -->|reads| Dep1
    ResolverLogic -->|reads| Dep2
    ResolverLogic -->|reads| Dep3
    UnityEditor -->|visits docs| Index
    Index -->|loads| AppJS
    Index -->|loads| Styles
    UnityEditor -->|links to| GitHub
    UnityEditor -->|links to| BuyCoffee
    UnityEditor -->|links to| VCCSite

    %% Click Events
    click CGINC "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/cat.hisa.number-counter-shader/Runtime/Shaders/NumberCounter.cginc"
    click Shader1 "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/cat.hisa.number-counter-shader/Runtime/Shaders/NumberCounterUnlitAlphaBlended.shader"
    click Shader2 "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/cat.hisa.number-counter-shader/Runtime/Shaders/NumberCounterUnlitAlphaBlendedAlwaysOnTop.shader"
    click Shader3 "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/cat.hisa.number-counter-shader/Runtime/Shaders/NumberCounterUnlitCutout.shader"
    click Shader4 "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/cat.hisa.number-counter-shader/Runtime/Shaders/NumberCounterUnlitCutoutAlwaysOnTop.shader"
    click Material1 "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/cat.hisa.number-counter-shader/Runtime/Materials/Number Counter Unlit Alpha Blended.mat"
    click Material2 "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/cat.hisa.number-counter-shader/Runtime/Materials/Number Counter Unlit Cutout.mat"
    click Material3 "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/cat.hisa.number-counter-shader/Runtime/Materials/Particle Number Counter Unlit Alpha Blended.mat"
    click Prefab1 "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/cat.hisa.number-counter-shader/Runtime/Prefabs/Number Counter Unlit Alpha Blend.prefab"
    click Prefab2 "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/cat.hisa.number-counter-shader/Runtime/Prefabs/Number Counter Unlit Cutout.prefab"
    click Prefab3 "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/cat.hisa.number-counter-shader/Runtime/Prefabs/Particle - Number Counter Unlit Alpha Blend.prefab"
    click FontTemplate "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/cat.hisa.number-counter-shader/FontTemplate.psd"
    click SamplePkgScene "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/cat.hisa.number-counter-shader/Runtime/Samples/Sample Scene.unity"
    click SampleAssetScene "https://github.com/hisacat/unity-numbercountershader/blob/main/Assets/Main Scene.unity"
    click ResolverWindow "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/com.vrchat.core.vpm-resolver/Editor/Resolver/ResolverWindow.cs"
    click ResolverLogic "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/com.vrchat.core.vpm-resolver/Editor/Resolver/Resolver.cs"
    click PackageMakerWindow "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/com.vrchat.core.vpm-resolver/Editor/PackageMaker/PackageMakerWindow.cs"
    click PackageMakerData "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/com.vrchat.core.vpm-resolver/Editor/PackageMaker/PackageMakerWindowData.cs"
    click Dep1 "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/com.vrchat.core.vpm-resolver/Editor/Dependencies/YamlDotNet.License.txt"
    click Dep2 "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/com.vrchat.core.vpm-resolver/Editor/Dependencies/Serilog.Sinks.Unity3D.License.md"
    click Dep3 "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/com.vrchat.core.vpm-resolver/Editor/Dependencies/SemanticVersioning.License.txt"
    click ASMDef "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/cat.hisa.number-counter-shader/Runtime/cat.hisa.number-counter-shader.asmdef"
    click PackageJSON "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/cat.hisa.number-counter-shader/package.json"
    click ResolverASM "https://github.com/hisacat/unity-numbercountershader/blob/main/Packages/com.vrchat.core.vpm-resolver/Editor/com.vrchat.core.vpm-resolver.Editor.asmdef"
    click Index "https://github.com/hisacat/unity-numbercountershader/blob/main/Website/index.html"
    click AppJS "https://github.com/hisacat/unity-numbercountershader/blob/main/Website/app.js"
    click Styles "https://github.com/hisacat/unity-numbercountershader/blob/main/Website/styles.css"

    %% Styles
    classDef unity fill:#d0e8ff,stroke:#0288d1,stroke-width:1px
    classDef runtime fill:#e8f5e9,stroke:#2e7d32,stroke-width:1px
    classDef editor fill:#fff3e0,stroke:#ef6c00,stroke-width:1px
    classDef website fill:#f3e5f5,stroke:#8e24aa,stroke-width:1px
    classDef external fill:#eceff1,stroke:#546e7a,stroke-width:1px
```
