This application provides display and control of Android devices connected on USB (or over TCP/IP). It does not require any root access. It works on GNU/Linux, Windows and MacOS.
The Android part requires at least API 21 (Android 5.0).
You need adb. It is available in the Android SDK platform
tools, or packaged in your distribution (android-adb-tools
).
On Windows, if you use the prebuilt application, it is already
included. Otherwise, just download the platform-tools
and extract the following files to a directory accessible from your PATH
:
adb.exe
AdbWinApi.dll
AdbWinUsbApi.dll
Make sure you enabled adb debugging on your device(s).
The client requires FFmpeg and LibSDL2. On Windows, they are included in the prebuilt application.
Install the required packages from your package manager.
# runtime dependencies
sudo apt install ffmpeg libsdl2-2.0.0
# client build dependencies
sudo apt install make gcc pkg-config meson \
libavcodec-dev libavformat-dev libavutil-dev \
libsdl2-dev
# server build dependencies
sudo apt install openjdk-8-jdk
# enable RPM fusion free
sudo dnf install https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm
# client build dependencies
sudo dnf install SDL2-devel ffms2-devel meson gcc make
# server build dependencies
sudo dnf install java
Two AUR packages have been created by users:
For Windows, for simplicity, prebuilt archives with all the dependencies
(including adb
) are available:
scrcpy-win32-v1.2.zip
.
(SHA-256: a1fe1de67ec75dcf970ca5d97a04c26ff0f2d61871f2ef51b6f2f0bf666966b2)scrcpy-win64-v1.2.zip
.
(SHA-256: 35ae3bcee51771e7c51b8a8be87aef2295c9f267606a7cf83ebb0a4d583ef536)
Instead, you may want to build it manually.
This is the preferred method (and the way the release is built).
From Debian, install mingw:
sudo apt install mingw-w64 mingw-w64-tools
You also need the JDK to build the server:
sudo apt install openjdk-8-jdk
Then generate the releases:
make -f Makefile.CrossWindows
It will generate win32 and win64 releases into dist/
.
From Windows, you need MSYS2 to build the project. From an MSYS2 terminal, install the required packages:
# runtime dependencies
pacman -S mingw-w64-x86_64-SDL2 \
mingw-w64-x86_64-ffmpeg
# client build dependencies
pacman -S mingw-w64-x86_64-make \
mingw-w64-x86_64-gcc \
mingw-w64-x86_64-pkg-config \
mingw-w64-x86_64-meson
For a 32 bits version, replace x86_64
by i686
:
# runtime dependencies
pacman -S mingw-w64-i686-SDL2 \
mingw-w64-i686-ffmpeg
# client build dependencies
pacman -S mingw-w64-i686-make \
mingw-w64-i686-gcc \
mingw-w64-i686-pkg-config \
mingw-w64-i686-meson
Java (>= 7) is not available in MSYS2, so if you plan to build the server,
install it manually and make it available from the PATH
:
export PATH="$JAVA_HOME/bin:$PATH"
The application is available in Homebrew. Just install it:
brew install scrcpy
Instead, you may want to build it manually. Install the packages:
# runtime dependencies
brew install sdl2 ffmpeg
# client build dependencies
brew install pkg-config meson
Additionally, if you want to build the server, install Java 8 from Caskroom, and
make it avaliable from the PATH
:
brew tap caskroom/versions
brew cask install java8
export JAVA_HOME="$(/usr/libexec/java_home --version 1.8)"
export PATH="$JAVA_HOME/bin:$PATH"
Install the Android SDK (Android Studio), and set ANDROID_HOME
to
its directory. For example:
export ANDROID_HOME=~/android/sdk
Clone the project:
git clone https://github.com/Genymobile/scrcpy
cd scrcpy
Then, build:
meson x --buildtype release --strip -Db_lto=true
cd x
ninja
You can test it from here:
ninja run
Or you can install it on the system:
sudo ninja install # without sudo on Windows
This installs two files:
/usr/local/bin/scrcpy
/usr/local/share/scrcpy/scrcpy-server.jar
Just remove them to "uninstall" the application.