An open API service indexing awesome lists of open source software.

https://github.com/georgeenglezos/scrcpy-gui

An unofficial beginner-friendly user interface for the Scrcpy Project
https://github.com/georgeenglezos/scrcpy-gui

mirror scrcpy scrcpy-android scrcpy-gui scrcpy-ui screencast

Last synced: 4 months ago
JSON representation

An unofficial beginner-friendly user interface for the Scrcpy Project

Awesome Lists containing this project

README

          

# Scrcpy GUI

[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-blue)]()

A modern, cross-platform graphical user interface for [scrcpy](https://github.com/Genymobile/scrcpy) - the powerful Android screen mirroring and control tool.

---

## 🎯 Overview

Scrcpy GUI transforms the command-line scrcpy experience into an intuitive graphical interface, making Android device mirroring and control accessible to everyone. Built with Flutter, this application provides a seamless experience across Windows, macOS, and Linux platforms.

### What is scrcpy?

[scrcpy](https://github.com/Genymobile/scrcpy) is an open-source tool that provides display and control of Android devices connected via USB or TCP/IP. It's lightweight, high-performance, and requires no root access.

### What does Scrcpy GUI add?

- **Visual Command Builder** - Generate complex scrcpy commands without memorizing flags
- **Multi-Device Management** - Control multiple Android devices simultaneously
- **Wireless Setup** - One-click wireless connection configuration
- **Process Monitoring** - Track and manage all running scrcpy instances
- **Command Favorites** - Save and reuse your frequently used configurations
- **Real-time Preview** - See generated commands with syntax highlighting
- **Cross-Platform** - Native support for Windows, macOS, and Linux

---

## πŸš€ Quick Start

### Prerequisites

1. **scrcpy** - Install from [official repository](https://github.com/Genymobile/scrcpy#get-the-app)
- Windows: `scoop install scrcpy` or `choco install scrcpy`
- macOS: `brew install scrcpy`
- Linux: `sudo apt install scrcpy`

2. **ADB (Android Debug Bridge)** - Usually included with scrcpy

3. **Android Device** - With USB debugging enabled
- Go to Settings β†’ About Phone β†’ Tap "Build Number" 7 times
- Go to Settings β†’ Developer Options β†’ Enable "USB Debugging"

### Installation

Download the latest release for your platform from the [Releases](https://github.com/GeorgeEnglezos/Scrcpy-GUI/releases) page:

- **Windows**: `scrcpy-gui-windows-vX.X.X.zip`
- **macOS**: `scrcpy-gui-macos-vX.X.X.zip`
- **Linux**: `scrcpy-gui-linux-vX.X.X.zip`

Extract and run the executable for your platform.

### First Use

1. Connect your Android device via USB
2. Accept the USB debugging authorization prompt on your device
3. Launch Scrcpy GUI
4. Your device should appear in the dropdown within 2 seconds
5. Click **Run** to start mirroring

That's it! Your Android screen should now be mirroring on your computer.

---

## ✨ Key Features

### 🎨 Visual Command Builder

Configure all scrcpy options through an intuitive interface organized into themed panels:

- **General Commands** - Window settings, display options, video encoding
- **Audio Commands** - Audio quality, codec selection, source configuration
- **Recording Commands** - Screen recording with format and quality controls
- **Camera Commands** - Mirror device cameras instead of screen
- **Virtual Display** - Create and manage virtual displays
- **Input Control** - Keyboard and mouse configuration
- **Network Connection** - Wireless setup and SSH tunneling
- **Advanced Options** - Developer settings and debugging tools

### πŸ“± Device Management

- **Automatic Detection** - Devices discovered every 2 seconds
- **USB and Wireless** - Support for both connection types
- **Multi-Device** - Control multiple devices simultaneously
- **Device Information** - Cached codecs, packages, and capabilities

### πŸ”„ Wireless Connection

Set up wireless mirroring with a single click:

1. Connect device via USB initially
2. Click "Connect Wirelessly"
3. Disconnect USB cable
4. Continue mirroring over WiFi

No manual ADB commands required!

### ⭐ Favorites System

- Save unlimited command configurations
- Track execution frequency
- Quick access from dedicated page
- Export as executable scripts

---

## πŸ“– Documentation

- **[Troubleshooting](Docs/TROUBLESHOOTING.md)** - Quick fixes for common issues
- **[API Reference](Docs/API_REFERENCE.md)** - Developer documentation

---

## πŸ–ΌοΈ Screenshots


Home - Command Builder
Home - Command Builder


Favorites
New Scripts Tab


Resources - Help
Settings - Configuration

6 - Running instances

---

## πŸ’» Platform Support

| Platform | Status | Notes |
|----------|--------|-------|
| Windows | βœ… Fully Supported | Windows 10/11 |
| macOS | βœ… Fully Supported | macOS 10.15+ (Intel & Apple Silicon) |
| Linux | βœ… Fully Supported | Ubuntu 20.04+, Debian, Fedora, Arch |

---

## 🌐 Web Version

Looking for a browser-based alternative? Check out the web companion app:

**πŸ”— [https://scrcpy-ui.web.app/](https://scrcpy-ui.web.app/)**

### Web App Advantages

- βœ… No installation required
- βœ… Works on any operating system
- βœ… Faster and more accessible
- βœ… Package, codec, and encoder selection

---

## 🀝 Contributing

Contributions are welcome! Here's how you can help:

1. **Report Bugs** - Open an issue with detailed reproduction steps
2. **Suggest Features** - Share your ideas in the discussions
3. **Improve Documentation** - Help make the docs clearer
4. **Share** - Tell others about the project
5. **Donation** - Make a small donation in paypal

---

## πŸ“ž Support

- **Issues**: [GitHub Issues](https://github.com/GeorgeEnglezos/Scrcpy-GUI/issues)
- **scrcpy Documentation**: [Official Docs](https://github.com/Genymobile/scrcpy)

---

## πŸ—ΊοΈ Project History

This project began as a .NET MAUI experiment to make scrcpy more user-friendly on Windows. With version 1.6, it has been completely ported in Flutter to provide true cross-platform support for Windows, macOS, and Linux.

The original .NET MAUI version (v1.5.1) is archived in the repository for reference but is no longer maintained.

---

**Made with ❀️ for the Android enthusiast community**

[⬆ Back to Top](#scrcpy-gui)