# kauri-off/voxelproxy architecture

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

- Interactive diagram: https://gitdiagram.com/kauri-off/voxelproxy
- Repository: https://github.com/kauri-off/voxelproxy

## Overview

VoxelProxy is a Minecraft proxy that lets two clients share one server identity, supporting manual connection and Wi-Fi-hotspot workflows across Minecraft versions 1.16.5–26.3. The main path is UI startup → backend session start → connection/session handling → packet proxying and protocol-specific synchronization. The README also documents setup guidance, a moderation-check toggle, support messaging, and updates. Some session, proxy, and UI details are represented at subsystem level because their source was not fully sampled.

Main entry points: [`src/backend.rs`](https://github.com/kauri-off/voxelproxy/blob/master/src/backend.rs) (Session backend), [`src/ui/mod.rs`](https://github.com/kauri-off/voxelproxy/blob/master/src/ui/mod.rs) (Desktop UI), [`src/session.rs`](https://github.com/kauri-off/voxelproxy/blob/master/src/session.rs) (Session modes), [`src/ui/setup_view.rs`](https://github.com/kauri-off/voxelproxy/blob/master/src/ui/setup_view.rs) (Setup view)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["Application and UI"]
  node_entry["App entry<br/>[main.rs]"]
  node_ui["Desktop UI<br/>[mod.rs]"]
  node_setup["Setup view<br/>[setup_view.rs]"]
  node_sessionview["Session view<br/>[session_view.rs]"]
  node_dialogs["Dialogs<br/>[dialogs.rs]"]
  node_support["Support chat<br/>[support.rs]"]
end

subgraph group_connection["Session and networking"]
  node_backend["Session backend<br/>[backend.rs]"]
  node_session["Session modes<br/>[session.rs]"]
  node_proxy["TCP proxy<br/>[proxy.rs]"]
  node_controller["Packet controller<br/>[controller.rs]"]
  node_redirect["Hotspot redirect"]
  node_resolver["Address resolution<br/>[resolver.rs]"]
  node_localip["Local network address<br/>[local_ip.rs]"]
end

subgraph group_protocol["Minecraft protocol"]
  node_protocols["Version dispatch<br/>[mod.rs]"]
  node_version["Version handlers<br/>[mod.rs]"]
  node_packets["Packet definitions<br/>[packets.rs]"]
end

subgraph group_operations["Diagnostics and updates"]
  node_config["Session config<br/>[config.rs]"]
  node_prefs["Preferences<br/>[prefs.rs]"]
  node_events["App events<br/>[events.rs]"]
  node_diagnostics["Diagnostics<br/>[diag.rs]"]
  node_changelog["Changelog<br/>[changelog.rs]"]
  node_updater["Update service<br/>[updater.rs]"]
end

node_user(("Player"))
node_server(("Minecraft server"))

node_user -->|"operates"| node_ui
node_entry -->|"starts"| node_ui
node_ui -->|"renders"| node_setup
node_ui -->|"renders"| node_sessionview
node_ui -->|"opens"| node_dialogs
node_ui -->|"opens"| node_support
node_setup -->|"starts sessions"| node_backend
node_sessionview -->|"reads status"| node_backend
node_dialogs -->|"requests updates"| node_backend
node_dialogs -->|"displays"| node_changelog
node_backend -->|"runs modes"| node_session
node_session -->|"uses"| node_proxy
node_session -->|"uses"| node_redirect
node_session -.->|"resolves targets"| node_resolver
node_session -->|"connects"| node_server
node_proxy -.->|"forwards traffic"| node_server
node_controller -->|"dispatches versions"| node_protocols
node_protocols -->|"selects handler"| node_version
node_version -->|"decodes packets"| node_packets
node_backend -->|"emits events"| node_events
node_events -->|"records events"| node_diagnostics
node_setup -->|"consumes events"| node_events
node_backend -->|"tracks session"| node_config
node_config -->|"uses preferences"| node_prefs
node_backend -->|"installs updates"| node_updater
node_backend -->|"uses address"| node_localip
node_support -.->|"exchanges messages"| node_user

click node_entry "https://github.com/kauri-off/voxelproxy/blob/master/src/main.rs"
click node_ui "https://github.com/kauri-off/voxelproxy/blob/master/src/ui/mod.rs"
click node_setup "https://github.com/kauri-off/voxelproxy/blob/master/src/ui/setup_view.rs"
click node_sessionview "https://github.com/kauri-off/voxelproxy/blob/master/src/ui/session_view.rs"
click node_dialogs "https://github.com/kauri-off/voxelproxy/blob/master/src/ui/dialogs.rs"
click node_support "https://github.com/kauri-off/voxelproxy/blob/master/src/ui/support.rs"
click node_backend "https://github.com/kauri-off/voxelproxy/blob/master/src/backend.rs"
click node_session "https://github.com/kauri-off/voxelproxy/blob/master/src/session.rs"
click node_proxy "https://github.com/kauri-off/voxelproxy/blob/master/src/proxy.rs"
click node_controller "https://github.com/kauri-off/voxelproxy/blob/master/src/controller.rs"
click node_redirect "https://github.com/kauri-off/voxelproxy/blob/master/src/hotspot_redirect.rs"
click node_resolver "https://github.com/kauri-off/voxelproxy/blob/master/src/resolver.rs"
click node_protocols "https://github.com/kauri-off/voxelproxy/blob/master/src/protocols/mod.rs"
click node_version "https://github.com/kauri-off/voxelproxy/blob/master/src/protocols/v26_3/mod.rs"
click node_packets "https://github.com/kauri-off/voxelproxy/blob/master/src/packets.rs"
click node_config "https://github.com/kauri-off/voxelproxy/blob/master/src/config.rs"
click node_prefs "https://github.com/kauri-off/voxelproxy/blob/master/src/prefs.rs"
click node_events "https://github.com/kauri-off/voxelproxy/blob/master/src/events.rs"
click node_diagnostics "https://github.com/kauri-off/voxelproxy/blob/master/src/diag.rs"
click node_changelog "https://github.com/kauri-off/voxelproxy/blob/master/src/changelog.rs"
click node_updater "https://github.com/kauri-off/voxelproxy/blob/master/src/updater.rs"
click node_localip "https://github.com/kauri-off/voxelproxy/blob/master/src/local_ip.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_entry,node_ui,node_setup,node_sessionview,node_dialogs,node_support toneBlue
class node_backend,node_session,node_proxy,node_controller,node_redirect,node_resolver,node_localip toneAmber
class node_protocols,node_version,node_packets,node_server toneMint
class node_config,node_prefs,node_events,node_diagnostics,node_changelog,node_updater toneRose
class node_user toneIndigo
```

## Components

### Application and UI

- [App entry](https://github.com/kauri-off/voxelproxy/blob/master/src/main.rs): `src/main.rs`
- [Desktop UI](https://github.com/kauri-off/voxelproxy/blob/master/src/ui/mod.rs): `src/ui/mod.rs`
- [Setup view](https://github.com/kauri-off/voxelproxy/blob/master/src/ui/setup_view.rs): `src/ui/setup_view.rs`
- [Session view](https://github.com/kauri-off/voxelproxy/blob/master/src/ui/session_view.rs): `src/ui/session_view.rs`
- [Dialogs](https://github.com/kauri-off/voxelproxy/blob/master/src/ui/dialogs.rs): `src/ui/dialogs.rs`
- [Support chat](https://github.com/kauri-off/voxelproxy/blob/master/src/ui/support.rs): `src/ui/support.rs`

### Session and networking

- [Session backend](https://github.com/kauri-off/voxelproxy/blob/master/src/backend.rs): `src/backend.rs`
- [Session modes](https://github.com/kauri-off/voxelproxy/blob/master/src/session.rs): `src/session.rs`
- [TCP proxy](https://github.com/kauri-off/voxelproxy/blob/master/src/proxy.rs): `src/proxy.rs`
- [Packet controller](https://github.com/kauri-off/voxelproxy/blob/master/src/controller.rs): `src/controller.rs`
- [Hotspot redirect](https://github.com/kauri-off/voxelproxy/blob/master/src/hotspot_redirect.rs): `src/hotspot_redirect.rs`
- [Address resolution](https://github.com/kauri-off/voxelproxy/blob/master/src/resolver.rs): `src/resolver.rs`
- [Local network address](https://github.com/kauri-off/voxelproxy/blob/master/src/local_ip.rs): `src/local_ip.rs`

### Minecraft protocol

- [Version dispatch](https://github.com/kauri-off/voxelproxy/blob/master/src/protocols/mod.rs): `src/protocols/mod.rs`
- [Version handlers](https://github.com/kauri-off/voxelproxy/blob/master/src/protocols/v26_3/mod.rs): `src/protocols/v26_3/mod.rs`
- [Packet definitions](https://github.com/kauri-off/voxelproxy/blob/master/src/packets.rs): `src/packets.rs`

### Diagnostics and updates

- [Session config](https://github.com/kauri-off/voxelproxy/blob/master/src/config.rs): `src/config.rs`
- [Preferences](https://github.com/kauri-off/voxelproxy/blob/master/src/prefs.rs): `src/prefs.rs`
- [App events](https://github.com/kauri-off/voxelproxy/blob/master/src/events.rs): `src/events.rs`
- [Diagnostics](https://github.com/kauri-off/voxelproxy/blob/master/src/diag.rs): `src/diag.rs`
- [Changelog](https://github.com/kauri-off/voxelproxy/blob/master/src/changelog.rs): `src/changelog.rs`
- [Update service](https://github.com/kauri-off/voxelproxy/blob/master/src/updater.rs): `src/updater.rs`

### Other components

- **Player**
- **Minecraft server**

## Connections

- Player → Desktop UI: operates
- App entry → Desktop UI: starts (evidence: `src/main.rs`)
- Desktop UI → Setup view: renders (evidence: `src/ui/mod.rs`)
- Desktop UI → Session view: renders (evidence: `src/ui/mod.rs`)
- Desktop UI → Dialogs: opens (evidence: `src/ui/mod.rs`)
- Desktop UI → Support chat: opens (evidence: `src/ui/mod.rs`)
- Setup view → Session backend: starts sessions (evidence: `src/ui/setup_view.rs`)
- Session view → Session backend: reads status (evidence: `src/ui/session_view.rs`)
- Dialogs → Session backend: requests updates (evidence: `src/ui/dialogs.rs`)
- Dialogs → Changelog: displays (evidence: `src/ui/dialogs.rs`)
- Session backend → Session modes: runs modes (evidence: `src/backend.rs`)
- Session modes → TCP proxy: uses (evidence: `src/session.rs`)
- Session modes → Hotspot redirect: uses (evidence: `src/session.rs`)
- Session modes → Address resolution: resolves targets
- Session modes → Minecraft server: connects (evidence: `src/session.rs`)
- TCP proxy → Minecraft server: forwards traffic
- Packet controller → Version dispatch: dispatches versions (evidence: `src/controller.rs`)
- Version dispatch → Version handlers: selects handler (evidence: `src/protocols/mod.rs`)
- Version handlers → Packet definitions: decodes packets (evidence: `src/protocols/v26_3/mod.rs`)
- Session backend → App events: emits events (evidence: `src/backend.rs`)
- App events → Diagnostics: records events (evidence: `src/events.rs`)
- Setup view → App events: consumes events (evidence: `src/ui/setup_view.rs`)
- Session backend → Session config: tracks session (evidence: `src/backend.rs`)
- Session config → Preferences: uses preferences (evidence: `src/config.rs`)
- Session backend → Update service: installs updates (evidence: `src/backend.rs`)
- Session backend → Local network address: uses address (evidence: `src/backend.rs`)
- Support chat → Player: exchanges messages
