Scrcpy Desktop is a user-friendly web application that streams your Android device's screen and audio directly to your browser. It utilizes the powerful scrcpy
server for efficient screen and audio capture.
Before you begin, ensure you have the following installed and configured:
- Node.js: Version 16 or higher (Download).
- ADB (Android Debug Bridge): Part of the Android SDK Platform Tools. Ensure it's in your system's PATH (ADB).
- Android Device:
Follow these steps to get Scrcpy Desktop running locally:
-
Clone or Download the Repository:
You can also download prebuilt release. Just run start script to get started.
Clone this repository or download the ZIP file. git clone https://github.com/serifpersia/scrcpy-desktop.git cd scrcpy-desktop
-
Install Dependencies & Build:
npm install npm run build
Automated run.bat/sh script do a full rebuild. Make sure you chmod +x run.sh before calling it.
-
Start the Application:
npm start
Use run.bat/.sh to start automatic install/build/start process or start it manually after npm install & build steps If you are using release zip build, just run start.bat/sh (chmod +x on linux before calling the start.sh script) These start scripts are automating npm install and start commands(npm install step is using ommit to avoid installing dev npm packages used for build, release build already has javascript files prebuilt)
-
Access the Web Interface:
- Open your web browser and navigate to the URL provided in the terminal (
http://localhost:8000
). - Google Chrome or Supermium chrome fork might work best if your pc struggles to play video with specific decoders.
- Open your web browser and navigate to the URL provided in the terminal (
-
Control Streaming:
- Use the web interface controls to select your desired settings (resolution, bitrate, FPS, audio).
- Click the "Start Stream" button.
Most scrcpy streaming parameters can be configured directly through the web interface and custom adb commands like screen rotation, wm size and density can be used for modes like native taskbar...
- scrcpy - For the core screen mirroring server.
- h264-converter - For in-browser fmp4 muxing.
- Brodway H264 Decoder - For in-browser h264 video decoding.
You can checkout earlier commmit or download legacy release to use legacy scrcpy-desktop which uses python and native scrcpy client. Read more about that version in LEGACY_README
This project is licensed under the MIT License - see the LICENSE file for details.