From: Joe Wreschnig Date: Sat, 9 Mar 2013 20:09:22 +0000 (+0100) Subject: Update documentation for mouse events. X-Git-Tag: version-1.1~69 X-Git-Url: https://git.yukkurigames.com/?a=commitdiff_plain;h=9ea06d60bddf1a35b0e8de00cf7516b6f7affe74;p=enjoyable.git Update documentation for mouse events. --- diff --git a/Enjoyable.xcodeproj/project.pbxproj b/Enjoyable.xcodeproj/project.pbxproj index 837baa9..276335d 100644 --- a/Enjoyable.xcodeproj/project.pbxproj +++ b/Enjoyable.xcodeproj/project.pbxproj @@ -14,6 +14,7 @@ EE3D897F16EA817E00596D1F /* Status Menu Icon Disabled.png in Resources */ = {isa = PBXBuildFile; fileRef = EE3D897D16EA817E00596D1F /* Status Menu Icon Disabled.png */; }; EE3D898016EA817E00596D1F /* Status Menu Icon.png in Resources */ = {isa = PBXBuildFile; fileRef = EE3D897E16EA817E00596D1F /* Status Menu Icon.png */; }; EE6A122E16E8F46300EDBD32 /* Icon.icns in Resources */ = {isa = PBXBuildFile; fileRef = EE6A122D16E8F46300EDBD32 /* Icon.icns */; }; + EECDEE2916EBCAF800DE7450 /* whatsnew.html in Resources */ = {isa = PBXBuildFile; fileRef = EECDEE2816EBCAF800DE7450 /* whatsnew.html */; }; EEE73B1616EA42E5009D9D99 /* NSRunningApplication+NJPossibleNames.m in Sources */ = {isa = PBXBuildFile; fileRef = EEE73B1516EA42E5009D9D99 /* NSRunningApplication+NJPossibleNames.m */; }; EEF17D1916E8E21A00D7DC4D /* com.yukkurigames.Enjoyable.mapping.icns in Resources */ = {isa = PBXBuildFile; fileRef = EEF17D1716E8E21A00D7DC4D /* com.yukkurigames.Enjoyable.mapping.icns */; }; EEF17D1F16E8E23A00D7DC4D /* InfoPlist.strings in Resources */ = {isa = PBXBuildFile; fileRef = EEF17D1B16E8E23A00D7DC4D /* InfoPlist.strings */; }; @@ -57,6 +58,7 @@ EE3D897D16EA817E00596D1F /* Status Menu Icon Disabled.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; name = "Status Menu Icon Disabled.png"; path = "Resources/Status Menu Icon Disabled.png"; sourceTree = ""; }; EE3D897E16EA817E00596D1F /* Status Menu Icon.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; name = "Status Menu Icon.png"; path = "Resources/Status Menu Icon.png"; sourceTree = ""; }; EE6A122D16E8F46300EDBD32 /* Icon.icns */ = {isa = PBXFileReference; lastKnownFileType = image.icns; path = Icon.icns; sourceTree = ""; }; + EECDEE2816EBCAF800DE7450 /* whatsnew.html */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.html; name = whatsnew.html; path = Resources/Help/Contents/Resources/English.lproj/pgs/whatsnew.html; sourceTree = ""; }; EEE73B1416EA42E5009D9D99 /* NSRunningApplication+NJPossibleNames.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = "NSRunningApplication+NJPossibleNames.h"; path = "Categories/NSRunningApplication+NJPossibleNames.h"; sourceTree = ""; }; EEE73B1516EA42E5009D9D99 /* NSRunningApplication+NJPossibleNames.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = "NSRunningApplication+NJPossibleNames.m"; path = "Categories/NSRunningApplication+NJPossibleNames.m"; sourceTree = ""; }; EEF17D1716E8E21A00D7DC4D /* com.yukkurigames.Enjoyable.mapping.icns */ = {isa = PBXFileReference; lastKnownFileType = image.icns; name = com.yukkurigames.Enjoyable.mapping.icns; path = Resources/com.yukkurigames.Enjoyable.mapping.icns; sourceTree = ""; }; @@ -199,6 +201,7 @@ 29B97314FDCFA39411CA2CEA /* Enjoy */ = { isa = PBXGroup; children = ( + EECDEE2816EBCAF800DE7450 /* whatsnew.html */, 8D1107310486CEB800E47090 /* Info.plist */, 080E96DDFE201D6D7F000001 /* Classes */, EE1D5F8B16E403D600749C36 /* Categories */, @@ -330,6 +333,7 @@ EE3D897C16EA806E00596D1F /* Status Menu Icon Disabled@2x.png in Resources */, EE3D897F16EA817E00596D1F /* Status Menu Icon Disabled.png in Resources */, EE3D898016EA817E00596D1F /* Status Menu Icon.png in Resources */, + EECDEE2916EBCAF800DE7450 /* whatsnew.html in Resources */, ); runOnlyForDeploymentPostprocessing = 0; }; diff --git a/Info.plist b/Info.plist index c382613..76b3f48 100644 --- a/Info.plist +++ b/Info.plist @@ -46,7 +46,7 @@ CFBundleSignature ???? CFBundleVersion - 77 + 84 LSApplicationCategoryType public.app-category.utilities NSHumanReadableCopyright diff --git a/Resources/Help/Contents/Info.plist b/Resources/Help/Contents/Info.plist index e62b80f..1f4edfb 100644 --- a/Resources/Help/Contents/Info.plist +++ b/Resources/Help/Contents/Info.plist @@ -13,11 +13,11 @@ CFBundlePackageType BNDL CFBundleShortVersionString - 1 + 1.1 CFBundleSignature hbwr CFBundleVersion - 1 + 2 HPDBookAccessPath index.html HPDBookIconPath diff --git a/Resources/Help/Contents/Resources/English.lproj/index.html b/Resources/Help/Contents/Resources/English.lproj/index.html index 1a52296..10d998a 100644 --- a/Resources/Help/Contents/Resources/English.lproj/index.html +++ b/Resources/Help/Contents/Resources/English.lproj/index.html @@ -33,6 +33,11 @@

+

+ + What's New in 1.1? + +

Quick Start

  • Connect a joystick or gamepad.
  • diff --git a/Resources/Help/Contents/Resources/English.lproj/pgs/mouse.html b/Resources/Help/Contents/Resources/English.lproj/pgs/mouse.html index 0293fd0..c88e8ad 100644 --- a/Resources/Help/Contents/Resources/English.lproj/pgs/mouse.html +++ b/Resources/Help/Contents/Resources/English.lproj/pgs/mouse.html @@ -61,18 +61,21 @@

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

    - 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 continuous scrolling check the Smooth + button and use the slider underneath the directions 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. Scrolling will continue as long as as the input is held + down.

    - 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. + To use discrete scrolling leave the button + unchecked. The input will trigger scrolling 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 @@ -84,19 +87,12 @@

    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 + Enjoyable is unable to send most mouse events to itself - the + application will freeze until you click on it with a real mouse + or touchpad. If you find another appliation that has problems + with Enjoyable's mouse support please file a ticket in the issue tracker. -

    - +

    diff --git a/Resources/Help/Contents/Resources/English.lproj/pgs/problems.html b/Resources/Help/Contents/Resources/English.lproj/pgs/problems.html index 8f3aa68..5cb6d8c 100644 --- a/Resources/Help/Contents/Resources/English.lproj/pgs/problems.html +++ b/Resources/Help/Contents/Resources/English.lproj/pgs/problems.html @@ -62,9 +62,13 @@

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

    + For reasons yet to be determined, Enjoyable can freeze if it + receives its own simulated mouse events. All other applications + should work fine; however, mouse events are finicky and it's + possible some applications may not like the way they are + handled. If you find an appliation that has problems with + Enjoyable's mouse support please + file a ticket in the issue tracker.

    diff --git a/Resources/Help/Contents/Resources/English.lproj/pgs/whatsnew.html b/Resources/Help/Contents/Resources/English.lproj/pgs/whatsnew.html new file mode 100644 index 0000000..a299806 --- /dev/null +++ b/Resources/Help/Contents/Resources/English.lproj/pgs/whatsnew.html @@ -0,0 +1,61 @@ + + + + + What's New in Enjoyable + + + + + + + + + +
    +
    + Icon +
    +

    What's New in 1.1

    +
    + +
      +
    • + The system menu bar now contains a status item when + Enjoyable is running. You can enable and disable it + and change mappings from this item. It flashes briefly + when the mapping changes automatically. +
    • +
    • + The middle mouse button, mouse buttons 4 and 5, and + horizontal scroll wheels can be simulated. +
    • +
    • + Many mouse issues have been fixed. Click-and-drag, + double-click, and other combined mouse gestures work + correctly in most applications other than Enjoyable + itself. +
    • +
    • + Automatic switching for applications with ambiguous + names (e.g. "Flash Player") has been improved. You can + now also name a mapping after the application's + filename. +
    • +
    + + \ No newline at end of file