</a><br />
Create and share mappings for different applications.
</p>
+ <p>
+ <a href="help:anchor='problems' bookID='Enjoyable Help'">
+ Troubleshooting
+ </a><br />
+ Assistance for common problems.
+ </p>
</div>
<p style="border-top: #777 solid 1px; text-align: center; margin-top: 2em">
<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Keyboard Events</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<meta name="robots" content="anchors" />
- <link href="../sty/default.css" rel="stylesheet" type="text/css" media="all"/>
+ <link href="../sty/default.css"
+ rel="stylesheet"
+ type="text/css"
+ media="all"/>
</head>
<body>
<p>
Enjoyable supports mapping joystick buttons, hat switches, and
- axis thresholds to simulate keyboard keys. To do this, first
- press the button on the joystick you want to map. This will
- select it on the left-hand side of the screen.
+ axis thresholds to simulate keyboard keys. First disable
+ mapping by deactivating the ▶ button in the top left. Then press
+ the button on the joystick you want to map. This will select it
+ on the left-hand side of the screen.
</p>
<p>
- If the button wasn't mapped, or was mapped to a key press
+ If the button wasn't mapped or was mapped to a key press
already, the key input field activates and you can simply press
the key you want to use. Otherwise, click on the <b>Press a
key</b> label or input field, then press the key.
</p>
+ <p>
+ To change a key without disabling mapping you can choose the
+ input's entry in the sidebar directly.
+ </p>
+
<h3><a name="clear_key"></a>Clearing the Selection</h3>
<p>
- To clear a mapped key, either select the <b>Do nothing</b>
- option, or press ⌥⌫ when the key input field is selected.
+ To clear a mapped key either select the <b>Do nothing</b>
+ option or press ⌥⌫ when the key input field is selected.
</p>
<h3><a name="cancel_key"></a>Cancelling the Selection</h3>
<p>
- If you select the key input field by mistake, you can press ⌥⎋
+ If you select the key input field by mistake you can press ⌥⎋
to cancel the selection without changing the current setting.
</p>
</body>
<h1>Application Mappings</h1>
</div>
+ <p>
+ You can make many different mappings and switch between them
+ easily. To open the list of mappings click the button at the
+ top-left or press ⌘L.
+ </p>
+
+ <p>
+ Click on a mapping to switch to it. Create a new mapping with
+ the + button or by typing ⌘N. Delete the current mapping with
+ the - button or ⌘⌫. Rename a mapping by double-clicking on it or
+ pressing Return while it's selected.
+ </p>
+
+ <p>
+ You can also switch mappings with the <b>Mappings</b> menu, with
+ Enjoyable's dock menu, or by pressing ⌘1 through ⌘9.
+ </p>
+
+ <p>
+ Switching mappings can also be mapped to an input. Select the
+ input you wish to use and then choose a mapping from
+ the <b>Switch to mapping</b> option. For example, you could have
+ one mapping for a game's menu and another for its main screen
+ and switch between them in-game without returning to Enjoyable.
+ </p>
+
<h3><a name="automatic"></a>Automatic Switching</h3>
-
+ <p>
+ If you name a mapping after an application it will be
+ automatically chosen when you switch to that application. The
+ name of an application is usually shown on the dock when you
+ hover your mouse over it. If you don't know the name of the
+ application you want to create a mapping for, create a mapping
+ with the name <kbd>@Application</kbd> (note the <kbd>@</kbd> at
+ the start). The mapping will automatically be renamed for the
+ next application you switch to while it's enabled.
+ </p>
<h3><a name="sharing"></a>Import and Export</h3>
-
-
+ <p>
+ Mappings can be exported and shared with other people. To export
+ your current mapping choose <b>Mappings > Export…</b> or press ⌘S and
+ save the file. This file can be shared with anyone; it doesn't
+ contain any personal information other than the product IDs of
+ the input devices you used and what you mapped them to.
+ </p>
+ <p>
+ To import a mapping choose <b>Mappings > Import…</b> or press
+ ⌘O and select the file you want to import. Mapping files end
+ with <kbd>.enjoyable</kbd> (the default), <kbd>.json</kbd>,
+ or <kbd>.txt</kbd>. If the imported mapping conflicts with one
+ you already made, you can choose to merge the two mappings or
+ create a new one with the same name.
+ </p>
</body>
</html>
</div>
<p>
- Like keyboard events, you can also map joystick input to mouse actions.
+ You can use Enjoyable to map input to mouse buttons, moving, and
+ scrolling.
</p>
- <h3><a name="analog"></a>Analog Inputs</h3>
-
+ <h3>Movement</h3>
+ <p>
+ Select the direction you'd like the input to move the
+ mouse. Adjust the movement speed using the slider underneath. If
+ you are mapping an analog input then this is the maximum speed;
+ for a button it's a constant speed.
+ </p>
+ <p>
+ The speed is set independently for each input. You can have
+ faster horizontal movement than vertical movement, or map one
+ set of inputs to a fast speed and another set to a slow
+ speed.
+ </p>
- <h3><a name="mousemode"></a>Toggle Mouse Mode</h3>
-
+ <h3>Buttons</h3>
+ <p>
+ Select the mouse button you'd like the input to simulate.
+ </p>
+ <h3><a name="scrolling"></a>Scrolling</h3>
+ <p>
+ Simulated scrolling can be continuous like the scrolling
+ gestures on a trackpad, or discrete like a mouse wheel that
+ clicks as you spin it.
+ </p>
+ <p>
+ To use <em>continuous scrolling</em> choose ↑ or ↓. Use the
+ slider underneath them to adjust the scrolling speed. If you are
+ mapping an analog input then this is the maximum speed; for a
+ button it's a constant speed.
+ <p>
+ To use <em>discrete scrolling</em> choose ⤒ or ⤓. The input
+ will trigger scrolling up or down by exactly one line and stop,
+ regardless of how long you hold the button down or how far
+ you move an analog input.
+ </p>
+ <p>
+ The arrows indicate the direction you would spin a mouse wheel
+ or move your fingers. Depending on settings this may mean you
+ need to choose a down arrow to scroll up and vice versa. You can
+ also change this globally in <b> > System Preferences… >
+ Mouse</b> and <b> > System Preferences… > Trackpad</b>.
+ </p>
+
<h3><a name="mouseissues"></a>Known Issues</h3>
<p>
Mouse events are more fragile than keyboard ones. While Enjoyble
will work fine for most games, regular OS X (Cocoa) applications
require specially formatted mouse events. Features such as
- click-and-drag or double-clicking will not work correctly, and
- so many applications will behave incorrectly if driven by an
+ click-and-drag or double-clicking will not work correctly, so
+ many applications will behave incorrectly if driven by an
Enjoyable simulated mouse.
</p>
<p>
If you find a non-Cocoa application that has problems with
Enjoyable's mouse
- support
, <a href="https://github.com/joewreschnig/enjoyable/issues">please
+ support <a href="https://github.com/joewreschnig/enjoyable/issues">please
file a ticket in the issue tracker</a>.
</p>
--- /dev/null
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Troubleshooting</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+ <meta name="robots" content="anchors" />
+ <link href="../sty/default.css"
+ rel="stylesheet"
+ type="text/css"
+ media="all"/>
+ </head>
+
+ <body>
+ <a name="problems"></a>
+
+ <div id="navbox">
+ <div id="navleftbox">
+ <a class="navlink_left"
+ href="help:anchor='home' bookID='Enjoyable Help'">
+ Home
+ </a>
+ </div>
+ </div>
+
+ <div id="headerbox">
+ <div id="iconbox">
+ <img id="iconimg"
+ src="../gfx/Icon.png"
+ alt="Icon"
+ height="32" width="32"/>
+ </div>
+ <h1>Troubleshooting</h1>
+ </div>
+
+ <h3>
+ <a name="unavailable"></a>
+ When I start Enjoyable, it says "Input devices are unavailable"
+ </h3>
+ <p>
+ This happens if Enjoyable is refused access to your input
+ devices by Mac OS X. This usually happens if another application
+ has requested exclusive access to them. Try quitting any other
+ applications using your input devices. If that doesn't work, try
+ disconnecting and reconnecting the device, then restarting
+ Enjoyable. If it still doesn't work you may need to reboot.
+ </p>
+
+ <h3>
+ <a name="noswitch"></a>
+ Enjoyable never switches to my application mapping
+ </h3>
+ <p>
+ Make sure it matches the name of the application exactly. If you
+ still have trouble, name the mapping <kbd>@Application</kbd> and
+ switch back to have Enjoyable try to deduce the correct name
+ automatically.
+ </p>
+
+ <h3>
+ Mouse clicks and drags don't work
+ <a name="brokenmouse"></a>
+ </h3>
+ <p>
+ This is a known issue with Cocoa applications, as they require
+ more specially-crafted mouse events. We hope to fix it in a
+ future version.
+ </p>
+ </body>
+</html>
projects / enjoyable.git / commitdiff