📱 Graphical Scrcpy to display and control Android, devices powered by Electron. | 使用图形化的 Scrcpy 显示和控制您的 Android 设备,由 Electron 驱动。
Go to file
2024-07-25 13:01:57 +08:00
.github/workflows fix: 🐛 Fixed asset publishing issues 2024-07-25 13:01:28 +08:00
.husky feat: 🚀 Add timing task entrance 2024-07-19 19:21:44 +08:00
.vscode perf: Support for custom startup mirroring 2024-07-12 01:53:09 +08:00
copilot perf: 🐛 Global search error 2024-05-15 11:16:02 +08:00
electron feat: 🚀 Support execution script function 2024-07-12 20:11:44 +08:00
public fix: 🐛 修复 macOS 最小化到托盘后状态栏图标不显示的问题 2023-10-24 11:08:27 +08:00
screenshots docs: 📝 Update screenshots 2024-07-25 10:44:55 +08:00
src fix: 💄 Optimize wireless connection user interface 2024-07-25 10:28:28 +08:00
.eslintrc-auto-import.json feat: 🚀 Add a scheduled task list 2024-07-24 19:06:34 +08:00
.gitignore fix: 🐛 Fix dependency build errors 2024-07-13 21:08:29 +08:00
.npmrc fix: 💄 Optimize wireless connection user interface 2024-07-25 10:28:28 +08:00
.nvmdrc build: 📝 Update 2024-07-13 21:32:42 +08:00
.yarnrc feat: 📝 添加基本的有线连接支持 2023-09-15 19:32:13 +08:00
auto-imports.d.ts feat: 🚀 Add a scheduled task list 2024-07-24 19:06:34 +08:00
CHANGELOG.md chore(main): release 1.22.1 2024-07-25 13:01:57 +08:00
components.d.ts feat: 🚀 Add a scheduled task list 2024-07-24 19:06:34 +08:00
dev-publish.yml refactor: 🚀 对目录结构和代码逻辑进行重构 2023-10-16 11:53:08 +08:00
electron-builder.json build: Add appx build 2023-11-14 15:22:26 +08:00
eslint.config.js perf: ♻️ FindInPage API 2024-05-13 22:49:39 +08:00
index.html perf: 🍻 Update base copilot 2023-11-21 16:37:02 +08:00
jsconfig.json perf: 🐛 Global search error 2024-05-15 11:16:02 +08:00
LICENSE docs: 📝 Update LICENSE 2023-11-14 17:24:46 +08:00
package.json chore(main): release 1.22.1 2024-07-25 13:01:57 +08:00
postcss.config.js feat: 🚀 Update dependencies to support ESM 2024-05-08 11:02:00 +08:00
README-CN.md feat: 🚀 Add a scheduled task list 2024-07-24 19:06:34 +08:00
README.md feat: 🚀 Add a scheduled task list 2024-07-24 19:06:34 +08:00
unocss.config.js feat: 🚀 Add a scheduled task list 2024-07-24 19:06:34 +08:00
vite.config.js perf: 🐛 Global search error 2024-05-15 11:16:02 +08:00

viarotel-escrcpy

Escrcpy

📱 Display and control your Android device with a graphical interface of Scrcpy powered by Electron. 中文文档

viarotel-escrcpy

Features

  • 🏃 Synchronous: Benefit from web technologies to synchronize with Scrcpy faster
  • 🤖 Automation: Auto-connect devices, auto-execute images, custom scripts, scheduled tasks
  • 💡 Customization: Multi-device management, independent configurations, custom notes, config import/export
  • 🔗 Reverse tethering: Gnirehtet reverse tethering
  • 🎨 Themes: Light mode, dark mode, system-based switching
  • 😎 Lightweight: Native support, only display device screen
  • Performance: 30-120 fps depending on device
  • 🌟 Quality: 1920×1080 or higher
  • 🕒 Low latency: 35~70 ms
  • 🚀 Quick startup: Display first image in about 1 second
  • 🙅‍♂️ Non-intrusive: No installation residual left on Android device
  • 🤩 User benefits: No account, no ads, no internet required
  • 🗽 Free and open source

Get Software Packages

Check release addresses

Quick Start

USB Connection

Note: If the phone prompts for debugging authorization, click allow

  1. Enable developer mode and USB debugging on your Android phone
  2. Open Escrcpy and connect your Android phone to your computer
  3. The device list in Escrcpy should have detected your phone, click start mirroring
  4. Enjoy!

WIFI Connection

Note: Wireless debugging needs to be enabled on your phone's wireless debugging page to get the IP address (usually the IP assigned when connecting to WIFI) and port number (default 5555) of the device

  1. Follow steps 1-2 in USB Connection
  2. Input the device IP address and port number obtained to Escrcpy and click connect device
  3. The device list in Escrcpy should have detected your phone, click start mirroring
  4. Enjoy!

macOS && Linux

Note: These platforms do not come with integrated Scrcpy, you need to install them manually

  1. Refer to the installation document for Linux
  2. Refer to the installation document for macOS
  3. Follow steps in USB Connection and WIFI Connection after dependencies are installed successfully

Gnirehtet Reverse Tethering

Note: macOS does not have Gnirehtet built-in. You need to manually install it to use this feature Installation Guide.

Gnirehtet is built into the Windows and Linux apps to provide reverse tethering from PC to Android devices.

Shortcuts

Refer to scrcpy/doc/shortcuts

Device Operation

Batch Processing

  • Batch Interception Screen
  • Batch Installation Application
  • Batch File Management
  • Batch Execution Script
  • Batch Scheduled Task

Control Model

  • Mirror
  • Recording
  • OTG
  • Camera
  • Custom

Device Interaction Bar

  • Switch
  • Home
  • Back
  • Notification
  • Power
  • Rotation
  • Volume
  • Screenshot
  • Reboot
  • Install APP
  • File Manager
  • Execution Script
  • Scheduled Task
  • Gnirehtet
  • Mirror Group

Preferences

Continuously improving. Currently supports the following common configurations

General

  • Change theme
  • Adjust language
  • File storage path (for storing audio/video recordings and device screenshots)
  • ADB path
  • Scrcpy path
  • Gnirehtet path
  • Scrcpy parameters
  • Auto-connect to historical devices
  • Gnirehtet Fix
  • Enable debugging

Video Control

  • Maximum size
  • Video bitrate
  • Refresh rate
  • Video encoding
  • Display orientation
  • Screen clipping
  • Monitor
  • Video buffering
  • Receiver (v4l2) buffering

Device Control

  • Show touch points
  • Keep awake
  • Turn off screen during control
  • Turn off screen after control
  • Disable auto-brightness during control
  • Simulate auxiliary display

Window Control

  • Window width
  • Window height
  • Window X coordinate
  • Window Y coordinate
  • Borderless mode
  • Fullscreen mode
  • Always on top
  • Disable screensaver

Audio Control

  • Audio source
  • Audio encoding
  • Audio bitrate
  • Audio buffering
  • Audio output buffering

Audio/Video Recording

  • Video recording format
  • Video recording orientation
  • Recording duration
  • Disable video recording
  • Disable audio recording
  • Disable video playback
  • Disable audio playback

Input Control

  • Mouse mode
  • Mouse binding
  • Keyboard mode
  • Keyboard injection method

Camera Control

  • Camera source
  • Camera resolution
  • Camera aspect ratio
  • Camera frame rate

Next Steps?

Priority from high to low:

  1. Improved logo
  2. Software update feature
  3. Record and save audio/video
  4. Device quick interaction control bar
  5. Custom Adb and Scrcpy dependencies
  6. Custom device names
  7. Export and import preferences
  8. Individual device configuration
  9. macOS and Linux support
  10. Internationalization
  11. Dark mode
  12. Reverse tethering (Gnirehtet)
  13. Camera mirroring
  14. Multi-screen collaboration
  15. File push, screen rotation, audio control
  16. Batch connect historical devices
  17. Built-in terminal
  18. Auto-execute mirroring
  19. Flexible mirroring launch
  20. Batch processing
  21. Scheduled tasks
  22. Device grouping 🚧
  23. File transfer assistant 🚧
  24. Manage device files via interface 🚧
  25. Game key mapping 🚧

FAQ

Computer cannot detect device after connecting

  1. Please unplug and reconnect your device, and make sure the device has granted USB debugging authorization.
  2. If it still doesn't work, your computer may be missing necessary drivers. Please install drivers using third-party tools such as DriverWizard and try again.

Unable to enter Chinese

This issue is known - Scrcpy doesn't seem to have tested and supported direct Chinese input. It's recommended to install a third-party input method on the phone that can well support, such as:

  • Sogou Input
  • QQ Input
  • Google Pinyin Input
  • Gboard

Wireless connection prompts: The target computer actively refuses access

The first wireless connection may require pairing. Alternatively, insert USB to ensure connection establishment and authorization success before using wireless.

Clicking wireless mode after connecting via data cable has no response

Please click again, or click refresh devices. Generally it will not exceed two clicks. If still not working, please provide device model and Android version to Issues

Why is the device interaction control bar not designed as an automatically sticking floating menu?

Adopting the floating menu approach will inevitably increase coupling with Scrcpy and difficulty in synchronization updates. Many similar ScrcpyGUI softwares had to invest a lot of effort in this approach and eventually gave up development due to update difficulties. Therefore, taking overall considerations, we decided to adopt the existing approach and look forward to Scrcpy's native support for an interaction control bar in the future.

Some devices can see screenshots after connecting but cannot operate

Note: For Xiaomi phones in particular, it requires not only enabling USB debugging but also enabling USB debugging (Security Settings), which is to allow modifying permissions or simulating clicks via USB debugging.

Please refer to the detailed instructions under Reasons why mouse and keyboard do not work

Downloading prompts antivirus detection causing unable to download normally

After feedback, Windows Defender may occasionally block the software packages from being downloaded due to lack of certificate signing. You can try the following solutions:

  1. Open Windows Security Center.
  2. Select Virus & threat protection.
  3. In the Virus & threat protection settings, click Manage settings.
  4. Find Real-time protection, you can try clicking Disable if permission allows. If unable to disable real-time protection, please skip this step.
  5. Scroll down the page, find Exclusions, click Add or remove exclusions.
  6. Add the folder path where you download the software packages as an exclusion item, i.e. add the folder to the Excluded list.

Failed to get device list or error when starting mirroring/recording

This is generally caused by an incorrect path for Adb or Scrcpy, you can try the following solutions:

  1. In the menu, select Preferences and then click the reset configuration button in the top right corner of Global Mode.
  2. Go to the Device List page and try enabling mirroring again.
  3. Make sure you have downloaded and installed the latest version of Escrcpy.
  4. Press Ctrl + Shift + I to open the developer tools and check for any error messages.
  5. If there are errors, take a screenshot and submit your issue with the screenshot on the Feedback Issues page.

macOS window minimized to system tray icon not found

This is generally caused by too many icons in the system tray overflowing and hiding the Escrcpy icon. Try using the following tools:

After a successful installation of macOS, when I try to open it, I receive a prompt saying the file is damaged.

This is usually due to the software package not being signed. You can try the following solutions:

  1. Open Terminal and execute sudo spctl --master-disable to allow software from any source.
  2. Open Terminal and execute sudo xattr -r -d com.apple.quarantine [AppPath] to attempt fixing the damaged software package prompt.

Only support Windows 10 and above versions.

Audio capture exception causing mirroring failure.

This usually happens because your computer lacks audio output or you have a low Android version (Android 11+).

Please try disabling audio forwarding feature through the preferences settings to resolve this issue.

Getting Help

As this is an open source project run entirely by donations, support is limited and updates may not be on a fixed schedule.

Acknowledgements

This project would not be possible without the following open source projects:

Support the Project

If this project has helped you, you can buy me a coffee to keep me energized and improving the project! 😛

Contributors

Thanks for all their contributions!

contributors

Star History

Star History Chart