virtual-gamepad

Transform your phone into a virtual gamepad.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Build
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

• vigemclient
• socket.io
• Express.js
• screenshot-desktop
• JQuery

(back to top)

Getting Started

This is an example of how you can setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Prerequisites for building this project.

Node-server

• npm

  npm install npm@latest -g

• ViGEmBus, Download from here

• Python, Latest Python 3

• Visual Studio, Latest Visual Studio including the "Desktop development with C++" workload.

Webview-app

• android studio, Download from here

Build

Node-server

1. Clone the repo

   git clone https://github.com/FahrulID/virtual-gamepad.git

2. Install NPM packages

   npm install

3. Create self-signed SSL and then put it inside the "SSL" folder, you can use this command using git bash in windows

   openssl req -x509 -newkey rsa:2048 -keyout keytmp.pem -out cert.pem -days 365

4. To create executable, run this command

   pkg --config package.json index.js

Webview-app

1. Clone the repo

   git clone https://github.com/FahrulID/virtual-gamepad.git

2. Open Android Studio
3. Open an Existing Project

   Open project ./src/webview

4. Build

(back to top)

Usage

Node-server

1. To use this application, you need to install ViGEmBus
2. After installing ViGEmBus, download released virtual-gamepad
3. Run the portable executable you downloaded
4. Go to the link as the application instructed

Webview-app

1. Simply download the .apk from the release page apk
2. Install it on your phone
3. Run it
4. Run the Node-server
5. Input URL shown in Node-server to the Webview-app
6. Press "Connect"

(back to top)

Roadmap

Node-server

• Add Steering Mode ( Accelerometer )
• Add Aiming Mode ( Gyroscope )
• Multi-language Support
• Support For Other Than Windows OS
• DS4 Controller
• Controller Skin
  • Hotas
  • Yoke
• Many More...

See the open issues for a full list of proposed features (and known issues). You can also request feature.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Fahrul Ramadhan Putra - Twitter - Instagram - [email protected]

Project Link: https://github.com/FahrulID/virtual-gamepad

(back to top)

Acknowledgments

Biggest thanks to

• Nefarius
• Jan Scheiper

as without them, this project will not work.

(back to top)