# oradimi/kancolle-english-patch-kccp architecture

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

- Interactive diagram: https://gitdiagram.com/oradimi/kancolle-english-patch-kccp
- Repository: https://github.com/oradimi/kancolle-english-patch-kccp

## Overview

KanColle English Patch is a local game-asset and text translation patch, distributed with helper scripts for updating it and clearing the browser cache. The main workflow is that the player uses KCCacheProxy to apply translated assets and raw-text replacements in the game client. The sampled patcher loads translation tables and appends code that replaces PIXI text and handles formatting tags. The README documents the asset and text-patching capabilities; updater internals were not sampled, so those components are shown only where their roles are supported by the README or filenames.

Main entry points: [`EN-patch/kcs2/js/main.js/patcher.js`](https://github.com/oradimi/kancolle-english-patch-kccp/blob/master/EN-patch/kcs2/js/main.js/patcher.js) (Patch code builder), [`EN-patch-manager/quick_updater.ps1`](https://github.com/oradimi/kancolle-english-patch-kccp/blob/master/EN-patch-manager/quick_updater.ps1) (Quick updater), [`EN-patch-manager/update_checker.ps1`](https://github.com/oradimi/kancolle-english-patch-kccp/blob/master/EN-patch-manager/update_checker.ps1) (Update checker), [`EN-patch/kcs2/js/main.js/ignore-patcher_contents.js`](https://github.com/oradimi/kancolle-english-patch-kccp/blob/master/EN-patch/kcs2/js/main.js/ignore-patcher_contents.js) (PIXI text replacement)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_patch_assets["Translated assets"]
  node_images["Translated textures"]
  node_resources["Translated resources"]
end

subgraph group_text_patch["Raw text patch"]
  node_patcher["Patch code builder<br/>[patcher.js]"]
  node_translations["Text translations"]
  node_regex_translations["Regex translations"]
  node_text_runtime["PIXI text replacement"]
end

subgraph group_manager["Patch manager"]
  node_quick_updater["Quick updater<br/>[quick_updater.ps1]"]
  node_cache_clearer["Browser cache clearer"]
  node_update_checker["Update checker<br/>[update_checker.ps1]"]
  node_update_notice["Update notice<br/>[update_notice.ps1]"]
end

node_player(("Player"))
node_game["KanColle client"]
node_proxy["KCCacheProxy"]
node_manager_user(("Patch user"))

node_player -->|"uses"| node_proxy
node_proxy -->|"applies assets"| node_images
node_proxy -.->|"patches resources"| node_resources
node_proxy -->|"injects sprites"| node_game
node_game -->|"renders patched text"| node_text_runtime
node_patcher -->|"loads entries"| node_translations
node_patcher -->|"loads patterns"| node_regex_translations
node_patcher -->|"appends code"| node_text_runtime
node_player -->|"runs update"| node_quick_updater
node_quick_updater -.->|"clears cache"| node_cache_clearer
node_manager_user -->|"enables checker"| node_update_checker
node_update_checker -.->|"shows notice"| node_update_notice

click node_images "https://github.com/oradimi/kancolle-english-patch-kccp/tree/master/EN-patch/kcs2/img"
click node_resources "https://github.com/oradimi/kancolle-english-patch-kccp/tree/master/EN-patch/kcs2/resources"
click node_patcher "https://github.com/oradimi/kancolle-english-patch-kccp/blob/master/EN-patch/kcs2/js/main.js/patcher.js"
click node_translations "https://github.com/oradimi/kancolle-english-patch-kccp/tree/master/EN-patch/kcs2/js/main.js/ignore-raw_text_translations"
click node_regex_translations "https://github.com/oradimi/kancolle-english-patch-kccp/tree/master/EN-patch/kcs2/js/main.js/ignore-raw_text_translations_regex"
click node_text_runtime "https://github.com/oradimi/kancolle-english-patch-kccp/blob/master/EN-patch/kcs2/js/main.js/ignore-patcher_contents.js"
click node_quick_updater "https://github.com/oradimi/kancolle-english-patch-kccp/blob/master/EN-patch-manager/quick_updater.ps1"
click node_cache_clearer "https://github.com/oradimi/kancolle-english-patch-kccp/blob/master/EN-patch-manager/clear_browser_cache.ps1"
click node_update_checker "https://github.com/oradimi/kancolle-english-patch-kccp/blob/master/EN-patch-manager/update_checker.ps1"
click node_update_notice "https://github.com/oradimi/kancolle-english-patch-kccp/blob/master/EN-patch-manager/update_notice.ps1"

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_images,node_resources,node_game,node_manager_user toneBlue
class node_patcher,node_translations,node_regex_translations,node_text_runtime,node_proxy toneAmber
class node_quick_updater,node_cache_clearer,node_update_checker,node_update_notice toneMint
class node_player toneIndigo
```

## Components

### Translated assets

- [Translated textures](https://github.com/oradimi/kancolle-english-patch-kccp/tree/master/EN-patch/kcs2/img): `EN-patch/kcs2/img`
- [Translated resources](https://github.com/oradimi/kancolle-english-patch-kccp/tree/master/EN-patch/kcs2/resources): `EN-patch/kcs2/resources`

### Raw text patch

- [Patch code builder](https://github.com/oradimi/kancolle-english-patch-kccp/blob/master/EN-patch/kcs2/js/main.js/patcher.js): `EN-patch/kcs2/js/main.js/patcher.js`
- [Text translations](https://github.com/oradimi/kancolle-english-patch-kccp/tree/master/EN-patch/kcs2/js/main.js/ignore-raw_text_translations): `EN-patch/kcs2/js/main.js/ignore-raw_text_translations`
- [Regex translations](https://github.com/oradimi/kancolle-english-patch-kccp/tree/master/EN-patch/kcs2/js/main.js/ignore-raw_text_translations_regex): `EN-patch/kcs2/js/main.js/ignore-raw_text_translations_regex`
- [PIXI text replacement](https://github.com/oradimi/kancolle-english-patch-kccp/blob/master/EN-patch/kcs2/js/main.js/ignore-patcher_contents.js): `EN-patch/kcs2/js/main.js/ignore-patcher_contents.js`

### Patch manager

- [Quick updater](https://github.com/oradimi/kancolle-english-patch-kccp/blob/master/EN-patch-manager/quick_updater.ps1): `EN-patch-manager/quick_updater.ps1`
- [Browser cache clearer](https://github.com/oradimi/kancolle-english-patch-kccp/blob/master/EN-patch-manager/clear_browser_cache.ps1): `EN-patch-manager/clear_browser_cache.ps1`
- [Update checker](https://github.com/oradimi/kancolle-english-patch-kccp/blob/master/EN-patch-manager/update_checker.ps1): `EN-patch-manager/update_checker.ps1`
- [Update notice](https://github.com/oradimi/kancolle-english-patch-kccp/blob/master/EN-patch-manager/update_notice.ps1): `EN-patch-manager/update_notice.ps1`

### Other components

- **Player**
- **KanColle client**
- **KCCacheProxy**
- **Patch user**

## Connections

- Player → KCCacheProxy: uses (evidence: `README.md`)
- KCCacheProxy → Translated textures: applies assets (evidence: `README.md`)
- KCCacheProxy → Translated resources: patches resources
- KCCacheProxy → KanColle client: injects sprites (evidence: `README.md`)
- KanColle client → PIXI text replacement: renders patched text (evidence: `README.md`)
- Patch code builder → Text translations: loads entries (evidence: `EN-patch/kcs2/js/main.js/patcher.js`)
- Patch code builder → Regex translations: loads patterns (evidence: `EN-patch/kcs2/js/main.js/patcher.js`)
- Patch code builder → PIXI text replacement: appends code (evidence: `EN-patch/kcs2/js/main.js/patcher.js`)
- Player → Quick updater: runs update (evidence: `README.md`)
- Quick updater → Browser cache clearer: clears cache
- Patch user → Update checker: enables checker (evidence: `README.md`)
- Update checker → Update notice: shows notice
