Use your smartphone as a virtual xbox controller for your PC!

Checkout the frontend demo here

(_{^{It is recommended you open this demo on a mobile device}})

Quickstart

Download one of the pre-built binaries for your desired platform from releases.

Required: Run the executable with --setup flag in a terminal to complete the setup process. This requires elevated system priviliges before running.

Once the setup is done, you can run the executable by either simply double clicking it or running it from a terminal.

For more information, see --help flag.

---

Manual Setup (Windows & Linux)

Clone the repo

git clone https://github.com/harsh2204/socketjoy.git
cd socketjoy/

Setup a virtual env and activate it

python3 -m venv .venv

# Linux
source .venv/bin/activate 

# Windows
.venv\Scripts\activate.bat

Install the python dependencies

pip install -r socketjoy/requirements.txt

We must run the socketjoy setup and the server itself using the following commands.

cd socketjoy/

# Setup
# Note - Higher system privileges are required to setup this program.
python app.py --setup

# Run server
python app.py

# Run python app.py --help for more info 

---

Building the binary file (Optional)

Install pyinstaller

pip install pyinstaller
pyinstaller --version

Windows

Note - You may need to install Visual Studio Runtime 2015 to build the executable.

pyinstaller --noconfirm --clean socketjoy.spec

The socketjoy.exe file will be placed in dist/.

Linux

! Install appimagetool using your distro's package manager

You can now run linux_build.sh to start the build and packaging process.

The AppImage binary will be placed in dist/socketJoy.AppImage. This is a portable binary that should work on other machines with the same architecture as your machine.