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 multiple configurations (for different games or
  10 programs) and you can even map joystick buttons to change
  11 configurations on-the-fly.
  12
  13 Enjoyable is free software written by Joe Wreschnig and is based on
  14 the Enjoy codebase written by [Yifeng Huang](htty://nongraphical.com)
  15 and [Sam McCall](http://abstractable.net/enjoy/).
  16
  17 ## How to Use
  18
  19 At startup, and when Enjoyable is paused, press any button or move any
  20 analog stick to jump to the configuration for that button or stick.
  21 From there, select one of the mapping options from the choices on the
  22 right.
  23
  24 To quickly map a joystick to keyboard actions, you can simply press
  25 the joystick button or axis, then the keyboard key you wish to map
  26 it to, and repeat.
  27
  28 Once you've done that, click the Start button and begin using your
  29 joystick as a keyboard and mouse.
  30
  31 If you name a configuration after the title of a program (e.g. what
  32 appears when you hover over it in the dock) that configuration will
  33 automatically be selected when you switch to that program.
  34
  35 ### Mouse Mapping Compatibility
  36
  37 Enjoyable offers two mouse mapping modes: global and single-window.
  38 Enjoyable starts in global mode, but you can set any joystick button to
  39 the "toggle mouse scope" action, which will change the mode. If you
  40 are using Enjoy2 to play a video game, you may find that one or the
  41 other mode offers better compatibility with your game's specific
  42 requirements.
  43
  44 ## Requirements
  45
  46 * Mac OS X 10.7+
  47 * HID-compatible (e.g. USB or Bluetooth) input device
  48
  49 ## Changes
  50
  51 Version 1
  52
  53 * Forked from Enjoy/Enjoy2. The code has been modernized and optimized.
  54   Many bugs and UI issues were fixed.
  55
  56 ## License
  57
  58 Enjoyable is based on Enjoy and Enjoy2, by Sam McCall and Yifeng Huang.
  59
  60 Copyright 2013 Joe Wreschnig
  61           2012 Yifeng Huang
  62           2009 Sam McCall, University of Otago
  63
  64 Permission is hereby granted, free of charge, to any person obtaining
  65 a copy of this software and associated documentation files (the
  66 "Software"), to deal in the Software without restriction, including
  67 without limitation the rights to use, copy, modify, merge, publish,
  68 distribute, sublicense, and/or sell copies of the Software, and to
  69 permit persons to whom the Software is furnished to do so, subject to
  70 the following conditions:
  71
  72 The above copyright notice and this permission notice shall be
  73 included in all copies or substantial portions of the Software.
  74
  75 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  76 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  77 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  78 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  79 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  80 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  81 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  82
  83 The joystick icon is from the Tango icon set and is public domain.