# ksp2redux/redux architecture

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

- Interactive diagram: https://gitdiagram.com/ksp2redux/redux
- Repository: https://github.com/ksp2redux/redux

## Overview

1. **What this repository is**
   - This repo is not the game/mod code itself. It is the public-facing repository for **KSP2 Redux**, a community mod for Kerbal Space Program 2.
   - The contents here are mostly **documentation, release metadata, and contributor/support scaffolding**.

2. **Primary purpose**
   - The project goal, stated in the README, is to continue KSP2 development and implement the original roadmap.
   - For an architecture diagram, this repo sits at the **top-level project coordination layer**, not the runtime mod layer.

3. **Documentation boundary**
   - `README.md` is the main entry point for users and contributors.
   - `roadmap.md` defines the planned feature scope.
   - `contributing.md` defines how external contributors participate.
   - These files together form the project’s **public specification and collaboration boundary**.

4. **Release-channel metadata**
   - `swinfo-beta.json` and `swinfo-stable.json` are the only machine-oriented artifacts visible here.
   - They likely act as **release/update descriptors** for beta and stable channels, supporting tooling that selects or identifies builds.
   - Architecturally, this implies a split between **beta testing** and **stable distribution**.

5. **Distribution and installation flow**
   - The README describes a manual install/update workflow driven by a separate tool: `Ksp2Redux.Tools.Installer.exe`.
   - The installer consumes a **patch file** and applies it to a stock KSP2 installation, producing a separate Redux install directory.
   - This implies the repo’s release process is centered around **patch-based distribution**, not in-place mutation of the original game folder.

6. **External dependency boundary**
   - The mod depends on a **specific base game version**: stock KSP2 v0.2.2.0.
   - The install process also varies by game distribution source: **Steam, Epic Games Store, or Private Division**.
   - So the architecture has an external boundary around the **upstream game install and platform-specific file layout**.

7. **User support and feedback loop**
   - The README directs bug reports to the in-game bug reporter and to a Discord server.
   - This indicates a support loop that captures logs, screenshots, saves, and vessel files for troubleshooting.
   - For a diagram, this is an important **feedback channel from users back to the maintainers**.

8. **Beta release model**
   - The repo explicitly warns that beta builds are not meant to be updated in place; they require a fresh install.
   - That means the release model is **install-per-build**, not incremental self-updating for beta.
   - This is relevant to lifecycle architecture because it affects how releases, installers, and user environments interact.

9. **Mod ecosystem boundary**
   - The README notes a transition from **BepInEx** to an **integrated mod loader** and changes to the modding API.
   - That suggests the project is not just content delivery; it also includes a **platform/runtime integration layer** for other mods.
   - However, no implementation code for that layer is present in this repo snapshot.

10. **Repository scaffolding**
   - `.github/ISSUE_TEMPLATE/*` supports structured issue intake, mainly bug reports.
   - `images/logo.png` is branding/supporting documentation only.
   - Overall, the repo is organized around **project communication, release coordination, and install metadata**, rather than source modules or services.

Main entry points: [`README.md`](https://github.com/ksp2redux/redux/blob/main/README.md) (README), [`.github/ISSUE_TEMPLATE/bug_report.md`](https://github.com/ksp2redux/redux/blob/main/.github/ISSUE_TEMPLATE/bug_report.md) (Bug report), [`swinfo-beta.json`](https://github.com/ksp2redux/redux/blob/main/swinfo-beta.json) (Beta info), [`swinfo-stable.json`](https://github.com/ksp2redux/redux/blob/main/swinfo-stable.json) (Stable info)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_group_docs["Public spec"]
  node_readme["README<br/>entry doc<br/>[README.md]"]
  node_roadmap["Roadmap<br/>plan doc<br/>[roadmap.md]"]
  node_contributing["Contributing<br/>policy doc<br/>[contributing.md]"]
end

subgraph group_group_release["Release data"]
  node_swinfo_beta["Beta info<br/>release metadata<br/>[swinfo-beta.json]"]
  node_swinfo_stable["Stable info<br/>release metadata<br/>[swinfo-stable.json]"]
end

subgraph group_group_support["Support intake"]
  node_bug_template["Bug report<br/>issue template<br/>[bug_report.md]"]
  node_issue_config["Issue config<br/>issue routing<br/>[config.yml]"]
  node_logo["Logo<br/>branding asset"]
end

subgraph group_group_external["External boundary"]
  node_installer["Installer<br/>external tool"]
  node_patch["Patch file<br/>release artifact"]
  node_stock_ksp2[("Stock KSP2<br/>upstream game")]
  node_platforms{{"Game stores<br/>distribution source"}}
  node_support_loop["Support loop<br/>feedback channel"]
  node_mod_loader[("Mod loader<br/>runtime boundary")]
end

node_repo_root(("Redux repo<br/>project root"))

node_repo_root -->|"publishes"| node_readme
node_repo_root -->|"releases"| node_swinfo_beta
node_repo_root -->|"releases"| node_swinfo_stable
node_repo_root -->|"supports"| node_bug_template
node_readme -->|"describes"| node_roadmap
node_readme -->|"guides"| node_contributing
node_readme -->|"documents"| node_installer
node_readme -->|"mentions"| node_patch
node_installer -->|"consumes"| node_patch
node_installer -->|"targets"| node_stock_ksp2
node_stock_ksp2 -->|"varies by"| node_platforms
node_readme -->|"routes users"| node_support_loop
node_support_loop -->|"formats"| node_bug_template
node_bug_template -->|"governed by"| node_issue_config
node_readme -->|"notes boundary"| node_mod_loader
node_swinfo_beta -->|"feeds"| node_installer
node_swinfo_stable -->|"feeds"| node_installer

click node_readme "https://github.com/ksp2redux/redux/blob/main/README.md"
click node_roadmap "https://github.com/ksp2redux/redux/blob/main/roadmap.md"
click node_contributing "https://github.com/ksp2redux/redux/blob/main/contributing.md"
click node_swinfo_beta "https://github.com/ksp2redux/redux/blob/main/swinfo-beta.json"
click node_swinfo_stable "https://github.com/ksp2redux/redux/blob/main/swinfo-stable.json"
click node_bug_template "https://github.com/ksp2redux/redux/blob/main/.github/ISSUE_TEMPLATE/bug_report.md"
click node_issue_config "https://github.com/ksp2redux/redux/blob/main/.github/ISSUE_TEMPLATE/config.yml"

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_readme,node_roadmap,node_contributing toneBlue
class node_swinfo_beta,node_swinfo_stable toneAmber
class node_bug_template,node_issue_config,node_logo toneMint
class node_installer,node_patch,node_stock_ksp2,node_platforms,node_support_loop,node_mod_loader toneRose
class node_repo_root toneNeutral
```

## Components

### Public spec

Documentation and contributor-facing project boundary

- [README](https://github.com/ksp2redux/redux/blob/main/README.md): entry doc · Main public entry point and install/support overview · `README.md`
- [Roadmap](https://github.com/ksp2redux/redux/blob/main/roadmap.md): plan doc · Planned feature scope and project direction · `roadmap.md`
- [Contributing](https://github.com/ksp2redux/redux/blob/main/contributing.md): policy doc · Contributor workflow and participation rules · `contributing.md`

### Release data

Machine-readable release and distribution descriptors

- [Beta info](https://github.com/ksp2redux/redux/blob/main/swinfo-beta.json): release metadata · Beta channel build descriptor · `swinfo-beta.json`
- [Stable info](https://github.com/ksp2redux/redux/blob/main/swinfo-stable.json): release metadata · Stable channel build descriptor · `swinfo-stable.json`

### Support intake

Issue templates and reporting scaffolding

- [Bug report](https://github.com/ksp2redux/redux/blob/main/.github/ISSUE_TEMPLATE/bug_report.md): issue template · Structured intake for bug reports and repro data · `.github/ISSUE_TEMPLATE/bug_report.md`
- [Issue config](https://github.com/ksp2redux/redux/blob/main/.github/ISSUE_TEMPLATE/config.yml): issue routing · Repository issue template configuration · `.github/ISSUE_TEMPLATE/config.yml`
- **Logo**: branding asset · Repository branding and documentation asset

### External boundary

Upstream game, install tooling, and mod ecosystem

- **Installer**: external tool · Patch-based install/update utility referenced by the docs
- **Patch file**: release artifact · Installer input used to build a Redux install
- **Stock KSP2**: upstream game · Required base game version and file layout
- **Game stores**: distribution source · Steam, Epic Games Store, and Private Division install variants
- **Support loop**: feedback channel · Bug reports, logs, screenshots, saves, and vessel files back to maintainers
- **Mod loader**: runtime boundary · Integrated mod loader and modding API boundary

### Other components

- **Redux repo**: project root · Public coordination layer for KSP2 Redux

## Connections

- Redux repo → README: publishes · Repository centers on the public README
- Redux repo → Beta info: releases · Maintains beta channel metadata
- Redux repo → Stable info: releases · Maintains stable channel metadata
- Redux repo → Bug report: supports · Provides structured bug intake
- README → Roadmap: describes · Public docs define planned scope
- README → Contributing: guides · Public docs define collaboration rules
- README → Installer: documents · Explains patch-based install workflow
- README → Patch file: mentions · Installation is driven by patch artifacts
- Installer → Patch file: consumes · Applies patch to create a Redux install
- Installer → Stock KSP2: targets · Updates a stock KSP2 installation
- Stock KSP2 → Game stores: varies by · Install layout depends on game store source
- README → Support loop: routes users · Directs users to bug reporter and Discord support
- Support loop → Bug report: formats · Bug reports are structured through the template
- Bug report → Issue config: governed by · Issue template availability is controlled by config
- README → Mod loader: notes boundary · Documents transition to integrated mod loading
- Beta info → Installer: feeds · Beta channel metadata can drive update/install tooling
- Stable info → Installer: feeds · Stable channel metadata can drive update/install tooling
