QtScrcpy can connect to Android devices via USB (or via TCP/IP) for display and control. No root privileges are required.
QtScrcpy connects to Android devices via USB (or via TCP/IP) for display and control. It does NOT require the root privileges.
A single application can support up to 16 Android devices to connect at the same time.
A single instance supports up to 16 Android device connections at the same time.
Supports three major desktop platforms, GNU/Linux, Windows and MacOS.
It supports three major platforms: GNU/Linux, Windows and MacOS.
It focuses on:
@ -29,59 +29,61 @@ It focuses on:
## Custom keymap（only windows enable）
You can write your own script to map the PC keyboard keys to the touch and click of the mobile phone according to your needs. [Here](docs/按键映射说明.md) are the rules.
## Customized key mapping (Windows only)
You can write your own script to map keyboard and mouse actions to touches and clicks of the mobile phone according to your needs. [Here](docs/按键映射说明.md) are the rules.
By default, it has its own mapping script for key and mouse mapping of "Game for peace" mobile games. When enabled, you can use key and mouse to play "Game for peace" mobile games like PC games. You can also write mapping files of other games according to [writing rules](docs/按键映射说明.md). The default key mapping is as follows:
A script for "PUBG mobile" mapping is provided by default. Once enabled, you can play the game with your keyboard and mouse as the PC version. You can also write your own mapping files for other games according to [writing rules](docs/按键映射说明.md). The default key mapping is as follows:
[Here is a video demonstration of playing "Game for peace"](http://mp.weixin.qq.com/mp/video?__biz=MzU1NTg5MjYyNw==&mid=100000015&sn=3e301fdc5a364bd16d6207fa674bc8b3&vid=wxv_968792362971430913&idx=1&vidsn=eec329cc13c3e24c187dc9b4d5eb8760&fromid=1&scene=20&xtrack=1&clicktime=1567346543&sessionid=1567346375&subscene=92&ascene=0&fasttmpl_type=0&fasttmpl_fullversion=4730859-zh_CN-zip&fasttmpl_flag=0&realreporttime=1567346543910#wechat_redirect)
[Here is a video demonstration of playing "PUBG mobile"](http://mp.weixin.qq.com/mp/video?__biz=MzU1NTg5MjYyNw==&mid=100000015&sn=3e301fdc5a364bd16d6207fa674bc8b3&vid=wxv_968792362971430913&idx=1&vidsn=eec329cc13c3e24c187dc9b4d5eb8760&fromid=1&scene=20&xtrack=1&clicktime=1567346543&sessionid=1567346375&subscene=92&ascene=0&fasttmpl_type=0&fasttmpl_fullversion=4730859-zh_CN-zip&fasttmpl_flag=0&realreporttime=1567346543910#wechat_redirect)
The operation method of custom key mapping is as follows：
- Write a custom script and put it in the keymap directory
- Check the custom mapping option and select the custom mapping script before starting the service
- Enter the game scene after connecting the mobile phone
- Press the ~ key (left side of the number key 1) to switch to the game mapping mode to experience (what key to press depends on the switchkey defined by your key script)
- Press the ~ key again to switch to normal control mode
- To start the WASD control car, remember to set it to single rocker mode in vehicle settings.
Here is the instruction of adding new customized mapping files.
- Write a customized script and put it in the `keymap` directory
- Click `refresh script` to check whether it can be found
- Connect your phone, start service and click `apply`
- Start the game and press `~` key (left side of the number key 1) to switch to the mapping mode (It can be changed in the script as `switchkey`)
- Press the ~ key again to switch back to normal mode
- (For PUBG and similar games) If you want to drive cars with WASD, you need to check the `single rocker mode` in the game setting.
## Thanks
QtScrcpy is based on [Genymobile's](https://github.com/Genymobile) [scrcpy](https://github.com/Genymobile/scrcpy) project and is very grateful to him.
QtScrcpy is based on [Genymobile's](https://github.com/Genymobile) [scrcpy](https://github.com/Genymobile/scrcpy) project. Thanks
The difference between QtScrcpy and the original scrcpy is as follows:
keys|scrcpy|QtScrcpy
--|:--:|:--:
ui|sdl|qt
video decode|ffmpeg|ffmpeg
video encode|ffmpeg|ffmpeg
video render|sdl|opengl
base tool|c++|Qt
cross-platform|self implemented|provided by Qt
language|C|C++
style|sync|asyn
style|sync|async
control|single touch|single/multi touch
build|meson+gradle|Qt Creator
- It's very easy to customize your interface with Qt
- It's very easy to customize your GUI with Qt
- Asynchronous programming of Qt-based signal slot mechanism improves performance
- Easy for novices to learn
- Add multi touch support
- Easy to learn
- Add support for multi-touch
## Learn
If you are interested in it and want to learn how it works and feel that you can't get started, you can choose to purchase my recorded video lessons.
It details the development architecture and development process of the entire software, and takes you to develop QtScrcpy from scratch.：
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 help you develop QtScrcpy from scratch.
- adb command line: convenient to execute custom adb commands (currently does not support blocking commands, such as shell)
- adb command: execute customized adb commands (blocking commands are not supported now, such as shell)
## The main function
- Display Android device screens in real time
Real-time mouse and keyboard control Android device
- Real-time mouse and keyboard control of Android devices
- Screen recording
- Wireless connections
- Supports up to 16 device connections (can be added if PC performance allows, you need to compile it yourself)
- full-screen display
- Window topping
- Wireless connection
- Supports up to 16 device connections (the number can be higher if your PC performance allows. You need to compile it by yourself)
- Full-screen display
- Display on the top
- Install apk: drag and drop apk to the video window to install
- Transfer files: Drag files to the video window to send files to Android devices
- Background recording: record only, no display interface
@ -181,23 +186,24 @@ Real-time mouse and keyboard control Android device
[DEVELOP](docs/DEVELOP.md)
## Why develop QtScrcpy?
There are several reasons for this, and the proportions are arranged from large to small:
1. In the process of learning Qt, you need a project to combat
2. It has audio and video related skills and is very interested in audio and video.
3. It has Android development skills, it’s a bit rusty for a long time, you need to consolidate it.
4. Found scrcpy, decided to re-entamrate with the new technology stack (C++ + Qt + Opengl + ffmpeg)
There are several reasons listed as 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 skill about audio and video and I am interested at 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
Try to provide all the dependencies and make it easy to compile.
## How to build
All the dependencies are provided and it is easy to compile.
### PC client
1. Set up the Qt development environment on the target platform (Qt >= 5.9.7, vs >= 2015 (not support mingw))
1. Set up the Qt development environment on the target platform (Qt >= 5.9.7, vs >= 2015 (mingw not supported))
2. Clone the project
3. Open the project root directory all.pro with QtCreator
4. Compile and run
### Android (If you do not need to modify the requirements, you can use the built-in scrcpy-server directly)
### Android (If you do not have special requirements, you can directly use the built-in scrcpy-server.jar)
1. Set up an 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 and create it. Select Cancel. After canceling, you will be prompted to select the location of the existing gradle. You can also cancel it (it will download automatically).
@ -208,13 +214,13 @@ Try to provide all the dependencies and make it easy to compile.
Since it is based on scrcpy, respect its Licence
Copyright (C) 2018 Genymobile
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.
Barry
6 years ago
committed by
GitHub
