scrcpy/README.md

scrcpy (v2.3.1)

pronounced "screen copy"

This application mirrors Android devices (video and audio) connected via USB or over TCP/IP, and allows to control the device with the keyboard and the mouse of the computer. It does not require any root access. It works on Linux, Windows and macOS.

It focuses on:

• lightness: native, displays only the device screen
• performance: 30~120fps, depending on the device
• quality: 1920×1080 or above
• low latency: 35~70ms
• low startup time: ~1 second to display the first image
• non-intrusiveness: nothing is left installed on the Android device
• user benefits: no account, no ads, no internet required
• freedom: free and open source software

Its features include:

• audio forwarding (Android 11+)
• recording
• mirroring with Android device screen off
• copy-paste in both directions
• configurable quality
• camera mirroring (Android 12+)
• mirroring as a webcam (V4L2) (Linux-only)
• physical keyboard and mouse simulation (HID)
• OTG mode
• and more…

Prerequisites

The Android device requires at least API 21 (Android 5.0).

Audio forwarding is supported for API >= 30 (Android 11+).

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

On some devices, you also need to enable an additional option USB debugging (Security Settings) (this is an item different from USB debugging) to control it using a keyboard and mouse. Rebooting the device is necessary once this option is set.

Note that USB debugging is not required to run scrcpy in OTG mode.

Get the app

• Linux
• Windows
• macOS

User documentation

The application provides a lot of features and configuration options. They are documented in the following pages:

• Connection
• Video
• Audio
• Control
• Keyboard
• Mouse
• Device
• Window
• Recording
• Tunnels
• OTG
• Camera
• Video4Linux
• Shortcuts

Resources

• FAQ
• Translations (not necessarily up to date)
• Build instructions
• Developers

Articles

• Introducing scrcpy
• Scrcpy now works wirelessly
• Scrcpy 2.0, with audio

Contact

If you encounter a bug, please read the FAQ first, then open an issue.

For general questions or discussions, you can also use:

• Reddit: r/scrcpy
• Twitter: @scrcpy_app

Donate

I'm @rom1v, the author and maintainer of scrcpy.

If you appreciate this application, you can support my open source work:

• GitHub Sponsors
• Liberapay
• PayPal

Licence

Copyright (C) 2018 Genymobile
Copyright (C) 2018-2023 Romain Vimont

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.