Updating README.md

This commit is contained in:
Alex Yatskov 2016-07-04 20:24:59 -07:00
parent 8c4c7e0eec
commit 4cd742c9d9

View File

@ -1,9 +1,8 @@
# AnkiJoy # # AnkiJoy #
This is a simple Python plugin I wrote for [Anki](http://ichi2.net/anki/) to enable Joystick and Gamepad support under AnkiJoy is a plugin for Anki (version 1.x only) which enables joystick and gamepad support in Linux via pygame. Due to
Linux. It relies on [PyQt](http://www.riverbankcomputing.co.uk/) which you already have installed if you run Anki, and differences in the Python runtime environment, this plugin does not currently function in Windows (no testing has been
[pygame](http://www.pygame.org/) for game controller support. It can likely be made to work with a little bit of done on Mac OS X).
tweaking on Windows and MacOS systems, but I am not pursuing this at this time.
With this plugin you can map any of the following actions to arbitrary buttons on your favorite game controller: With this plugin you can map any of the following actions to arbitrary buttons on your favorite game controller:
@ -20,8 +19,14 @@ With this plugin you can map any of the following actions to arbitrary buttons o
* Suspend Card * Suspend Card
* Undo * Undo
*Note: this plugin only works for Anki 1.x and has been largely superseded by [this ## Dependencies ##
addon](http://tmbb.bitbucket.org/gamepad/index.html).*
* [Anki 1.x](http://ankisrs.net/download/mirror/archive/)
* [pygame](http://www.pygame.org/)
## Installation ##
To install this extension, simply copy the included `ankijoy.py` file into Anki's `addons` directory.
## Screenshots ## ## Screenshots ##