Skip to content

Commit

Permalink
Fixed up the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
rajetic committed Sep 5, 2018
1 parent 246cce7 commit 26d93ba
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 87 deletions.
87 changes: 0 additions & 87 deletions bin/readme.txt

This file was deleted.

14 changes: 14 additions & 0 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,29 @@ AutoOculusTouch is a library and script for AutoHotKey. It allows you to read th
Prerequisites
You must have AutoHotKey installed. It is available from https://autohotkey.com
(AutoOculusTouch is tested against AutoHotKey version 1.1.29.01)
If you want vJoy support, you must have it installed. It is available from http://vjoystick.sourceforge.net/site/index.php/download-a-install
(AutoOculusTouch is tested against vJoy version 2.1.8)


Change History
v0.1.1 - Initial release. Built against Oculus SDK 1.10
v0.1.2 - Added capacitive sensor support. Built against Oculus SDK 1.20
v0.1.3 - Changed initialisation to use Invisible mode. Added button comments to example script.
v0.1.4 - Added vibration. Added orientation tracking (yaw, pitch, roll) for touch. More example scripts. Built against Oculus SDK 1.26
v0.1.5 - Added vJoy integration. You can now output gamepad/joystick values for axes and buttons.


Installation
AutoOculusTouch can be placed anywhere. No explicit installation is required.
There are several files included in the AutoOculusTouch binary release:
- auto_oculus_touch.dll (A library that wraps around the Oculus SDK.
- vJoyInterface.dll (Interface to the vJoy drivers)
- auto_oculus_touch.ahk (An AutoHotKey script that defines various Oculus related functions. This is needed by the other scripts)
- oculus_remote_mouse.ahk (Lets you use the remote as a mouse. Up/Down/Left/Right move. The centre button is left mouse. The back button is right mouse)
- oculus_remote_spotify.ahk (Send media keys with the remote. Up is previous track, Down is next track, centre button is play/pause. Not just for spotify, works with any media key compatible program)
- oculus_touch_mouse.ahk (Move the mouse with the right touch controller. Index trigger is left mouse. A is right mouse. Thumbstick is mouse move. Hold the hand trigger to enable tracking, then pitch or yaw the mouse to move. Press B to reset yaw centre point to your current heading)
- oculus_touch_test.ahk (Display a GUI of all touch values)
- oculus_touch_vjoy.ahk (Turn the Touch controllers into a virtual gamepad for DirectInput games)

You should keep these files together.

Expand Down Expand Up @@ -61,6 +67,14 @@ Yaw works a little different to the other two angles. Pitch and roll have defini
Each controller may have a different Yaw origin.
If you aren't wearing the Oculus headset, camera tracking is disabled. Touch rotation can still be tracked, but it is done with the onboard IMUs, which may drift over time.

vJoy Support
Normally AutoHotKey can only generate keyboard and mouse events.
vJoy is a driver that emulates one or more virtual joysticks with configurable features. AutoOculusTouch can now send analog axis and digital button values to vJoy. This lets you use Touch (or the remote) as a gamepad in games that support DirectInput.
Note: while most of the controls match an XBox controller, it technically isn't one. Any game that uses XInput directly can't see vJoy. Only DirectInput games will work here.

To use vJoy support, you need to install the vJoy drivers. You can download them from here: http://vjoystick.sourceforge.net/site/index.php/download-a-install
If you don't want vJoy support, you don't need to install the drivers, this is an optional feature, AutoOculusTouch works like v0.1.4 without it.


Important Notes
(v0.1.2 and below)
Expand Down

0 comments on commit 26d93ba

Please sign in to comment.