Skip to content

Commit 748be1d

Browse files
authored
Merge pull request #632 from cjakeman/menu-options07a
Menu options07a - Re-do System Tab
2 parents c204d0a + a24a4f1 commit 748be1d

File tree

14 files changed

+1218
-1059
lines changed

14 files changed

+1218
-1059
lines changed

Source/Contrib/TimetableEditor/languages/contrib.timetableeditor.ru.po

Lines changed: 626 additions & 626 deletions
Large diffs are not rendered by default.
-1.22 KB
Loading
-4.31 KB
Loading
22.7 KB
Loading
-66 KB
Binary file not shown.
-1.61 KB
Loading

Source/Documentation/Manual/options.rst

Lines changed: 134 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -33,30 +33,6 @@ therefore will not see the alerter warning, selecting the related option
3333
*Also in external views* enables the alerter in those views as well.
3434

3535

36-
.. _options-control-confirmations:
37-
38-
Control confirmations
39-
---------------------
40-
41-
Following MSTS practice, whenever you make adjustments to the train
42-
controls (e.g. open the throttle) OR briefly shows a message near the
43-
bottom of the screen.
44-
45-
.. image:: images/options-confirmations.png
46-
47-
This is helpful for operations that don't have visible feedback and also
48-
allows you to control the train without being in the cab.
49-
50-
Uncheck this option if you prefer to monitor your cab instruments and
51-
don't want to see these messages.
52-
53-
OR uses the same message scheme for system messages such as "Game saved"
54-
or "Replay ended" but you cannot suppress these system messages.
55-
56-
Control confirmations can also be toggled on and off at runtime using the
57-
key combination Ctrl-Alt-F10.
58-
59-
6036
Graduated release air brakes
6137
----------------------------
6238

@@ -66,7 +42,6 @@ standard and unchecked is equivalent to freight standard. A complete
6642
description of this option can be found :ref:`here <physics-braking>`.
6743

6844

69-
7045
.. _options-retainers:
7146

7247
Retainer valve on all cars
@@ -89,23 +64,13 @@ The Brake Pipe Charging Rate (psi/s) value controls the charging rate of
8964
the main air brake pipe. Increasing the value will reduce the time
9065
required to recharge the train (i.e. when releasing the brakes after a
9166
brake application), while decreasing the value will slow the charging
92-
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
9368
system.
9469

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

99-
Language
100-
--------
101-
102-
OR is an internationalized package. It supports many languages, and others
103-
can be added by following the instructions contained in the *Localization
104-
Manual* which can be found in the Open Rails ``Documentation``
105-
folder.
106-
107-
When *System* is selected, OR automatically selects the language of the
108-
hosting OS, if the language is available.
10974

11075
.. _options-pressure:
11176

@@ -136,37 +101,12 @@ These windows use the abbreviations *t-us* for short tons (2000 lb),
136101
Note: The units displayed by the :ref:`F4 Track Monitor <driving-track-monitor>` (e.g. velocity and
137102
distance) are always based on data read from the route files.
138103

139-
Enable TCS scripts
104+
Use TCS scripts
140105
-------------------
141106

142-
This option enables the train control system scripts for locomotives where
107+
This option uses the train control system scripts for locomotives where
143108
these have been implemented.
144109

145-
.. _options-web-server-port:
146-
147-
Web server port
148-
-----------------
149-
150-
The web server can be accessed from a browser on the local machine at
151-
``http://localhost:<port>``, where ``<port>`` is the specified port number.
152-
Change the default value of 2150 if it conflicts with other services.
153-
154-
If you `open
155-
<https://www.howtogeek.com/394735/how-do-i-open-a-port-on-windows-firewall/>`_
156-
the web server port (just granting RunActivity.exe an exemption is not
157-
sufficient) in Windows Firewall, the server can also be accessed from a device
158-
on the local network, such as a smartphone, tablet or another PC, using your
159-
system's `IP address
160-
<https://support.microsoft.com/en-us/windows/find-your-ip-address-f21a9bbc-c582-55cd-35e0-73431160a1b9>`_.
161-
E.g.: If your Open Rails PC is at IP address 192.168.0.99, browse to
162-
``http://192.168.0.99:<port>``, where ``<port>`` is the specified port number.
163-
164-
:ref:`Sample web pages <sample-web-pages>` are included in the Open Rails
165-
installation and the browser will show a menu of sample pages.
166-
167-
As well as a web browser, data from the web server can also be fetched by any
168-
program which can make a web request, such as C# or Python, using the
169-
:ref:`Application Programming Interface <web-server-api>` (API).
170110

171111
Overspeed Monitor
172112
-----------------
@@ -218,14 +158,6 @@ Note: This may reduce the frame rate.
218158
Note: Static objects provided with shadows (in the World files)
219159
will cast shadows anyway. This option adds shadows for other static objects.
220160

221-
222-
Glass on in-game windows
223-
------------------------
224-
225-
When this option is checked, the in-game windows are displayed in a
226-
semitransparent mode.
227-
228-
229161
Model instancing
230162
----------------
231163

@@ -249,7 +181,7 @@ Double overhead wires
249181
---------------------
250182

251183
MSTS uses a single wire for electrified routes; you may check this box so
252-
that OR will show the two overhead wires that are more common.
184+
that ORTS will show the two overhead wires that are more common.
253185

254186

255187
.. _options-vsync:
@@ -314,12 +246,6 @@ In legacy routes, all the content was assigned to categories 0-10.
314246
In more modern routes, content may be assigned to categories between 0 and 49.
315247
Content builders are advised to reserve values 50 to 99 for objects used in building the route.
316248

317-
Window size
318-
-----------
319-
320-
This pair of values defines the size of the OR window. There are some
321-
preconfigured pairs of values, however you may also manually enter a
322-
different size to be used.
323249

324250
Ambient daylight brightness
325251
---------------------------
@@ -369,14 +295,14 @@ Break couplers
369295

370296
When this option is selected, if the force on a coupler is higher than the
371297
threshold set in the .eng file, the coupler breaks and the train is
372-
divided into two parts. OR will display a message to report this.
298+
divided into two parts. ORTS will display a message to report this.
373299

374300
.. _options-curve-resistance:
375301

376302
Curve dependent speed limit
377303
---------------------------
378304

379-
When this option is selected, OR computes whether the train is running too
305+
When this option is selected, ORTS computes whether the train is running too
380306
fast on curves, and if so, a warning message is logged and displayed on
381307
the monitor. Excessive speed may lead to overturn of cars, this is also
382308
displayed as a message. This option is described in detail
@@ -415,7 +341,7 @@ Forced red at station stops
415341
---------------------------
416342

417343
In case a signal is present beyond a station platform and in the same
418-
track section (no switches in between), OR will set the signal to red
344+
track section (no switches in between), ORTS will set the signal to red
419345
until the train has stopped and then hold it as red from that time up to
420346
two minutes before starting time. This is useful in organizing train meets
421347
and takeovers, however it does not always correspond to reality nor to
@@ -487,14 +413,14 @@ Keyboard Options
487413
.. image:: images/options-keyboard.png
488414

489415
In this panel you will find listed the keyboard keys that are associated
490-
with all OR commands.
416+
with all ORTS commands.
491417

492418
You can modify them by clicking on a field and pressing the new desired
493419
key. Three symbols will appear at the right of the field: with the first
494420
one you validate the change, with the second one you cancel it, with the
495421
third one you return to the default value.
496422

497-
By clicking on *Check* OR verifies that the changes made are compatible,
423+
By clicking on *Check* ORTS verifies that the changes made are compatible,
498424
that is, that there is no key that is used for more than one command.
499425

500426
By clicking on *Defaults* all changes that were made are reset, and the
@@ -526,7 +452,7 @@ installations or miniroute installations for Open Rails. Installations
526452
located on other drives, or on a USB key, can be added even if they are
527453
not always available.
528454

529-
Click on the *Add* button, and locate the desired installation. OR will
455+
Click on the *Add* button, and locate the desired installation. ORTS will
530456
automatically enter a proposed name in the *Name:* window that will
531457
appear in the *Installation set:* window on the main menu form. Modify
532458
the name if desired, then click *OK* to add the new path and name to
@@ -537,15 +463,131 @@ itself!) select the entry in the window, and click *Delete*, then *OK*
537463
to close the window. To modify an entry, use the *Change...* button to
538464
access the location and make the necessary changes.
539465

540-
.. _options-updater:
466+
.. _options-system:
541467

542-
Updater Options
468+
System Options
543469
===============
544470

545-
.. image:: images/options-updater.png
471+
.. image:: images/options-system.png
472+
473+
474+
Language
475+
--------
476+
ORTS is an internationalized package. It supports many languages, and others
477+
can be added by following the instructions contained in the *Localization
478+
Manual* which can be found in the Open Rails ``Documentation``
479+
folder.
480+
481+
When *System* is selected, ORTS automatically selects the language of the
482+
hosting OS, if that language is available.
483+
484+
485+
.. _options-updater-options:
486+
487+
Update mode
488+
-----------
489+
These options set which channel is active to update the ORTS version.
490+
More details are given
491+
:ref:`here <updating-or>`.
492+
493+
494+
.. _options-windowed:
495+
496+
Windowed
497+
--------
498+
If the ``Windowed`` checkbox is checked, Open Rails will run in a window
499+
instead of full screen.
500+
501+
Once the game has started, you can toggle between windowed mode and full screen by
502+
pressing ``Alt+Enter``.
503+
504+
The default setting is unchecked.
505+
506+
507+
Window size
508+
-----------
509+
510+
This pair of values defines the size of the ORTS window. There are some
511+
pre-configured pairs of values and you can also enter a
512+
specific width and height to be used.
513+
514+
The format is <width>x<height>, for example 1024x768.
515+
516+
517+
.. _options-window-glass:
518+
519+
Glass on in-game windows
520+
------------------------
521+
522+
When this option is checked, the in-game windows are shown semi-transparently.
523+
524+
The default setting is checked.
525+
526+
527+
.. _options-control-confirmations:
528+
529+
Control confirmations
530+
---------------------
531+
532+
Whenever you make adjustments to the train
533+
controls (e.g. open the throttle) Open Rails briefly shows a message near the
534+
bottom of the screen.
535+
536+
.. image:: images/options-confirmations.png
537+
538+
This is helpful for operations that don't have visible feedback and also
539+
allows you to control the train without being in the cab.
540+
541+
The default setting is checked.
542+
Uncheck this option if you prefer to monitor your cab instruments and
543+
don't want to see these messages.
544+
545+
OR uses the same message scheme for system messages such as "Game saved"
546+
or "Replay ended" but you cannot suppress these system messages.
547+
548+
Once the game has started, you can toggle the confirmations on and off
549+
by pressing ``Ctrl+Alt+F10``.
550+
551+
552+
.. _options-web-server-port:
553+
554+
Web server port
555+
-----------------
556+
557+
The web server can be accessed from a browser on the local machine at
558+
``http://localhost:<port>``, where ``<port>`` is the specified port number.
559+
Change the default value of 2150 if it conflicts with other services.
560+
561+
If you `open
562+
<https://www.howtogeek.com/394735/how-do-i-open-a-port-on-windows-firewall/>`_
563+
the web server port (just granting RunActivity.exe an exemption is not
564+
sufficient) in Windows Firewall, the server can also be accessed from a device
565+
on the local network, such as a smartphone, tablet or another PC, using your
566+
system's `IP address
567+
<https://support.microsoft.com/en-us/windows/find-your-ip-address-f21a9bbc-c582-55cd-35e0-73431160a1b9>`_.
568+
E.g.: If your Open Rails PC is at IP address 192.168.0.99, browse to
569+
``http://192.168.0.99:2150``, where ``2150`` is the specified port number.
570+
571+
:ref:`Sample web pages <sample-web-pages>` are included in the Open Rails
572+
installation and the browser will show a menu of sample pages.
573+
574+
As well as a web browser, data from the web server can also be fetched by any
575+
program which can make a web request, such as C# or Python, using the
576+
:ref:`Application Programming Interface <web-server-api>` (API).
577+
578+
579+
.. _options-performance-tuner:
580+
581+
Automatically tune settings to keep performance level
582+
-----------------------------------------------------
583+
584+
When this option is selected ORTS attempts to maintain the selected Target
585+
frame rate FPS ( Frames per second). To do this it decreases or increases
586+
the viewing distance of the standard terrain. If the option is selected,
587+
also select the desired FPS in the *Target frame rate* field.
588+
589+
The default setting is unchecked.
546590

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

550592
.. _options-experimental:
551593

@@ -561,7 +603,7 @@ described below.
561603
Super-elevation
562604
---------------
563605

564-
If the value set for *Level* is greater than zero, OR supports super-elevation
606+
If the value set for *Level* is greater than zero, ORTS supports super-elevation
565607
for long curved tracks. The value *Minimum Length* determines
566608
the length of the shortest curve to have super-elevation. You need to
567609
choose the correct gauge for your route, otherwise some tracks may not be
@@ -587,20 +629,13 @@ discussions about track profiles can also be found on `Elvas Tower
587629
<http://www.elvastower.com/forums/index.php?/topic/21119-superelevation/
588630
page__view__findpost__p__115247>`_.
589631

590-
Automatically tune settings to keep performance level
591-
-----------------------------------------------------
592-
593-
When this option is selected OR attempts to maintain the selected Target
594-
frame rate FPS ( Frames per second). To do this it decreases or increases
595-
the viewing distance of the standard terrain. If the option is selected,
596-
also select the desired FPS in the *Target frame rate* window.
597632

598633
.. _options-shape-warnings:
599634

600635
Show shape warnings
601636
-------------------
602637

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

@@ -639,7 +674,7 @@ checked (only for single-pipe brake system):
639674
``AirBrakesAirCompressorPowerRating`` (if this generates a value greater
640675
than 0.5 psi/s) instead of using a default value.
641676

642-
For a full list of parameters, see :ref:`Developing OR Content - Parameters and Tokens<parameters_and_tokens>`
677+
For a full list of parameters, see :ref:`Developing ORTS Content - Parameters and Tokens<parameters_and_tokens>`
643678

644679
.. _options-act-randomization:
645680

Source/Documentation/Manual/start.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,6 @@ useful to document and investigate malfunctions.
7979
At every restart of the game (that is, after clicking ``Start`` or ``Server``
8080
or ``Client``) the log file is cleared and a new one is generated.
8181

82-
If the ``Windowed`` checkbox is checked, Open Rails will run in a window
83-
instead of full screen.
84-
8582
If you wish to fine-tune Open Rails for your system, click on the
8683
``Options`` button. See the Chapter: :ref:`Open Rails Options <options>` which describes
8784
the extensive set of OR options. It is recommended that you read this

0 commit comments

Comments
 (0)