mirror of
https://github.com/Genymobile/scrcpy.git
synced 2025-08-02 22:29:25 +00:00
commit
ee0df0d1c8
1 changed files with 46 additions and 72 deletions
118
README.md
118
README.md
|
@ -7,7 +7,7 @@ _pronounced "**scr**een **c**o**py**"_
|
||||||
[Read in another language](#translations)
|
[Read in another language](#translations)
|
||||||
|
|
||||||
This application provides display and control of Android devices connected via
|
This application provides display and control of Android devices connected via
|
||||||
USB (or [over TCP/IP](#tcpip-wireless)). It does not require any _root_ access.
|
USB (or [over TCP/IP](#tcpip-wireless)). It _does not require_ any root access.
|
||||||
It works on _GNU/Linux_, _Windows_ and _macOS_.
|
It works on _GNU/Linux_, _Windows_ and _macOS_.
|
||||||
|
|
||||||

|

|
||||||
|
@ -56,52 +56,44 @@ control it using keyboard and mouse.
|
||||||
|
|
||||||
### Summary
|
### Summary
|
||||||
|
|
||||||
- Linux: `apt install scrcpy`
|
- Linux (Debian and Ubuntu): `apt install scrcpy`
|
||||||
- Windows: [download][direct-win64]
|
- Windows: [download][direct-win64]
|
||||||
- macOS: `brew install scrcpy`
|
- macOS ([Homebrew](https://brew.sh/)): `brew install scrcpy`
|
||||||
|
\* You need `adb`, accessible from your `PATH` *\*.
|
||||||
|
|
||||||
Build from sources: [BUILD] ([simplified process][BUILD_simple])
|
*\*
|
||||||
|
```bash
|
||||||
[BUILD]: BUILD.md
|
brew install android-platform-tools
|
||||||
[BUILD_simple]: BUILD.md#simple
|
|
||||||
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
On Debian and Ubuntu:
|
|
||||||
|
|
||||||
```
|
|
||||||
apt install scrcpy
|
|
||||||
```
|
```
|
||||||
|
|
||||||
On Arch Linux:
|
### More
|
||||||
|
|
||||||
|
**Linux > Arch Linux**
|
||||||
|
|
||||||
```
|
```
|
||||||
pacman -S scrcpy
|
pacman -S scrcpy
|
||||||
```
|
```
|
||||||
|
|
||||||
A [Snap] package is available: [`scrcpy`][snap-link].
|
**Linux > [Snap] package**
|
||||||
|
|
||||||
[snap-link]: https://snapstats.org/snaps/scrcpy
|
[`scrcpy`](https://snapstats.org/snaps/scrcpy)
|
||||||
|
|
||||||
[snap]: https://en.wikipedia.org/wiki/Snappy_(package_manager)
|
[snap]: https://en.wikipedia.org/wiki/Snappy_(package_manager)
|
||||||
|
|
||||||
For Fedora, a [COPR] package is available: [`scrcpy`][copr-link].
|
**Linux > Fedora / [COPR] package**
|
||||||
|
|
||||||
|
[`scrcpy`](https://copr.fedorainfracloud.org/coprs/zeno/scrcpy/)
|
||||||
|
|
||||||
[COPR]: https://fedoraproject.org/wiki/Category:Copr
|
[COPR]: https://fedoraproject.org/wiki/Category:Copr
|
||||||
[copr-link]: https://copr.fedorainfracloud.org/coprs/zeno/scrcpy/
|
|
||||||
|
|
||||||
|
**Linux > Gentoo / [Ebuild]**
|
||||||
|
|
||||||
For Gentoo, an [Ebuild] is available: [`scrcpy/`][ebuild-link].
|
Available at [`scrcpy/`](https://github.com/maggu2810/maggu2810-overlay/tree/master/app-mobilephone/scrcpy).
|
||||||
|
|
||||||
[Ebuild]: https://wiki.gentoo.org/wiki/Ebuild
|
[Ebuild]: https://wiki.gentoo.org/wiki/Ebuild
|
||||||
[ebuild-link]: https://github.com/maggu2810/maggu2810-overlay/tree/master/app-mobilephone/scrcpy
|
|
||||||
|
|
||||||
You could also [build the app manually][BUILD] ([simplified
|
|
||||||
process][BUILD_simple]).
|
|
||||||
|
|
||||||
|
|
||||||
### Windows
|
**Windows > archive**
|
||||||
|
|
||||||
For Windows, for simplicity, a prebuilt archive with all the dependencies
|
For Windows, for simplicity, a prebuilt archive with all the dependencies
|
||||||
(including `adb`) is available:
|
(including `adb`) is available:
|
||||||
|
@ -111,58 +103,40 @@ For Windows, for simplicity, a prebuilt archive with all the dependencies
|
||||||
|
|
||||||
[direct-win64]: https://github.com/Genymobile/scrcpy/releases/download/v1.23/scrcpy-win64-v1.23.zip
|
[direct-win64]: https://github.com/Genymobile/scrcpy/releases/download/v1.23/scrcpy-win64-v1.23.zip
|
||||||
|
|
||||||
It is also available in [Chocolatey]:
|
**Windows > Chocolatey**
|
||||||
|
|
||||||
[Chocolatey]: https://chocolatey.org/
|
It is also available in [Chocolatey](https://chocolatey.org/):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
choco install scrcpy
|
choco install scrcpy
|
||||||
choco install adb # if you don't have it yet
|
choco install adb # if you don't have it yet
|
||||||
```
|
```
|
||||||
|
|
||||||
And in [Scoop]:
|
**Windows > Scoop (<https://scoop.sh>)**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
scoop install scrcpy
|
scoop install scrcpy
|
||||||
scoop install adb # if you don't have it yet
|
scoop install adb # if you don't have it yet
|
||||||
```
|
```
|
||||||
|
|
||||||
[Scoop]: https://scoop.sh
|
|
||||||
|
|
||||||
You can also [build the app manually][BUILD].
|
**macOS > in [MacPorts](https://www.macports.org/)**
|
||||||
|
|
||||||
|
(which sets up adb for you)
|
||||||
### macOS
|
|
||||||
|
|
||||||
The application is available in [Homebrew]. Just install it:
|
|
||||||
|
|
||||||
[Homebrew]: https://brew.sh/
|
|
||||||
|
|
||||||
```bash
|
|
||||||
brew install scrcpy
|
|
||||||
```
|
|
||||||
|
|
||||||
You need `adb`, accessible from your `PATH`. If you don't have it yet:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
brew install android-platform-tools
|
|
||||||
```
|
|
||||||
|
|
||||||
It's also available in [MacPorts], which sets up adb for you:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo port install scrcpy
|
sudo port install scrcpy
|
||||||
```
|
```
|
||||||
|
|
||||||
[MacPorts]: https://www.macports.org/
|
|
||||||
|
|
||||||
|
**Manual build**
|
||||||
|
|
||||||
You can also [build the app manually][BUILD].
|
You could build manually from sources: [BUILD.md](BUILD.md). [Simplified process](BUILD.md#simple).
|
||||||
|
|
||||||
|
|
||||||
## Run
|
## Run
|
||||||
|
|
||||||
Plug an Android device, and execute:
|
Plug in an Android device, **connect with [`adb`](https://developer.android.com/studio/command-line/adb)** and execute:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
scrcpy
|
scrcpy
|
||||||
|
@ -174,6 +148,24 @@ It accepts command-line arguments, listed by:
|
||||||
scrcpy --help
|
scrcpy --help
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Custom paths
|
||||||
|
|
||||||
|
(Linux): For Android Studio (SDK) `adb` to be `adb` command, do `sudo ln --symbolic ### /usr/local/bin/adb`.
|
||||||
|
"###" should be a path to your Android Debug Bridge file.
|
||||||
|
|
||||||
|
To use a specific _adb_ binary, configure its path in the environment variable `ADB`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ADB=/path/to/adb scrcpy
|
||||||
|
```
|
||||||
|
|
||||||
|
To override the path of the `scrcpy-server` file, configure its path in
|
||||||
|
`SCRCPY_SERVER_PATH`.
|
||||||
|
|
||||||
|
To override the icon, configure its path in `SCRCPY_ICON_PATH`.
|
||||||
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
### Capture configuration
|
### Capture configuration
|
||||||
|
@ -1073,21 +1065,6 @@ All <kbd>Ctrl</kbd>+_key_ shortcuts are forwarded to the device, so they are
|
||||||
handled by the active application.
|
handled by the active application.
|
||||||
|
|
||||||
|
|
||||||
## Custom paths
|
|
||||||
|
|
||||||
To use a specific _adb_ binary, configure its path in the environment variable
|
|
||||||
`ADB`:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
ADB=/path/to/adb scrcpy
|
|
||||||
```
|
|
||||||
|
|
||||||
To override the path of the `scrcpy-server` file, configure its path in
|
|
||||||
`SCRCPY_SERVER_PATH`.
|
|
||||||
|
|
||||||
To override the icon, configure its path in `SCRCPY_ICON_PATH`.
|
|
||||||
|
|
||||||
|
|
||||||
## Why _scrcpy_?
|
## Why _scrcpy_?
|
||||||
|
|
||||||
A colleague challenged me to find a name as unpronounceable as [gnirehtet].
|
A colleague challenged me to find a name as unpronounceable as [gnirehtet].
|
||||||
|
@ -1105,10 +1082,7 @@ See [BUILD].
|
||||||
|
|
||||||
## Common issues
|
## Common issues
|
||||||
|
|
||||||
See the [FAQ].md).
|
See the [FAQ](FAQ.md).
|
||||||
|
|
||||||
[FAQ]: FAQ.md
|
|
||||||
|
|
||||||
|
|
||||||
## Developers
|
## Developers
|
||||||
|
|
||||||
|
@ -1144,7 +1118,7 @@ Read the [developers page].
|
||||||
|
|
||||||
## Contact
|
## Contact
|
||||||
|
|
||||||
If you encounter a bug, please read the [FAQ] first, then open an [issue].
|
If you encounter a bug, please read the [FAQ](FAQ.md) first, then open an [issue].
|
||||||
|
|
||||||
[issue]: https://github.com/Genymobile/scrcpy/issues
|
[issue]: https://github.com/Genymobile/scrcpy/issues
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue