Update README.
[enjoyable.git] / README.md
1 Enjoyable
2 =========
3
4 Enjoyable is a simple program for Mac OS X which allows you to use
5 joystick inputs like a mouse or keyboard. If you've ever played a
6 video game which only supports mouse and keyboard input but you want
7 to use a joystick or gamepad, then Enjoyable is the program for you.
8
9 Enjoyable supports
10
11 * Mapping gamepad and joystick buttons to keyboard and mouse
12 actions
13 * Fine control over mouse movement and scrolling using analog axis
14 inputs
15 * Automatic and dynamic switching between different input mappings
16 * Downloading and sharing input presets for different applications
17 * Modern OS X features like resume and automatic termination
18
19 Enjoyable is free software written by Joe Wreschnig and is based on
20 the Enjoy codebase written by [Yifeng Huang](htty://nongraphical.com)
21 and [Sam McCall](http://abstractable.net/enjoy/).
22
23 ## How to Use
24
25 To start, just press a button on your joystick or gamepad, then press
26 the key you want to map it for. Then press the ▶ button and switch
27 back to your game. For more details, Enjoyable has a in-application
28 manual available in Help Viewer via `⌘?`.
29
30 ## Requirements
31
32 * Mac OS X 10.7+
33 * One or more HID-compatible (e.g. USB or Bluetooth) input devices
34
35 ## License
36
37 Copyright 2013 Joe Wreschnig
38 2012 Yifeng Huang
39 2009 Sam McCall, University of Otago
40
41 Permission is hereby granted, free of charge, to any person obtaining
42 a copy of this software and associated documentation files (the
43 "Software"), to deal in the Software without restriction, including
44 without limitation the rights to use, copy, modify, merge, publish,
45 distribute, sublicense, and/or sell copies of the Software, and to
46 permit persons to whom the Software is furnished to do so, subject to
47 the following conditions:
48
49 The above copyright notice and this permission notice shall be
50 included in all copies or substantial portions of the Software.
51
52 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
53 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
54 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
55 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
56 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
57 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
58 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
59
60 The joystick icon is from the Tango icon set and is public domain.