diff --git a/README.md b/README.md index 6e6b2e1..0823931 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # RobertsmaniaPitGirl - iRacing Replay -This project presents a plugin for VoiceAttack that integrates with the iRacing SDK to monitor race events and build a list of event markers to be used for replay review. +This project presents a plugin for VoiceAttack which integrates with the iRacing SDK to monitor race events and build a list of event markers to be used for replay review. The iRacing telemetry data is monitored constantly and markers are recorded when any driver has an offtrack incident, overtake, undertake, or radio broadcast. The race start and driver finishes are also entered as markers. @@ -18,6 +18,9 @@ Return to the default state where all marker types for all cars will be presente The provided profile has commands that can be used with speech, but is also intended to work with a gamepad/controller so the use of speech recognition is not required. +Here's a video overview: +[![Robertsmania PitGirl iRacing Replay Overview](https://www.robertsmania.com/pitgirl/PitGirl_Replay_Overview_02.PNG)](https://youtu.be/C0pFp6Jwkww) + ## Controller This is the controller configuration I use, and what is in the provided VoiceAttack profile. The goal is to make it easy to use the controller to review the replay data. If you are not using voice commands, you will still need to interact with the standard iRacing UI to change cameras. Also note that **NUMLOCK** on your keyboard will interfere with some of the controls, if things do not appear to be working try toggling NUMLOCK. @@ -402,7 +405,7 @@ This is a basic set of commands that demonstrates the features of the plugin. F The provided profile does have the commands setup for speech recognition and it will have the system confirm things like camera changes with speech synthesis. -There are two boolean variables set on initialization that control the speech synthesis. Both of those get set to true by default, but you can esaily change that in the Initialize command. +There are two boolean variables set on initialization that control the speech synthesis. Both of those get set to true by default, but you can easily change that in the Initialize command. * **SayAnything** - Controls whether anything is said. If this is true, the system will speak. If it is false it will not say anything. * **SayAnnouncements** - Secondary value to determine whether announcements like "Kris Roberts had an Overtake" are made when replay markers are played (but if SayAnything is false, then SayAnnouncements has no effect).