README.md

Yoke (desktop client)

Yoke is a hackable Android gamepad for Linux (and Windows)

Get the Android app on F-Droid, Google Play or Github.

The Linux client can be installed with

# Requires Python 3.5+ which comes pre-installed in Ubuntu 16.04 and after.
git clone --branch v0.1 --depth 1 https://github.com/rmst/yoke
cd yoke
# Now tweak files in e.g. yoke/assets/joypad
pip3 install .
# Note: you can use pip3 install --user to install to home dir.
# Note: you can use pip3 install -e to make pip create symlinks instead of copying files
# so you won't have to rerun pip after changes

On Linux to enable Yoke to create gamepad devices we need to add a udev rule

yoke-enable-uinput  # you can find that script in the "bin" directory

(This can be undone via yoke-disable-uinput)

On Windows Yoke needs the vJoy driver. The installer can be downloaded here.

Now you can run the client with

yoke

Your computer should then show up in the Yoke app immediately if you are on the same network.

To test Yoke on Linux you can install, e.g. jstest-gtk:

sudo apt install jstest-gtk
jstest-gtk  # to run

To use Yoke effectively with SDL-based games (e.g. all games using Unreal Engine or Unity3D), you can install the SDL gamepad tool. (If the package is not found, download the tool from the website.)

sudo apt install gamepadtool
gamepadtool   # to run

Multiple virtual devices on the same machine

Each yoke process creates one virtual device. To run multiple processes on the same machine make sure to give them different --id numbers (any integer greater than 0).

Security

The communication between the Linux client and the Android app are unencrypted UDP messages. You should therefore use it in networks you trust. However, if you are not in a trusted environment you can always create one via USB or Bluetooth. Just enable USB or Bluetooth tethering on your Android device and connect your Linux computer. This will create a mini-network for just your Phone and Computer and Yoke will work as usual.

Tweaking

Many aspects of Yoke behavior can be changed easily - have a look at yoke/assets/joypad, bin/yoke and yoke/service.py.