docs/INSTALL.md
# Installation
## AppImages  [](https://g.srev.in/get-appimage/guiscrcpy/)
AppImages are distributed on the AppImage catalog and on the releases page. To get seamless updates and desktop integration, install the AppImage
with [Zap AppImage Package Manager](https://github.com/srevinsaju/zap), and then just run
```bash
zap install guiscrcpy
```
and you are done!
If you already installed an older version of guiscrcpy
using `zap`, then it would be easier to download only the
changed parts, (or delta) of the binary. Just do
```bash
zap update guiscrcpy
```
Alternatively, the longer method :
Download the AppImage either from the releases, or from by clicking the `Status` badge and then download the AppImage artifact for the latest commit.
**AppImages** are built on `manylinux2014` base image. Older linux might / might not support it. A possible test for it, might be to check if you can install the `wheel` of `PyQt5>=5.14`.
AppImages are more supported than snaps. Snaps are containerised. So it is likely that guiscrcpy might not work as a snap.
```bash
wget https://github.com/srevinsaju/guiscrcpy/releases/v4.11.3/download/guiscrcpy-*.AppImage
chmod +x guiscrcpy-*.AppImage
# one time execution
./guiscrcpy-*.AppImage
# for systems without FUSE support
guiscrcpy-x86_64.AppImage --appimage-extract-and-run
```
> NOTE: The AppImage includes `scrcpy` pre-built binary along
along with adb. This implies you do not need to have anything
additionally installed other than to download this AppImage.
For some linux desktops, it would be needed to install
`libva-drm2` or `libva` to enable scrcpy's new video acceleration
feature using OpenGL.
On ubuntu, if you have enabled `universe` repositories, you can just
Ubuntu:
```bash
sudo apt install libva-drm2
```
The bug was found on ubuntu. Tested on Ubuntu 20.10, 20.04 (GNOME). Most linux distros (not live CDs) have these installed on them by default. I do not mind bundling this lib too, but it might break other linux'es. So feel free to pop into `guiscrcpy` 's Discord channel or open a GitHub issue, if you need some help.
[](https://srevinsaju.github.io/get-appimage/guiscrcpy)
<br>
## Flatpak
```bash
flatpak install flathub in.srev.guiscrcpy
```
<br>
## Snap Store [](https://snapcraft.io/guiscrcpy) [](https://snapcraft.io/guiscrcpy)
The guiscrcpy [snap](https://snapcraft.io) is a recent implementation of making `guiscrcpy` widely accessible for Ubuntu and its derivatives, and other operating systems with `snap` pre-installed. This increases the security, if you are concerned about them, and while using `guiscrcpy` because, “snap is confined”.
What makes a snap better than the `PyPI` package is:
* security
* `guiscrcpy` works out of the box, meaning,`scrcpy` and `adb` are pre-installed on the `guiscrcpy` snap. Thanks to [@sisco311](https://github.com/sisco311/scrcpy-snap)
`guiscrcpy` snap is supported for all `AMD64` aka `x86_64` devices which support the [`snappy daemon`](https://snapcraft.io/docs/installing-snapd). macOS is an exception from the list. Use `brew` to install `snapd`
[](https://snapcraft.io/guiscrcpy)
> **NOTE**:
>
> For issues regarding the:
>
> * Failure of `scrcpy`: Please create an issue at [sisco311/scrcpy-snap](https://github.com/sisco311/scrcpy-snap/issues) and make sure that a similar issue does not exist. You wouldn’t want to disturb the developer
> * Failure of `guiscrcpy`: Please report it [here](https://github.com/srevinsaju/guiscrcpy/issues)
<br>
## Windows Executable [](https://github.com/srevinsaju/guiscrcpy/actions?query=+event%3Apush++is%3Asuccess+branch%3Amaster+workflow%3A%22Windows+Executable%22)
`guiscrcpy` provides a compiled windows executable, for users who are not interested in installing python and `pip`. Although this is not, suggested (guiscrcpy is converted to the compiled python `*.pyc`), it is useful for end consumers on the Windows system.
Download the windows `.exe` either from releases, or click on the status badge to download the `exe `matching the latest commit.
Along with `guiscrcpy.exe`; You would also want to download windows binary of [scrcpy](https://github.com/Genymobile/scrcpy/releases/latest) and extract the `.zip` file to any directory you wish to. You may add it to path, if you like; but it is completely optional. If `scrcpy` is not found on `PATH`, guiscrcpy will open a file selector to select `scrcpy.exe`, `adb.exe` and `scrcpy-server`.
Optionally, to get better appearance, you would like to install [Titillium Web](https://fonts.google.com/specimen/Titillium+Web).
> **NOTE**: Windows Binaries are now available only for 64-bit. If you would like to have 32-bit binary, please build `guiscrcpy` from source
<br>
## Building from source 
See [BUILD](BUILD.md) for more information