Skip to content

Commit 2ef2b6e

Browse files
committed
docs: Add telemetry options section to manual
1 parent 6d14344 commit 2ef2b6e

File tree

3 files changed

+34
-0
lines changed

3 files changed

+34
-0
lines changed
Loading
Loading

Source/Documentation/Manual/options.rst

+34
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,40 @@ Otherwise, if the loco has an Overspeed Monitor specified in its ENG file, then
129129

130130
This monitor is enabled by checking the option.
131131

132+
133+
.. _telemetry:
134+
135+
Telemetry
136+
---------
137+
138+
.. image:: images/options-telemetry.png
139+
140+
These options let you choose which (if any) anonymous data collection types you would like to enable, preview the data that will be collected, and visit the `telemetry server and source code <https://telemetry.openrails.org>`_.
141+
142+
Each anonymous data collection type can be set to:
143+
144+
- **Undecided (off)** - (default) no data is collected or sent, but we may ask if you want to participate via :ref:`notifications`
145+
- **Off** - no data is collected or sent
146+
- **On** - data is collected and sent automatically
147+
148+
There is no option to allow you to check through the collected data before it is sent.
149+
150+
Application, runtime, operating system, and hardware properties
151+
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
152+
153+
This anonymous data collection type can be previewed to see what will be sent; for example::
154+
155+
Application = Open Rails U2025.01.31-1152 (X64)
156+
Runtime = .NET Framework 4.8.9290.0
157+
System = Microsoft Windows 11 Home 10.0.26100 (X64; en-GB; en-GB,en-US,ja-JP)
158+
Memory = 32,592 MB
159+
CPU = 12th Gen Intel(R) Core(TM) i7-1255U (GenuineIntel; 12 threads; 2,600 MHz)
160+
GPU = Intel(R) Iris(R) Xe Graphics (Intel Corporation; 128 MB)
161+
Direct3D = 12_1,12_0,11_1,11_0,10_1,10_0,9_3,9_2,9_1
162+
163+
This is also included at the start of every :ref:`log file <driving-logfile>`.
164+
165+
132166
Audio Options
133167
=============
134168

0 commit comments

Comments
 (0)