From: Joe Wreschnig Date: Wed, 6 Mar 2013 14:12:27 +0000 (+0100) Subject: Finish first draft of manual. X-Git-Tag: version-1.0~27 X-Git-Url: https://git.yukkurigames.com/?a=commitdiff_plain;h=1714378fcdcaab227f99df6bbf5963ea9b94d525;p=enjoyable.git Finish first draft of manual. --- diff --git a/Enjoyable Help/Enjoyable Help.helpindex b/Enjoyable Help/Enjoyable Help.helpindex index 47ef795..2c29321 100644 Binary files a/Enjoyable Help/Enjoyable Help.helpindex and b/Enjoyable Help/Enjoyable Help.helpindex differ diff --git a/Enjoyable Help/Enjoyable Help.html b/Enjoyable Help/Enjoyable Help.html index e5ba139..d2e382b 100644 --- a/Enjoyable Help/Enjoyable Help.html +++ b/Enjoyable Help/Enjoyable Help.html @@ -61,6 +61,12 @@
Create and share mappings for different applications.

+

+ + Troubleshooting +
+ Assistance for common problems. +

diff --git a/Enjoyable Help/pgs/keyboard.html b/Enjoyable Help/pgs/keyboard.html index 99c414d..1facc88 100644 --- a/Enjoyable Help/pgs/keyboard.html +++ b/Enjoyable Help/pgs/keyboard.html @@ -1,11 +1,15 @@ - + Keyboard Events - + @@ -32,27 +36,33 @@

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.

- 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 Press a key label or input field, then press the key.

+

+ To change a key without disabling mapping you can choose the + input's entry in the sidebar directly. +

+

Clearing the Selection

- To clear a mapped key, either select the Do nothing - option, or press ⌥⌫ when the key input field is selected. + To clear a mapped key either select the Do nothing + option or press ⌥⌫ when the key input field is selected.

Cancelling the Selection

- 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.

diff --git a/Enjoyable Help/pgs/mappings.html b/Enjoyable Help/pgs/mappings.html index 27942d4..6a49461 100644 --- a/Enjoyable Help/pgs/mappings.html +++ b/Enjoyable Help/pgs/mappings.html @@ -34,11 +34,59 @@

Application Mappings

+

+ 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. +

+ +

+ 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. +

+ +

+ You can also switch mappings with the Mappings menu, with + Enjoyable's dock menu, or by pressing ⌘1 through ⌘9. +

+ +

+ Switching mappings can also be mapped to an input. Select the + input you wish to use and then choose a mapping from + the Switch to mapping 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. +

+

Automatic Switching

- +

+ 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 @Application (note the @ at + the start). The mapping will automatically be renamed for the + next application you switch to while it's enabled. +

Import and Export

- - +

+ Mappings can be exported and shared with other people. To export + your current mapping choose Mappings > Export… 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. +

+

+ To import a mapping choose Mappings > Import… or press + ⌘O and select the file you want to import. Mapping files end + with .enjoyable (the default), .json, + or .txt. 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. +

diff --git a/Enjoyable Help/pgs/mouse.html b/Enjoyable Help/pgs/mouse.html index f7b5097..e02df2e 100644 --- a/Enjoyable Help/pgs/mouse.html +++ b/Enjoyable Help/pgs/mouse.html @@ -35,28 +35,67 @@

- 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.

-

Analog Inputs

- +

Movement

+

+ 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. +

+

+ 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. +

-

Toggle Mouse Mode

- +

Buttons

+

+ Select the mouse button you'd like the input to simulate. +

+

Scrolling

+

+ Simulated scrolling can be continuous like the scrolling + gestures on a trackpad, or discrete like a mouse wheel that + clicks as you spin it. +

+

+ To use continuous scrolling 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. +

+ To use discrete scrolling 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. +

+

+ 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  > System Preferences… > + Mouse and  > System Preferences… > Trackpad. +

+

Known Issues

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.

If you find a non-Cocoa application that has problems with Enjoyable's mouse - support, please + support please file a ticket in the issue tracker.

diff --git a/Enjoyable Help/pgs/problems.html b/Enjoyable Help/pgs/problems.html new file mode 100644 index 0000000..a472cff --- /dev/null +++ b/Enjoyable Help/pgs/problems.html @@ -0,0 +1,71 @@ + + + + + Troubleshooting + + + + + + + + + + +
+
+ Icon +
+

Troubleshooting

+
+ +

+ + When I start Enjoyable, it says "Input devices are unavailable" +

+

+ 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. +

+ +

+ + Enjoyable never switches to my application mapping +

+

+ Make sure it matches the name of the application exactly. If you + still have trouble, name the mapping @Application and + switch back to have Enjoyable try to deduce the correct name + automatically. +

+ +

+ Mouse clicks and drags don't work + +

+

+ 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. +

+ +