Skip to content

Commit

Permalink
Update documentation for 1.0 release
Browse files Browse the repository at this point in the history
Signed-off-by: John Strunk <john.strunk@gmail.com>
  • Loading branch information
JohnStrunk committed Nov 30, 2018
1 parent 7b640b7 commit 086131e
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 10 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## Master

## Version v1.0

- Added
- Axis range can be customized via `-r range`.
- Moving average momentum can be customized via `-m value`.
Expand All @@ -14,6 +16,9 @@
- Limitations
- Deadzone settings are not visible to other applications and must be set
manually.
- Changes to the calibration are not visible to applications that are
currently running. Only newly launched applications see the most current
configuration.

## Version v0.1

Expand Down
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,30 +26,31 @@ calibrates the center, limits, and deadzone on-the-fly.
Download the latest version from the [Releases
page](https://github.com/JohnStrunk/tilt-wizard/releases).

Run `tilt-wizard` with no arguments to scan for available DirectInput devices:
Run `tilt-wizard -l` with no arguments to list available DirectInput devices:

```
C:\tilt-wizard>tilt-wizard.exe
C:\tilt-wizard>tilt-wizard.exe -l
```

This should discover any devices attached to your computer. To have tilt-wizard
automatically tune the device, pass in the GUID of the desired device:
automatically tune the device, pass in the GUID of the desired device via the
`-d` option:

```
C:\tilt-wizard>tilt-wizard.exe {34BE2320-42C7-11E6-8001-444553540000}
C:\tilt-wizard>tilt-wizard.exe -d {34BE2320-42C7-11E6-8001-444553540000}
```

The application will then run, sampling the X & Y axes and updating the center
point.

- `current`: The most recent sample
- `avg`: The currently calculated average (and center point)
- `stdev`: The calculated standard deviation of the incoming data. You probably
want to manually set the deadzone percentage to approximately 4x this value.
- `DZ%`: The recommended deadzone percentage for this axis. It is calculated
based on the standard deviation of the incoming data.

Example:

![Example output fo tilt-wizard](docs/images/output.png)
![Example output for tilt-wizard](docs/images/output.png)

To integrate tilt-wizard with your pinball cabinet, see the [installation
document](docs/installation.md).
Expand All @@ -67,7 +68,8 @@ C:\>choco install mingw
...
```

Once you have the prerequisites installed, make sure you update your PATH. In my case, that was:
Once you have the prerequisites installed, make sure you update your PATH. In my
case, that was:

```
set PATH=%PATH%;C:\ProgramData\chocolatey\lib\mingw\tools\install\mingw64\bin
Expand Down
Binary file modified docs/images/output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/pinballx_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/shortcut.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 31 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
This document provides installation guidance for integrating tilt-wizard with
your pinball setup.

Installation options:

- [Integration with PinballX](#pinballx)
- [Run during Windows startup](#run-on-startup)

---

## PinballX

Integrating with [PinballX](https://www.pinballx.com/) is fairly
Expand All @@ -13,7 +20,29 @@ straightforward. Make a note of:

Launch the PinballX configuration program and go the "Startup settings" menu.
Configure tilt-wizard to run on startup as shown below. Substitute the directory
of `tilt-wizard.exe` for the "Working path" and put your device GUID in the
"Parameters" field.
of `tilt-wizard.exe` for the "Working path" and in the "Parameters" field, put
"`-d`" and your device GUID.

![PinballX startup settings](images/pinballx_config.png)

## Run on startup

Tilt-wizard can also be configured to run at startup by creating a shortcut and
placing that in your Startup folder.

- Locate the `tilt-wizard.exe` executable, right-click, and select "Create
shortcut".
- Right-click the shortcut and select "Properties".
- In the "Shortcut" tab:
- Add `-d` and your device GUID to the end of the "Target" field.
- Change the "Run" field to "Minimized".
- Click "OK".

![Shortcut settings](images/shortcut.png)

After following the above, double clicking the shortcut should start a minimized
window w/ tilt-wizard tuning your device.

Move **just the shortcut** to your startup folder. The folder will be at a path
similar to: `C:\Users\johns\AppData\Roaming\Microsoft\Windows\Start
Menu\Programs\Startup`. Remember to replace my username (johns) with your own.

0 comments on commit 086131e

Please sign in to comment.