Merge pull request #2 from arithex/work

Update readme

Author: arithex

README.md

@@ -1,16 +1,28 @@
 # DragWheel #
 
-### *A mouse-as-throttle (HOJAM) experiment for [Falcon BMS](https://www.benchmarksims.org/)* ###
-
-Mouselook Gang!
+### *Hands-on-joystick-and-mouse (HOJAM) experiment for [Falcon BMS](https://www.benchmarksims.org/)* ###
+### *(Use your mouse as a throttle!)* ###
 
 Are you tired of reaching back and forth, from your mouse to the dodgy 8-bit slider on your cheapo-joystick?  Me too.
 
-I wondered, what if we could control the throttle by simply *dragging* the mouse forward and back?  There isn't any other interaction in the 3D cockpit controlled by drag/drop which should conflict with that.
+What if you could control the throttle by simply *dragging* the mouse forward and back?  There isn't any other interaction in the 3D cockpit controlled by drag/drop which should conflict with that.
+
+This simple prototype is a proof-of-concept, to try that out -- it works by hooking mouse input in the background, watching for (by default) left-button-drag movements, and generating mousewheel-rotation input events in response.  If you assign throttle-axis to the mousewheel in BMS, voila -- your mouse is now a HOTAS throttle!  (With far fewer knobs and buttons.. but hey, you can use it to look around.)
+
+This is still just a crude prototype -- but I'd like to get feedback and hear ideas before developing it further.  (Is this useful for anyone but me?)
+
+## Change Log ##
 
-So I built this simple prototype as a proof-of-concept, to try it out -- it works by hooking mouse input in the background, watching for left-button-drag movement, and generating mousewheel-rotation input events in response.  If you assign throttle-axis to the mousewheel in BMS, voila -- your mouse is now a HOTAS throttle!  (With far fewer knobs and buttons.. but hey you can use it to look around.)
+#### v1.1:
 
-Currently this is just a crude prototype -- but I'd like to get feedback and hear ideas before developing it further.  (Is this useful for anyone but me?)  Here are the details for installation and tips for configuration:
+- Implemented rudimentary tracking of throttle-lever position, and audible feedback when your throttle hits the minimum/maximum extent (and push-through afterburner detent).
+  - NOTE: for this to work, you must have mousewheel-sensitivity (in Falcon settings) set all the way to minimum.
+- Bonus feature: for those with a 5-button mouse.. you can map the two x-buttons to keyboard scancodes.  Some fun ideas: 
+  - PTT for UHF/VHS comms
+  - Look-ahead / Check-six
+  - Look-closer / Reset-FOV
+  - Speedbrake in/out
+  - Chaff/Flare programs (eg. slap switch / pgm #6)
 
 ## Instructions ##
 
@@ -33,11 +45,14 @@ Currently this is just a crude prototype -- but I'd like to get feedback and hea
   `set g_bMouseWheelKnobs 0`
 - (recommended) Disable clickable-hotspot anchoring, to clear the way for smooth uniform, mouse dragging: 
   `set g_b3DClickableCursorAnchored 0`
+- (recommended) Disable 4th-button clickable-pit toggle, if you want to utilize the new x-button remapping: 
+  `set g_bMouseButton4TogglesClickablePit 0`
 
 #### *Pre-flight:*
 
 - Simply launch `DragWheel.exe` before launching BMS .. it will open in a console window.  Left-click and drag the window up and down, by its titlebar, and observe the stream of console output to verify it's working.
-- Relocate your mouse to the left side of your keyboard .. wherever you'd place your hotas throttle if you had one.
+  - NOTE: to avoid messing up interaction in the 2D environment, wait to launch DragWheel.exe until after you enter 3D.
+- (optional) Relocate your mouse to the left side of your keyboard .. wherever you'd place your hotas throttle if you had one.
 
 #### *In BMS:*
 
@@ -51,6 +66,7 @@ Currently this is just a crude prototype -- but I'd like to get feedback and hea
 - Use right-button-drag to look around, as you normally do.
 - ***Use left-button-drag (up and down) to control the throttle (forward and back, respectively).***
 - (protip) If you prefer to fly with mouselook engaged, you can press and hold both left+right buttons simultaneously to move the throttle without panning the view up or down.  (Reminder: [alt+3] is the default key binding to toggle between mouselook and clickable-cockpit modes.)
+- (protip) If you have a dx-shift button defined, and it's convenient to press-and-hold on the stick, you can configure that as the button to engage the throttle.
 
 #### *Debrief:*
 
@@ -68,14 +84,16 @@ Currently this is just a crude prototype -- but I'd like to get feedback and hea
 - This is just a prototype / proof of concept.  The most obvious downside to this approach is, you lose ability to control FOV with the mousewheel.
   - Setting `g_fNarrowFOV 40` in bms.cfg can help mitigate that, if you assign `FOVToggle` "Look Closer" to a stick button you can make regular use of that while keeping hotas.
   - If your stick has a throttle-slider, consider assigning that to control FOV.
-- Mapping mousewheel-to-throttle isn't well supported or documented by BMS.  There are many quirks.. eg. if you click the middle-button it will still reset fov, like normal, but also it will snap your throttle to the 50% point.  And beware taxiway-starts -- be ready on the wheelbrakes -- you will spawn in with throttle immediately set to 50%!
+- Mapping mousewheel-to-throttle isn't well supported or documented by BMS.  There are many quirks.. eg. if you click the middle-button it will still reset fov, like normal, but also it will snap your throttle to the 50% point.  And beware taxiway-starts -- be ready on the wheelbrakes! -- you will spawn in with throttle immediately set to 50% (ie. about 75% MIL-power).
   - Sometimes the throttle in BMS will stop responding to mousewheel entirely .. when that happens, clicking the wheel (middle) button usually re-engages it.. usually.
 
 ## Future
 
-If this idea generates enough interest, I plan to pursue a different approach based on vJoy (or similar framework) to drive a virtual-axis for the throttle instead of relying on mousewheel.
+To avoid all the quirks and conflicts with hardcoded mousewheel behaviors, and to provide more reliable behavior based on knowing the absolute throttle-axis position -- this app needs to be rebuilt as a vJoy "feeder" application.
 
 That should be more stable, supportable, and allow the mousewheel to return to its rightful role controlling FOV.
 
-With full control of a virtual-axis, we can also add the possibility of configurable detents (eg. stop the throttle at MIL power; require a second drag to go into AB).  Or perhaps add a 2nd axis to control two engines independently -- perhaps by dragging with buttons 4 & 5 held (for 5-button mice) or dragging with a modifier key held.  Or .. whatever other crazy ideas we come up with.
+Other changes in progress:
 
+- use BMS shared memory interface to only hook the mouse while in 3D pit
+- optional overlay to display throttle position, rpm, ftit, brake