Skip to content

Commit f81fe9f

Browse files
committed
Manual entries for Menu > Options corrected
and a missing one added
1 parent e5d8f1c commit f81fe9f

File tree

2 files changed

+580
-446
lines changed

2 files changed

+580
-446
lines changed

Source/Documentation/Manual/options.rst

Lines changed: 46 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ Language
127127

128128
OR is an internationalized package. It supports many languages, and others
129129
can be added by following the instructions contained in the *Localization
130-
Manual* which can be found in the Open Rails ``Source/Trunk/Documentation``
130+
Manual* which can be found in the Open Rails ``Documentation``
131131
folder.
132132

133133
When *System* is selected, OR automatically selects the language of the
@@ -148,18 +148,18 @@ Other units
148148
-----------
149149

150150
This selects the units displayed for length, mass, pressure, etc. in the
151-
:ref:`F5 HUD <driving-hud>` of the simulation.
151+
:ref:`F5 Train Driving Info Window and also the Alt+F5 HUD <driving-hud>` of the simulation.
152152

153153
The option *Player's Location* sets the units according to the Windows
154154
*Language and Region* settings on the player's computer.
155155

156156
The option *Route* sets the units based on the data in the route files.
157157
The other options are self-explanatory.
158158

159-
The F5 HUD uses the abbreviations *stn* for short tons (2000 lb) and
160-
*t* or *tn* for metric tons (tonnes).
159+
These windows use the abbreviations *stn* for short tons (2000 lb),
160+
*t* for long tons (2,240 lb) or *tn* for metric tons (tonnes).
161161

162-
Note that the units displayed by the :ref:`F4 Track Monitor <driving-track-monitor>` (e.g. velocity and
162+
Note: The units displayed by the :ref:`F4 Track Monitor <driving-track-monitor>` (e.g. velocity and
163163
distance) are always based on data read from the route files.
164164

165165
Disable TCS scripts
@@ -227,20 +227,22 @@ Video Options
227227
Dynamic shadows
228228
---------------
229229

230-
The default setting is unchecked.
231230
Check this option to cast shadows from movable objects such as trains.
232231

232+
The default setting is unchecked.
233+
233234
Note: This may reduce the frame rate.
234235

235236
Shadow for all shapes
236237
---------------------
237238

238-
The default setting is unchecked.
239239
Check this option to cast shadows from static objects.
240240

241+
The default setting is unchecked.
242+
241243
Note: This may reduce the frame rate.
242244

243-
Note: Static objects provided with shadows (in the file <route>.ref)
245+
Note: Static objects provided with shadows (in the World files)
244246
will cast shadows anyway. This option adds shadows for other static objects.
245247

246248

@@ -268,9 +270,12 @@ semitransparent mode.
268270
Model instancing
269271
----------------
270272

271-
When the option is checked, in cases where multiple instances of the same
272-
object have to be drawn, only a single draw call is sent to the GPU. This
273-
means lower CPU load. It is suggested to always check this option.
273+
When the option is checked, in cases where multiple instances of the same
274+
object have to be drawn, only a single draw call is sent to the GPU.
275+
Uncheck this option to avoid the graphical glitches which appear on some
276+
hardware, but this may reduce the frame rate.
277+
278+
The default setting is checked.
274279

275280
Overhead wire
276281
-------------
@@ -338,22 +343,26 @@ any stretching.
338343
Viewing distance
339344
----------------
340345

341-
This option defines the maximum distance at which terrain is displayed. At
342-
higher distances Distant Mountains will be displayed (see below).
343-
Increasing this parameter tends to increase CPU and GPU load.
344-
Also, some routes are optimized for the standard MSTS maximum viewing distance (2000m).
346+
This option defines the maximum distance at which terrain is displayed.
347+
Where the content provides "Distant Mountains", these are displayed independently (see below).
348+
349+
Note: Some routes are optimized for the standard MSTS maximum viewing distance (2km).
345350

346351
Note: When the option to tune settings automatically is applied, then this
347352
value will be overridden and dynamically changed to maintain a target frame rate.
348353

354+
The default distance is 2km.
355+
349356
Distant mountains
350357
-----------------
351358

352-
Distant mountains are supported in a way that is compatible with MSTS.
353-
Distant mountains are present in the route if it has a folder called
354-
LO_TILE. You may turn the feature on by checking the *Distant Mountains*
355-
checkbox. In addition to MSTS capability, you can select the viewing
356-
distance of the distant mountains.
359+
This option defines the maximum distance at which "Distant Mountains" are displayed.
360+
361+
Note: "Distant Mountains" are present in the route if it has a folder called LO_TILE.
362+
363+
The default setting is checked.
364+
365+
The default distance is 40km
357366

358367
.. image:: images/options-mountains.png
359368

@@ -496,9 +505,11 @@ until the train has stopped and then hold it as red from that time up to
496505
two minutes before starting time. This is useful in organizing train meets
497506
and takeovers, however it does not always correspond to reality nor to
498507
MSTS operation. So with this option the player can decide which behavior
499-
the start signal will have. This option is checked by default.
508+
the start signal will have.
509+
510+
This option is checked by default.
500511

501-
Unchecking the option has no effect when in
512+
Note: Unchecking the option has no effect when in
502513
:ref:`Timetable mode <timetable>`.
503514

504515
.. _options-open-doors-ai:
@@ -546,12 +557,21 @@ This is an option which players can set to simplify either the train controls or
546557
This feature is intended for players who want to focus on "running" trains and don't want to be bothered
547558
by complex controls or prototypical physics which may require some additional expertise to operate.
548559

549-
Initally this option affects only trains that use vacuum braking but other controls may be added in future versions.
560+
Initially this option affects only trains that use vacuum braking but other controls may be added in future versions.
550561

551562
With vacuum braking, it is sometimes necessary to operate two different controls to apply and release the brakes.
552563
With "Simple control and physics" checked, the player is able to operate the brakes just with the brake valve
553564
and doesn't need to consider the steam ejector separately.
554565

566+
Diesel engines stopped at simulation start
567+
------------------------------------------
568+
569+
When this option is unchecked, stationary diesel locos start the simulation with their engines running.
570+
Check this option for a more detailed behaviour in which the player has to start the loco's engine.
571+
572+
The default setting is unchecked.
573+
574+
555575
.. _options-keyboard:
556576

557577
Keyboard Options
@@ -859,7 +879,9 @@ level of detail comes into view. This may be useful to sharpen distant content
859879
that was created for a smaller screen or a wider field of view than you are
860880
currently using.
861881

862-
If your content does not use multiple LODs, then this option will have no effect.
882+
The default setting is 0.
883+
884+
Note: If your content does not use multiple LODs, then this option will have no effect.
863885

864886

865887
Adhesion proportional to rain/snow/fog

0 commit comments

Comments
 (0)