[[ XBox360 USB Gamepad Driver for Userspace ]]
==============================================

This is a XBox360 gamepad driver for Linux that works in userspace. It
is a alternative to the xpad kernel driver.


[[ Compilation ]]
-----------------

Required libraries and tools:

 * libusb
 * boost
 * scons
 * uinput

You can compile by typing:

 % scons


[[ Running ]]
--------------

First make sure that the xpad kernel module does not get loaded,
either by deleting or renaming it. rmmod might not be enough since it
might be automatically loaded.

Once ensured that xpad is out of the way plug in your XBox360 gamepad
and start the userspace driver:

 % ./xbox360

This will create a /dev/input/js0 and allow you to access the gamepad
from any game. To exit the driver press Ctrl-c  twice

If you have multiple controllers you need to start multiple instances
of the xbox360 driver and append the -i argument like this:

 % ./xbox360 -i 1

This will then use the second detected controller, see to see which id
your controller has:

 % ./xbox360 --list-controller

If you want to abuse the led or rumble of the gamepad for notification
in scripts you can do see via:

 % ./xbox360 --led 10 --rumble 30,30 --quit

This will cause a mild rumble and the led to rotate, you can stop it
again via:

 % ./xbox360 -q


[[ SDL Notes ]]
---------------

To let SDL know which axis act as a hat and which act as normal axis
you have to set an environment variable:

 % SDL_LINUX_JOYSTICK="'XBox360 Gamepad (userspace driver)' 6 1 0"
 % export SDL_LINUX_JOYSTICK

This will let the DPad act as Hat in case you need that for any
game. For most games the driver should work as-is.

See ftp://ptah.lnf.kth.se/pub/misc/sdl-env-vars for more information.


# EOF #