This is the first driver for the Xbox One Wireless Gamepad (which is shipped with the Xbox One S). I wrote it for a student project at fortiss GmbH and it is fully functional but does only support the connection via Bluetooth as yet - more will follow.
Many thanks to Kai Krakow who sponsored me a Xbox One Wireless Controller 🎮 (including Wireless Adapter) and a pack of mouthwatering guarana cacao ☕
- xow is a driver for the Xbox One S controllers, too, and supports the native dongles packaged with the controller. Kudos to @medusalix for working together on finding some work-arounds for controller firmware bugs.
- xpad supports this and many other controllers in USB mode.
- MissionControl aims to support the controller on Nintendo Switch via Bluetooth.
These other projects may not support some of the advanced features of xpadneo.
As of SDL 2.0.12, SDL introduced a new HIDAPI which can read HID devices in raw mode, bypassing the drivers. Due to
the way SDL works, and because xpadneo exposes hidraw devices as user-readable, SDL may see wrong button mappings
because it may make wrong assumptions about the protocol mode of Xbox and compatible controllers. If you see wrong
button mappings / missing buttons in SDL applications, you may need to turn off this behavior by setting an
environment variable in your profile: SDL_JOYSTICK_HIDAPI=0
- Supports Bluetooth
- Supports all Force Feedback/Rumble effects through Linux
ff-memlesseffect emulation - Supports Trigger Force Feedback in every game by applying a pressure-dependent effect intensity to the current rumble effect (not even supported in Windows)
- Supports disabling FF
- Supports multiple Gamepads at the same time (not even supported in Windows)
- Offers a consistent mapping, even if the Gamepad was paired to Windows/Xbox before, and independent of software layers (SDL2, Stadia via Chrome Gamepad API, etc)
- Working Select, Start, Mode buttons
- Correct Axis Range (signed, important for e.g. RPCS3)
- Supports Battery Level Indication (including the Play 'n Charge Kit)
- Easy Installation
- Agile Support and Development
- Supports customization through profiles (work in progress)
- Optional high-precision mode for Wine/Proton users
- Share button support on supported controllers
This is the initial controller supported from the first version of xpadneo. All features are fully supported. This controller uses emulated profile switching support (see below).
Basic support for the Xbox Elite Series 2 Wireless controller is present, covering all the features of the driver. The following features are missing:
- The four paddles at the bottom are currently not supported.
- Upload of profile mappings and sensitivity curves is currently not supported.
This controller uses native profile switching support (see below).
Full support for the Xbox Series X / S controller is present including the share button. This is currently mapped
to keyboard event KEY_RECORD and may not work at all for any purpose. Thus, this implementation details may
change during one of the next updates. This controller uses emulated profile switching support (see below).
This controller uses BLE (Bluetooth low energy) and can only be supported if your Bluetooth dongle also supports BLE.
This driver respects the Nintendo layout of those controllers and exposes them correctly as button A, B, X, and Y as labelled on the device. This is swapped compared to the original Xbox controller layout. You can override that behavior with a quirk flag (by removing the Nintendo layout bit). This controller uses emulated profile switching support (see below).
Breaking change: Users of previous versions of the driver may want to remove their custom SDL mappings. Full support has been added for these controllers and broken mapping of previously versions no longer needs to be applied. See also: SDL.
The driver supports switching between different profiles, either through emulation or by using the hardware switch that comes with some models. This switching can be done at any time even while in a game. The API for customizing each profile does not exist yet.
The driver support native profile switching for
- Profile support. All four profiles behave the same way currently, and there is no support for configuring them.
The driver emulates profile switching for controllers without a hardware profile switch by pressing buttons A, B, X, or Y while holding down the Xbox logo button. However, the following caveats apply:
- Profiles currently behave all the same, and there is no support for configuring them.
- Full support will be available once the Xbox Elite Series 2 controller is fully supported.
Make sure you have installed dkms, linux headers and a bluetooth implementation (e.g. bluez) and their dependencies.
- On Arch and Arch-based distros (like Antergos), try
sudo pacman -S dkms linux-headers bluez bluez-utils - On Debian based systems (like Ubuntu) you can install those packages by running
sudo apt-get install dkms linux-headers-`uname -r` - On Fedora, it is
sudo dnf install dkms make bluez bluez-tools kernel-devel-`uname -r` kernel-headers-`uname -r` - On Manjaro try
sudo pacman -S dkms linux-latest-headers bluez bluez-utils - On OSMC you will have to run the following commands
sudo apt-get install dkms rbp2-headers-`uname -r`sudo ln -s "/usr/src/rbp2-headers-`uname -r`" "/lib/modules/`uname -r`/build"(as a workaround) - On Raspbian, it is
sudo apt-get install dkms raspberrypi-kernel-headersIf you recently updated your firmware usingrpi-updatethe above package may not yet include the header files for your kernel. Please follow the steps described here in this case. - On generic distributions, it doesn't need DKMS but requires a configured kernel source tree, then:
cd hid-xpadneo && make modules && sudo make modules_install
Please feel free to add other Distributions as well!
- Download the Repository to your local machine
git clone https://github.com/atar-axis/xpadneo.git cd xpadneo- If using DKMS, run
sudo ./install.sh - If not using DKMS, follow steps above (generic distribution)
- Done!
sudo bluetoothctl[bluetooth]# scan on- wait until all available devices are listed (otherwise it may be hard to identify which one is the gamepad)
- push the connect button on upper side of the gamepad, and hold it down until the light starts flashing fast
- wait for the gamepad to show up in bluetoothctl, remember the address (e.g.
C8:3F:26:XX:XX:XX) [bluetooth]# pair <MAC>[bluetooth]# trust <MAC>[bluetooth]# connect <MAC>- The
<MAC>parameter is optional if the command line already shows the controller name
You know that everything works fine when you feel the gamepad rumble ;)
- If using DKMS: Use
sudo ./configure.shto configure the driver as you wish. The script will guide you through the available options.
In order to update xpadneo, do the following
- Update your cloned repo:
git pull - If using DKMS: Run
sudo ./update.sh - otherwise follow the steps above (generic distribution)
- If using DKSM: Run
sudo ./uninstall.shto remove all installed versions of hid-xpadneo - otherwise follow the steps above (generic distribution)
For further information please visit the GitHub Page https://atar-axis.github.io/xpadneo/ which is generated
automatically from the content of the /docs folder.
You will find there e.g. the following sections