Overview - SeriousOldMan/Simulator-Controller GitHub Wiki

Welcome to the Simulator Controller documentation. Here you will find everything to understand, install, configure and use your complete solution for getting the best experience from your immersive simulation games. If you are looking for a quick start, you can download and install the software using the instructions found here. But because the Simulator Controller suite offers such a huge amount of functions and individual applications, I recommend to take at least a look at the different areas of the documenation, so that you have an overview of what to expect.

The documentation is devided into the following sections:

  • README

    Useful information about the Simulator Controller project and its functions & features.

  • Release Notes

    Here you will find information about the current or previous releases. Even infos for the next upcoming stable release are included. Useful information about Simulator Controller project and its functions & features.

  • Update Notes

    Beginning with Version 2.0, Simulator Controller supports an update mechanism for your local configurations, which is mostly automated. Please read the information on this page carefully, if you update an already configured installation to a newer version, to be sure, that all the new features will be available in your configuration as well. Here you will also find information for additional manual installation or configuration activities, that might be necessary for new features introduced by a given release.

  • Installation & Configuration

    Maybe the most important part of the documentation, a complete description on how to install and configure Simulator Controller. The documentation is structured along different topics, which will give you complete control to adapt Simulator Controller to your equipment.

  • Using Simulator Controller

    General information how to start and use the Simulator Controller and how to use the available runtime options. You will also find information on how to use voice control and how to interact with the Race Assistants.

  • Plugin & Modes

    Reference information for all the builtin plugins and modes.

  • Tyre Compounds

    Gives you detailed information, how to configure and manage all available tyre compounds for a specific car in a given simulator.

  • Setup Workbench

    This smart tool gives valuable recommendations on how to change a car setup for a given problem. The tool follows an interview-like approach and can even handle contradictory requirements.

  • Virtual Driving Coach

    This a very special chatbot, which behaves as your personal driving coach. Based on text-based GPT technology, it uses a publically available large language model which has been trained with vasts amount of information. Aks anything about racing, car handling and driving techniques and you will probably will get an interesting answer.

  • Virtual Race Engineer

    You don't want to miss out Jona, the world first full voice dialog capable Virtual Race Engineer based on artificial intelligence algorithms. Jona keeps an eye on all the technical stuff regarding your car and will help you to determine the correct amount of fuel and the correct tyre pressures for an upcoming pitstop.

  • Virtual Race Strategist

    The other Assistant, Cato, takes care of all strategic aspects during races with one or more pit stops, even under changing weather conditions. It will provide you with extensive after race reports for analysis and documentation and will help you with strategy development based on telemetry data of past sessions.

  • Virtual Race Spotter

    The third Assistant, Elisa, will watch your race and will warn you about nearby other cars and will give you general information about the current race situation.

  • Team Server

    If you are participating in multiplayer team-based endurance races, you use the Team Server to share the car state and the knowledge ot the Virtual Race Assistants between all participating drivers. Using the "Race Center", a complete pitwall application, you can plan the race, prepare a strategy and based on that the stint plan for the race. All team members or even a dedicated engineer can investigate the telemetry data and gather information about the race development in general and can remote control the car, for example to prepare an upcoming pitstop, without any driver interaction. Last, but not least, if you encounter an unforeseen event during the race, you have various tools at hand to adopt the strategy to the new race situation.

  • Development Guide

    Complete set of information for developers, who want to create their own plugins or even contribute to the further development of Simulator Controller.

  • Development Backlog

    You may also want to take a look at the backlog of upcoming features.

If you have any questions that have not been answered here, please feel free to contact me, but please be sure to have read anything related in the documentation in advance. If you want to report a bug, please open an issue. And last, but not least, if you want to contribute, feel free to contact me as well.