Skip to content

Commit

Permalink
Added some documentation to the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
artman41 committed Apr 26, 2019
1 parent b5318c0 commit 1744daa
Showing 1 changed file with 36 additions and 1 deletion.
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,36 @@
# GuitarSniffer
# GuitarSniffer

## Installation

### Install WinPCap
* [WinPCap](https://www.winpcap.org/install/bin/WinPcap_4_1_3.exe)

### Install USBPcap
* [USBPCap](https://desowin.org/usbpcap/)

### Install vJoy
* [vJoy](http://vjoystick.sourceforge.net/site/index.php/component/weblinks/weblink/13-uncategorised/14-latest-download?Itemid=435&task=weblink.go)

### Configure vJoy

* Open `vJoyConf` and format your `vJoy Device 1` to mirror the image below
* 16 Buttons
* Axes `X`, `Y`, `Z`

![Example vJoy conf](https://hqfkrq.dm.files.1drv.com/y4mfA_TWqV9c0YDOfJKXMlp74qZcF63ER80kkFav8cXEawoCeDGVerXA3IqT2JjVmPSMZLgz2Wq43_kDeD0nOspinxREHG9Yid14_ZvOLQYxrsJhgIIw9hoom7EbdEYKSRh126QG_4fr5dapg8G90ytaehW4zppm7QudRGD7g1qxiixjWKyyJwhJzMypzLSyNblb9dts1sudcD3lDNzL5h7xw?width=367&height=490&cropmode=none)

### Download the Application

* Download the latest release from [here](https://github.com/artman41/guitarsniffer/releases/latest)

### DONE!

Enjoy yourself!

Currently the console will only output the `CurrentPacket`, but this will change in the future to be a display of all the active outputs in the `CurrentPacket`

## Development

* A folder full of logs for every possible packet can be found [here](https://1drv.ms/f/s!AgQGk0OeTMLwhA-uDO9IQHEHqGhv)
* A spreadsheet detailing the byte to view for each packet piece can be found [here](https://docs.google.com/spreadsheets/d/1ITZUvRniGpfS_HV_rBpSwlDdGukc3GC1CeOe7SavQBo/edit?usp=sharing)
* The original spreadsheet can be found [here](https://1drv.ms/x/s!AgQGk0OeTMLwg3GBDXFUC3Erj4Wb)

0 comments on commit 1744daa

Please sign in to comment.