From: Joe Wreschnig Date: Wed, 6 Mar 2013 17:43:28 +0000 (+0100) Subject: Move help files around. Build index correctly. X-Git-Tag: version-1.0~24 X-Git-Url: https://git.yukkurigames.com/?p=enjoyable.git;a=commitdiff_plain;h=c64183eb482084e21263968d22de0fa8feab97c9 Move help files around. Build index correctly. --- diff --git a/Enjoyable Help/Enjoyable Help.helpindex b/Enjoyable Help/Enjoyable Help.helpindex deleted file mode 100644 index 8a646b3..0000000 Binary files a/Enjoyable Help/Enjoyable Help.helpindex and /dev/null differ diff --git a/Enjoyable Help/Enjoyable Help.html b/Enjoyable Help/Enjoyable Help.html deleted file mode 100644 index 4c8ec53..0000000 --- a/Enjoyable Help/Enjoyable Help.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - Enjoyable Help - - - - - - - - - - - - -
-
- Enjoyable Icon -
-
-

Enjoyable Help

-
-
- -

- Enjoyable helps you use a joystick or gamepad to control - applications which normally require a keyboard and mouse. -

- -
-

Quick Start

-
- -
-

- - Keyboard Events -
- Map buttons to keys on a keyboard. -

-

- - Mouse Events -
- Use axes and buttons to simulate a mouse. -

-

- - Application Mappings -
- Create and share mappings for different applications. -

-

- - Troubleshooting -
- Assistance for common problems. -

-
- -

- - license - - - - - website - -

- - - diff --git a/Enjoyable Help/gfx/Icon.png b/Enjoyable Help/gfx/Icon.png deleted file mode 100644 index 36c4254..0000000 Binary files a/Enjoyable Help/gfx/Icon.png and /dev/null differ diff --git a/Enjoyable Help/pgs/boring.html b/Enjoyable Help/pgs/boring.html deleted file mode 100644 index 89c0efb..0000000 --- a/Enjoyable Help/pgs/boring.html +++ /dev/null @@ -1,74 +0,0 @@ - - - - - License & Copyright - - - - - - - - - - -
-
- Icon -
-

License & Copyright

-
- -

Copyright

-

- 2013 Joe Wreschnig
- 2012 Yifeng Huang
- 2009 Sam McCall & the University of Otago -

- -

License

-

- Permission is hereby granted, free of charge, to any person - obtaining a copy of this software and associated documentation - files (the "Software"), to deal in the Software without - restriction, including without limitation the rights to use, - copy, modify, merge, publish, distribute, sublicense, and/or - sell copies of the Software, and to permit persons to whom the - Software is furnished to do so, subject to the following - conditions: -

-

- The above copyright notice and this permission notice shall be - included in all copies or substantial portions of the Software. -

-

- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES - OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND - NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT - HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, - WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING - FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR - OTHER DEALINGS IN THE SOFTWARE. -

-

- The joystick icon is from the Tango icon set and is public - domain. -

- - diff --git a/Enjoyable Help/pgs/keyboard.html b/Enjoyable Help/pgs/keyboard.html deleted file mode 100644 index 1facc88..0000000 --- a/Enjoyable Help/pgs/keyboard.html +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Keyboard Events - - - - - - - - - - -
-
- Enjoyable Icon -
-

Keyboard Events

-
- -

- Enjoyable supports mapping joystick buttons, hat switches, and - 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 - 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. -

- -

Cancelling the Selection

-

- 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 deleted file mode 100644 index 6a49461..0000000 --- a/Enjoyable Help/pgs/mappings.html +++ /dev/null @@ -1,92 +0,0 @@ - - - - - Application Mappings - - - - - - - - - - -
-
- Icon -
-

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 deleted file mode 100644 index e02df2e..0000000 --- a/Enjoyable Help/pgs/mouse.html +++ /dev/null @@ -1,103 +0,0 @@ - - - - - Mouse Events - - - - - - - - - - -
-
- Icon -
-

Mouse Events

-
- -

- You can use Enjoyable to map input to mouse buttons, moving, and - scrolling. -

- -

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

- -

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, 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 - file a ticket in the issue tracker. -

- - - diff --git a/Enjoyable Help/pgs/problems.html b/Enjoyable Help/pgs/problems.html deleted file mode 100644 index a472cff..0000000 --- a/Enjoyable Help/pgs/problems.html +++ /dev/null @@ -1,71 +0,0 @@ - - - - - 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. -

- - diff --git a/Enjoyable Help/pgs/template.html b/Enjoyable Help/pgs/template.html deleted file mode 100644 index 2825bb5..0000000 --- a/Enjoyable Help/pgs/template.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - Title - - - - - - - - - - -
-
- Icon -
-

Title

-
- -

- Content starts here. -

- - diff --git a/Enjoyable Help/sty/default.css b/Enjoyable Help/sty/default.css deleted file mode 100644 index 58b7747..0000000 --- a/Enjoyable Help/sty/default.css +++ /dev/null @@ -1 +0,0 @@ -body { font-size: 8pt; font-family: "Lucida Grande", Arial, sans-serif; line-height: 12pt; text-decoration: none; margin-right: 1em; margin-left: 1em; } #navbox { background-color: #f2f2f2; position: fixed; top: 0; left: 0; width: 100%; height: 1.5em; float: left; border-bottom: 1px solid #bfbfbf } #navleftbox { position: absolute; top: 1px; left: 15px } #navrightbox { background-color: #f2f2f2; padding-right: 25px; float: right; padding-bottom: 1px; border-left: 1px solid #bfbfbf } #navbox a { font-size: 8pt; color: #666; font-weight: normal; margin: -9px 0 -6px; } #headerbox { margin-top: 36px; padding-right: 6px; margin-bottom: 2em; } #iconbox { float: left; } h1 { margin-left: 40px; width: 88%; font-size: 15pt; line-height: 15pt; font-weight: bold; padding-top: 6px; margin-bottom: 0; } h2 { font-size: 11pt; line-height: 12pt; font-weight: bold; color: black; margin-top: 0; margin-bottom: 11px; } h3 { font-size: 8pt; font-weight: bold; letter-spacing: 0.1em; line-height: 8pt; color: #666; margin-top: 1em; margin-bottom: 0px; padding-bottom: 0.5em; } p { margin-left: 0px; margin-top: 0px; margin-bottom: 0.5em; } ul { margin-left: 2em; margin-top: 6px; margin-bottom: 0px; padding-left: 0px; } li { margin-left: 0px; } a { color: #778fbd; font-size: 9pt; font-weight: bold; text-decoration: none; } a:hover { text-decoration: underline; } .weblink { color: #666; font-weight: normal; } \ No newline at end of file diff --git a/Enjoyable.xcodeproj/project.pbxproj b/Enjoyable.xcodeproj/project.pbxproj index d28d5b8..9e1bd43 100644 --- a/Enjoyable.xcodeproj/project.pbxproj +++ b/Enjoyable.xcodeproj/project.pbxproj @@ -30,10 +30,11 @@ D594BF830FAE9661007A85F2 /* EnjoyableApplicationDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = D594BF820FAE9661007A85F2 /* EnjoyableApplicationDelegate.m */; }; D5F809710FB093400006A4DE /* NJOutputMapping.m in Sources */ = {isa = PBXBuildFile; fileRef = D5F809700FB093400006A4DE /* NJOutputMapping.m */; }; D5F80A9D0FB0A2FF0006A4DE /* icon.icns in Resources */ = {isa = PBXBuildFile; fileRef = D5617A080FAEAF8300928B3A /* icon.icns */; }; - EE03150D16E63481002B2DCE /* Enjoyable Help in Resources */ = {isa = PBXBuildFile; fileRef = EE03150C16E63481002B2DCE /* Enjoyable Help */; }; + EE03150D16E63481002B2DCE /* Help in Resources */ = {isa = PBXBuildFile; fileRef = EE03150C16E63481002B2DCE /* Help */; }; EE1D7C9216E01E7000B000EB /* NSView+FirstResponder.m in Sources */ = {isa = PBXBuildFile; fileRef = EE1D7C9116E01E7000B000EB /* NSView+FirstResponder.m */; }; EE1D7C9616E0ECCF00B000EB /* NSError+Description.m in Sources */ = {isa = PBXBuildFile; fileRef = EE1D7C9516E0ECCF00B000EB /* NSError+Description.m */; }; EE96929416E54B480054A3C8 /* NSMenu+RepresentedObjectAccessors.m in Sources */ = {isa = PBXBuildFile; fileRef = EE96929316E54B480054A3C8 /* NSMenu+RepresentedObjectAccessors.m */; }; + EED7E81516E7ADBB004A0BA4 /* Info.plist in Resources */ = {isa = PBXBuildFile; fileRef = EED7E81416E7ADBB004A0BA4 /* Info.plist */; }; /* End PBXBuildFile section */ /* Begin PBXFileReference section */ @@ -82,13 +83,14 @@ D594BF820FAE9661007A85F2 /* EnjoyableApplicationDelegate.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = EnjoyableApplicationDelegate.m; sourceTree = ""; }; D5F8096F0FB093400006A4DE /* NJOutputMapping.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = NJOutputMapping.h; sourceTree = ""; }; D5F809700FB093400006A4DE /* NJOutputMapping.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = NJOutputMapping.m; sourceTree = ""; }; - EE03150C16E63481002B2DCE /* Enjoyable Help */ = {isa = PBXFileReference; lastKnownFileType = folder; path = "Enjoyable Help"; sourceTree = ""; }; + EE03150C16E63481002B2DCE /* Help */ = {isa = PBXFileReference; lastKnownFileType = folder; path = Help; sourceTree = ""; }; EE1D7C9016E01E7000B000EB /* NSView+FirstResponder.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "NSView+FirstResponder.h"; sourceTree = ""; }; EE1D7C9116E01E7000B000EB /* NSView+FirstResponder.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "NSView+FirstResponder.m"; sourceTree = ""; }; EE1D7C9416E0ECCF00B000EB /* NSError+Description.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "NSError+Description.h"; sourceTree = ""; }; EE1D7C9516E0ECCF00B000EB /* NSError+Description.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "NSError+Description.m"; sourceTree = ""; }; EE96929216E54B480054A3C8 /* NSMenu+RepresentedObjectAccessors.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "NSMenu+RepresentedObjectAccessors.h"; sourceTree = ""; }; EE96929316E54B480054A3C8 /* NSMenu+RepresentedObjectAccessors.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "NSMenu+RepresentedObjectAccessors.m"; sourceTree = ""; }; + EED7E81416E7ADBB004A0BA4 /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = Info.plist; path = Help/Contents/Info.plist; sourceTree = ""; }; EEF86B7316E2241000674B87 /* NJInputPathElement.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = NJInputPathElement.h; sourceTree = ""; }; EEF86B7416E298CD00674B87 /* NJEvents.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = NJEvents.h; sourceTree = ""; }; /* End PBXFileReference section */ @@ -177,6 +179,7 @@ 29B97314FDCFA39411CA2CEA /* Enjoy */ = { isa = PBXGroup; children = ( + EED7E81416E7ADBB004A0BA4 /* Info.plist */, 080E96DDFE201D6D7F000001 /* Classes */, EE1D5F8B16E403D600749C36 /* Categories */, 29B97315FDCFA39411CA2CEA /* Other Sources */, @@ -200,7 +203,7 @@ 29B97317FDCFA39411CA2CEA /* Resources */ = { isa = PBXGroup; children = ( - EE03150C16E63481002B2DCE /* Enjoyable Help */, + EE03150C16E63481002B2DCE /* Help */, D5617A080FAEAF8300928B3A /* icon.icns */, 8D1107310486CEB800E47090 /* Info.plist */, 089C165CFE840E0CC02AAC07 /* InfoPlist.strings */, @@ -238,6 +241,7 @@ isa = PBXNativeTarget; buildConfigurationList = C01FCF4A08A954540054247B /* Build configuration list for PBXNativeTarget "Enjoyable" */; buildPhases = ( + EED7E81616E7B547004A0BA4 /* ShellScript */, 8D1107290486CEB800E47090 /* Resources */, 8D11072C0486CEB800E47090 /* Sources */, 8D11072E0486CEB800E47090 /* Frameworks */, @@ -287,12 +291,29 @@ 8D11072B0486CEB800E47090 /* InfoPlist.strings in Resources */, 1DDD58160DA1D0A300B32029 /* MainMenu.xib in Resources */, D5F80A9D0FB0A2FF0006A4DE /* icon.icns in Resources */, - EE03150D16E63481002B2DCE /* Enjoyable Help in Resources */, + EE03150D16E63481002B2DCE /* Help in Resources */, + EED7E81516E7ADBB004A0BA4 /* Info.plist in Resources */, ); runOnlyForDeploymentPostprocessing = 0; }; /* End PBXResourcesBuildPhase section */ +/* Begin PBXShellScriptBuildPhase section */ + EED7E81616E7B547004A0BA4 /* ShellScript */ = { + isa = PBXShellScriptBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + inputPaths = ( + ); + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "cd ${SOURCE_ROOT}/Help/Contents/Resources/English.lproj\nmake\n"; + }; +/* End PBXShellScriptBuildPhase section */ + /* Begin PBXSourcesBuildPhase section */ 8D11072C0486CEB800E47090 /* Sources */ = { isa = PBXSourcesBuildPhase; diff --git a/Help/Contents/Info.plist b/Help/Contents/Info.plist new file mode 100644 index 0000000..e62b80f --- /dev/null +++ b/Help/Contents/Info.plist @@ -0,0 +1,34 @@ + + + + + CFBundleIdentifier + com.yukkurigames.Enjoyable.help + CFBundleDevelopmentRegion + en_US + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + Enjoyable + CFBundlePackageType + BNDL + CFBundleShortVersionString + 1 + CFBundleSignature + hbwr + CFBundleVersion + 1 + HPDBookAccessPath + index.html + HPDBookIconPath + gfx/Icon.png + HPDBookIndexPath + Enjoyable.helpindex + HPDBookKBProduct + enjoyable1 + HPDBookTitle + Enjoyable Help + HPDBookType + 3 + + diff --git a/Help/Contents/Resources/English.lproj/Enjoyable.helpindex b/Help/Contents/Resources/English.lproj/Enjoyable.helpindex new file mode 100644 index 0000000..ba5a567 Binary files /dev/null and b/Help/Contents/Resources/English.lproj/Enjoyable.helpindex differ diff --git a/Help/Contents/Resources/English.lproj/gfx/Icon.png b/Help/Contents/Resources/English.lproj/gfx/Icon.png new file mode 100644 index 0000000..36c4254 Binary files /dev/null and b/Help/Contents/Resources/English.lproj/gfx/Icon.png differ diff --git a/Help/Contents/Resources/English.lproj/index.html b/Help/Contents/Resources/English.lproj/index.html new file mode 100644 index 0000000..9003192 --- /dev/null +++ b/Help/Contents/Resources/English.lproj/index.html @@ -0,0 +1,83 @@ + + + + + Enjoyable Help + + + + + + + + + + + + +
+
+ Enjoyable Icon +
+
+

Enjoyable Help

+
+
+ +

+ Enjoyable helps you use a joystick or gamepad to control + applications which normally require a keyboard and mouse. +

+ +
+

Quick Start

+
    +
  • Connect a joystick or gamepad.
    • +
  • Press a button on it, then the keyboard key you want to use.
    • +
  • Press the ▶ button in the upper-right.
    • +
  • Start up your game and use your gamepad!
    • + +
+ +
+

+ + Keyboard Events +
+ Map buttons to keys on a keyboard. +

+

+ + Mouse Events +
+ Use axes and buttons to simulate a mouse. +

+

+ + Application Mappings +
+ Create and share mappings for different applications. +

+

+ + Troubleshooting +
+ Assistance for common problems. +

+
+ +

+ + license + + - + + website + +

+ + + diff --git a/Help/Contents/Resources/English.lproj/pgs/boring.html b/Help/Contents/Resources/English.lproj/pgs/boring.html new file mode 100644 index 0000000..45c6719 --- /dev/null +++ b/Help/Contents/Resources/English.lproj/pgs/boring.html @@ -0,0 +1,73 @@ + + + + + License & Copyright + + + + + + + + + +
+
+ Icon +
+

License & Copyright

+
+ +

Copyright

+

+ 2013 Joe Wreschnig
+ 2012 Yifeng Huang
+ 2009 Sam McCall & the University of Otago +

+ +

License

+

+ Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, + copy, modify, merge, publish, distribute, sublicense, and/or + sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following + conditions: +

+

+ The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. +

+

+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + OTHER DEALINGS IN THE SOFTWARE. +

+

+ The joystick icon is from the Tango icon set and is public + domain. +

+ + diff --git a/Help/Contents/Resources/English.lproj/pgs/keyboard.html b/Help/Contents/Resources/English.lproj/pgs/keyboard.html new file mode 100644 index 0000000..dca6136 --- /dev/null +++ b/Help/Contents/Resources/English.lproj/pgs/keyboard.html @@ -0,0 +1,68 @@ + + + + + Keyboard Events + + + + + + + + + +
+
+ Enjoyable Icon +
+

Keyboard Events

+
+ +

+ Enjoyable supports mapping joystick buttons, hat switches, and + 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 + 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. +

+ +

Cancelling the Selection

+

+ If you select the key input field by mistake you can press ⌥⎋ + to cancel the selection without changing the current setting. +

+ + diff --git a/Help/Contents/Resources/English.lproj/pgs/mappings.html b/Help/Contents/Resources/English.lproj/pgs/mappings.html new file mode 100644 index 0000000..b45591a --- /dev/null +++ b/Help/Contents/Resources/English.lproj/pgs/mappings.html @@ -0,0 +1,91 @@ + + + + + Application Mappings + + + + + + + + + +
+
+ Icon +
+

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/Help/Contents/Resources/English.lproj/pgs/mouse.html b/Help/Contents/Resources/English.lproj/pgs/mouse.html new file mode 100644 index 0000000..0293fd0 --- /dev/null +++ b/Help/Contents/Resources/English.lproj/pgs/mouse.html @@ -0,0 +1,102 @@ + + + + + Mouse Events + + + + + + + + + +
+
+ Icon +
+

Mouse Events

+
+ +

+ You can use Enjoyable to map input to mouse buttons, moving, and + scrolling. +

+ +

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

+ +

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, 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 + file a ticket in the issue tracker. +

+ + + diff --git a/Help/Contents/Resources/English.lproj/pgs/problems.html b/Help/Contents/Resources/English.lproj/pgs/problems.html new file mode 100644 index 0000000..8f3aa68 --- /dev/null +++ b/Help/Contents/Resources/English.lproj/pgs/problems.html @@ -0,0 +1,70 @@ + + + + + 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. +

+ + diff --git a/Help/Contents/Resources/English.lproj/sty/default.css b/Help/Contents/Resources/English.lproj/sty/default.css new file mode 100644 index 0000000..58b7747 --- /dev/null +++ b/Help/Contents/Resources/English.lproj/sty/default.css @@ -0,0 +1 @@ +body { font-size: 8pt; font-family: "Lucida Grande", Arial, sans-serif; line-height: 12pt; text-decoration: none; margin-right: 1em; margin-left: 1em; } #navbox { background-color: #f2f2f2; position: fixed; top: 0; left: 0; width: 100%; height: 1.5em; float: left; border-bottom: 1px solid #bfbfbf } #navleftbox { position: absolute; top: 1px; left: 15px } #navrightbox { background-color: #f2f2f2; padding-right: 25px; float: right; padding-bottom: 1px; border-left: 1px solid #bfbfbf } #navbox a { font-size: 8pt; color: #666; font-weight: normal; margin: -9px 0 -6px; } #headerbox { margin-top: 36px; padding-right: 6px; margin-bottom: 2em; } #iconbox { float: left; } h1 { margin-left: 40px; width: 88%; font-size: 15pt; line-height: 15pt; font-weight: bold; padding-top: 6px; margin-bottom: 0; } h2 { font-size: 11pt; line-height: 12pt; font-weight: bold; color: black; margin-top: 0; margin-bottom: 11px; } h3 { font-size: 8pt; font-weight: bold; letter-spacing: 0.1em; line-height: 8pt; color: #666; margin-top: 1em; margin-bottom: 0px; padding-bottom: 0.5em; } p { margin-left: 0px; margin-top: 0px; margin-bottom: 0.5em; } ul { margin-left: 2em; margin-top: 6px; margin-bottom: 0px; padding-left: 0px; } li { margin-left: 0px; } a { color: #778fbd; font-size: 9pt; font-weight: bold; text-decoration: none; } a:hover { text-decoration: underline; } .weblink { color: #666; font-weight: normal; } \ No newline at end of file diff --git a/Info.plist b/Info.plist index 4a530d9..3881216 100644 --- a/Info.plist +++ b/Info.plist @@ -3,9 +3,9 @@ CFBundleHelpBookName - Enjoyable Help + com.yukkurigames.Enjoyable.help CFBundleHelpBookFolder - Enjoyable Help + Help NSSupportsAutomaticTermination YES NSSupportsSuddenTermination