This is a preview version of the source code and presently, it does not support all the features found in the macOS version. We are in the process of optimizing the code and refining the building methods. Your feedback is invaluable to us. If you have any suggestions or recommendations, feel free to reach out to the project team via email. Alternatively, you can join our Discord channel for direct discussions.

• Welcome to Openterface Mini-KVM QT version (For Linux & Windows)
• Table of Contents
  • Features
  • Supported OS
  • Download & installing
    • For Windows users
    • For Linux users
  • Build from source
    • For Windows
    • For Linux
  • FAQ
  • Asking questions and reporting issues
  • License Information
    • Third-Party Libraries and Their Licenses
    • Static Linking
    • License Compliance Details

• Basic KVM operations
• Mouse control absolute mode
• Mouse relative mode
• Audio playing from target
• Paste text to Target device
• OCR text from Target device
• Other feature request? Please join the Discord channel and tell me

For a detailed list of features, please refer to the Features Documentation.

• Window (10/11)
• Ubuntu 22.04 (You need to upgrade QT to >=6.4)
• Ubuntu 24.04
• Linux Mint 21.3 (Need to upgrade QT to >=6.4)
• openSUSE Tumbleweed, built by community
• Raspberry Pi OS (64-bit), working good
• Raspberry Pi OS (32-bit), Not supported, because the QT version is too old

1. Download the package from GitHub release page, and find the latest version to download according to your OS and CPU architecture.
2. Run the installer and it will install all required drivers and application to your windows. You can run the application from start menu.

Note: Users have reported that the Windows installer is unable to automate driver installation correctly on Windows 11 Version 22H2. You may need to manually download and install the driver from the WCH website. For more details, please refer to this issue. We are also actively working on a solution to improve driver installation for this version.

For a quick and automated installation, run this single command:

Note: By default, this script automatically builds the stable version (currently v0.3.19) defined in the source code. If you want to try the latest development version with the newest features, replace main with dev_20250804_add_oneline_buildscript in the URL above.

This script will automatically:

• Install all required dependencies (Qt6, FFmpeg, build tools)
• Set up user permissions for hardware access
• Configure device permissions (udev rules)
• Clone and build the stable version of the source code
• Install the application system-wide with desktop integration
• Create proper Qt environment wrappers to avoid plugin issues

To install a specific version:

For interactive installation with customization options:

1. Download the package from GitHub release page, and find the latest version to download according to your OS and CPU architecture.
2. Install the dependency
3. Setup dialout for Serial permissions and the hidraw permission for Switchable USB device
4. Install the package.

• Using QT Creator
  1. Install QT for opensource, recommended version 6.4.3
  2. Use Qt Maintenance Tool to add following components
     • QtMultiMedia
     • QtSerialPort
  3. Download the source and import the project
  4. Now you can run the project

Use our automated installation script that handles the entire build process. It takes 5 - 30 minutes (Raspberry PI take longer) to complete the whole process.

Note: By default, the script builds the stable version (currently v0.3.19) automatically detected from the source code. To build the latest development version instead, use: BUILD_VERSION="main" before the command.

This script automatically handles dependency installation, environment setup, building, and system integration.

To build a specific version:

If you prefer to build manually or need to customize the build process:

• Keyboard and Mouse not responding in Windows
  • The CH340 serial chip driver wasn't installed properly during setup, you have two options:
    1. Download and install the driver directly from the WCH website
    2. Install the driver from our source repository by running this command as Administrator:
    pnputil -a CH341SER.INF

• Keyboard and Mouse not responding in Linux

  • Likely the CH340 serial chip driver is missing in your OS, you should

    1. Download the driver: Visit the driver website and download the appropriate driver for Linux.

    2. Install the driver:

       • Extract the downloaded file.
       • Open a terminal and navigate to the extracted folder.
       • Run the following commands to compile and install the driver:
         make
         sudo make install

    3. Load the driver: After installation, load the driver using:

       sudo modprobe ch341

    4. Reconnect the device: Unplug and reconnect the OpenTouch interface to see if the mouse and keyboard inputs are now being sent to the target.

    If the issue persists, it could also be related to permissions or udev rules. Ensure that your user has the necessary permissions to access the device. Please refer to For Linux users

We encourage you to engage with us.

• On Discord to ask questions and report issues.
• On GitHub to report issues.
• Email to techxartisan@gmail.com to ask questions and report issues.

The Openterface Mini-KVM QT project is licensed under the AGPL-3.0 (Affero General Public License). This license allows you to use, modify, and redistribute the software under the following conditions:

1. Source Code Availability: If you distribute the software, you must make the source code available to the recipients under the same AGPL-3.0 license.
2. Modification: You are free to modify the software, but you must also distribute your modifications under the AGPL-3.0 license.
3. No Warranty: The software is provided "as is", without warranty of any kind.

For more details, please refer to the full text of the AGPL-3.0 license: GNU AGPL v3.0.

This project uses the following third-party libraries, each with its own licensing terms:

• Qt Framework: LGPL v3
• libusb (1.0.26): LGPL v2.1
• FreeType (2.13.2): FreeType License (BSD-style) / GPL v2
• Fontconfig (2.14.2): MIT License
• D-Bus: AFL v2.1 or GPL v2
• PulseAudio (16.1): LGPL v2.1+
• libxkbcommon (1.7.0): MIT License
• xproto, libXdmcp, libXau, xcb, xcb-util: Generally under permissive licenses

Most of the libraries used in this project are compatible with AGPL, especially if you provide the source code or object files for LGPL libraries. Ensure compliance with the terms of each license, especially for LGPL libraries.

1. Complete source code is available in this repository.
2. Build instructions are provided above.
3. You have the right to modify and redistribute the code under the terms of the AGPL-3.0.
4. You have the right to relink with different versions of the LGPL libraries.
5. For any modifications to the code, you must make the source code available under AGPL-3.0.

The full text of all licenses can be found in the license file of this repository.

For more information about the licenses:

• GNU AGPL v3.0
• GNU LGPL v2.1
• GNU LGPL v3.0
• MIT License
• Academic Free License v2.1