Here are the instructions to build scrcpy (client and server).
You may want to build only the client: the server binary, which will be pushed to the Android device, does not depend on your system and architecture. In that case, use the prebuilt server (so you will not need Java or the Android SDK).
master branch concerns the latest release, and is the home page of the project on Github.
dev is the current development branch. Every commit present in
dev will be in the next release.
If you want to contribute code, please base your commits on the latest
You need adb. It is available in the Android SDK platform tools, or packaged in your distribution (
On Windows, download the platform-tools and extract the following files to a directory accessible from your
The client requires FFmpeg and LibSDL2. Just follow the instructions.
Install the required packages from your package manager.
# runtime dependencies sudo apt install ffmpeg libsdl2-2.0-0 adb # client build dependencies sudo apt install gcc git pkg-config meson ninja-build \ libavcodec-dev libavformat-dev libavutil-dev \ libsdl2-dev # server build dependencies sudo apt install openjdk-8-jdk
On old versions (like Ubuntu 16.04),
meson is too old. In that case, install it from
sudo apt install python3-pip pip3 install meson
# 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-devel
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
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
# 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
Install the packages with Homebrew:
# 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
brew tap caskroom/versions brew cask install java8 export JAVA_HOME="$(/usr/libexec/java_home --version 1.8)" export PATH="$JAVA_HOME/bin:$PATH"
If you want to build the server, install the Android SDK (Android Studio), and set
ANDROID_HOME to its directory. For example:
If you don't want to build the server, use the prebuilt server.
Clone the project:
git clone https://github.com/Genymobile/scrcpy cd scrcpy
meson x --buildtype release --strip -Db_lto=true ninja -Cx
ninja must be run as a non-root user (only
ninja install must be run as root).
To run without installing:
./run x [options]
After a successful build, you can install scrcpy on the system:
sudo ninja -Cx install # without sudo on Windows
This installs two files:
Just remove them to "uninstall" the application.
You can then run scrcpy.
Download the prebuilt server somewhere, and specify its path during the Meson configuration:
meson x --buildtype release --strip -Db_lto=true \ -Dprebuilt_server=/path/to/scrcpy-server ninja -Cx sudo ninja -Cx install
The server only works with a matching client version (this server works with the