hammy275 / scrcpy-gui

A GUI application written in Python for easily creating scrcpy sessions.

scrcpy-gui

A tool allowing you to use scrcpy from a comfy GUI, without having to memorize any command-line parameters and to connect easily through Wi-Fi or USB!

Requirements

• A system running Windows or Linux (untested on macOS, but it should work there)

If you're running on macOS and/or you're running from the .py file, you also need:

• An installation of Python 3
• scrcpy and adb added to PATH (on Linux this can be done by installing scrcpy from your distro's repositories such as the AUR or Snap's repositories and adb through something such as apt.)
• PySimpleGUI installed (python3 -m pip install PySimpleGUI or python -m pip install PySimpleGUI)

Using

• If you're using Windows or Linux, you can just go to the releases page, and download the latest release of the exe file.
• If you're using the raw python file, you should be able to simply run the python file with a command such as: python3 main.py or python main.py (depending on if your default Python installation is Python 3 or not)

scrcpy-gui's Issues

Install scrcpy/ADB

If not installed, the software should prompt to install ADB and scrcpy. If the user agrees to have them installed, it should use the operating system's preferred methods to install (Windows would be extracting the scrcpy zip to a directory to be determined, while an Ubuntu-based system would be to apt install adb and snap install scrcpy.

Stop Using snap

Auto setup for Linux should not use snap

Modern ADB Wi-Fi Support

Modern versions of Android (11+, iirc) have support for direct Wi-Fi ADB through a pairing code. This should be supported!

Skip Initial Wi-Fi Setup if Possible

If a user has previously connected through Wi-Fi, there should be an option to skip the initial USB process.

Add images to your readme?

I've noticed that projects that have images in their readme file get a lot more attention than those with just text.

Your program is a visual one. People are curious what it looks like. Even what you believe is the most basic looking GUI is often interesting to other people.

Catch up with modern scrcpy

scrcpy-gui was built off of scrcpy_helper, and such only has features from up to scrcpy version 1.4. More options need to be added to the GUI to catch up to scrcpy's latest release.

"distro" install has dumb check

The distro package, if needed, will only install if PySimpleGUI was also asked to be installed on that run of scrcpy-gui and the user accepted said install.

Save Settings

Settings should be saved between launches of scrcpy-gui for convenience.

requirements.txt

Text Corrections

Not really that much of a bug but the custom settings that don't require text to be filled in have :'s on the end just like the ones that do require text to be filled in. Just have to get rid of them.

Custom Port

Allow users to chose a custom port for communication if using Wi-Fi.

Semi-Automatic Pip Installs

If a required package isn't found, the user should be prompted if they want to let scrcpy-gui install it or not. If so, it should install the package for the user.

Failed to execute script main

When scrcpy is started, the application throws an error "failed to execute script main" if run after being turned into a binary with pyinstaller.

Linux Auto Setup

Windows has support for auto setup (no need to download adb or scrcpy, scrcpy-gui takes care of it for the user). A similar process should take place for Linux systems.

Currently I plan to have Ubuntu systems apt install android-tools-adb and snap install scrcpy., while Arch based systems will use the AUR to install the scrcpy package (I currently don't have a running Arch system, so I'll have to set up a VM and go from there).

Get Device Authorized

GUI should walk users through device authorization first time around.