Skip to content

varaddorle007/stream-deck

Repository files navigation

StreamLink Deck 📱💻

StreamLink Deck is a high-performance, bi-directional Stream Deck alternative. It features a modern Native Android Client (built with Kotlin & Jetpack Compose) and a robust PC Host Server (Node.js).

✨ Features

  • Low Latency: Optimized socket communication for real-time control.
  • Bi-directional: Get live feedback from your PC (Volume levels, OBS status) on your Android device.
  • Multi-Connection: Support for Wi-Fi and USB (Wired/ADB) connections.
  • Custom Macros: Easily extensible macro system using nut-js.
  • OBS Integration: Control scenes and sources directly.

🏗️ Project Structure

  • app/: Native Android Client (Kotlin/Compose). Open in Android Studio.
  • server/: Host Backend (Node.js). The engine that talks to your PC and OBS.

🚀 Getting Started

1. Host Server Setup (PC)

The server acts as the bridge between your Android device and your PC's applications.

  1. Navigate to the server directory.
  2. Install dependencies:
    npm install
  3. Start the server:
    npm start
  4. Optional: Ensure OBS WebSocket is running on port 4455.

2. Android App Setup

  1. Open the app directory in Android Studio.
  2. Allow Gradle to sync dependencies.
  3. Connect your Android device via USB or use an emulator.
  4. Build and Run.

🔌 Connection Methods

Wi-Fi (Same Network)

  1. Ensure your PC and Android device are on the same Wi-Fi.
  2. Note your PC's local IP address (e.g., 192.168.1.5).
  3. Enter the IP in the app and tap Connect.

USB / ADB (Recommended for Low Latency)

  1. Connect via USB and enable USB Debugging.
  2. Run the following command on your PC:
    adb reverse tcp:3000 tcp:3000
  3. In the app, connect to localhost.

🛠️ Troubleshooting

  • Firewall: Ensure Windows Firewall allows Node.js to communicate on port 3000.
  • IP Address: Verify you are using the correct IPv4 address from ipconfig.
  • Dependencies: If npm install fails, ensure you have Node.js 16+ installed.

📄 License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors