Merge branch 'master' into downloadContent2

Author: sweiland-openrails

Source/ContentChecker/ContentChecker.csproj

@@ -3,8 +3,6 @@
     <TargetFramework Condition="'$(BuildDotNet)' == 'true'">net6-windows</TargetFramework>
     <TargetFramework Condition="'$(TargetFramework)' == ''">net472</TargetFramework>
     <OutputType>Exe</OutputType>
-    <UseWindowsForms>true</UseWindowsForms>
-    <ImportWindowsDesktopTargets>true</ImportWindowsDesktopTargets>
     <IsPublishable>False</IsPublishable>
     <AssemblyTitle>Open Rails Content Checker</AssemblyTitle>
     <Description>Open Rails Transport Simulator</Description>

Source/ContentChecker/Loader.cs

@@ -43,7 +43,6 @@
 using System.Linq;
 using System.Text;
 using Microsoft.Xna.Framework.Graphics;
-using System.Windows.Forms;
 
 namespace ContentChecker
 {
@@ -70,7 +69,7 @@ abstract class Loader
         /// <summary> The number of files that were actually loaded </summary>
         public int FilesLoaded { get; protected set; }
         /// <summary> The number of files that were not loaded but skipped </summary>
-        public int FilesSkipped {get; protected set;}
+        public int FilesSkipped { get; protected set; }
 
         /// <summary> The action to take when an additonal file has been identified. This is intended to be set externally </summary>
         protected Action<string, Loader> AddAdditionalFileAction { get; set; }
@@ -158,17 +157,13 @@ protected static GraphicsDevice GetGraphicsDevice()
         {
             if (_graphicsDevice == null)
             {
-                // We use a Windows.Forms Control instead of an xna GAME because it is much easier to use.
-                var _c = new Control();
-
                 // Details probably do not matter too much
                 PresentationParameters parameters = new PresentationParameters()
                 {
                     BackBufferWidth = 100,
                     BackBufferHeight = 100,
                     BackBufferFormat = SurfaceFormat.Color,
                     //DepthStencilFormat = DepthFormat.Depth24,
-                    DeviceWindowHandle = _c.Handle,
                     PresentationInterval = PresentInterval.Immediate,
                     IsFullScreen = false,
                 };

Source/ContentChecker/Program.cs

@@ -77,11 +77,10 @@ static bool OptionsContain(string[] args, IEnumerable<string> optionNames) {
         /// </summary>
         static void ShowHelp()
         {
-            var version = FileVersionInfo.GetVersionInfo(typeof(Program).Assembly.Location);
-            Console.WriteLine("{0} {1}", version.FileDescription, VersionInfo.VersionOrBuild);
+            Console.WriteLine("{0} {1}", ApplicationInfo.ApplicationName, VersionInfo.VersionOrBuild);
             Console.WriteLine();
             Console.WriteLine("Usage:");
-            Console.WriteLine("  {0} [options] <FILE> [...]", Path.GetFileNameWithoutExtension(version.FileName));
+            Console.WriteLine("  {0} [options] <FILE> [...]", Path.GetFileNameWithoutExtension(ApplicationInfo.ProcessFile));
             Console.WriteLine();
             Console.WriteLine("Arguments:");
             Console.WriteLine("  <FILE>           Data files to check; may contain wildcards");

Source/Contrib/DataCollector/Program.cs

@@ -19,7 +19,6 @@
 using ORTS.Common;
 using System;
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.IO;
 using System.Linq;
 
@@ -39,11 +38,10 @@ static void Main(string[] args)
 
         static void ShowHelp()
         {
-            var version = FileVersionInfo.GetVersionInfo(typeof(Program).Assembly.Location);
-            Console.WriteLine("{0} {1}", version.FileDescription, VersionInfo.VersionOrBuild);
+            Console.WriteLine("{0} {1}", ApplicationInfo.ApplicationName, VersionInfo.VersionOrBuild);
             Console.WriteLine();
             Console.WriteLine("Usage:");
-            Console.WriteLine("  {0} [options] [<PATH> [...]]", Path.GetFileNameWithoutExtension(version.FileName));
+            Console.WriteLine("  {0} [options] [<PATH> [...]]", Path.GetFileNameWithoutExtension(ApplicationInfo.ProcessFile));
             Console.WriteLine();
             Console.WriteLine("Arguments:");
             Console.WriteLine("  <PATH>         Directories to scan for specific options");

Source/Contrib/DataConverter/Program.cs

@@ -17,7 +17,6 @@
 
 using System;
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.IO;
 using System.Linq;
 using System.Runtime.Serialization;
@@ -87,11 +86,10 @@ static void Main(string[] args)
 
         static void ShowHelp(List<IDataConverter> converters)
         {
-            var version = FileVersionInfo.GetVersionInfo(typeof(Program).Assembly.Location);
-            Console.WriteLine("{0} {1}", version.FileDescription, VersionInfo.VersionOrBuild);
+            Console.WriteLine("{0} {1}", ApplicationInfo.ApplicationName, VersionInfo.VersionOrBuild);
             Console.WriteLine();
             Console.WriteLine("Usage:");
-            Console.WriteLine("  {0} /input <INPUT> [/output] [<OUTPUT> [...]]", Path.GetFileNameWithoutExtension(version.FileName));
+            Console.WriteLine("  {0} /input <INPUT> [/output] [<OUTPUT> [...]]", Path.GetFileNameWithoutExtension(ApplicationInfo.ProcessFile));
             Console.WriteLine();
             Console.WriteLine("Arguments:");
             Console.WriteLine("  <INPUT>   Specifies the file to read");

Source/Contrib/DataValidator/Program.cs

@@ -39,11 +39,10 @@ static void Main(string[] args)
 
         static void ShowHelp()
         {
-            var version = FileVersionInfo.GetVersionInfo(typeof(Program).Assembly.Location);
-            Console.WriteLine("{0} {1}", version.FileDescription, VersionInfo.VersionOrBuild);
+            Console.WriteLine("{0} {1}", ApplicationInfo.ApplicationName, VersionInfo.VersionOrBuild);
             Console.WriteLine();
             Console.WriteLine("Usage:");
-            Console.WriteLine("  {0} [options] <FILE> [...]", Path.GetFileNameWithoutExtension(version.FileName));
+            Console.WriteLine("  {0} [options] <FILE> [...]", Path.GetFileNameWithoutExtension(ApplicationInfo.ProcessFile));
             Console.WriteLine();
             Console.WriteLine("Arguments:");
             Console.WriteLine("  <FILE>    Data files to validate; may contain wildcards");

Source/Contrib/SimulatorTester/Program.cs

@@ -21,9 +21,7 @@
 using Orts.Simulation;
 using ORTS.Common;
 using System.IO;
-using System.Windows.Forms;
 using Orts.Common;
-using System.Diagnostics;
 
 namespace SimulatorTester
 {
@@ -37,23 +35,22 @@ static void Main(string[] args)
 
             if (files.Count != 1 || options.Contains("help", StringComparer.InvariantCultureIgnoreCase))
             {
-                var version = FileVersionInfo.GetVersionInfo(Application.ExecutablePath);
-                Console.WriteLine("{0} {1}", version.FileDescription, VersionInfo.VersionOrBuild);
+                Console.WriteLine("{0} {1}", ApplicationInfo.ApplicationName, VersionInfo.VersionOrBuild);
                 Console.WriteLine();
                 Console.WriteLine("Usage:");
-                Console.WriteLine("  {0} [options] <SAVE_FILE>", Path.GetFileNameWithoutExtension(Application.ExecutablePath));
+                Console.WriteLine("  {0} [options] <SAVE_FILE>", Path.GetFileNameWithoutExtension(ApplicationInfo.ProcessFile));
                 Console.WriteLine();
                 Console.WriteLine("Arguments:");
-                Console.WriteLine("  <SAVE_FILE>  {0} save file to use", Application.ProductName);
+                Console.WriteLine("  <SAVE_FILE>  {0} save file to use", ApplicationInfo.ProductName);
                 Console.WriteLine();
                 Console.WriteLine("Options:");
                 Console.WriteLine("  /quiet       Do not show summary of simulation (only exit code is set)");
-                Console.WriteLine("  /verbose     Show version and settings (similar to a {0} log)", Application.ProductName);
+                Console.WriteLine("  /verbose     Show version and settings (similar to a {0} log)", ApplicationInfo.ProductName);
                 Console.WriteLine("  /fps <FPS>   Set the simulation frame-rate [default: 10]");
                 Console.WriteLine("  /help        Show help and usage information");
-                Console.WriteLine("  ...and any standard {0} option", Application.ProductName);
+                Console.WriteLine("  ...and any standard {0} option", ApplicationInfo.ProductName);
                 Console.WriteLine();
-                Console.WriteLine("The {0} takes a save file and:", version.FileDescription);
+                Console.WriteLine("The {0} takes a save file and:", ApplicationInfo.ApplicationName);
                 Console.WriteLine("  - Loads the same activity as contained in the save file");
                 Console.WriteLine("  - Runs the simulation at the specified FPS for the same duration as the save file");
                 Console.WriteLine("  - Compares the final position with that contained in the save file");
@@ -65,15 +62,15 @@ static void Main(string[] args)
 
             if (settings.Verbose)
             {
-                Console.WriteLine("This is a log file for {0}. Please include this file in bug reports.", Application.ProductName);
+                Console.WriteLine("This is a log file for {0}. Please include this file in bug reports.", ApplicationInfo.ProductName);
                 LogSeparator();
 
                 SystemInfo.WriteSystemDetails(Console.Out);
                 LogSeparator();
 
                 Console.WriteLine("Version      = {0}", VersionInfo.Version.Length > 0 ? VersionInfo.Version : "<none>");
                 Console.WriteLine("Build        = {0}", VersionInfo.Build);
-                Console.WriteLine("Executable   = {0}", Path.GetFileName(Application.ExecutablePath));
+                Console.WriteLine("Executable   = {0}", Path.GetFileName(ApplicationInfo.ProcessFile));
                 foreach (var arg in args)
                     Console.WriteLine("Argument     = {0}", arg);
                 LogSeparator();

Source/Contrib/SimulatorTester/SimulatorTester.csproj

@@ -6,9 +6,6 @@
     <RootNamespace>Orts.SimulatorTester</RootNamespace>
     <AssemblyName>Contrib.SimulatorTester</AssemblyName>
     <ApplicationIcon>..\..\ORTS.ico</ApplicationIcon>
-    <UseWindowsForms>true</UseWindowsForms>
-    <ImportWindowsDesktopTargets>true</ImportWindowsDesktopTargets>
-    <OutputPath>..\..\..\Program\</OutputPath>
     <IsPublishable>False</IsPublishable>
     <AssemblyTitle>Open Rails Simulator Tester (Contributed)</AssemblyTitle>
     <Description>Open Rails Transport Simulator</Description>

Source/Contrib/TrackViewer/Drawing/DrawTerrain.cs

@@ -486,8 +486,14 @@ void UpdateCamera(DrawArea drawArea)
             float camHeight = width / device.Viewport.AspectRatio / 2;
             Vector3 cameraPosition = cameraTarget;
             cameraPosition.Y = -camHeight;
+            float nearPlaneDistance = camHeight / 2;
+            if (nearPlaneDistance <= 0)
+            {
+                // distance is too close for CreatePerspectiveFieldOfView
+                return;
+            }
             basicEffect.View = Matrix.CreateLookAt(cameraPosition, cameraTarget, new Vector3(0, 0, 1));
-            basicEffect.Projection = Matrix.CreatePerspectiveFieldOfView(MathHelper.PiOver2, device.Viewport.AspectRatio, camHeight / 2, camHeight * 2);
+            basicEffect.Projection = Matrix.CreatePerspectiveFieldOfView(MathHelper.PiOver2, device.Viewport.AspectRatio, nearPlaneDistance, camHeight * 2);
 
         }
         #endregion

Source/Documentation/Manual/images/notification-error.png

@@ -15,6 +15,8 @@ What's been added
 -----------------
 
 - detailed map which tracks player train
+- self-installing content
+- new rolling stock lighting controls, including horn-activated flashing lights
 - partial turntables
 - cab controls operated remotely from a tablet or control desk
 - animations for cab windows
@@ -30,6 +32,7 @@ What's been improved
 --------------------
 
 - sky, sunrise and sunset appearance
+- auto-pilot extended to timetables
 - wheelslip, exhaust and steam
 - layout of map window
 - F9 menu for controlling cars and brakes

Source/Documentation/Manual/images/notification-icon.png

@@ -83,20 +83,22 @@ The player can select the unit of measure of brake pressure in the
 When set to *automatic* the unit of measure is the same as that used in
 the cabview of the locomotive.
 
-Other units
------------
+Other units of measure
+----------------------
 
 This selects the units displayed for length, mass, pressure, etc. in the
 :ref:`F5 Train Driving Info Window and also the Alt+F5 HUD <driving-hud>` of the simulation.
 
+These windows use the abbreviations *t-us* for short tons (2000 lb),
+*t-uk* for long tons (2240 lb) and *t* for metric tons (1000 kg).
+
+The option *Route* sets the units based on the data in the route files. The route's TRK file may contain ``MilepostUnitsMiles ()`` or 
+``MilepostUnitsKilometers ()`` to specify the units of distance for this route.
+
 The option *Player's Location* sets the units according to the Windows
 *Language and Region* settings on the player's computer.
 
-The option *Route* sets the units based on the data in the route files.
-The other options are self-explanatory.
-
-These windows use the abbreviations *t-us* for short tons (2000 lb),
-*t-uk* for long tons (2240 lb) and *t* for metric tons (1000 kg).
+The other choices for units of measure are straightforward.
 
 Note: The units displayed by the :ref:`F4 Track Monitor <driving-track-monitor>` (e.g. velocity and
 distance) are always based on data read from the route files.

Source/Documentation/Manual/images/notification-red-indicator.png

@@ -85,6 +85,115 @@ to close the window and save the changes to OR.
 Updating OR
 ===========
 
+Four update modes are provided and you can update Open Rails with a single click of a button.
+
+"Stable" is the default and recommended mode.
+
+"Testing" is updated more frequently than the "Stable" mode.
+
+If you follow the Open Rails project on the forums, then you will hear about bug-fixes and new features. 
+These are included in the "Unstable" version for developers and testers to try out. 
+Once they have been checked and approved, they are published (on Fridays) as the latest "Testing" version. 
+Any user can easily update to the current weekly "Testing" version and benefit from these improvements.
+
+New versions are advertised and installed using the :ref:`Notifications <notifications>` feature.
+
+You can change your current mode using Options > System > Update mode. 
+The fourth mode is "none", which does not search for a new version.
+
+
+.. _notifications:
+
+Notifications
+=============
+
+Notifications are brief messages sent to Open Rails when you launch Open Rails. 
+You can view these by clicking on the notifications icon and stop viewing by toggling the icon again.
+
+.. image:: images/notification-icon.png
+
+Old notifications persist, but when new ones are available, the icon is overlaid with a red indicator showing the number of new notifications. 
+The icons are presented in date order with the latest one first. Step through them by clicking on the arrows:
+
+.. image:: images/notification-red-indicator.png
+
+Static Notifications
+--------------------
+
+A simple notification may be shown in the same way to all users, such as:
+
+.. image:: images/notification-static.png
+
+Pressing the “Archive” button will launch your default browser to provide extra detail.
+
+Responsive Notifications
+------------------------
+
+Many notifications show differently depending on the user’s installation. 
+
+Responsive notifications are used to advise that a new version is available. 
+If a new version is available, then the notification might be shown as:
+
+.. image:: images/notification-update-available.png
+
+As before, the button “What’s new” will launch your default browser to provide extra detail. 
+The “Install” button is special and launches a seamless process to download the latest version available and use it to replace the active version.
+
+Once the user has upgraded, the previous message is no longer appropriate and the notification responds to the changes by showing as:
+
+.. image:: images/notification-update-installed.png
+
+Privacy Note
+------------
+
+No information is returned to the Open Rails web server.
+
+Update Mode
+-----------
+
+There are 4 update modes – Stable, Testing, Unstable and None. More details are available :ref:`here <updating-or>`.
+Note, however, that previously saved games may not be compatible with newer versions, as described :ref:`here <driving-saveresume>`.
+
+Checking Compatibility
+----------------------
+
+Responsive notifications are also used to check that an update is compatible with your system. For example, you might see useful warnings such as:
+
+.. image:: images/notification-update-incompatible.png
+
+Responding to Routes
+--------------------
+
+These notifications can respond to the routes you have installed, so you can be advised of updates to routes you have already installed. For example, you might see:
+
+.. image:: images/notification-routes.png
+
+But this notification would be missing if you don’t already have the route installed.
+
+Responding to Settings
+----------------------
+
+The notifications can also respond to the settings you are using - see :ref:`Open Rails Options<options>`.
+
+In this fictional example, you might see a message encouraging you to try an improved feature:
+
+.. image:: images/notification-settings.png
+
+However, if you have the option turned on already, then the notification is not shown.
+
+Communication Error
+-------------------
+
+If there is a problem with the Internet then the Notifications are replaced by a single prepared notification which gives a reason for the error and a chance to re-try:
+
+.. image:: images/notification-error.png
+
+Publishing Notifications
+------------------------
+
+The Notifications document explains how to publish notifications and is included in the :ref:`Documents drop-down<documents>`.
+
+=======
 When a new release of OR is available and your computer is online, a link 
 ``Update to xnnnn`` appears in the upper right corner. The string ``xnnnn`` is 
 the release number of the newest release that matches your selected level 
@@ -110,6 +219,8 @@ Tools
 By clicking this button you get access to the ancillary tools (see :ref:`here 
 <intro-reality>`).
 
+.. _documents:
+
 Documents
 ---------