[For modders] How to setup dashboard

Overview

How to setup dashboard

Abstract

This document is a manual for configuring dial instruments and indicators on the instrument panel for cars created and added by users to the simulator “City Car Driving. Home Edition”.

Configuring dial instruments

The following parameters are configured in the file “CarProperty.ini” located at the path: “datagamedatacars<My_car_name>”:

1. “MinAngle” — minimum value of angle in radians which is the lowest limit of the pointer. The pointer turns clockwise.
2. “MinValue” — minimum value on the scale which is the lowest limit of the pointer (for example, for the scale 50 – 130 MinValue = 50).
3. “DivValue” — difference of maximum and minimum values; the maximum value is the top limit of the pointer (for example, for the scale 50 – 130, DivValue = 130 – 50 = 80).
4. “DivAngle” — angle of one scale division in radians. If DivCount = 1, this is the difference of values of the maximum and minimum angles (for example, if the minimum angle = 1 and the maximum angle = 5, DivAngle = 5 – 1 = 4). The pointer turns clockwise.
5. “DivCount” — a scale division. DivAngle turns the pointer by one scale division. Increase of a scale division reduces turning angle, i.e. full turning angle of the pointer from MinAngle to (MinAngle + DivAngle / DivCount). 1 should better be used.

Some indicators also optionally support “sections” (their use is not obligatory):

• “SpeedometerSectionsNumber”;
• “TachometerSectionsNumber”;
• “ManometerSectionsNumber”;
• “FuelLevelSectionsNumber”.

When sections are used:

• zero (first) section — “DivValue”, “DivAngle”, “DivCount”;
• all subsequent sections — “DivValue_N”, “DivAngle_N”, “DivCount_N”, where N is a section number from 1 to (the number of sections minus 1);
• the maximum value of the first section is the minimum value of the second section;
• the maximum value of the second section is the minimum value of the third section;
• the maximum value of the last section is the minimum value of the scale.

Speedometer
“SpeedometerSectionsNumber”;
“SmtrZeroOffset” is MinAngle;
“SmtrMinSpeed” is MinValue;
“SmtrDivValue”;
“SmtrDivAngle”;
“SmtrDivCount”.

Tachometer
“TachometerSectionsNumber”;
“TmtrZeroOffset” is MinAngle;
“TmtrMinRPM” is MinValue;
“TtmrDivValue”;
“TmtrDivAngle”;
“TtmrDivCount”.

Thermometer
“TermometerMinAngle”;
“TermometerMinValue”;
“TermometerDivValue”;
“TermometerDivAngle”;
“TermometerDivCount”.

Oil manometer
“OilManometerMinAngle”;
“OilManometerMinValue”;
“OilManometerDivValue”;
“OilManometerDivAngle”;
“OilManometerDivCount”.

Manometer
“ManometerSectionsNumber”;
“MmtrZeroOffset” is MinAngle;
“MmtrMinPressure” is MinValue;
“MmtrDivValue”;
“MmtrDivAngle”;
“MmtrDivCount”.

Fuel level
“FuelLevelSectionsNumber”;
“FmtrZeroOffset” is MinAngle;
“FmtrMinValue”;
“FmtrDivValue”;
“FmtrDivAngle”;
“FmtrDivCount”.

Fuel level
In “CarProperty.ini” located at the path: “datagamedatacars<My_car_name>” in the section “[saloonDetail]” the following is written:
carFuelArrowName = “fuel_arrow”,
where “fuel_arrow” is the name of the pointer in the car model.

[SpeedometerAndTachometer]
FmtrDivCount = 1 is a scale division;
FmtrDivValue = 100 is the parameter indicating maximum fuel level in the fuel tank, shown in percent;
FmtrDivAngle = 1.50098 is the maximum fuel level in the fuel tank, shown in radians;
FmtrZeroOffset = 0.0 is the parameter of the value of deviation angle relative to the pointer position in the model (minimum value of pointer angle), shown in radians.

It is advisable that the pointer in the model be turned in such way that its position is originally on the minimum scale value, then “FmtrZeroOffset = 0.0”; thus there will be no need to calculate the minimum angle.

Thermometer
In “CarProperty.ini” the following is written in “[saloonDetail]”:
carTemperatureArrowName = “temperature_arrow”,
where “temperature_arrow” is the name of the pointer in the car model.

[SpeedometerAndTachometer]
TermometerMinAngle = 0.0 — minimum value of angle in radians, specified in the same way as for fuel level (see above);
TermometerMinValue = 40 — minimum value on the scale;
TermometerDivValue = 80 — difference in maximum and minimum values;
TermometerDivAngle = 1.410226 — angle of one scale division, in radians;
TermometerDivCount = 1 is a scale division.

The other dial instruments are configured similarly.
Important! Indicators with corresponding names are added in the model.

Configuring indicators

The following parameters can be defined in the file “CarProperty.ini” located at the path: “datagamedatacars<My_car_name>” in the section “[lightDetail]”:

Signals of indicators in the car interior:
carHWDLightDashboardName = “signal_HDWlight” — marker lights;
carHWDLightDashboardColor = 0; 255; 0 — a parameter responsible for indicator light, specified in the RGB color model;

carNearLightDashboardName = “NearLight” — low beam;
carNearLightDashboardColor = 0; 255; 0 — a parameter responsible for indicator light, specified in the RGB color model;

carFarLightName = “signal_farlight” — high beam;
carFarLightColor = 0; 0; 255 — a parameter responsible for indicator light, specified in–the RGB color model;

carLowFuelLightName = “signal_lowfuel” — low fuel level;
carLowFuelLightColor = 255; 112; 0 — indicator light, specified in the RGB color model;

carCheckEngineLightName = “signal_engine” — “Check Engine” indicator;
carCheckEngineLightColor = 255; 0; 0 — a parameter responsible for indicator light, specified in the RGB color model;

carEngineOverheatLightName = “signal_temperature” — temperature sensor;
carEngineOverheatLightColor = 255; 112; 0 — a parameter responsible for indicator light, specified in the RGB color model.

All of the other dial instruments are configured similarly.
Important! Indicators with corresponding names are added in the model.