Welcome to Approximate Engineering’s Python Game Controller Documentation!¶
This library simplifies access to the axes and buttons on game controller hardware from Python. It was originally written to support my PiWars robots, and remains focused on similar projects, but can be used wherever game controller functionality is required. The current code only supports Linux based systems, including the Raspberry Pi.
Check out the Change Log to see what’s new. In particular, version 2.3 introduces changes to the way controllers are discovered and allows for multiple controllers to be used simultaneously. This release also drops support for Python2, this and subsequent releases will be Python3 only.
In general you don’t need to code to a specific controller, but some may need extra steps when connecting to your Pi or other computer. In other cases, some controllers offer unique features such as the PS4’s light bar. You can see more details for specific controller types which are non-standard in some way:
Other controller types use standardised names called snames, which can be found under simple usage
Tom Oinn (@approx_eng) wrote and maintains the bulk of this library. Follow me for updates!
Keith Ellis (@PiTutorials) contributed initial support for Rock Candy controllers.
Tom Broughton (@dpolymath) added support for the SF30Pro controller.
Clare Macrae (@ClareMacraeUK) helped herd the documentation beasts.
Getting the code¶
You can install the code using pip, you’ll have to add a few native libraries first though:
$ sudo apt-get install python-dev python-pip gcc $ pip3 install approxeng.input
(The exact dependencies may vary depending on your operating system, they come from using evdev and having to compile that particular python module against whatever underlying libraries your OS is using). I strongly recommend using a virtual environment (virtualenv) as a general practice.
The controller support code is written in Python, but relies on some underlying operating system functionality which is exclusive to Linux based computers like the Pi. As a result, it won’t work on Windows or OSX. If you need to handle joysticks on those platforms I recommend taking a look at PyGame, which includes joystick support amongst its other functionality.
To work with the code on other platforms you’ll want to clone it from GitHub, it’s available under the ASL, the same as almost everything Python based. Documentation (this site) is generated using Sphinx.
- Change Log
- Simple Usage
- Standard Names
- Command-line tools
- Pairing Controllers over Bluetooth
- Profiling and Testing Controllers
- API Documentation
- Common APIs - approxeng.input
- Binding - approxeng.input.selectbinder
- Controller Discovery - approxeng.input.controllers
- PlayStation 3 Controller Support
- PlayStation 4 Controller Support
- XBox-One S Controller Support
- Steam Controller Support
- Wii Remote Pro Controller Support
- Wired SpaceMouse Pro Support
- Adding support for a new controller type
- Advanced Usage Guide
- LEDs and Battery Monitoring