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