Skip to content

jehervy/node-virtual-gamepads

Repository files navigation

node-virtual-gamepads

This nodejs application turns your smartphone into a gamepad controller on Linux OS simply by reaching a local address. You can virtually plug in multiple gamepad controllers.

Demo

Demo video 1 player in game here

Demo video 3 players on EmulStation here

Prerequisite

This application is only compatible with Linux OS with the uinput kernel module installed.

Installation

git clone https://github.com/miroof/node-virtual-gamepads
cd node-virtual-gamepads
npm install

If you encounter problems while installing or running node-virtual-gamepads have a look at the troubleshooting page.

You can now configure the server to your needs. Just open config.json with the editor of you choice and adjust the values. Explanation of the individual values can be found in README_CONFIG.md.

To start the server run

sudo node main.js

Usage

Once the nodejs application is launched, you just have to plug your gamepad controller by connecting your device on the same local network and by reaching the address http://node_server_address

Features

Plug up to 4 virtual gamepads

The application will plug automatically a new controller when the web application is launched and unplug it at disconnection. 4 slots are available so 4 virtual gamepads can be created. You can see your current slot on the indicator directly on the vitual gamepad.

Virtual gamepad

Use it as standalone application (chrome mobile)

With the add to homescreen chrome feature, you can easily use virtual gamepads application without launching the browser each time you want to play.

With only 3 clicks, virtual gamepads web application becomes a standalone application.

Standalone installation step 1 Standalone installation step 2

Then a shortcut is added on your homescreen and the application will be launched outside the browser.

Virtual gamepad directly from the homescreen Launched outside the browser

Enjoy haptic feedbacks

Because it's difficult to spot the right place in a touch screen without looking at it, the touch zone of each button was increased. LT button was moved at the center of the screen to let as much space as possible for the joystick and avoid touch mistakes.

Step 1

To know if we pressed a button with success, the web application provides an haptic feedback which can be easily deactivated by turning off the vibrations of the phone.

Use the keyboard to enter text

Virtual Keyboard

Use the touchpad for mouse inputs

Virtual Touchpad

An index page lets you choose

Index page

Developing

Please read the contribution guideline first if you haven't already.

Clone this repository and install its dependencies with

npm install

When you change something in a coffeescript (e.g. main.coffee) run

npx coffee -c main.coffee

This will compile main.coffee to main.js which than can be run with node (see Installation) To compile all coffee files when ever they change run

npx coffee -cw .

If you want do add a new keyboard layout please refer to this file.