Installation Guide

PyRDPConnect requires XQuartz to function correctly on macOS. XQuartz is an open-source version of the X.Org X server, a component necessary for running remote desktop applications.

1. Visit the official XQuartz website: XQuartz Download Page.
2. Download and install the latest version of XQuartz.
3. (Optional) Restart your computer to ensure all necessary components are initialized.

Why XQuartz? XQuartz provides the necessary X11 environment that FreeRDP relies on for graphical rendering on macOS. Without it, the application may not display the RDP session correctly.

brew install python3
pip3 install pyqt5

Clone the PyRDPConnect repository:

git clone https://github.com/LaswitchTech/PyRDPConnect.git

Navigate to the src directory and execute the application:

python3 src/client.py

For Linux users, PyRDPConnect requires Python 3, PyQt5, and FreeRDP to function correctly.

Update your package list and install the necessary packages:

sudo apt-get update
sudo apt-get install -y git python3 python3-pip python3-pyqt5 python3-pyqt5.qtquick python3-pyqt5.sip freerdp2-x11

1. Clone the PyRDPConnect repository:

   git clone https://github.com/LaswitchTech/PyRDPConnect.git

2. Navigate to the src directory and execute the application:

   python3 src/client.py

PyRDPConnect is available as a pre-built macOS application (.app). Before using the application, you must install XQuartz.

1. Visit the official XQuartz website: XQuartz Download Page.
2. Download and install the latest version of XQuartz.
3. (Optional) Restart your computer to ensure all necessary components are initialized.

1. Locate the PyRDPConnect.app in the dist/macos directory or where you saved it.
2. Double-click the application to launch it.
3. PyRDPConnect should now open and run as expected.

Troubleshooting: If PyRDPConnect does not open or shows an error related to X11 or XQuartz, ensure that XQuartz is installed and running. You can manually start XQuartz from your Applications folder (/Applications/Utilities/XQuartz.app).

PyRDPConnect is also available as a pre-built single-file executable on Linux.

Make sure FreeRDP is installed:

sudo apt-get install -y freerdp2-x11

1. Locate the PyRDPConnect executable in the dist/linux directory or where you saved it.
2. Make the file executable if it’s not already:

   chmod +x dist/linux/PyRDPConnect

3. Run the application:

   ./dist/linux/PyRDPConnect

Permission Denied Error: If you encounter a “Permission denied” error, ensure that the script has executable permissions:

chmod +x <script_name>.sh

XQuartz Issues: If XQuartz does not start automatically, you can manually start it from /Applications/Utilities/XQuartz.app.

If you have any questions or need further assistance, feel free to open an issue in the GitHub Repository.