scrcpy README

The project's README from github.com/Genymobile/scrcpy. As one markdown file: README.md.

[!WARNING] This GitHub repo (https://github.com/Genymobile/scrcpy) is the only official source for the project. Do not download releases from random websites, even if their name contains scrcpy.

scrcpy (v4.1)

scrcpy

pronounced "screen copy"

This application mirrors Android devices (video and audio) connected via USB or TCP/IP and allows control using the computer's keyboard and mouse. It does not require root access or an app installed on the device. It works on Linux, Windows, and macOS.

Linux  Windows  macOS 

screenshot

It focuses on:

Its features include:

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 (especially Xiaomi), you might get the following error:

Injecting input events requires the caller (or the source of the instrumentation, if any) to have the INJECT_EVENTS permission.

In that case, you 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

Must-know tips

Usage examples

There are a lot of options, documented in separate pages. Here are just some common examples.

User documentation

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

Resources

Articles

Contact

You can open an issue for bug reports, feature requests or general questions.

For bug reports, please read the FAQ first, you might find a solution to your problem immediately.

You can also use:

Donate

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

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

License

Copyright (C) 2018 Genymobile
Copyright (C) 2018-2026 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.

scrcpy (Genymobile/scrcpy)

Searching Database…

152.3K ·GitHub
What is this?scrcpy (pronounced 'screen copy') displays and controls your Android device from the computer: it mirrors video and audio over USB or TCP/IP and lets you drive the phone with your keyboard and mouse.
Do I need to install anything on my phone?Nothing — it is a desktop app for Linux, Windows, and macOS. It needs no root access and leaves nothing installed on the Android device.
What does it take to start mirroring my phone?Install the app for your OS, enable USB debugging in the phone's developer options, then plug in a cable or connect over TCP/IP.
Will my Android version be supported?Any device with Android 5.0 (API 21) or newer works; audio forwarding needs Android 11+ and camera mirroring needs Android 12+.
Are there devices where control does not work right away?Yes — on some phones, notably Xiaomi, you must additionally enable 'USB debugging (Security Settings)' and reboot the device before keyboard and mouse control works.
Does mirroring send anything to the internet?No. scrcpy works with no account, no ads, and no internet required — the screen and audio travel over your own USB or TCP/IP link.
How smooth is the mirroring in practice?Expect 30~120fps depending on the device, 1920×1080 or above, 35~70ms of latency, and roughly one second until the first image appears.
What can it do beyond plain mirroring?It records the screen, mirrors while the Android screen stays off, copy-pastes in both directions, runs apps in virtual displays, simulates a physical keyboard and mouse over HID, supports gamepads, and has an OTG mode.
Can it use the phone's camera or act as a webcam?Yes — on Android 12+ it can mirror the camera and record it to MP4, and on Linux it can expose the device's front camera as a webcam via V4L2.
Any must-know shortcuts once it is running?Right-click triggers BACK, middle-click triggers HOME, Alt+f toggles fullscreen, and running scrcpy -m1024 to lower the resolution can greatly improve performance.
Creator
Genymobile
Size
9 MB
Stars
152.3K
Age
8y
Commits · 90 Days