An open API service indexing awesome lists of open source software.

https://github.com/kitswas/virtualgamepad

Android phone as gamepad for Windows
https://github.com/kitswas/virtualgamepad

android game-controller gamepad gaming input-method peripherals virtual-gamepad windows

Last synced: about 1 month ago
JSON representation

Android phone as gamepad for Windows

Awesome Lists containing this project

README

        

# VirtualGamePad

[![GitHub License](https://img.shields.io/github/license/kitswas/VirtualGamePad)
![GitHub Stars](https://img.shields.io/github/stars/kitswas/VirtualGamePad?style=social)](https://github.com/kitswas/VirtualGamePad/)

VirtualGamePad lets you use your Android phone as a gamepad for your Windows PC.
It's similar to DroidJoy, but free and open source.

## Screenshots

VirtualGamePad running on an Android 12 device:

![VirtualGamePad](assets/VGP.svg)

![VirtualGamePad Dark](assets/VGP_night.svg)

VirtualGamePad Server running on Windows 11:

![VirtualGamePad Server](assets/VGP_Server.png)

## Installation

To use VirtualGamePad, you need to install the Android app (client) on your phone and the Windows app (server) on your PC.

To be notified of new updates, you can star ⭐ or watch 👁️ the source repositories on GitHub.

![GitHub Star and Watch](assets/GitHub_Star_Watch.png)

### Android

Grab the latest APK from the [releases page](https://github.com/kitswas/VirtualGamePad-Mobile/releases) and install it on your phone.
[![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/kitswas/VirtualGamePad-Mobile/total)
![GitHub Latest Release](https://img.shields.io/github/v/release/kitswas/VirtualGamePad-Mobile?logo=github)](https://github.com/kitswas/VirtualGamePad-Mobile/releases/latest)

### Windows

Grab the latest archive(.zip) from the [releases page](https://github.com/kitswas/VirtualGamePad-PC/releases), extract it and run `VGamepadPC.exe`.
[![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/kitswas/VirtualGamePad-PC/total)
![GitHub Latest Release](https://img.shields.io/github/v/release/kitswas/VirtualGamePad-PC?logo=github)](https://github.com/kitswas/VirtualGamePad-PC/releases/latest)

## Usage

Run the server on your PC and the client on your phone.
Connect to the server from the Android app by entering the IP address and port of the server.
Both devices need to be on the same network.

There's an [**FAQ** for gamers](FAQ.md).

## Troubleshooting

### Help! I cannot connect to the server

If you're having trouble connecting to the server, try disabling your firewall or adding an exception for the server.
On Windows, you will be prompted to allow the server to communicate through the firewall when you run it for the first time.

![Firewall](assets/VGP_UAC_Dialog.png)

**If you're still having trouble, start a hotspot on your phone and connect your PC to it.** (or vice-versa, try both)
Then, restart the server and try connecting again.

_Do this before complaining about the app not working._

### Help! The QR code scanner doesn't work

This is a known issue with the Google library used for scanning.

[Google code scanner](https://developers.google.com/ml-kit/vision/barcode-scanning/code-scanner) is an optional module in Google Play Services. It's fast but the delivery is unreliable when installing apps from outside the Play Store.

The problem shows up [in various forms](https://stackoverflow.com/questions/tagged/barcode-scanner+android+google-mlkit) due to various reasons:

1. Google code scanner doesn't work at all. This is because it uses an unbundled library that must be downloaded before use.
Simply connect the device to the internet, launch the app and wait for a few minutes. _This is required only once._
2. Google code scanner might stop working after a while. This might happen due to a Play Services update.
Clear the data for Google Play Services to fix it. _This will remove the module and it must be downloaded again._

You may also use a third-party QR code scanner or enter the data manually.

### Help! The Gamepad doesn't work for a game

If it is a newer title with built-in support for Gamepads on PC, you might face some problems.
Try running the server as admin. 🛡️

**The game should not be running as admin.** This prevents input injection.

Games without gamepad support should work out of the box.

Read [How it works](https://kitswas.github.io/VirtualGamePad-PC/#how-it-works) to know why.

## Source Code

Glad you asked! VirtualGamePad is open source and licensed under the [GPLv3 licence](LICENCE.TXT).

VirtualGamePad uses open-source libraries and assets which are governed by their own licences.

The source code for the Android app is available at [kitswas/VirtualGamePad-Mobile](https://github.com/kitswas/VirtualGamePad-Mobile).

The source code for the Windows app is available at [kitswas/VirtualGamePad-PC](https://github.com/kitswas/VirtualGamePad-PC).
Visit the [companion website](https://kitswas.github.io/VirtualGamePad-PC/) to see the documentation.

[kitswas/VGP_Data_Exchange](https://github.com/kitswas/VGP_Data_Exchange/) is used to handle the communication between the client and the server.

### Star History



VirtualGamePad Star History Chart