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).
You need adb. It is available in the Android SDK platform
tools, or packaged in your distribution (adb
).
On Windows, download the platform-tools and extract
the following files to a directory accessible from your PATH
:
adb.exe
AdbWinApi.dll
AdbWinUsbApi.dll
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 pip3
:
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 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"
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 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"
If you want to build the server, install the Android SDK (Android Studio),
and set ANDROID_HOME
to its directory. For example:
export ANDROID_HOME=~/android/sdk
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
Then, build:
meson x --buildtype release --strip -Db_lto=true
ninja -Cx
Note: 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:
/usr/local/bin/scrcpy
/usr/local/share/scrcpy/scrcpy-server
Just remove them to "uninstall" the application.
You can then run scrcpy.
scrcpy-server-v1.12.1
(SHA-256: 63e569c8a1d0c1df31d48c4214871c479a601782945fed50c1e61167d78266ea)
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