Differences

This shows you the differences between two versions of the page.

--- firstrun [2023/07/09 10:55] – [Starting the Overlay] marvin
+++ firstrun [2023/09/06 14:51] (current) – [Starting the Controller] marvin
@@ Line 10: / Line 10: @@
   * SessionFlags
   * Subtitles
+  * WebPage
-In addition to those folders, there are also two files that get created in the main ''iRacing-TV'' folder when you run the iRacing-TV controller.  They are the ''Editor.xml'' file which contains all of your settings for the controller itself, and also the ''iRacing-TV.log'' file that could contain useful information if you ever experience a failure like an application crash.
+In addition to those folders, there are also a few files that get created in the main ''iRacing-TV'' folder when you run the iRacing-TV controller.  They are:
+  * **Editor.xml** - This contains all of your settings for the controller itself
+  * **iRacing-TV.log** - This contains useful information if you ever experience a failure like an application crash
+  * **iRacing-TV-STT.log** - This contains Microsoft Azure speech-to-text logs if you use this feature
 ==== Assets ====
-These are where the graphical elements such as images can be found. This folder contains mostly ''PNG'' image files, but there are a few other files in here that you should take note of:
+These are where the graphical elements such as images can be found, broken up into a few subfolders:
-  * RevolutionGothic_ExtraBold.otf
+  * **default** - This has the graphics for the default overlays
-  * RevolutionGothic_ExtraBold_It.otf
+  * **fonts** - This hast the default fonts for iRacing-TV
+  * **icon** - This has the iRacing-TV icon in various sizes
+  * **logo** - This has the iRacing-TV logo in a couple of different color schemes
+  * **source** - This has some of the Photoshop and Illustrator files I created
+  * **webpage** - This has the source HTML, CSS, and JS files for the live telemetry feature
-Those are font files that you should install, because the default overlay graphics are set up using these fonts. To install these fonts, right click on those files and select ''Install''. Do this for both font files.
+Note that the ''default-iracing-overlay-parts.ai'' file is where most of the graphics in the default folder comes from. Feel free to clone and modify this to make your own variations, or come up with something completely unique!
-{{ :installer:font-installation.png?nolink |}}
+I would strongly recommend creating and saving your custom overlay graphics into its own subfolder here under this ''Assets'' folder, instead of modifying the default installed directly. This way you can ensure that if you ever need to uninstall / reinstall iRacing-TV, you won't lose your custom graphics.
-There is also an Adobe Illustrator file you can find here called ''Overlay.ai''. If you have Adobe Illustrator, you can use that application to open this file and find the original vector images that were used to create most of the PNG files found in this ''Assets'' folder.
+The same is true for the ''webpage'' subdirectory - if you want to modify these HTML, CSS, and/or JS files to create your own custom look for the live telemetry, I would recommend first copying these files into their own new subdirectory under this ''Assets'' folder, and then modifying those copied files.  That way if you uninstall / reinstall iRacing-TV you won't lose anything.
 ==== DirectorSettings ====
@@ Line 38: / Line 47: @@
 ==== Subtitles ====
 These are where your subtitles go. The iRacing-TV app creates and manages these files for you. Each subtitle file corresponds to a specific race, and the file name is in the format of ''[Session ID]-[Subsession ID].xml''.
+==== WebPage ====
+This is the default output location of the live telemetry web page. You would typically share this folder to a web server that would serve the files in this directory to the public Internet.
 ===== Starting iRacing-TV =====
@@ Line 45: / Line 57: @@
 Both of these applications can either be found in the ''Start Menu'' or on your ''Desktop'' if this option was chosen during installation.
-{{ :installer:app-icons.png?nolink |App icons}}
+{{ :installer:installed_shortcuts.png?nolink |Installed Shortcuts}}
 ==== Starting the Overlay ====
-{{ ::overlay:overlay-red-1.png?direct&400|Overlay window}}
+{{ ::overlay:overlay_grid.jpg?direct&400|Overlay window}}
-To start the iRacing-TV overlay, launch it by clicking on its icon. When do you do, the Unity splash screen will display for a few seconds. After the splash screen goes away, the overlay window should become transparent red with an "iRacing-TV Controller is not running." message in the middle.
+To start the iRacing-TV overlay, launch it by clicking on its icon. When do you do, the Unity splash screen will display for a few seconds. After the splash screen goes away, the overlay window should become a transparent blue grid with an "iRacing-TV Controller is not running." message in the middle.
 Because the overlay window is a special transparent window with no border or window controls on it, there is not a typical ''X'' button to close it. When you want to close the overlay window, you can do this one of two ways:
@@ Line 57: / Line 70: @@
 ==== Starting the Controller ====
-{{ ::controller:control-panel-tab.png?direct&400|}}
+{{ ::controller:iracingtv_controller.png?direct&400|}}
-To start the iRacing-TV controller, simply launch it by clicking on its icon.
-At the top right of this application window, there are two lights shown. The first light indicates the connection with iRacing. It will be red if iRacing is not running, and green if it is.
-In order to get the best experience from this application, it is recommended to run the iRacing-TV controller any time you participate in a live race in iRacing. The reason for this, is so that it can automatically record the live race session flags for you. These session flags are **not** saved in iRacing's replay file. If you do not run the controller during these live races, we will not be able to get back some important race state information, such as caution flags, during the playback of the replay file. It is ok to minimize the iRacing-TV controller window to get it out of the way during live races.
-==== Initial Fonts Setup ====
-As soon as you launch both the overlay and the controller applications, you will see something like this on top of the iRacing window.
-{{ :overlay:overlay-fonts-1.png?direct&400 |Overlay with default fonts}}
-This looks nice, however the fonts are not quite correct. Hopefully you have followed the instructions to install the two fonts that comes with this application. If you did not, go back to the beginning of this wiki page and look for the section about installing fonts.
-Once you have the fonts installed, run the overlay and controller applications, and then visit the ''Overlay'' > ''Fonts'' tab in the controller.
-{{ :controller:initial-fonts-setup.png?direct&400 |Overlay fonts settings}}
+To start the iRacing-TV controller, launch it by clicking on its icon.
-Change ''Font A'' to be ''Revolution Gothic'' and change ''Font B'' to be ''Revolution Gothic It''. As soon as you do that, you should see the fonts change in the overlay immediately! All changes to settings are reflected in the overlay instantly, and they are also saved automatically - there is no ''Save'' button.
+At the top right of this application window, there is a light. The light indicates the connection with iRacing. It will be red if iRacing is not running, and green if it is.
-{{ :overlay:overlay-fonts-2.png?direct&400 |Overlay with Revolution Gothic fonts}}
+In order to get the best experience from this application, it is recommended to run the iRacing-TV controller any time you participate in a live race in iRacing. The reason for this, is so that iRacing-TV can automatically record the live race session flags for you. These session flags are **not** saved in iRacing's replay file. If you do not run the controller during these live races, we will not be able to get back some important race state information, such as caution flags, during the playback of the replay file. It is ok to minimize the iRacing-TV controller window to get it out of the way during live races.
-Now that you have done all of the initial setup steps, you are ready to fully customize your iRacing-TV experience! The next step is to learn about the different [[start|controller tabs]].
+If you do forget to run the iRacing-TV controller during your live race, it is possible to manually recreate the session flags.