Skip to content

README.md

Latest commit

 

History

History
93 lines (61 loc) · 2.71 KB

README.md

File metadata and controls

93 lines (61 loc) · 2.71 KB

🎮 WebControllerPro

Turn your Smartphone into a Zero-Latency Gamepad

WebControllerPro allows you to use your smartphone as a fully functional game controller for your PC. Connect up to 8 players simultaneously using just your local WiFi network.

✨ Features

  • Zero Latency: Uses local WebSocket connections for instant response.
  • Multiplayer Madness: Support for up to 4 Players as Xbox 360 Controllers.
  • Extended Play: Slots 5-8 are supported as DualShock 4 controllers.
  • Cross-Platform Client: Works on any device with a web browser (iOS, Android).
  • Easy Pairing: simply scan a QR code to join the game.

🛠️ Prerequisites

To run the host application and create virtual controllers, you need:

  1. Windows PC (required for Virtual Controller emulation)
    • Note: On successful connection, the app runs in Background Mode on non-Windows systems for testing.
  2. Node.js installed.
  3. Python 3.x installed.
  4. ViGEmBus Driver (installed automatically by many gamepad tools, or available here).

🚀 Installation

Follow these steps to get your server running.

1. Install Python Dependencies

Open your terminal or command prompt and install the required virtual joystick library:

pip install vgamepad

2. Install Node Dependencies

Navigate to the project root directory and install the necessary packages:

npm install

🎮 Usage Guide

1. Start the Server

Run the application using npm:

npm start

You may be prompted to allow firewall access. This is required for your phone to communicate with your PC.

2. Connect Your Phone

Once the application launches, a QR Code will appear on the screen.

  1. Open your phone's camera app.
  2. Scan the QR code.
  3. Open the link in your web browser.

3. iOS Full Screen Mode (Required) 📱

For the best experience on iPhone/iPad (to remove address bars and prevent gestures from interfering):

  1. Open the link in Safari.
  2. Tap the Share Button (box with an arrow up).
  3. Scroll down and tap "Add to Home Screen".
  4. Launch the new app icon from your home screen.

🕹️ Controls

  • Standard Layout: A, B, X, Y, Triggers, Bumpers, Joysticks, and D-Pad.
  • Haptic Feedback: Your phone will vibrate on interactions (device supported).

🐛 Troubleshooting

  • Controllers not appearing? Ensure pip install vgamepad was successful and you are on Windows.
  • Can't connect? Ensure your PC and Phone are on the same WiFi network.
  • Lag? Check your network connection. 5GHz WiFi is recommended for best performance.

Hope you find this useful (I sure did!)