How paraccoli/remote-desktop-rs works
Project Type and Purpose
• The application is a remote desktop system supporting Windows, macOS, and Linux. It features both a desktop client (with an egui/eframe-based UI) and a Web client (using Rust/Yew/WebAssembly) to connect to a central server.
• The README clearly describes functionalities such as screen sharing, remote input, file and clipboard sharing, image compression, multiple connection protocols (TCP, WebSocket, and WebRTC), and end-to-end encryption. This context is crucial in identifying each high-level component and their responsibilities.
File Structure
• Top-level directories include:
• common — contains shared modules for encryption, compression, protocol definitions, and various utilities.
• server — houses the server-side code with sub-modules for screen capture, input handling, network management (including authentication, session management, etc.), and a dedicated UI/tray for system-level controls.
• client — contains the desktop client code featuring modules for UI rendering (with controls, settings, window management), remote input, and network connectivity.
• web-client — handles the web client built on Yew/WebAssembly with its own structure for UI components, state management, network utilities, and static assets.
• Notice how the directory names (client, server, web-client) and their internal structures clearly separate concerns and functionalities, which is an important architectural characteristic.
Elements
• From the server to the clients representing screen sharing and status updates.
• From clients to the server representing input commands and control signals.
• Annotations or legends to explain protocols used (TCP, WebSocket, WebRTC) and any specific design patterns implemented.
Final Touches
• Component is detailed with its sub-modules where necessary (e.g., list “Screen Capture” sub-modules such as encoder and monitor under the server section).
Happy diagramming!