QtScrcpy README

The project's README from github.com/barry-ran/QtScrcpy. As one markdown file: README.md.

QtScrcpy

Financial Contributors to Open Collective Windows MacOS Ubuntu

license release star

中文用户?点我查看中文介绍

QtScrcpy supports displaying and controlling Android devices via USB or over network. It does NOT require root privileges.

It supports three major platforms: GNU/Linux, Windows and macOS.

It focuses on:

win

mac

linux

The author has developed a more professional screen casting software called QuickMirror

QuickMirror function&features:

Mapping Keys

You can write your script to map keyboard and mouse actions to touches and clicks of the mobile phone according to your needs. Here are the script writing rules.

Script for TikTok and some other games are provided by default. Once enabled, you can play the game with your keyboard and mouse. The default key mapping for PUBG Mobile is as follows:

game

Instruction for adding new customized mapping files.

If you don't know how to manually write mapping rules, you can also use the QuickAssistant developed by the author QuickAssistant Features&Functions:

Group control

You can control all your phones at the same time.

group-control-demo

Star History

Star History Chart

Thanks

QtScrcpy is based on Genymobile's scrcpy project. Thanks a lot!

The difference between QtScrcpy and the original scrcpy is as follows:

key points scrcpy QtScrcpy
ui sdl qt
video encode ffmpeg ffmpeg
video render sdl opengl
cross-platform self implemented provided by Qt
language C C++
style sync async
keymap no custom keymap support custom keymap
build meson+gradle qmake or CMake

Learn

If you are interested in it and want to learn how it works but do not know how to get started, you can choose to purchase my recorded video lessons. It details the development architecture and the development process of the entire software and helps you develop QtScrcpy from scratch.

Course introduction:https://blog.csdn.net/rankun1/article/details/87970523

You can join Telegram Group for QtScrcpy and exchange ideas with like-minded friends.:

Telegram Group:https://t.me/+EnQNmb47C_liYmRl

Requirements

Android API >= 21 (Android 5.0).

Make sure you have enabled ADB debugging on your device(s).

Download

Windows

On Windows, for simplicity, prebuilt archives with all the dependencies (including ADB) are available at Releases:

or you can build it yourself

Mac OS

On Mac OS, for simplicity, prebuilt archives with all the dependencies (including ADB) are available at Releases:

or you can build it yourself

Linux

For Arch Linux Users, you can use AUR to install: yay -Syu qtscrcpy (may be outdated; maintainer: yochananmarqos)

For users in other distros, you can use the prebuilt archives from Releases:

or you can get it at GitHub Actions, in branch dev and download the latest artifact.

or you can build it yourself (not recommended, get it in Actions if you can)

Run

Connect to your Android device on your computer, then run the program and click USB connect or WiFi connect

Wireless connection steps (ensure that the mobile phone and PC are on the same LAN):

  1. Enable USB debugging in developer options on the Android device
  2. Connect the Android device to the computer via USB
  3. Click update device, and you will see that the device number is updated
  4. Click get device IP
  5. Click start adbd
  6. Click wireless connect
  7. Click update device again, and another device with an IP address will be found. Select this device.
  8. Click start service

Note: it is not necessary to keep your Android device connected via USB after you start adbd.

Interface button introduction:

The main function

Shortcuts

Action Shortcut (Windows) Shortcut (macOS)
Switch fullscreen mode Ctrl+f Cmd+f
Resize window to 1:1 (pixel-perfect) Ctrl+g Cmd+g
Resize window to remove black borders Ctrl+w | Double-click¹ Cmd+w | Double-click¹
Click on HOME Ctrl+h | Middle-click Ctrl+h | Middle-click
Click on BACK Ctrl+b | Right-click² Cmd+b | Right-click²
Click on APP_SWITCH Ctrl+s Cmd+s
Click on MENU Ctrl+m Ctrl+m
Click on VOLUME_UP Ctrl+↑ (up) Cmd+↑ (up)
Click on VOLUME_DOWN Ctrl+↓ (down) Cmd+↓ (down)
Click on POWER Ctrl+p Cmd+p
Power on Right-click² Right-click²
Turn device screen off (keep mirroring) Ctrl+o Cmd+o
Expand notification panel Ctrl+n Cmd+n
Collapse notification panel Ctrl+Shift+n Cmd+Shift+n
Copy to clipboard³ Ctrl+c Cmd+c
Cut to clipboard³ Ctrl+x Cmd+x
Synchronize clipboards and paste³ Ctrl+v Cmd+v
Inject computer clipboard text Ctrl+Shift+v Cmd+Shift+v

¹Double-click on black borders to remove them.

²Right-click turns the screen on if it was off, presses BACK otherwise.

³Only on Android >= 7.

TODO

TODO

FAQ

FAQ

DEVELOP

DEVELOP

Everyone is welcome to maintain this project and contribute your own code, but please follow these requirements:

  1. Please open PRs to the dev branch instead of the master branch
  2. Please rebase the original project before opening PRs
  3. Please submit PRs on the principle of "small amounts, many times" (one PR for a change is recommended)
  4. Please keep the code style consistent with the existing style.

Why develop QtScrcpy?

There are several reasons listed below according to importance (high to low).

  1. In the process of learning Qt, I need a real project to try.
  2. I have some background skills in audio and video and I am interested in them.
  3. I have some Android development skills. But I have used it for a long time. I want to consolidate it.
  4. I found scrcpy and decided to re-make it with the new technology stack (C++ + Qt + Opengl + FFmpeg).

Build

All the dependencies are provided and it is easy to compile.

QtScrcpy

Non-Arch Linux Users

  1. Set up the Qt development environment with the official Qt installer or third-party tools such as aqt on the target platform. Qt version bigger than 5.12 is required. (use MSVC 2019 on Windows)
  2. Clone the project with git clone --recurse-submodules [email protected]:barry-ran/QtScrcpy.git
  3. For Windows, open CMakeLists.txt with QtCreator and compile Release
  4. For Linux, directly run ./ci/linux/build_for_linux.sh "Release" Note: compiled artifacts are located at output/x64/Release

Arch Linux Users

  1. Install packages: base-devel cmake qt5-base qt5-multimedia qt5-x11extras (qtcreator is recommended)
  2. Clone the project with git clone --recurse-submodules [email protected]:barry-ran/QtScrcpy.git
  3. Run ./ci/linux/build_for_linux.sh "Release"

Scrcpy-Server

  1. Set up Android development environment on the target platform
  2. Open server project in project root with Android Studio
  3. The first time you open it, if you do not have the corresponding version of Gradle, you will be prompted to find Gradle, whether to upgrade Gradle or create it. Select Cancel. After cancelling, you will be prompted to select the location of existing Gradle. Cancel it too and it will download automatically.
  4. After compiling the apk, rename it to scrcpy-server and replace QtScrcpy/QtScrcpyCore/src/third_party/scrcpy-server.

Licence

Since it is based on scrcpy, it uses the same license as scrcpy

Copyright (C) 2025 Rankun

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About the author

Barry CSDN

An ordinary programmer, working mainly in C++ for desktop client development, graduated from Shandong for more than a year of steel simulation education software, and later moved to Shanghai to work in security, online education-related fields, familiar with audio and video. I have an understanding of audio and video fields such as voice calls, live education, video conferencing and other related solutions. I also have experience in Android, Linux servers and other kinds of development.

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

QtScrcpy (barry-ran/QtScrcpy)

Searching Database…

32.5K ·GitHub
这是什么?QtScrcpy 是一款桌面应用,可以通过 USB 或 WiFi 在电脑上实时显示并控制你的安卓手机屏幕,无需 root 权限。
这是库还是可以直接运行的应用?它是用 Qt 和 C++ 开发的独立桌面图形界面应用,不是可以嵌入其他软件的库。
怎么让它运行起来?从 Releases 下载适用于 Windows、macOS 或 Linux 的预编译压缩包,在安卓设备上开启 USB 调试,连接设备后,在应用中点击 USB 连接或 WiFi 连接即可。
我的手机需要先做什么准备吗?你需要一台 API 21 及以上(即安卓 5.0 或更高版本)的安卓设备,并在开发者选项中开启 USB 调试;Windows 和 Mac 的预编译包已内置 ADB。
设置时有哪些需要注意的坑?无线连接前,必须先用 USB 连接一次以启动 adbd,之后才能拔掉数据线;另外,内置 ADB 命令框不支持打开 shell 等“阻塞式”ADB 命令。
它在 Linux 上也能用吗,还是只支持 Windows 和 Mac?支持。它兼容 GNU/Linux、Windows 和 macOS;Arch Linux 用户可以通过 AUR 安装,其他发行版可以使用预编译压缩包,或自行编译。
它会在我的手机上安装东西吗?不会,它对设备的影响很小:手机本身不会安装任何程序,只会临时推送一个服务组件来镜像屏幕。
它和原版 scrcpy 项目有什么不同?QtScrcpy 基于 scrcpy,但用 C++ 和 Qt 代替 SDL 重写,使用 OpenGL 而非 SDL 渲染视频,采用异步信号/槽编程,并新增了原版 scrcpy 没有的自定义按键映射功能。
我可以用键盘和鼠标玩游戏吗?可以。你可以编写或使用现成的脚本,把键盘和鼠标操作映射为触控输入,内置了《和平精英》(PUBG Mobile)的默认映射;按 ~ 键可以开启或关闭自定义映射模式。
我能同时控制多部手机吗?可以。QtScrcpy 支持同时连接并控制多台安卓设备,还提供群控模式,可以一起操作所有已连接的手机。
能通过它传输文件或安装应用吗?可以。把 APK 文件拖放到视频窗口上即可安装;把任意文件拖放到窗口上,则可以将该文件传输到安卓设备中。
Creator
barry-ran
Size
42.4 MB
Stars
32.5K
Age
7y
Commits · 90 Days