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