Skip to content

Commit 281b3d9

Browse files
committed
Revised manual text for some options
As discussed at http://www.elvastower.com/forums/index.php?/topic/35301-menu-options/
1 parent 1c4a84d commit 281b3d9

File tree

3 files changed

+614
-473
lines changed

3 files changed

+614
-473
lines changed

Source/Documentation/Manual/options.rst

Lines changed: 59 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -227,16 +227,22 @@ Video Options
227227
Dynamic shadows
228228
---------------
229229

230-
With this option it is possible to enable or disable the display of
231-
dynamic shadows. Disabling can be helpful if low frame rates are
232-
experienced.
230+
The default setting is unchecked.
231+
Check this option to cast shadows from movable objects such as trains.
232+
233+
Note: This may reduce the frame rate.
233234

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

237-
When this option is selected and also the Dynamic shadows option is selected,
238-
OR displays a shadow also for the objects that don't have a shadow defined in
239-
the .ref file, and also for forest trees. This may reduce game performance.
238+
The default setting is unchecked.
239+
Check this option to cast shadows from static objects.
240+
241+
Note: This may reduce the frame rate.
242+
243+
Note: Static objects provided with shadows (in the file <route>.ref)
244+
will cast shadows anyway. This option adds shadows for other static objects.
245+
240246

241247
.. _options-fullscreen:
242248

@@ -284,9 +290,15 @@ that OR will show the two overhead wires that are more common.
284290
Vertical sync
285291
-------------
286292

287-
When this option is selected, the OR update rate cannot be higher than the
288-
monitor vertical sync frequency (typically 60 Hz). This reduces CPU energy
289-
consumption in fast PCs.
293+
Vertical Sync (VSync) attempts to lock Open Rails’ output frame rate
294+
to your monitor's refresh rate for the smoothest image and to resist
295+
image "tearing”.
296+
VSync may help keep the frame rate more stable on complex routes,
297+
reducing sudden frame rate drops and apparent control lag in some cases.
298+
If Open Rails' frame rate drops below your monitor's frame rate, you
299+
may see stuttering or image "tearing". To prevent this, either turn off
300+
the VSync option or reduce the values for video options such as view
301+
distance, anti-aliasing, or world object density.
290302

291303
.. _options-cab-stretch:
292304

@@ -327,9 +339,12 @@ Viewing distance
327339
----------------
328340

329341
This option defines the maximum distance at which terrain is displayed. At
330-
higher distances Distant Mountains will be displayed (see below). This
331-
parameter increases CPU and GPU load. Also, some routes are optimized for
332-
the standard MSTS maximum viewing distance (2000m).
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).
345+
346+
Note: When the option to tune settings automatically is applied, then this
347+
value will be overridden and dynamically changed to maintain a target frame rate.
333348

334349
Distant mountains
335350
-----------------
@@ -453,13 +468,10 @@ When this option is selected, resistance to train motion is influenced by
453468
the wind speed, and the direction that it is blowing. This option is
454469
described in detail :ref:`here <physics-wind-resistance>`
455470

471+
Run electric locos on non-electrified routes
472+
--------------------------------------------
456473

457-
458-
Override non-electrified route line-voltage
459-
-------------------------------------------
460-
461-
This option allows running (in a non-prototypical way) electric
462-
locomotives on non-electrified routes.
474+
This option allows the running of electric locomotives on non-electrified routes.
463475

464476
Steam locomotive hot start
465477
--------------------------
@@ -480,9 +492,10 @@ until the train has stopped and then hold it as red from that time up to
480492
two minutes before starting time. This is useful in organizing train meets
481493
and takeovers, however it does not always correspond to reality nor to
482494
MSTS operation. So with this option the player can decide which behavior
483-
the start signal will have. This option is checked by default. Unchecking
484-
the option has an effect on simulation behavior only if no
485-
:ref:`Timetable mode <timetable>` operation is under way.
495+
the start signal will have. This option is checked by default.
496+
497+
Unchecking the option has no effect when in
498+
:ref:`Timetable mode <timetable>`.
486499

487500
.. _options-open-doors-ai:
488501

@@ -626,27 +639,28 @@ described below.
626639
Super-elevation
627640
---------------
628641

629-
If the value set for *Level* is greater than zero, OR supports super
630-
elevation for long curved tracks. The value *Minimum Length* determines
642+
If the value set for *Level* is greater than zero, OR supports super-elevation
643+
for long curved tracks. The value *Minimum Length* determines
631644
the length of the shortest curve to have super-elevation. You need to
632645
choose the correct gauge for your route, otherwise some tracks may not be
633646
properly shown.
634647

635-
When superelevation is selected, two viewing effects occur at runtime:
648+
When super-elevation is selected, two viewing effects occur at runtime:
636649

637650
1. If an external camera view is selected, the tracks and the running
638-
train will be shown inclined towards the internal part of the curve.
651+
train will be shown inclined towards the inside of the curve.
639652
2. When the cab view is selected, the external world will be
640-
shown as inclined towards the external part of the curve.
653+
shown as inclined towards the outside of the curve.
641654

642655
.. image:: images/options-superelevation_1.png
643656
.. image:: images/options-superelevation_2.png
644657

645-
OR implements super elevated tracks using Dynamic Tracks. You can change
658+
OR implements super-elevated tracks using Dynamic Tracks. You can change
646659
the appearance of tracks by creating a ``<route folder>/TrackProfiles/
647660
TrProfile.stf`` file. The document ``How to Provide Track Profiles for
648-
Open Rails Dynamic Track.docm`` describing the creation of track profiles
649-
can be found in the OpenRails ``/Source/Documentation/`` folder. Forum
661+
Open Rails Dynamic Track.pdf`` describing the creation of track profiles
662+
can be found in the *Menu > Documents* drop-down or the
663+
Open Rails ``/Source/Documentation/`` folder. Forum
650664
discussions about track profiles can also be found on `Elvas Tower
651665
<http://www.elvastower.com/forums/index.php?/topic/21119-superelevation/
652666
page__view__findpost__p__115247>`_.
@@ -820,10 +834,22 @@ and therefore a more difficult, but more challenging driving experience.
820834
Level of detail bias
821835
--------------------
822836

823-
This option is an expansion (and replacement) of an earlier experimental
824-
option: *Always use highest level of detail*. The new option allows you to
825-
increase or reduce the level of detail generally shown independently of
826-
the viewing distance and world object density.
837+
Many visual objects are modelled at more than one level of detail (LOD) so,
838+
when they are seen at a distance, Open Rails can switch to the lesser level
839+
of detail without compromising the view. This use of multiple LODs reduces
840+
the processing load and so may increase frame rates.
841+
842+
Lowering the LOD Bias setting below 0 reduces the distance at which a lower
843+
level of detail comes into view, and so boosts frame rates but there may be
844+
some loss of sharpness.
845+
846+
Raising the LOD Bias setting above 0 increases the distance at which a lower
847+
level of detail comes into view. This may be useful to sharpen distant content
848+
that was created for a smaller screen or a wider field of view than you are
849+
currently using.
850+
851+
If your content does not use multiple LODs, then this option will have no effect.
852+
827853

828854
Adhesion proportional to rain/snow/fog
829855
--------------------------------------

0 commit comments

Comments
 (0)