# zlwzk/coloringpixels-tool architecture

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

- Interactive diagram: https://gitdiagram.com/zlwzk/coloringpixels-tool
- Repository: https://github.com/zlwzk/coloringpixels-tool

## Overview

Coloring Pixels Tool combines a Windows installer with a BepInEx in-game plugin. The principal path is game discovery, payload deployment, and launch; in-game, the player opens the panel and uses automatic painting or screen-scanning assistance against the game’s live canvas. The graph also includes documented unlocks, presets, HUD/highlighting, profile and usage records, and installer updates. Some capabilities are README-only; their implementation links are limited to relationships visible in the excerpts or SOURCE INDEX.

Main entry points: [`src/ColoringPixelsTool/CheatPanel.cs`](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/CheatPanel.cs) (In-game panel), [`src/ColoringPixelsTool/Plugin.cs`](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/Plugin.cs) (BepInEx plugin), [`installer/MainForm.cs`](https://github.com/zlwzk/coloringpixels-tool/blob/main/installer/MainForm.cs) (Installer UI), [`src/ColoringPixelsTool/AssistOverlay.cs`](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/AssistOverlay.cs) (Assist overlay)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_setup["Installer"]
  node_program["CLI entry<br/>[Program.cs]"]
  node_locator["Game discovery<br/>[GameLocator.cs]"]
  node_steam["Steam libraries<br/>[SteamLocator.cs]"]
  node_installer_ui["Installer UI<br/>[MainForm.cs]"]
  node_deploy["Deploy / restore"]
  node_installer_settings[("Remembered directory<br/>[Settings.cs]")]
  node_updater["Release updater<br/>[Updater.cs]"]
end

subgraph group_runtime["Plugin Runtime"]
  node_plugin["BepInEx plugin<br/>[Plugin.cs]"]
  node_panel["In-game panel<br/>[CheatPanel.cs]"]
  node_game_api["Game API adapter<br/>[GameApi.cs]"]
end

subgraph group_painting["Painting Workflows"]
  node_auto_paint["Automatic painting<br/>[AutoPainter.cs]"]
  node_scheduler["Timed automation<br/>[AutoScheduler.cs]"]
  node_assist_overlay["Assist overlay<br/>[AssistOverlay.cs]"]
  node_assist_engine["Scan engine<br/>[AssistEngine.cs]"]
  node_assist_region["Scan region model<br/>[AssistRegion.cs]"]
  node_assist_detect["Canvas recognition"]
  node_assist_store[("Scan presets<br/>[AssistStore.cs]")]
  node_preview["Canvas preview<br/>[CanvasPreview.cs]"]
end

subgraph group_support["Game Features &amp; State"]
  node_highlighter["Color highlighter"]
  node_unlocker["Content unlocks<br/>[Unlocker.cs]"]
  node_presets["Game settings presets<br/>[GamePreset.cs]"]
  node_settings_panel["Game settings panel"]
  node_profile[("Player profile<br/>[UserProfile.cs]")]
  node_timer[("Painting timer<br/>[PaintTimer.cs]")]
  node_stats[("Usage statistics<br/>[Stats.cs]")]
  node_feedback["Feedback integration<br/>[GitHubFeedback.cs]"]
end

node_user(("Player / operator"))
node_game_files[("Game installation")]
node_game["Coloring Pixels"]
node_github["GitHub"]

node_user -->|"runs installer"| node_program
node_program -->|"detects game"| node_locator
node_locator -->|"searches libraries"| node_steam
node_program -->|"loads directory"| node_installer_settings
node_program -->|"opens UI"| node_installer_ui
node_installer_ui -->|"scans for game"| node_locator
node_installer_ui -->|"installs or uninstalls"| node_deploy
node_deploy -->|"writes / restores"| node_game_files
node_installer_ui -->|"downloads update"| node_updater
node_installer_ui -->|"launches game"| node_game
node_game -->|"loads plugin"| node_plugin
node_plugin -->|"creates panel"| node_panel
node_panel -->|"requests game actions"| node_game_api
node_plugin -->|"initializes painter"| node_auto_paint
node_panel -->|"controls painting"| node_auto_paint
node_auto_paint -->|"edits game canvas"| node_game_api
node_panel -->|"configures automation"| node_scheduler
node_scheduler -->|"runs painter"| node_auto_paint
node_scheduler -->|"switches levels"| node_game_api
node_plugin -->|"initializes assistance"| node_assist_overlay
node_assist_overlay -->|"drives scans"| node_assist_engine
node_assist_engine -->|"uses scan region"| node_assist_region
node_assist_overlay -->|"recognizes canvas"| node_assist_detect
node_assist_overlay -->|"loads presets"| node_assist_store
node_panel -->|"controls scanning"| node_assist_overlay
node_panel -->|"shows preview"| node_preview
node_preview -->|"reads grid data"| node_game_api
node_plugin -->|"initializes highlighter"| node_highlighter
node_panel -->|"invokes unlocks"| node_unlocker
node_panel -->|"offers presets"| node_presets
node_presets -->|"supports settings UI"| node_settings_panel
node_plugin -->|"loads profile"| node_profile
node_scheduler -->|"records automation"| node_profile
node_plugin -->|"initializes timer"| node_timer
node_timer -->|"reads painting progress"| node_game_api
node_plugin -->|"initializes statistics"| node_stats
node_panel -->|"offers feedback"| node_feedback
node_feedback -.->|"sends feedback"| node_github

click node_program "https://github.com/zlwzk/coloringpixels-tool/blob/main/installer/Program.cs"
click node_locator "https://github.com/zlwzk/coloringpixels-tool/blob/main/installer/GameLocator.cs"
click node_steam "https://github.com/zlwzk/coloringpixels-tool/blob/main/installer/SteamLocator.cs"
click node_installer_ui "https://github.com/zlwzk/coloringpixels-tool/blob/main/installer/MainForm.cs"
click node_deploy "https://github.com/zlwzk/coloringpixels-tool/blob/main/installer/PayloadInstaller.cs"
click node_installer_settings "https://github.com/zlwzk/coloringpixels-tool/blob/main/installer/Settings.cs"
click node_updater "https://github.com/zlwzk/coloringpixels-tool/blob/main/installer/Updater.cs"
click node_plugin "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/Plugin.cs"
click node_panel "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/CheatPanel.cs"
click node_game_api "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/GameApi.cs"
click node_auto_paint "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/AutoPainter.cs"
click node_scheduler "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/AutoScheduler.cs"
click node_assist_overlay "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/AssistOverlay.cs"
click node_assist_engine "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/AssistEngine.cs"
click node_assist_region "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/AssistRegion.cs"
click node_assist_detect "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/AssistAutoDetect.cs"
click node_assist_store "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/AssistStore.cs"
click node_preview "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/CanvasPreview.cs"
click node_highlighter "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/ColorHighlighter.cs"
click node_unlocker "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/Unlocker.cs"
click node_presets "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/GamePreset.cs"
click node_settings_panel "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/GameSettingsPanel.cs"
click node_profile "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/UserProfile.cs"
click node_timer "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/PaintTimer.cs"
click node_stats "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/Stats.cs"
click node_feedback "https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/GitHubFeedback.cs"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_program,node_locator,node_steam,node_installer_ui,node_deploy,node_installer_settings,node_updater toneBlue
class node_plugin,node_panel,node_game_api,node_game_files toneAmber
class node_auto_paint,node_scheduler,node_assist_overlay,node_assist_engine,node_assist_region,node_assist_detect,node_assist_store,node_preview toneMint
class node_highlighter,node_unlocker,node_presets,node_settings_panel,node_profile,node_timer,node_stats,node_feedback toneRose
class node_user,node_game,node_github toneIndigo
```

## Components

### Installer

- [CLI entry](https://github.com/zlwzk/coloringpixels-tool/blob/main/installer/Program.cs): `installer/Program.cs`
- [Game discovery](https://github.com/zlwzk/coloringpixels-tool/blob/main/installer/GameLocator.cs): `installer/GameLocator.cs`
- [Steam libraries](https://github.com/zlwzk/coloringpixels-tool/blob/main/installer/SteamLocator.cs): `installer/SteamLocator.cs`
- [Installer UI](https://github.com/zlwzk/coloringpixels-tool/blob/main/installer/MainForm.cs): `installer/MainForm.cs`
- [Deploy / restore](https://github.com/zlwzk/coloringpixels-tool/blob/main/installer/PayloadInstaller.cs): `installer/PayloadInstaller.cs`
- [Remembered directory](https://github.com/zlwzk/coloringpixels-tool/blob/main/installer/Settings.cs): `installer/Settings.cs`
- [Release updater](https://github.com/zlwzk/coloringpixels-tool/blob/main/installer/Updater.cs): `installer/Updater.cs`

### Plugin Runtime

- [BepInEx plugin](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/Plugin.cs): `src/ColoringPixelsTool/Plugin.cs`
- [In-game panel](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/CheatPanel.cs): `src/ColoringPixelsTool/CheatPanel.cs`
- [Game API adapter](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/GameApi.cs): `src/ColoringPixelsTool/GameApi.cs`

### Painting Workflows

- [Automatic painting](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/AutoPainter.cs): `src/ColoringPixelsTool/AutoPainter.cs`
- [Timed automation](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/AutoScheduler.cs): `src/ColoringPixelsTool/AutoScheduler.cs`
- [Assist overlay](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/AssistOverlay.cs): `src/ColoringPixelsTool/AssistOverlay.cs`
- [Scan engine](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/AssistEngine.cs): `src/ColoringPixelsTool/AssistEngine.cs`
- [Scan region model](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/AssistRegion.cs): `src/ColoringPixelsTool/AssistRegion.cs`
- [Canvas recognition](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/AssistAutoDetect.cs): `src/ColoringPixelsTool/AssistAutoDetect.cs`
- [Scan presets](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/AssistStore.cs): `src/ColoringPixelsTool/AssistStore.cs`
- [Canvas preview](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/CanvasPreview.cs): `src/ColoringPixelsTool/CanvasPreview.cs`

### Game Features & State

- [Color highlighter](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/ColorHighlighter.cs): `src/ColoringPixelsTool/ColorHighlighter.cs`
- [Content unlocks](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/Unlocker.cs): `src/ColoringPixelsTool/Unlocker.cs`
- [Game settings presets](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/GamePreset.cs): `src/ColoringPixelsTool/GamePreset.cs`
- [Game settings panel](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/GameSettingsPanel.cs): `src/ColoringPixelsTool/GameSettingsPanel.cs`
- [Player profile](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/UserProfile.cs): `src/ColoringPixelsTool/UserProfile.cs`
- [Painting timer](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/PaintTimer.cs): `src/ColoringPixelsTool/PaintTimer.cs`
- [Usage statistics](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/Stats.cs): `src/ColoringPixelsTool/Stats.cs`
- [Feedback integration](https://github.com/zlwzk/coloringpixels-tool/blob/main/src/ColoringPixelsTool/GitHubFeedback.cs): `src/ColoringPixelsTool/GitHubFeedback.cs`

### Other components

- **Player / operator**
- **Game installation**
- **Coloring Pixels**
- **GitHub**

## Connections

- Player / operator → CLI entry: runs installer (evidence: `README.md`)
- CLI entry → Game discovery: detects game (evidence: `installer/Program.cs`)
- Game discovery → Steam libraries: searches libraries (evidence: `installer/GameLocator.cs`)
- CLI entry → Remembered directory: loads directory (evidence: `installer/Program.cs`)
- CLI entry → Installer UI: opens UI (evidence: `installer/Program.cs`)
- Installer UI → Game discovery: scans for game (evidence: `installer/MainForm.cs`)
- Installer UI → Deploy / restore: installs or uninstalls (evidence: `installer/MainForm.cs`)
- Deploy / restore → Game installation: writes / restores (evidence: `README.md`)
- Installer UI → Release updater: downloads update (evidence: `installer/MainForm.cs`)
- Installer UI → Coloring Pixels: launches game (evidence: `README.md`)
- Coloring Pixels → BepInEx plugin: loads plugin (evidence: `README.md`)
- BepInEx plugin → In-game panel: creates panel (evidence: `src/ColoringPixelsTool/Plugin.cs`)
- In-game panel → Game API adapter: requests game actions (evidence: `src/ColoringPixelsTool/CheatPanel.cs`)
- BepInEx plugin → Automatic painting: initializes painter (evidence: `src/ColoringPixelsTool/Plugin.cs`)
- In-game panel → Automatic painting: controls painting (evidence: `src/ColoringPixelsTool/CheatPanel.cs`)
- Automatic painting → Game API adapter: edits game canvas (evidence: `src/ColoringPixelsTool/AutoPainter.cs`)
- In-game panel → Timed automation: configures automation (evidence: `src/ColoringPixelsTool/CheatPanel.cs`)
- Timed automation → Automatic painting: runs painter (evidence: `src/ColoringPixelsTool/AutoScheduler.cs`)
- Timed automation → Game API adapter: switches levels (evidence: `src/ColoringPixelsTool/AutoScheduler.cs`)
- BepInEx plugin → Assist overlay: initializes assistance (evidence: `src/ColoringPixelsTool/Plugin.cs`)
- Assist overlay → Scan engine: drives scans (evidence: `src/ColoringPixelsTool/AssistOverlay.cs`)
- Scan engine → Scan region model: uses scan region (evidence: `src/ColoringPixelsTool/AssistEngine.cs`)
- Assist overlay → Canvas recognition: recognizes canvas (evidence: `src/ColoringPixelsTool/AssistOverlay.cs`)
- Assist overlay → Scan presets: loads presets (evidence: `src/ColoringPixelsTool/AssistOverlay.cs`)
- In-game panel → Assist overlay: controls scanning (evidence: `src/ColoringPixelsTool/CheatPanel.cs`)
- In-game panel → Canvas preview: shows preview (evidence: `src/ColoringPixelsTool/CheatPanel.Preview.cs`)
- Canvas preview → Game API adapter: reads grid data (evidence: `src/ColoringPixelsTool/CanvasPreview.cs`)
- BepInEx plugin → Color highlighter: initializes highlighter (evidence: `src/ColoringPixelsTool/Plugin.cs`)
- In-game panel → Content unlocks: invokes unlocks (evidence: `src/ColoringPixelsTool/CheatPanel.cs`)
- In-game panel → Game settings presets: offers presets (evidence: `src/ColoringPixelsTool/CheatPanel.cs`)
- Game settings presets → Game settings panel: supports settings UI (evidence: `src/ColoringPixelsTool/GamePreset.cs`)
- BepInEx plugin → Player profile: loads profile (evidence: `src/ColoringPixelsTool/Plugin.cs`)
- Timed automation → Player profile: records automation (evidence: `src/ColoringPixelsTool/AutoScheduler.cs`)
- BepInEx plugin → Painting timer: initializes timer (evidence: `src/ColoringPixelsTool/Plugin.cs`)
- Painting timer → Game API adapter: reads painting progress (evidence: `src/ColoringPixelsTool/PaintTimer.cs`)
- BepInEx plugin → Usage statistics: initializes statistics (evidence: `src/ColoringPixelsTool/Plugin.cs`)
- In-game panel → Feedback integration: offers feedback (evidence: `src/ColoringPixelsTool/CheatPanel.Extras.cs`)
- Feedback integration → GitHub: sends feedback
