Skip to content

README.md

Latest commit

 

History

History
187 lines (142 loc) · 5.34 KB

README.md

File metadata and controls

187 lines (142 loc) · 5.34 KB

RootStream KDE Plasma Client

RootStream KDE Client

Native KDE Plasma / Qt 6 client for RootStream secure P2P game streaming

Features

  • ✅ Native KDE Plasma integration - Built with Qt 6 and QML
  • ✅ Secure P2P streaming - Ed25519 + ChaCha20-Poly1305 encryption
  • ✅ Peer discovery - Automatic mDNS discovery and manual peer entry
  • ✅ Low latency - Hardware-accelerated decoding with VA-API
  • ✅ Audio streaming - Opus codec with PulseAudio/PipeWire support
  • ✅ Settings persistence - KConfig integration for settings
  • ✅ AI logging mode - Debug logging for troubleshooting
  • ✅ Multiple codecs - H.264, H.265, VP9, VP8 support
  • ✅ Fullscreen mode - Optimized for gaming

Quick Start

Installation

Arch Linux / CachyOS

# Install dependencies
sudo pacman -S qt6-base qt6-declarative qt6-quickcontrols2 \
               libsodium opus libva libpulse

# Clone and build
git clone https://github.com/infinityabundance/RootStream.git
cd RootStream/clients/kde-plasma-client
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
make -j$(nproc)
sudo make install

From PKGBUILD

cd packaging
makepkg -si

Usage

# Launch the client
rootstream-kde-client

# With AI logging (for debugging)
rootstream-kde-client --ai-logging

# Auto-connect to peer
rootstream-kde-client --connect "kXx7YqZ3...@hostname"

Documentation

Architecture

┌─────────────────────────────────────────┐
│         QML UI Layer                     │
│  - Peer selection and discovery          │
│  - Video streaming view                  │
│  - Settings and configuration            │
└─────────────┬───────────────────────────┘
              │
┌─────────────▼───────────────────────────┐
│      C++ Qt Wrapper Classes              │
│  - RootStreamClient (API wrapper)        │
│  - PeerManager (discovery)               │
│  - VideoRenderer (OpenGL)                │
│  - AudioPlayer (PulseAudio/PipeWire)     │
│  - InputManager (uinput)                 │
│  - SettingsManager (KConfig)             │
└─────────────┬───────────────────────────┘
              │
┌─────────────▼───────────────────────────┐
│      RootStream C API (libRootStream)    │
│  - Network, Crypto, Codecs               │
│  - Discovery, Peer management            │
└──────────────────────────────────────────┘

Development Status

✅ Implemented

  • Basic UI structure and navigation
  • Connection management
  • Peer discovery (partial)
  • Settings persistence
  • AI logging integration
  • Multiple codec support
  • Fullscreen mode

🚧 In Progress

  • Video rendering (OpenGL integration)
  • Audio playback (Opus decoding)
  • Input injection (uinput/xdotool)
  • Performance metrics display
  • mDNS peer discovery

📋 Planned

  • Virtual input overlay
  • Gamepad support
  • Recording playback
  • HDR support
  • Multi-monitor support

Building from Source

Dependencies

Required:

  • Qt 6.4+
  • libsodium
  • Opus
  • libRootStream

Optional:

  • KDE Frameworks 6 (KConfig, CoreAddons)
  • VA-API (hardware decoding)
  • PulseAudio or PipeWire

See BUILDING.md for detailed instructions.

Build

mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
make -j$(nproc)

Test

ctest --verbose

Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

Areas Needing Help

  1. Video rendering - OpenGL texture upload and rendering
  2. Audio playback - PulseAudio/PipeWire integration
  3. Input injection - Mouse/keyboard event handling
  4. Performance optimization - Reduce latency, improve FPS
  5. Testing - Unit tests, integration tests, stress tests
  6. Documentation - Tutorials, examples, API docs

License

MIT License - see LICENSE

Support

Acknowledgments

Built on:

Secure P2P streaming for everyone 🎮🔐