======================================================================== Tech HUD Network Monitor (tech-hud-net) v0.5.0 Active Network Telemetry Desktop HUD & Network Management Tool License: GNU General Public License v2.0 or later (GPLv2+) ======================================================================== 1. OVERVIEW & END-USER GUIDE ------------------------------------------------------------------------ Tech HUD Network Monitor (tech-hud-net) is a lightweight, futuristic, always-on-top desktop widget written in Vala and GTK+ 3. It displays real-time network telemetry for Wi-Fi and Ethernet interfaces using hardware-accelerated Cairo graphics and Pango font rendering. Key Features: * Live Telemetry: - Real-time Wi-Fi status (SSID, Signal %, Download/Upload speeds, Total MBs) - Real-time Ethernet interface throughput (Interface name, Down/Up rates, Total MBs) * Dynamic GUI Customization: - 20 Color Themes (Cyber Cyan, Matrix Emerald, Amber Terminal, Neon Sunset, etc.) - 9 Border Styles (Classic HUD Box, Top-Notch, Slanted Vent, Armored Hex, etc.) - 3 Design Categories (Starship-Neon, Glass, Marble texture rendering) - 5 Glass Overlay Variants (Clear, Frosted, Blurry, Ultra-Clear, Diamond) - Typography Engine: 3D Text Effects (Debossed/Embossed), Custom Shadow/Glow - Geometry & Opacity Controls: Pixel-perfect position adjustments, custom width, and independent background/text/border opacity sliders. * Window Management: - Borderless HUD design with drag-and-drop movement. - Layer placement (Above all windows, Normal layer, or Desktop background layer). - Sticky option across all desktop workspaces. * Integrated Wi-Fi & Network Manager: - Left-click or Context Menu access to available Wi-Fi networks. - Rescan, connect to saved profiles, auto-connect toggle, and password prompt. - Fallback preset menu for system tools (nmtui, nm-connection-editor, kcmshell5, Puppy SNS, WAG). Adding & Editing Custom Languages (languages.rc): ------------------------------------------------------------------------ tech-hud-net bypasses Gettext entirely and uses a simple, flat-text runtime translation file named `languages.rc`. This allows users to tweak or add translations directly without compiling PO/MO files. Lookup Order for languages.rc: 1. Current working directory (`./languages.rc`) 2. User config directory (`~/.config/tech-hud/languages.rc`) 3. Installed share path (`/usr/local/share/tech-hud-net/languages.rc` or `/usr/share/...`) 4. System directory (`/etc/tech-hud/languages.rc`) To customize or add a language: Copy the global file to your home directory: $ mkdir -p ~/.config/tech-hud $ cp /usr/local/share/tech-hud-net/languages.rc ~/.config/tech-hud/languages.rc Format: : = Example (Adding Italian - 'it'): it:Tech HUD Network Monitor = Monitor di Rete Tech HUD it:WLAN INTERFACE = INTERFACCIA SENZA FILI it:Not Connected = Non connesso Save the file and select your language code from the Options menu inside tech-hud-net. Comparison with Standard Network Managers (e.g. NetworkManager / connman): ------------------------------------------------------------------------ What tech-hud-net IS NOT / What it omits by design: * It is NOT a standalone network daemon or service stack. It relies on `nmcli` (NetworkManager) or backend CLI tools for actual socket/interface state changes. * Missing Heavy Enterprise Networking Options: - No direct editing of complex VPNs (OpenVPN, WireGuard), 802.1X Enterprise EAP, VLANs, or Network Bridges inside its own UI (for these, launch the external connection editor button configured in Options). - No manual static IPv4/IPv6 address assignment or custom DNS configuration submenus. - Designed specifically as a HUD status visualizer and lightweight Wi-Fi switcher for desktop setups, tiling WMs, and lightweight distros (Puppy, antiX, MX Linux). 2. DEVELOPER DOCUMENTATION & ARCHITECTURE ------------------------------------------------------------------------ The application is structured into two core Vala source files: 1. `tech-hud-engine.vala`: - `ColorTheme` & `ThemeManager`: Defines RGB color matrices for 20 themes. - `HudDesignSystem`: Handles Cairo rendering pipelines, marble texture tile patterns, and alpha/glass blending modes. - `TechPanelBox`: Custom GTK DrawingArea widget that uses Cairo vector paths to draw futuristic sci-fi panels, and uses Pango Layout API (`Pango.cairo_show_layout`) for accurate multi-language CJK, Cyrillic, and Arabic baseline text placement. - `TechSphericalPanel`: Animated radial/radar indicator widget. 2. `tech-hud-net.vala`: - `TechHudNetWindow`: Main borderless GTK Window handling telemetry polling via GLib threads (`/proc/net/dev` and `nmcli`), configuration serialization (`key_file`), drag-and-drop window positioning, custom `languages.rc` parser, and context menu. - `TechHudNetworkDialog`: Wi-Fi scanning and connection UI using GTK ListBox. - `TechHudNetOptionsDialog`: Tabbed notebook dialog for realtime HUD configuration. Building and Installation: ------------------------------------------------------------------------ Prerequisites: * valac (Vala Compiler) * libgtk-3-dev, libcairo2-dev, libpango1.0-dev, libglib2.0-dev * NetworkManager (`nmcli`) for Wi-Fi management Build commands: $ make # Compiles tech-hud-net binary and desktop entry $ sudo make install # Installs binary, desktop file, and languages.rc to /usr/local Packaging: $ make deb # Generates Debian .deb package (amd64) $ make pet64 # Generates Puppy Linux .pet package $ make source # Creates source release tarball (.tar.gz) 3. LICENSE ------------------------------------------------------------------------ This project is licensed under the GNU General Public License v2.0 or later (GPLv2+). See https://www.gnu.org/licenses/gpl-2.0.html for full license details.