bass: add guiscrcpy documentation

BlissRoms-x86 · Mar 6, 2024 · 769c96a · 769c96a
1 parent 8ea80c4
commit 769c96a
Show file tree

Hide file tree

Showing 12 changed files with 58 additions and 0 deletions.
diff --git a/...ss-bass/remote_management/images/device-primary_display_2024-03-06_11-44-51.png b/...ss-bass/remote_management/images/device-primary_display_2024-03-06_11-44-51.png
diff --git a/...-bass/remote_management/images/device-secondary_display_2024-03-06_11-45-39.png b/...-bass/remote_management/images/device-secondary_display_2024-03-06_11-45-39.png
diff --git a/...ss/remote_management/images/device_connection-connected_2024-03-06_11-34-02.png b/...ss/remote_management/images/device_connection-connected_2024-03-06_11-34-02.png
diff --git a/...e/bliss-bass/remote_management/images/device_connection_2024-03-06_11-33-10.png b/...e/bliss-bass/remote_management/images/device_connection_2024-03-06_11-33-10.png
diff --git a/...gebase/bliss-bass/remote_management/images/init_mapping_2024-03-06_11-37-56.png b/...gebase/bliss-bass/remote_management/images/init_mapping_2024-03-06_11-37-56.png
diff --git a/...iss-bass/remote_management/images/main-keep_display_off_2024-03-06_11-34-41.png b/...iss-bass/remote_management/images/main-keep_display_off_2024-03-06_11-34-41.png
diff --git a/knowledgebase/bliss-bass/remote_management/images/mapping_2024-03-06_11-37-25.png b/knowledgebase/bliss-bass/remote_management/images/mapping_2024-03-06_11-37-25.png
diff --git a/...base/bliss-bass/remote_management/images/mapping_screen_2024-03-06_11-38-29.png b/...base/bliss-bass/remote_management/images/mapping_screen_2024-03-06_11-38-29.png
diff --git a/...dgebase/bliss-bass/remote_management/images/permissions_2024-03-06_12-07-50.png b/...dgebase/bliss-bass/remote_management/images/permissions_2024-03-06_12-07-50.png
diff --git a/...ase/bliss-bass/remote_management/images/primary_display_2024-03-06_11-32-32.png b/...ase/bliss-bass/remote_management/images/primary_display_2024-03-06_11-32-32.png
diff --git a/...base/bliss-bass/remote_management/images/second_display_2024-02-28_20-57-16.png b/...base/bliss-bass/remote_management/images/second_display_2024-02-28_20-57-16.png
diff --git a/knowledgebase/bliss-bass/remote_management/using_scrcpy_for_remote_management.md b/knowledgebase/bliss-bass/remote_management/using_scrcpy_for_remote_management.md
@@ -0,0 +1,58 @@
+# Using Scrcpy For Remote Management
+
+scrcpy is a popular open-source tool that allows remote access and control of your Android device using adb interface. 
+
+It comes in a number of forms:
+
+**scrcpy:**
+- https://github.com/Genymobile/scrcpy
+
+**guiscrcpy:**
+- https://github.com/srevinsaju/guiscrcpy
+
+**qtscrcpy:**
+- https://github.com/barry-ran/QtScrcpy
+
+## Installing guiscrcpy:
+
+This guide will run through using the guiscrcpy tool. We will start off by navigating to the latest [releases](https://github.com/srevinsaju/guiscrcpy/releases/tag/v2023.1.1) page and downloading the "guiscrcpy-vXXXX.X.X.dev.r.glibcX.X-x86_64.AppImage" file as it contains all the required dependencies to run on most setups. 
+
+Once downloaded, you will want to set executable permissions for the AppImage file by right-clicking, selecting Properties, and checking the box next to **Allow this file to run as an executable**, then you can close the dialog.
+
+![permissions](images/permissions_2024-03-06_12-07-50.png)
+
+## Main Program:
+
+Launching the AppImage will load to display the main GUI:
+![main GUI](images/main-keep_display_off_2024-03-06_11-34-41.png)
+
+### Connecting to a device:
+
+To connect to a new device, start by clicking on the **wireless icon** under the options panel. From there, you can hit the **refresh** button to display any devices broadcasting ADB on the network, or you can type in the IP directly and tap the **Connect** button to connect to that device. 
+![device connection](images/device_connection_2024-03-06_11-33-10.png)
+Once a device is connected, it will show the status in the grey textbox like below:
+![device connected](images/device_connection-connected_2024-03-06_11-34-02.png)
+From here, we can close the window and continue to the next steps. 
+
+### Remote operation of the device
+
+Once we are connected, you can select the **Start Scrcpy** button to remote into the device
+
+![remote display - primary screen](images/device-primary_display_2024-03-06_11-44-51.png)
+
+You can use your mouse and keyboard to operate the device, or you can use the button tools provided by guiscrcpy (moving those out of the main interaction area first). 
+
+#### Connecting to secondary display:
+
+In order to remote into the connected displays on the device, this requires us to use the "additional flags" preferences from within guiscrcpy, adding `--display #` where `#` is the display ID for your target display. 
+
+Example:
+![second-display specification](images/second_display_2024-02-28_20-57-16.png)
+
+After adding `--display 2`, we can click the **Start Scrcpy** button and it will remote into the secondary display connected to the device. 
+![remote display - display ID 2](images/device-secondary_display_2024-03-06_11-45-39.png)
+
+## Other Options:
+
+You can configure the options further by using the "additional flags" textbox. A good reference for the possibilities is the [official scrcpy documentation](https://github.com/Genymobile/scrcpy?tab=readme-ov-file#user-documentation). 
+