2023-09-12 10:45:52 -07:00
# TunerStudio (TS)
2021-05-22 12:10:58 -07:00
2019-11-03 05:41:14 -08:00
This directory contains the initialization and configuration files for the
2021-10-30 17:32:59 -07:00
rusEFI interface to TunerStudio.
2019-11-03 05:41:14 -08:00
The primary contents are a set ```rusefi*.ini``` initialization files, used to
configure TunerStudio to setup and monitor a specific ECU board. These are
the only files a typical end user needs.
The ```translations``` directory contains non-English-language translations
for TunerStudio.
2023-09-12 10:45:52 -07:00
In TunerStudio some fields have little question mark on the left of the name for additional field tips.
Those tips are defined in `../integration/rusefi_config.txt`
2019-11-03 05:41:14 -08:00
The initialization files are automatically generated from a combination
of input files located both in this directory and in the board-specific
directories .
2017-03-27 19:03:50 -07:00
2019-06-09 17:36:29 -07:00
```rusefi*.ini``` files are generated based on the following four inputs:
1) ```rusefi_config.txt``` contains configuration region definition in proprietary text format.
2) ```rusefi.input``` contains the UI - all the menus and dialogs. UI definition starts at ```menuDialog = main```
line - here you will see all top level menus defined with internal IDs and visible text labels.
3) ```mapping.yaml``` is a minor detail related to how pins are named in drop downs
4) ```prepend.txt``` is a minor detail which allows you to hide elements of the UI using ```@@if_XXX``` syntax.
2019-11-03 05:41:14 -08:00
The combined file is generated by ConfigDefinition.jar tool.
On Windows this may be run with ```gen_config.bat```.
2020-04-19 12:23:51 -07:00
Q: how do I offer my changes to TS project?
2023-09-12 10:45:52 -07:00
A: please PR only source files (rusefi.input & rusefi_config.txt). Once merged, gen_config.bat would be executed automatically and results would be pushed by automation.
