|
1 | | -# Teensy XInput USB Mode [](https://github.com/dmadison/ArduinoXInput_Teensy/actions?query=workflow%3Abuild) |
| 1 | +# Teensy XInput USB Mode |
| 2 | +[](https://github.com/dmadison/ArduinoXInput_Teensy/actions?query=workflow%3Abuild) |
2 | 3 |
|
3 | 4 | The files in this repository will add an additional USB mode ("XInput") to your Teensy board, allowing it to emulate an Xbox gamepad. |
4 | 5 |
|
5 | 6 | This is meant to be used in conjunction with the [ArduinoXInput library](https://github.com/dmadison/ArduinoXInput). |
6 | 7 |
|
7 | 8 | ## Installation |
8 | 9 |
|
9 | | -You must have both [Arduino](https://www.arduino.cc/en/main/software) and [Teensyduino](https://www.pjrc.com/teensy/td_download.html) installed before proceeding. Double-check that your installed Teensyduino version matches the files provided in this repository. This repository is currently using version [**1.58**](https://www.pjrc.com/teensy/td_158). If you don't know your Teensyduino version, compile a blank sketch with a Teensy board selected and the Teensy Loader will open. In the Teensy Loader window select `Help -> About` and it will tell you the version number. If your version does not match you will have to reinstall or update the Teensyduino software. |
| 10 | +You must have both [the Arduino IDE](https://www.arduino.cc/en/main/software) and [Teensyduino](https://www.pjrc.com/teensy/td_download.html) installed before proceeding. |
10 | 11 |
|
11 | | -Navigate to your Arduino installation directory and open up the 'hardware' folder. It is recommended that you make a backup of this folder before proceeding in case something goes wrong or if you want to revert the installation. |
| 12 | +Double-check that your installed Teensyduino version matches the files provided in this repository. This repository is currently using [**Teensyduino 1.58**](https://www.pjrc.com/teensy/td_158). You can download older versions on [the releases page](../../releases). |
12 | 13 |
|
13 | | -To install, copy the files from the repository's "teensy" directory into the hardware folder and replace any pre-existing files. This will not affect your saved sketches. |
| 14 | +If you don't know your Teensyduino version, compile a blank sketch with a Teensy board selected and the Teensy Loader will open. In the Teensy Loader window select `Help -> About` and it will tell you the version number. If your version does not match you will have to reinstall or update the Teensyduino software. |
14 | 15 |
|
15 | | -To uninstall, restore your 'teensy' folder from a backup or reinstall Teensyduino. |
| 16 | +It is recommended that you make a backup of your hardware folder before proceeding in case something goes wrong or if you want to revert the installation. |
| 17 | + |
| 18 | +To install the XInput modifications, copy the files from the repository's "teensy" directory into the hardware folder and replace any pre-existing files. This will not affect your saved sketches. |
| 19 | + |
| 20 | +To remove the XInput modifications, restore your Teensy hardware folder from backup or reinstall the Teensyduino software. |
| 21 | + |
| 22 | +#### Arduino IDE 1.x |
| 23 | + |
| 24 | +For IDE version 1.x the Teensy hardware files are located in your Arduino IDE installation directory. On Windows this is typically in your "Program Files" folder: |
| 25 | + |
| 26 | +``` |
| 27 | +C:\Program Files (x86)\Arduino\hardware\teensy\avr |
| 28 | +``` |
| 29 | + |
| 30 | +#### Arduino IDE 2.x |
| 31 | + |
| 32 | +For IDE version 2.x the Teensy hardware files are located in your application data folder. On Windows this is typically at the following path: |
| 33 | + |
| 34 | +``` |
| 35 | +%AppData%\..\Local\Arduino15\packages\teensy\hardware\avr\{version} |
| 36 | +``` |
| 37 | + |
| 38 | +Where `{version}` is the installed version number of the Teensyduino software. |
16 | 39 |
|
17 | 40 | ## Supported Boards |
18 | 41 |
|
|
0 commit comments