Clean up root folder.
[enjoyable.git] / Resources / Help / Contents / Resources / English.lproj / pgs / mouse.html
diff --git a/Resources/Help/Contents/Resources/English.lproj/pgs/mouse.html b/Resources/Help/Contents/Resources/English.lproj/pgs/mouse.html
new file mode 100644 (file)
index 0000000..0293fd0
--- /dev/null
@@ -0,0 +1,102 @@
+<?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>Mouse Events</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+    <link href="../sty/default.css"
+          rel="stylesheet"
+          type="text/css"
+          media="all"/>
+  </head>
+  
+  <body>
+    <a name="mouse"></a>
+    
+    <div id="navbox">
+      <div id="navleftbox">
+        <a class="navlink_left"
+           href="help:anchor='home' bookID='com.yukkurigames.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>Mouse Events</h1>
+    </div>
+
+    <p>
+      You can use Enjoyable to map input to mouse buttons, moving, and
+      scrolling.
+    </p>
+
+    <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>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, 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
+      file a ticket in the issue tracker</a>.
+    </p>
+    
+  </body>
+</html>