Skip to content

Commit 3d9089a

Browse files
authored
Merge pull request #571 from cjakeman/menu-options01
01: Manual entries for Menu > Options corrected
2 parents fda6ff4 + 611ddf1 commit 3d9089a

File tree

1 file changed

+54
-28
lines changed

1 file changed

+54
-28
lines changed

Source/Documentation/Manual/options.rst

Lines changed: 54 additions & 28 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 *t-us* for short tons (2000 lb),
160+
*t-uk* for long tons (2240 lb) and *t* for metric tons (1000 kg).
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
@@ -226,20 +226,22 @@ Video Options
226226
Dynamic shadows
227227
---------------
228228

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

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

234235
Shadow for all shapes
235236
---------------------
236237

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

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

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

245247
Glass on in-game windows
@@ -251,9 +253,12 @@ semitransparent mode.
251253
Model instancing
252254
----------------
253255

254-
When the option is checked, in cases where multiple instances of the same
255-
object have to be drawn, only a single draw call is sent to the GPU. This
256-
means lower CPU load. It is suggested to always check this option.
256+
When the option is checked, in cases where multiple instances of the same
257+
object have to be drawn, only a single draw call is sent to the GPU.
258+
Uncheck this option to avoid the graphical glitches which appear on some
259+
hardware, but this may reduce the frame rate.
260+
261+
The default setting is checked.
257262

258263
Overhead wire
259264
-------------
@@ -286,22 +291,26 @@ distance, anti-aliasing, or world object density.
286291
Viewing distance
287292
----------------
288293

289-
This option defines the maximum distance at which terrain is displayed. At
290-
higher distances Distant Mountains will be displayed (see below).
291-
Increasing this parameter tends to increase CPU and GPU load.
292-
Also, some routes are optimized for the standard MSTS maximum viewing distance (2000m).
294+
This option defines the maximum distance at which terrain is displayed.
295+
Where the content provides "Distant Mountains", these are displayed independently (see below).
296+
297+
Note: Some routes are optimized for the standard MSTS maximum viewing distance (2km).
293298

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

302+
The default distance is 2km.
303+
297304
Distant mountains
298305
-----------------
299306

300-
Distant mountains are supported in a way that is compatible with MSTS.
301-
Distant mountains are present in the route if it has a folder called
302-
LO_TILE. You may turn the feature on by checking the *Distant Mountains*
303-
checkbox. In addition to MSTS capability, you can select the viewing
304-
distance of the distant mountains.
307+
This option defines the maximum distance at which "Distant Mountains" are displayed.
308+
309+
Note: "Distant Mountains" are present in the route if it has a folder called LO_TILE.
310+
311+
The default setting is checked.
312+
313+
The default distance is 40km
305314

306315
.. image:: images/options-mountains.png
307316

@@ -400,10 +409,14 @@ This option allows the running of electric locomotives on non-electrified routes
400409
Steam locomotive hot start
401410
--------------------------
402411

403-
This option allows starting the game with the boiler water temperature
404-
already at a value that allows running the locomotive. If the option is
405-
not selected, you will have to wait until the water temperature reaches a
406-
high enough value.
412+
With this option selected, the temperature and pressure of steam in the boiler is ready to pull the train.
413+
If not, the boiler pressure will be at 2/3 of maximum, which is only adequate for light work.
414+
If your schedule gives you time to raise the pressure close to maximum, then
415+
switch from AI Firing to Manual Firing (Ctrl+F) and increase the Blower (N) to 100% to raise a draught.
416+
Replenish the coal using R and Shift+R to keep the fire mass close to 100%.
417+
Full pressure may be reached in 5 minutes or so.
418+
419+
The default setting is checked.
407420

408421
.. _options-forced-red:
409422

@@ -416,9 +429,11 @@ until the train has stopped and then hold it as red from that time up to
416429
two minutes before starting time. This is useful in organizing train meets
417430
and takeovers, however it does not always correspond to reality nor to
418431
MSTS operation. So with this option the player can decide which behavior
419-
the start signal will have. This option is checked by default.
432+
the start signal will have.
420433

421-
Unchecking the option has no effect when in
434+
This option is checked by default.
435+
436+
Note: Unchecking the option has no effect when in
422437
:ref:`Timetable mode <timetable>`.
423438

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

469-
Initally this option affects only trains that use vacuum braking but other controls may be added in future versions.
484+
Initially this option affects only trains that use vacuum braking but other controls may be added in future versions.
470485

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

490+
Diesel engines stopped at simulation start
491+
------------------------------------------
492+
493+
When this option is unchecked, stationary diesel locos start the simulation with their engines running.
494+
Check this option for a more detailed behaviour in which the player has to start the loco's engine.
495+
496+
The default setting is unchecked.
497+
498+
475499
.. _options-keyboard:
476500

477501
Keyboard Options
@@ -779,7 +803,9 @@ level of detail comes into view. This may be useful to sharpen distant content
779803
that was created for a smaller screen or a wider field of view than you are
780804
currently using.
781805

782-
If your content does not use multiple LODs, then this option will have no effect.
806+
The default setting is 0.
807+
808+
Note: If your content does not use multiple LODs, then this option will have no effect.
783809

784810

785811
Adhesion proportional to rain/snow/fog

0 commit comments

Comments
 (0)