# sidey-app/sidey architecture

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

- Interactive diagram: https://gitdiagram.com/sidey-app/sidey
- Repository: https://github.com/sidey-app/sidey

## Overview

SIDEY is a macOS and Windows desktop messenger that places pixel-animal representations of friends at the screen edge. The documented workflow is to observe friends’ activity and use SIDEY to exchange short messages or small pranks while continuing to use other apps. The repository tree contains no runtime source, so this map reflects README-documented capabilities only; internal modules, services, and implementation links cannot be established.

Main entry points: [`README.md`](https://github.com/sidey-app/sidey/blob/main/README.md) (SIDEY app)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_desktop["Desktop experience"]
  node_sidey["SIDEY app<br/>[README.md]"]
  node_overlay["Screen overlay<br/>[README.md]"]
end

subgraph group_presence["Friend presence"]
  node_characters["Pixel animals<br/>[README.md]"]
  node_status["Friend status<br/>[README.md]"]
end

subgraph group_communication["Communication"]
  node_messages["Short messages<br/>[README.md]"]
  node_pranks["Small pranks<br/>[README.md]"]
end

node_user(("User"))
node_friends(("Friends"))

node_user -->|"opens and uses"| node_sidey
node_sidey -->|"shows"| node_overlay
node_overlay -->|"displays"| node_characters
node_characters -->|"indicates"| node_status
node_user -->|"writes"| node_messages
node_sidey -->|"sends and receives"| node_messages
node_friends -->|"exchange"| node_messages
node_user -->|"plays"| node_pranks
node_sidey -->|"enables"| node_pranks
node_friends -->|"share"| node_pranks
node_overlay -->|"passes clicks through"| node_user

click node_sidey "https://github.com/sidey-app/sidey/blob/main/README.md"
click node_overlay "https://github.com/sidey-app/sidey/blob/main/README.md"
click node_characters "https://github.com/sidey-app/sidey/blob/main/README.md"
click node_status "https://github.com/sidey-app/sidey/blob/main/README.md"
click node_messages "https://github.com/sidey-app/sidey/blob/main/README.md"
click node_pranks "https://github.com/sidey-app/sidey/blob/main/README.md"

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_sidey,node_overlay,node_user toneBlue
class node_characters,node_status toneAmber
class node_messages,node_pranks toneMint
class node_friends toneIndigo
```

## Components

### Desktop experience

- [SIDEY app](https://github.com/sidey-app/sidey/blob/main/README.md): `README.md`
- [Screen overlay](https://github.com/sidey-app/sidey/blob/main/README.md): `README.md`

### Friend presence

- [Pixel animals](https://github.com/sidey-app/sidey/blob/main/README.md): `README.md`
- [Friend status](https://github.com/sidey-app/sidey/blob/main/README.md): `README.md`

### Communication

- [Short messages](https://github.com/sidey-app/sidey/blob/main/README.md): `README.md`
- [Small pranks](https://github.com/sidey-app/sidey/blob/main/README.md): `README.md`

### Other components

- **User**
- **Friends**

## Connections

- User → SIDEY app: opens and uses
- SIDEY app → Screen overlay: shows
- Screen overlay → Pixel animals: displays
- Pixel animals → Friend status: indicates
- User → Short messages: writes
- SIDEY app → Short messages: sends and receives
- Friends → Short messages: exchange
- User → Small pranks: plays
- SIDEY app → Small pranks: enables
- Friends → Small pranks: share
- Screen overlay → User: passes clicks through