Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shashwat2003 authored Aug 1, 2020
1 parent a96af2f commit 1ad76f1
Showing 1 changed file with 72 additions and 2 deletions.
74 changes: 72 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,72 @@
# uicy
uiCY is an Open-Source GUI program based on scrCPY(Genymobile) and sndCPY(rom1v).It can be used to mirror your phone screen + internal audio to your PC(Windows/Linux)through USB data cable. It was made keeping bugdet gamers and streamers in mind whocannot afford devices like Elgato. Indeed this program cannot give as much qualityas Elgato but still it serves the purpose i.e. you can easily stream/record at 480p.
![uicy](https://user-images.githubusercontent.com/68629996/89100304-a66f4a80-d413-11ea-94ef-284592389517.png)
# Introduction to uiCY

>uiCY is an Open-Source GUI program based on [scrCPY(Genymobile)](https://github.com/Genymobile/scrcpy) and [sndCPY(rom1v)](https://github.com/rom1v/sndcpy).It can be used to mirror your phone screen + internal audio to your PC(Windows/Linux)through USB data cable. It was made keeping bugdet gamers and streamers in mind whocannot afford devices like Elgato™. Indeed this program cannot give as much quality as Elgato™ but still it serves the purpose i.e. you can easily stream/record at 480p.
# Pre-requisite
- Android 10 running smartphone
- USB debugging turned ON

> You can do this by navigating to Developer Options>USB Debugging
You can find the [guide here.](https://www.howtogeek.com/129728/how-to-access-the-developer-options-menu-and-enable-usb-debugging-on-android-4.2/)
- A USB cable
- A computer xD
-[VLC](https://www.videolan.org/vlc/) should be installed

# Installation
### Install on Windows

- Just download uicy_V1_Windows.zip, extract it, and run uicy.exe
- Make sure to select vlc.exe(Navigate to the path where you installed VLC and select vlc.exe) while setting up uiCY
>You can change later by going into settings
- Connect your smartphone
- Voila! Now you can mirror your screen and audio to you PC!

### Install on Linux
You will need the following:
- scrcpy
- python/python3
- tkinter
- adb
- vlc

Everything can be installed with apt-get and snapcraft through terminal.
Make sure you have all these!
>If anything is missing than use these commands to get them.
**scrcpy**
sudo apt-get install scrcpy
**python,python3**
sudo apt-get install python
sudo apt-get install python3
**tkinter**
sudo apt-get install python-tk
sudo apt-get install python3-tk
**adb**
sudo apt-get install adb
**vlc**
Use either
sudo apt-get install vlc
or
sudo snap install vlc
prefered snap install.

# ScreenShots
### Windows
![photo_2020-08-01_17-00-40](https://user-images.githubusercontent.com/68629996/89100908-c35a4c80-d418-11ea-9163-af2bd2efbced.jpg)
![photo_2020-08-01_17-00-44](https://user-images.githubusercontent.com/68629996/89100902-b63d5d80-d418-11ea-847a-e1f2fb693860.jpg)
### Linux
![photo_2020-08-01_17-04-50](https://user-images.githubusercontent.com/68629996/89100940-3368d280-d419-11ea-94fb-04d991e2aced.jpg)
![photo_2020-08-01_17-04-54](https://user-images.githubusercontent.com/68629996/89100943-36fc5980-d419-11ea-9d8a-90addca48de9.jpg)

# Credits
First of all huge thanks to [Genymobile](https://github.com/Genymobile) for [scrcpy](https://github.com/Genymobile/scrcpy) and [rom1v](https://github.com/rom1v) for [sndcpy](https://github.com/rom1v/sndcpy) without which this project would be impossible!

GUI is designed by Shashwat(ME xD) [Windows Version]
and Yashraj! [Linux Version]
Developed under DeRadian

Follow us on Instagram: (I know you won't xD)
Shashwat: https://www.instagram.com/jaanijunior_13
Yashraj: https://www.instagram.com/legendofrj10

# Got Bugs?
**Just create an issue [here](https://github.com/DeRadian/uicy/issues) we will see to it!**

0 comments on commit 1ad76f1

Please sign in to comment.