# mcpride/susi-the-cat architecture

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

- Interactive diagram: https://gitdiagram.com/mcpride/susi-the-cat
- Repository: https://github.com/mcpride/susi-the-cat

## Overview

Susi is a Rust computer-assisted translation tool for editing Sisulizer `.slp` projects and scanning/building localized resource files. The main workflow is to open or create a project, scan its sources into a shared translation model, edit and validate translations, then save or export them; the GUI and SlMake-compatible CLI expose that core. Separate capabilities include translation memory, exchange formats, pseudo-translation, and Git-based collaboration. The graph reflects documented capabilities and shown module references; some subsystem-to-runtime links are omitted where sampled source does not establish the call.

Main entry points: [`crates/core/src/model.rs`](https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/model.rs) (Project model), [`apps/susi/src/app.rs`](https://github.com/mcpride/susi-the-cat/blob/main/apps/susi/src/app.rs) (GUI state), [`crates/workflow/src/flow.rs`](https://github.com/mcpride/susi-the-cat/blob/main/crates/workflow/src/flow.rs) (Workflow engine), [`crates/workflow/src/forge.rs`](https://github.com/mcpride/susi-the-cat/blob/main/crates/workflow/src/forge.rs) (Forge interface)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_clients["User interfaces"]
  node_gui["Desktop GUI<br/>[main.rs]"]
  node_gui_state["GUI state<br/>[app.rs]"]
  node_gui_actions["GUI actions<br/>[actions.rs]"]
  node_gui_dialogs["Editing dialogs<br/>[dialogs.rs]"]
  node_cli["CLI entry<br/>[main.rs]"]
  node_cli_args["CLI arguments<br/>[args.rs]"]
  node_cli_tasks["CLI tasks<br/>[tasks.rs]"]
end

subgraph group_translation["Translation core"]
  node_project["Project model<br/>[model.rs]"]
  node_slp["SLP persistence<br/>[slp.rs]"]
  node_formats["Resource formats"]
  node_operations["Scan and build<br/>[ops.rs]"]
  node_validation["Validation<br/>[validate.rs]"]
  node_filter["Translation filters<br/>[filter.rs]"]
  node_exchange["Import and export<br/>[exchange.rs]"]
  node_tm["Translation memory<br/>[tm.rs]"]
  node_stats["Statistics<br/>[stats.rs]"]
  node_pseudo["Pseudo-translation<br/>[pseudo.rs]"]
end

subgraph group_collaboration["Git workflow"]
  node_gui_workflow["Workflow UI<br/>[workflow_ui.rs]"]
  node_workflow["Workflow engine<br/>[flow.rs]"]
  node_git["Git operations<br/>[git.rs]"]
  node_forge["Forge interface<br/>[forge.rs]"]
  node_github["GitHub client<br/>[github.rs]"]
  node_gitlab["GitLab client<br/>[gitlab.rs]"]
end

subgraph group_agent["Agent interface"]
  node_mcp["MCP server<br/>[server.rs]"]
end

node_translator(("Translator"))
node_agent_user(("AI agent"))
node_git_host{{"Git hosting service"}}

node_translator -->|"uses"| node_gui
node_gui -->|"starts"| node_gui_state
node_gui_state -->|"dispatches"| node_gui_actions
node_gui_state -->|"uses"| node_gui_dialogs
node_gui_actions -->|"opens"| node_gui_dialogs
node_gui_state -.->|"holds"| node_project
node_translator -->|"uses"| node_cli
node_cli -.->|"parses"| node_cli_args
node_cli_args -->|"selects"| node_cli_tasks
node_cli_tasks -.->|"operates on"| node_project
node_project -->|"reads and writes"| node_slp
node_formats -->|"maps resources"| node_project
node_operations -.->|"scans and builds"| node_formats
node_operations -.->|"updates"| node_project
node_validation -->|"checks"| node_project
node_exchange -->|"imports and exports"| node_project
node_translator -->|"requests collaboration"| node_gui_workflow
node_gui_workflow -.->|"runs actions"| node_workflow
node_workflow -->|"uses"| node_git
node_workflow -->|"uses"| node_forge
node_forge -->|"selects client"| node_github
node_forge -->|"selects client"| node_gitlab
node_github -.->|"calls API"| node_git_host
node_gitlab -.->|"calls API"| node_git_host
node_agent_user -->|"sends requests"| node_mcp
node_mcp -.->|"exposes tasks"| node_cli_tasks

click node_gui "https://github.com/mcpride/susi-the-cat/blob/main/apps/susi/src/main.rs"
click node_gui_state "https://github.com/mcpride/susi-the-cat/blob/main/apps/susi/src/app.rs"
click node_gui_actions "https://github.com/mcpride/susi-the-cat/blob/main/apps/susi/src/actions.rs"
click node_gui_dialogs "https://github.com/mcpride/susi-the-cat/blob/main/apps/susi/src/dialogs.rs"
click node_gui_workflow "https://github.com/mcpride/susi-the-cat/blob/main/apps/susi/src/workflow_ui.rs"
click node_cli "https://github.com/mcpride/susi-the-cat/blob/main/apps/susi-cli/src/main.rs"
click node_cli_args "https://github.com/mcpride/susi-the-cat/blob/main/apps/susi-cli/src/args.rs"
click node_cli_tasks "https://github.com/mcpride/susi-the-cat/blob/main/apps/susi-cli/src/tasks.rs"
click node_project "https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/model.rs"
click node_slp "https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/slp.rs"
click node_formats "https://github.com/mcpride/susi-the-cat/tree/main/crates/core/src/formats"
click node_operations "https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/ops.rs"
click node_validation "https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/validate.rs"
click node_filter "https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/filter.rs"
click node_exchange "https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/exchange.rs"
click node_tm "https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/tm.rs"
click node_stats "https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/stats.rs"
click node_pseudo "https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/pseudo.rs"
click node_workflow "https://github.com/mcpride/susi-the-cat/blob/main/crates/workflow/src/flow.rs"
click node_git "https://github.com/mcpride/susi-the-cat/blob/main/crates/workflow/src/git.rs"
click node_forge "https://github.com/mcpride/susi-the-cat/blob/main/crates/workflow/src/forge.rs"
click node_github "https://github.com/mcpride/susi-the-cat/blob/main/crates/workflow/src/github.rs"
click node_gitlab "https://github.com/mcpride/susi-the-cat/blob/main/crates/workflow/src/gitlab.rs"
click node_mcp "https://github.com/mcpride/susi-the-cat/blob/main/crates/mcp/src/server.rs"

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_gui,node_gui_state,node_gui_actions,node_gui_dialogs,node_cli,node_cli_args,node_cli_tasks toneBlue
class node_project,node_slp,node_formats,node_operations,node_validation,node_filter,node_exchange,node_tm,node_stats,node_pseudo toneAmber
class node_gui_workflow,node_workflow,node_git,node_forge,node_github,node_gitlab toneMint
class node_mcp toneRose
class node_translator,node_agent_user,node_git_host toneIndigo
```

## Components

### User interfaces

- [Desktop GUI](https://github.com/mcpride/susi-the-cat/blob/main/apps/susi/src/main.rs): `apps/susi/src/main.rs`
- [GUI state](https://github.com/mcpride/susi-the-cat/blob/main/apps/susi/src/app.rs): `apps/susi/src/app.rs`
- [GUI actions](https://github.com/mcpride/susi-the-cat/blob/main/apps/susi/src/actions.rs): `apps/susi/src/actions.rs`
- [Editing dialogs](https://github.com/mcpride/susi-the-cat/blob/main/apps/susi/src/dialogs.rs): `apps/susi/src/dialogs.rs`
- [CLI entry](https://github.com/mcpride/susi-the-cat/blob/main/apps/susi-cli/src/main.rs): `apps/susi-cli/src/main.rs`
- [CLI arguments](https://github.com/mcpride/susi-the-cat/blob/main/apps/susi-cli/src/args.rs): `apps/susi-cli/src/args.rs`
- [CLI tasks](https://github.com/mcpride/susi-the-cat/blob/main/apps/susi-cli/src/tasks.rs): `apps/susi-cli/src/tasks.rs`

### Translation core

- [Project model](https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/model.rs): `crates/core/src/model.rs`
- [SLP persistence](https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/slp.rs): `crates/core/src/slp.rs`
- [Resource formats](https://github.com/mcpride/susi-the-cat/tree/main/crates/core/src/formats): `crates/core/src/formats`
- [Scan and build](https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/ops.rs): `crates/core/src/ops.rs`
- [Validation](https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/validate.rs): `crates/core/src/validate.rs`
- [Translation filters](https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/filter.rs): `crates/core/src/filter.rs`
- [Import and export](https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/exchange.rs): `crates/core/src/exchange.rs`
- [Translation memory](https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/tm.rs): `crates/core/src/tm.rs`
- [Statistics](https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/stats.rs): `crates/core/src/stats.rs`
- [Pseudo-translation](https://github.com/mcpride/susi-the-cat/blob/main/crates/core/src/pseudo.rs): `crates/core/src/pseudo.rs`

### Git workflow

- [Workflow UI](https://github.com/mcpride/susi-the-cat/blob/main/apps/susi/src/workflow_ui.rs): `apps/susi/src/workflow_ui.rs`
- [Workflow engine](https://github.com/mcpride/susi-the-cat/blob/main/crates/workflow/src/flow.rs): `crates/workflow/src/flow.rs`
- [Git operations](https://github.com/mcpride/susi-the-cat/blob/main/crates/workflow/src/git.rs): `crates/workflow/src/git.rs`
- [Forge interface](https://github.com/mcpride/susi-the-cat/blob/main/crates/workflow/src/forge.rs): `crates/workflow/src/forge.rs`
- [GitHub client](https://github.com/mcpride/susi-the-cat/blob/main/crates/workflow/src/github.rs): `crates/workflow/src/github.rs`
- [GitLab client](https://github.com/mcpride/susi-the-cat/blob/main/crates/workflow/src/gitlab.rs): `crates/workflow/src/gitlab.rs`

### Agent interface

- [MCP server](https://github.com/mcpride/susi-the-cat/blob/main/crates/mcp/src/server.rs): `crates/mcp/src/server.rs`

### Other components

- **Translator**
- **AI agent**
- **Git hosting service**

## Connections

- Translator → Desktop GUI: uses (evidence: `README.md`)
- Desktop GUI → GUI state: starts (evidence: `apps/susi/src/main.rs`)
- GUI state → GUI actions: dispatches (evidence: `apps/susi/src/app.rs`)
- GUI state → Editing dialogs: uses (evidence: `apps/susi/src/app.rs`)
- GUI actions → Editing dialogs: opens (evidence: `apps/susi/src/actions.rs`)
- GUI state → Project model: holds
- Translator → CLI entry: uses (evidence: `README.md`)
- CLI entry → CLI arguments: parses
- CLI arguments → CLI tasks: selects (evidence: `apps/susi-cli/src/lib.rs`)
- CLI tasks → Project model: operates on
- Project model → SLP persistence: reads and writes (evidence: `README.md`)
- Resource formats → Project model: maps resources (evidence: `crates/core/src/formats/mod.rs`)
- Scan and build → Resource formats: scans and builds
- Scan and build → Project model: updates
- Validation → Project model: checks (evidence: `crates/core/src/validate.rs`)
- Import and export → Project model: imports and exports (evidence: `crates/core/src/exchange.rs`)
- Translator → Workflow UI: requests collaboration (evidence: `README.md`)
- Workflow UI → Workflow engine: runs actions
- Workflow engine → Git operations: uses (evidence: `crates/workflow/src/flow.rs`)
- Workflow engine → Forge interface: uses (evidence: `crates/workflow/src/flow.rs`)
- Forge interface → GitHub client: selects client (evidence: `crates/workflow/src/forge.rs`)
- Forge interface → GitLab client: selects client (evidence: `crates/workflow/src/forge.rs`)
- GitHub client → Git hosting service: calls API
- GitLab client → Git hosting service: calls API
- AI agent → MCP server: sends requests (evidence: `README.md`)
- MCP server → CLI tasks: exposes tasks
