README.md
<p align="center">
<img src="https://raw.githubusercontent.com/srevinsaju/guiscrcpy/master/guiscrcpy/ui/ui/guiscrcpy_logo.png" alt="guiscrcpy logo" width=128 height=128>
<h2 align="center">📱 guiscrcpy</h2>
<p align="center">
A simple, pluggable, graphical user interface for the fastest Android screen mirroring software, <a href="https://github.com/Genymobile/scrcpy">scrcpy</a>
</p>
</p>
> [!WARNING]
> This repository is archived. Please see [#348](https://github.com/srevinsaju/guiscrcpy/348) for more information.
<div align="center">
[](https://g.srev.in/get-appimage/guiscrcpy/)
[](https://aur.archlinux.org/packages/guiscrcpy)
[](https://snapcraft.io/guiscrcpy)
[](https://github.com/srevinsaju/guiscrcpy/releases)
[](https://matrix.to/#/#guiscrcpy:matrix.org)
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://github.com/srevinsaju) [](https://github.com/srevinsaju/guiscrcpy/stargazers)
 
[](https://www.codacy.com/gh/srevinsaju/guiscrcpy/dashboard?utm_source=github.com&utm_medium=referral&utm_content=srevinsaju/guiscrcpy&utm_campaign=Badge_Grade) [](https://codeclimate.com/github/srevinsaju/guiscrcpy/maintainability)
</div>
guiscrcpy is a multiplatform, ready-to-use GUI layer for Android to PC screen mirroring written in the advancing programming language python3 for the most award winning open-source android screen mirroring system -- `scrcpy` located on `https://github.com/genymobile/scrcpy/` by [@rom1v](https://github.com/rom1v)
<br>
## Installation
These are the common methods of installation. To see more interesting ways, checkout [Installation wiki](docs/INSTALL.md) page for more information, and to find a compatible installation method for your device and device architecture
>NOTE: Out of the two links for downloading AppImage, the `.m` one does not include the scrcpy binary. The one with `.r` includes the scrcpy binary. See https://github.com/srevinsaju/guiscrcpy/discussions/341 for more information on the release builds.
| Package Type | Platforms | Status | Command / Link |
| ------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ----------------------------- |
| Flatpak | <img src="https://guiscrcpy.github.io/img/linux.png" height=15px> | [](https://flathub.org/apps/details/in.srev.guiscrcpy) | `flatpak install flathub in.srev.guiscrcpy` |
| Snap Store | <img src="https://guiscrcpy.github.io/img/linux.png" height=15px><img src="https://guiscrcpy.github.io/img/darwin.jpeg" height=15px style="border-radius: 50%"> | [](https://snapcraft.io/guiscrcpy) | `sudo snap install guiscrcpy` |
| AUR* | <img src="https://raw.githubusercontent.com/guiscrcpy/guiscrcpy.github.io/master/img/archlinux.png" height=15px> | [](https://aur.archlinux.org/packages/guiscrcpy) | `yay -S guiscrcpy` |
| Windows (exe) | <img src="https://guiscrcpy.github.io/img/windows.png" height=15px> | [](https://github.com/srevinsaju/guiscrcpy/actions/workflows/continuous.yml) | [Download `.exe`](https://github.com/srevinsaju/guiscrcpy/releases/tag/v2023.1.1) |
| AppImage | <img src="https://guiscrcpy.github.io/img/linux.png" height=15px> | [](https://github.com/srevinsaju/guiscrcpy/actions/workflows/continuous.yml) | [Download `.AppImage`](https://github.com/srevinsaju/guiscrcpy/releases/tag/v2023.1.1) |
<br>
## Table of Contents
1. [Installation](docs/INSTALL.md) (detailed)
2. [Features](docs/FEATURES.md)
3. [Configuration files](docs/CONFIGURATION.md)
4. [FAQ](docs/FAQ.md)
<br>
## Further reading
Thanks to users around the world,
you may like to see some articles written by well wishers:
* [Mirror your Android screen on your computer with Guiscrcpy - opensource.com](https://opensource.com/article/19/9/mirror-android-screen-guiscrcpy)
* [Helper GUI For scrcpy, The Android Desktop Display And Remote Control Tool - linuxuprising.com](https://www.linuxuprising.com/2019/09/helper-gui-for-scrcpy-android-desktop.html)
* [Mirror your Android display screen in your laptop with Guiscrcpy - breakingexpress.com](https://breakingexpress.com/2019/09/26/mirror-your-android-display-screen-in-your-laptop-with-guiscrcpy/)
* [guiscrcpy demonstration (windows) - Youtube](https://www.youtube.com/watch?v=Uc1ozt4AtrY)
* [guiscrcpy = OpenCollective](https://opencollective.com/guiscrcpy)
## Contributors
### Code Contributors
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
<a href="https://github.com/srevinsaju/guiscrcpy/graphs/contributors"><img src="https://opencollective.com/guiscrcpy/contributors.svg?width=890&button=false" /></a>
### Financial Contributors
Thanks to everyone who supported `guiscrcpy`! It definitely meant a lot.
#### Individuals
<a href="https://opencollective.com/guiscrcpy"><img src="https://opencollective.com/guiscrcpy/individuals.svg?width=890"></a>
## License
```
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Icon made by Dave Gandy from www.flaticon.com used under
Creative Commons 3.0 Unported. The original SVG black work
by Dave Gandy has been re-oriented, flipped or color-changed.
The rest of Terms and Conditions put forward by
CC-3.0:Unported has been feverently followed by the developer.
Icons pack obtained from www.flaticon.com
All rights reserved.
```
---------------------
Copyright © 2019 - 2023 [Srevin Saju](https://github.com/srevinsaju) and `guiscrcpy` contributors.