Skip to content
MirallDroid provides display and control of Android devices connected on USB (or over TCP/IP).
C Java Meson Objective-C Shell Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
assets
config
gradle/wrapper
prebuilt-deps
scripts
server
.gitignore
BUILD.md
DEVELOP.md
FAQ.md
LICENSE
Makefile.CrossWindows
README.md
build.gradle
cross_win32.txt
cross_win64.txt
gradle.properties
gradlew
gradlew.bat
meson.build
meson_options.txt
release.sh
run
settings.gradle

README.md

MirallDroid is a fork based on SCRCPY available https://github.com/Genymobile/scrcpy

miralldroid (v1.0)

This application provides display and control of Android devices connected on USB (or over TCP/IP). It does not require any root access. It works on GNU/Linux, Windows and MacOS.

screenshot1 screenshot2

Requirements

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

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

On some devices, you also need to enable an additional option to control it using keyboard and mouse.

Get the app

Linux

On Linux, you typically need to build the app manually. Don't worry, it's not that hard.

Windows

For Windows, for simplicity, prebuilt archives with all the dependencies (including adb) are available:

You can also build the app manually.

Run

Plug an Android device, and execute:

miralldroid

It accepts command-line arguments, listed by:

miralldroid --help

Features

Reduce size

Sometimes, it is useful to mirror an Android device at a lower definition to increase performances.

To limit both width and height to some value (e.g. 1024):

miralldroid --max-size 1024
miralldroid -m 1024  # short version

The other dimension is computed to that the device aspect-ratio is preserved. That way, a device in 1920×1080 will be mirrored at 1024×576.

Change bit-rate

The default bit-rate is 8Mbps. To change the video bitrate (e.g. to 2Mbps):

miralldroid --bit-rate 2M
miralldroid -b 2M  # short version

Crop

The device screen may be cropped to mirror only part of the screen.

This is useful for example to mirror only 1 eye of the Oculus Go:

miralldroid --crop 1224:1440:0:0   # 1224x1440 at offset (0,0)
miralldroid -c 1224:1440:0:0       # short version

If --max-size is also specified, resizing is applied after cropping.

Wireless

Miralldroid uses adb to communicate with the device, and adb can connect to a device over TCP/IP:

  1. Connect the device to the same Wi-Fi as your computer.
  2. Get your device IP address (in Settings → About phone → Status).
  3. Enable adb over TCP/IP on your device: adb tcpip 5555.
  4. Unplug your device.
  5. Connect to your device: adb connect DEVICE_IP:5555 (replace DEVICE_IP).
  6. Run miralldroid as usual.

It may be useful to decrease the bit-rate and the definition:

miralldroid --bit-rate 2M --max-size 800
miralldroid -b2M -m800  # short version

Record screen

It is possible to record the screen while mirroring:

miralldroid --record file.mp4
miralldroid --record file.mkv
miralldroid -r file.mp4
miralldroid -r file.mkv

2 Video file formats are accepted: Matroska (MKV) or MP4. If no valid extension specified, MP4 will be the video file format by default.

"Skipped frames" are recorded, even if they are not displayed in real time (for performance reasons). Frames are timestamped on the device, so packet delay variation does not impact the recorded file.

Multi-devices

If several devices are listed in adb devices, you must specify the serial:

miralldroid --serial 0123456789abcdef
miralldroid -s 0123456789abcdef  # short version

You can start several instances of miralldroid for several devices.

Fullscreen

The app may be started directly in fullscreen:

miralldroid --fullscreen
miralldroid -f  # short version

Fullscreen can then be toggled dynamically with Ctrl+f.

Always on top

The window of app can always be above others by:

miralldroid --always-on-top
miralldroid -T  # short version

OnScreen Menus

The app may be started hiding onscreen menus :

miralldroid --onscreen_menus_off
miralldroid -n  # short version

onscreen_menus can then be toggled dynamically with Ctrl+n.

Show touches

For presentations, it may be useful to show physical touches (on the physical device).

Android provides this feature in Developers options.

Miralldroid provides an option to enable this feature on start and disable on exit:

miralldroid --show-touches
miralldroid -t

Note that it only shows physical touches (with the finger on the device).

Install APK

To install an APK, drag & drop an APK file (ending with .apk) to the miralldroid window.

There is no visual feedback, a log is printed to the console.

Push file to device

To push a file to /sdcard/ on the device, drag & drop a (non-APK) file to the miralldroid window.

There is no visual feedback, a log is printed to the console.

Forward audio

Audio is not forwarded by miralldroid.

Shortcuts

Action Shortcut
switch fullscreen mode Ctrl+f
toggle onscreen_menus Ctrl+n
resize window to 1:1 (pixel-perfect) Ctrl+g
resize window to remove black borders Ctrl+x | Double-click¹
click on HOME Ctrl+h | Middle-click
click on BACK Ctrl+b | Right-click²
click on APP_SWITCH Ctrl+s
click on MENU Ctrl+m
click on VOLUME_UP Ctrl+ (up) (Cmd+ on MacOS)
click on VOLUME_DOWN Ctrl+ (down) (Cmd+ on MacOS)
click on POWER Ctrl+p
turn screen on Right-click²
paste computer clipboard to device Ctrl+v
enable/disable FPS counter (on stdout) Ctrl+i

¹Double-click on black borders to remove them.
²Right-click turns the screen on if it was off, presses BACK otherwise.

How to build?

See BUILD.

Common issues

See the FAQ.

Developers

Read the developers page.

Licence

Based on the project scrcpy from Genymobile https://github.com/Genymobile/scrcpy

Copyright (C) 2018 https://www.vispo.org

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.
You can’t perform that action at this time.