Skip to content

Commit 6a640d6

Browse files
author
Chris Jakeman
committed
Move PerformanceTuner control to System tab
1 parent 0d217a6 commit 6a640d6

File tree

7 files changed

+188
-147
lines changed

7 files changed

+188
-147
lines changed
22.7 KB
Loading
-66 KB
Binary file not shown.

Source/Documentation/Manual/options.rst

Lines changed: 53 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -64,23 +64,13 @@ The Brake Pipe Charging Rate (psi/s) value controls the charging rate of
6464
the main air brake pipe. Increasing the value will reduce the time
6565
required to recharge the train (i.e. when releasing the brakes after a
6666
brake application), while decreasing the value will slow the charging
67-
rate. See also the :ref:`paragraphs <physics-hud-brake>` on the OR implementation of the braking
67+
rate. See also the :ref:`paragraphs <physics-hud-brake>` on the ORTS implementation of the braking
6868
system.
6969

7070
If this parameter is set at 1000, a simplified, MSTS-like braking model is
7171
implemented, providing for faster brake release and being less influenced
7272
by incoherent braking parameters within .eng file.
7373

74-
Language
75-
--------
76-
77-
OR is an internationalized package. It supports many languages, and others
78-
can be added by following the instructions contained in the *Localization
79-
Manual* which can be found in the Open Rails ``Documentation``
80-
folder.
81-
82-
When *System* is selected, OR automatically selects the language of the
83-
hosting OS, if the language is available.
8474

8575
.. _options-pressure:
8676

@@ -189,7 +179,7 @@ Double overhead wires
189179
---------------------
190180

191181
MSTS uses a single wire for electrified routes; you may check this box so
192-
that OR will show the two overhead wires that are more common.
182+
that ORTS will show the two overhead wires that are more common.
193183

194184
.. _options-vsync:
195185

@@ -298,14 +288,14 @@ Break couplers
298288

299289
When this option is selected, if the force on a coupler is higher than the
300290
threshold set in the .eng file, the coupler breaks and the train is
301-
divided into two parts. OR will display a message to report this.
291+
divided into two parts. ORTS will display a message to report this.
302292

303293
.. _options-curve-resistance:
304294

305295
Curve dependent speed limit
306296
---------------------------
307297

308-
When this option is selected, OR computes whether the train is running too
298+
When this option is selected, ORTS computes whether the train is running too
309299
fast on curves, and if so, a warning message is logged and displayed on
310300
the monitor. Excessive speed may lead to overturn of cars, this is also
311301
displayed as a message. This option is described in detail
@@ -332,7 +322,7 @@ Forced red at station stops
332322
---------------------------
333323

334324
In case a signal is present beyond a station platform and in the same
335-
track section (no switches in between), OR will set the signal to red
325+
track section (no switches in between), ORTS will set the signal to red
336326
until the train has stopped and then hold it as red from that time up to
337327
two minutes before starting time. This is useful in organizing train meets
338328
and takeovers, however it does not always correspond to reality nor to
@@ -412,14 +402,14 @@ Keyboard Options
412402
.. image:: images/options-keyboard.png
413403

414404
In this panel you will find listed the keyboard keys that are associated
415-
with all OR commands.
405+
with all ORTS commands.
416406

417407
You can modify them by clicking on a field and pressing the new desired
418408
key. Three symbols will appear at the right of the field: with the first
419409
one you validate the change, with the second one you cancel it, with the
420410
third one you return to the default value.
421411

422-
By clicking on *Check* OR verifies that the changes made are compatible,
412+
By clicking on *Check* ORTS verifies that the changes made are compatible,
423413
that is, that there is no key that is used for more than one command.
424414

425415
By clicking on *Defaults* all changes that were made are reset, and the
@@ -460,7 +450,7 @@ installations or miniroute installations for Open Rails. Installations
460450
located on other drives, or on a USB key, can be added even if they are
461451
not always available.
462452

463-
Click on the *Add* button, and locate the desired installation. OR will
453+
Click on the *Add* button, and locate the desired installation. ORTS will
464454
automatically enter a proposed name in the *Name:* window that will
465455
appear in the *Installation set:* window on the main menu form. Modify
466456
the name if desired, then click *OK* to add the new path and name to
@@ -471,15 +461,33 @@ itself!) select the entry in the window, and click *Delete*, then *OK*
471461
to close the window. To modify an entry, use the *Change...* button to
472462
access the location and make the necessary changes.
473463

474-
.. _options-updater:
464+
.. _options-system:
475465

476466
System Options
477467
===============
478468

479-
.. image:: images/options-updater.png
469+
.. image:: images/options-system.png
470+
471+
472+
Language
473+
--------
474+
ORTS is an internationalized package. It supports many languages, and others
475+
can be added by following the instructions contained in the *Localization
476+
Manual* which can be found in the Open Rails ``Documentation``
477+
folder.
478+
479+
When *System* is selected, ORTS automatically selects the language of the
480+
hosting OS, if that language is available.
481+
482+
483+
.. _options-updater-options:
484+
485+
Update mode
486+
-----------
487+
These options set which channel is active to update the ORTS version.
488+
More details are given
489+
:ref:`here <updating-or>`.
480490

481-
These options control which OR version update channel is active (see also
482-
:ref:`here <updating-or>`). The various options available are self-explanatory.
483491

484492
.. _options-windowed:
485493

@@ -489,13 +497,15 @@ If the ``Windowed`` checkbox is checked, Open Rails will run in a window
489497
instead of full screen.
490498

491499
Once the game has started, you can toggle between windowed mode and full screen by
492-
pressing ``<Alt+Enter>``.
500+
pressing ``Alt+Enter``.
501+
502+
The default setting is unchecked.
493503

494504

495505
Window size
496506
-----------
497507

498-
This pair of values defines the size of the OR window. There are some
508+
This pair of values defines the size of the ORTS window. There are some
499509
pre-configured pairs of values and you can also enter a
500510
specific width and height to be used.
501511

@@ -509,6 +519,8 @@ Glass on in-game windows
509519

510520
When this option is checked, the in-game windows are shown semi-transparently.
511521

522+
The default setting is checked.
523+
512524

513525
.. _options-control-confirmations:
514526

@@ -524,14 +536,15 @@ bottom of the screen.
524536
This is helpful for operations that don't have visible feedback and also
525537
allows you to control the train without being in the cab.
526538

539+
The default setting is checked.
527540
Uncheck this option if you prefer to monitor your cab instruments and
528541
don't want to see these messages.
529542

530543
OR uses the same message scheme for system messages such as "Game saved"
531544
or "Replay ended" but you cannot suppress these system messages.
532545

533546
Once the game has started, you can toggle the confirmations on and off
534-
by pressing ``<Ctrl+Alt+F10>``.
547+
by pressing ``Ctrl+Alt+F10``.
535548

536549

537550
.. _options-web-server-port:
@@ -561,6 +574,18 @@ program which can make a web request, such as C# or Python, using the
561574
:ref:`Application Programming Interface <web-server-api>` (API).
562575

563576

577+
.. _options-performance-tuner:
578+
579+
Automatically tune settings to keep performance level
580+
-----------------------------------------------------
581+
582+
When this option is selected ORTS attempts to maintain the selected Target
583+
frame rate FPS ( Frames per second). To do this it decreases or increases
584+
the viewing distance of the standard terrain. If the option is selected,
585+
also select the desired FPS in the *Target frame rate* field.
586+
587+
The default setting is unchecked.
588+
564589

565590
.. _options-experimental:
566591

@@ -576,7 +601,7 @@ described below.
576601
Super-elevation
577602
---------------
578603

579-
If the value set for *Level* is greater than zero, OR supports super-elevation
604+
If the value set for *Level* is greater than zero, ORTS supports super-elevation
580605
for long curved tracks. The value *Minimum Length* determines
581606
the length of the shortest curve to have super-elevation. You need to
582607
choose the correct gauge for your route, otherwise some tracks may not be
@@ -602,20 +627,13 @@ discussions about track profiles can also be found on `Elvas Tower
602627
<http://www.elvastower.com/forums/index.php?/topic/21119-superelevation/
603628
page__view__findpost__p__115247>`_.
604629

605-
Automatically tune settings to keep performance level
606-
-----------------------------------------------------
607-
608-
When this option is selected OR attempts to maintain the selected Target
609-
frame rate FPS ( Frames per second). To do this it decreases or increases
610-
the viewing distance of the standard terrain. If the option is selected,
611-
also select the desired FPS in the *Target frame rate* window.
612630

613631
.. _options-shape-warnings:
614632

615633
Show shape warnings
616634
-------------------
617635

618-
When this option is selected, when OR is loading the shape (.s) files it
636+
When this option is selected, when ORTS is loading the shape (.s) files it
619637
will report errors in syntax and structure (even if these don't cause
620638
runtime errors) in the :ref:`Log file <driving-logfile>` ``OpenRailsLog.txt`` on the desktop.
621639

@@ -654,7 +672,7 @@ checked (only for single-pipe brake system):
654672
``AirBrakesAirCompressorPowerRating`` (if this generates a value greater
655673
than 0.5 psi/s) instead of using a default value.
656674

657-
For a full list of parameters, see :ref:`Developing OR Content - Parameters and Tokens<parameters_and_tokens>`
675+
For a full list of parameters, see :ref:`Developing ORTS Content - Parameters and Tokens<parameters_and_tokens>`
658676

659677
.. _options-act-randomization:
660678

0 commit comments

Comments
 (0)