Merge branch 'openrails:master' into master

Author: sweiland-openrails

.config/dotnet-tools.json

@@ -0,0 +1,12 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "dotnet-mgfxc": {
+      "version": "3.8.0.1641",
+      "commands": [
+        "mgfxc"
+      ]
+    }
+  }
+}

.gitattributes

@@ -35,16 +35,6 @@
 *.svg text
 *.eps binary
 
-
-# https://github.com/Danimoth/gitattributes/blob/master/VisualStudio.gitattributes
-# Custom for Visual Studio
-*.sln text eol=crlf merge=union
-*.csproj merge=union
-*.vbproj merge=union
-*.fsproj merge=union
-*.dbproj merge=union
-
-
 # https://github.com/Danimoth/gitattributes/blob/master/CSharp.gitattributes
 # Custom for C#
 *.cs diff=csharp

Source/.editorconfig

@@ -1,7 +1,9 @@
 # To learn more about .editorconfig see https://aka.ms/editorconfigdocs
+# BEGIN COPY FROM https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/code-style-rule-options#example-editorconfig-file
 ###############################
 # Core EditorConfig Options   #
 ###############################
+root = true
 # All files
 [*]
 indent_style = space
@@ -58,7 +60,7 @@ dotnet_style_prefer_conditional_expression_over_return = true:silent
 ###############################
 # Style Definitions
 dotnet_naming_style.pascal_case_style.capitalization             = pascal_case
-# Use PascalCase for constant fields  
+# Use PascalCase for constant fields
 dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
 dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols  = constant_fields
 dotnet_naming_rule.constant_fields_should_be_pascal_case.style    = pascal_case_style
@@ -92,7 +94,7 @@ csharp_preferred_modifier_order = public,private,protected,internal,static,exter
 csharp_prefer_braces = true:silent
 csharp_style_deconstructed_variable_declaration = true:suggestion
 csharp_prefer_simple_default_expression = true:suggestion
-csharp_style_pattern_local_over_anonymous_function = true:suggestion
+csharp_style_prefer_local_over_anonymous_function = true:suggestion
 csharp_style_inlined_variable_declaration = true:suggestion
 ###############################
 # C# Formatting Rules         #
@@ -130,3 +132,29 @@ csharp_preserve_single_line_blocks = true
 [*.vb]
 # Modifier preferences
 visual_basic_preferred_modifier_order = Partial,Default,Private,Protected,Public,Friend,NotOverridable,Overridable,MustOverride,Overloads,Overrides,MustInherit,NotInheritable,Static,Shared,Shadows,ReadOnly,WriteOnly,Dim,Const,WithEvents,Widening,Narrowing,Custom,Async:suggestion
+# END COPY
+
+#################################
+# Open Rails Coding Conventions #
+#################################
+[*.cs]
+
+# .NET analyzers
+dotnet_style_require_accessibility_modifiers = omit_if_default:silent
+dotnet_naming_symbols.all_fields.applicable_kinds           = field
+dotnet_naming_symbols.all_fields.applicable_accessibilities = *
+dotnet_naming_rule.all_fields_should_be_pascal_case.symbols  = all_fields
+dotnet_naming_rule.all_fields_should_be_pascal_case.style    = pascal_case_style
+dotnet_naming_rule.all_fields_should_be_pascal_case.severity = warning
+
+# StyleCop analyzers
+dotnet_diagnostic.SA1101.severity = none # Readability: PrefixLocalCallsWithThis
+dotnet_diagnostic.SA1200.severity = none # Ordering: UsingDirectivesMustBePlacedCorrectly
+dotnet_diagnostic.SA1306.severity = none # Naming: FieldNamesMustBeginWithLowerCaseLetter
+dotnet_diagnostic.SA1400.severity = none # Maintainability: AccessModifierMustBeDeclared
+dotnet_diagnostic.SA1401.severity = none # Maintainability: FieldsMustBePrivate
+dotnet_diagnostic.SA1402.severity = none # Maintainability: FileMayOnlyContainASingleType
+dotnet_diagnostic.SA1600.severity = none # Documentation: ElementsMustBeDocumented
+dotnet_diagnostic.SA1602.severity = none # Documentation: EnumerationItemsMustBeDocumented
+dotnet_diagnostic.SA1633.severity = none # Documentation: FileMustHaveHeader
+dotnet_diagnostic.SA1649.severity = none # Documentation: FileNameMustMatchTypeName

Source/3rdPartyLibs/MonoGame/CppNet.dll

@@ -12,11 +12,6 @@
     <Copyright>Copyright © 2009 - 2022</Copyright>
     <PackageLicenseExpression>GPL-3.0-or-later</PackageLicenseExpression>
   </PropertyGroup>
-  <ItemGroup>
-    <Reference Include="MonoGame.Framework">
-      <HintPath>$(SolutionDir)\3rdPartyLibs\MonoGame\MonoGame.Framework.dll</HintPath>
-    </Reference>
-  </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\ORTS.Content\ORTS.Content.csproj" />
     <ProjectReference Include="..\Orts.Formats.Msts\Orts.Formats.Msts.csproj" />
@@ -27,8 +22,9 @@
     <ProjectReference Include="..\RunActivity\RunActivity.csproj" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.336902">
+    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.355802">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
+    <PackageReference Include="MonoGame.Framework.WindowsDX" Version="3.8.0.1641" />
   </ItemGroup>
 </Project>

Source/3rdPartyLibs/MonoGame/MonoGame.Framework.Content.Pipeline.dll

@@ -15,11 +15,6 @@
     <PackageLicenseExpression>GPL-3.0-or-later</PackageLicenseExpression>
     <DefineConstants>TRACE;WINDOWS;ACTIVITY_EDITOR</DefineConstants>
   </PropertyGroup>
-  <ItemGroup>
-    <Reference Include="MonoGame.Framework">
-      <HintPath>$(SolutionDir)\3rdPartyLibs\MonoGame\MonoGame.Framework.dll</HintPath>
-    </Reference>
-  </ItemGroup>
   <ItemGroup>
     <Compile Update="Wizard\ActivityDescr.cs">
       <SubType>UserControl</SubType>
@@ -87,8 +82,9 @@
     <ProjectReference Include="..\LibAE\LibAE.csproj" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.336902">
+    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.355802">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
+    <PackageReference Include="MonoGame.Framework.WindowsDX" Version="3.8.0.1641" />
   </ItemGroup>
 </Project>

Source/3rdPartyLibs/MonoGame/MonoGame.Framework.Content.Pipeline.xml

@@ -12,11 +12,6 @@
     <PackageLicenseExpression>GPL-3.0-or-later</PackageLicenseExpression>
     <DefineConstants>TRACE;WINDOWS;ACTIVITY_EDITOR;JSON_OR_XML</DefineConstants>
   </PropertyGroup>
-  <ItemGroup>
-    <Reference Include="MonoGame.Framework">
-      <HintPath>$(SolutionDir)\3rdPartyLibs\MonoGame\MonoGame.Framework.dll</HintPath>
-    </Reference>
-  </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Include="Icon\Start.ico" />
     <EmbeddedResource Include="Icon\Stop.ico" />
@@ -35,9 +30,10 @@
     <ProjectReference Include="..\..\..\ORTS.Settings\ORTS.Settings.csproj" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.336902">
+    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.355802">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
+    <PackageReference Include="MonoGame.Framework.WindowsDX" Version="3.8.0.1641" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.2" />
   </ItemGroup>
 </Project>

Source/3rdPartyLibs/MonoGame/MonoGame.Framework.dll

@@ -28,7 +28,7 @@
     <ProjectReference Include="..\..\ORTS.Settings\ORTS.Settings.csproj" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.336902">
+    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.355802">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
   </ItemGroup>

Source/3rdPartyLibs/MonoGame/MonoGame.Framework.xml

@@ -13,18 +13,14 @@
     <Copyright>Copyright © 2009 - 2022</Copyright>
     <PackageLicenseExpression>GPL-3.0-or-later</PackageLicenseExpression>
   </PropertyGroup>
-  <ItemGroup>
-    <Reference Include="MonoGame.Framework">
-      <HintPath>$(SolutionDir)\3rdPartyLibs\MonoGame\MonoGame.Framework.dll</HintPath>
-    </Reference>
-  </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\..\Orts.Formats.Msts\Orts.Formats.Msts.csproj" />
     <ProjectReference Include="..\..\ORTS.Common\ORTS.Common.csproj" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.336902">
+    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.355802">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
+    <PackageReference Include="MonoGame.Framework.WindowsDX" Version="3.8.0.1641" />
   </ItemGroup>
 </Project>

Source/3rdPartyLibs/MonoGame/SharpDX.D3DCompiler.dll

@@ -19,9 +19,9 @@
     <ProjectReference Include="..\..\Orts.Parsers.Msts\Orts.Parsers.Msts.csproj" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.336902">
+    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.355802">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.2" />
   </ItemGroup>
 </Project>

Source/3rdPartyLibs/MonoGame/SharpDX.DXGI.dll

@@ -18,7 +18,7 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
-    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.336902">
+    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.355802">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
   </ItemGroup>

Source/3rdPartyLibs/MonoGame/SharpDX.Direct3D11.dll

@@ -23,7 +23,7 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
-    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.336902">
+    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.355802">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
     <PackageReference Include="System.Data.DataSetExtensions" Version="4.5.0" />

Source/3rdPartyLibs/MonoGame/SharpDX.XAudio2.dll

@@ -25,9 +25,6 @@
       <SpecificVersion>False</SpecificVersion>
       <HintPath>..\..\3rdPartyLibs\GNU.Gettext.dll</HintPath>
     </Reference>
-    <Reference Include="MonoGame.Framework">
-      <HintPath>$(SolutionDir)\3rdPartyLibs\MonoGame\MonoGame.Framework.dll</HintPath>
-    </Reference>
   </ItemGroup>
   <ItemGroup>
     <Content Include="Content\activeBroken.png">
@@ -90,12 +87,13 @@
     <ProjectReference Include="..\..\RunActivity\RunActivity.csproj" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="System.ServiceModel.Duplex" Version="4.9.0" />
-    <PackageReference Include="System.ServiceModel.NetTcp" Version="4.9.0" />
-    <PackageReference Include="System.ServiceModel.Federation" Version="4.9.0" />
-    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.336902">
+    <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.355802">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
+    <PackageReference Include="MonoGame.Framework.WindowsDX" Version="3.8.0.1641" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.2" />
+    <PackageReference Include="System.ServiceModel.Duplex" Version="4.10.0" />
+    <PackageReference Include="System.ServiceModel.NetTcp" Version="4.10.0" />
+    <PackageReference Include="System.ServiceModel.Federation" Version="4.10.0" />
   </ItemGroup>
 </Project>

Source/3rdPartyLibs/MonoGame/SharpDX.dll

@@ -1217,6 +1217,22 @@ shape movement, however for greater accuracy the modeler can add specific values
 ``ORTSLengthAirHose``. In addition the length values suggested in the Derailment Coefficient should 
 also be added.
 
+Passenger doors
+===============
+
+.. index:: ORTSDoors
+
+Passenger doors are opened and closed (by default) using the ``<Q>`` and ``<Shift+Q>`` keys.
+It is possible to add opening and closing delays, which can be useful to delay the indication of
+"Doors closed" until all doors are fully closed.
+The delays can be added inserting the following block in the wagon section of any
+ENG or WAG file::
+
+  ORTSDoors (
+    ClosingDelay ( 5s )
+    OpeningDelay ( 1s )
+  )
+
 
 C# engine scripting
 ===================
@@ -1705,8 +1721,8 @@ interface), which can include a (touch screen) display and buttons.
 Being the display fields and icons and the buttons specific of every TCS, 
 a set of generic cabview controls are available, which can be customized 
 within the TCS script.
-More precisely 48 generic cabview controls, named from ORTS_TCS1 to ORTS_TCS48 
-are available. All 48 may be used as two state or multistate controls,  
+Generic cabview controls, named ORTS_TCS1, ORTS_TCS2, and so on
+are available. All of them may be used as two state or multistate controls,  
 like e.g.::
 
     MultiStateDisplay (
@@ -1750,7 +1766,7 @@ like e.g.::
    single: Style
    single: MouseControl
 
-Each one of the first 32 can be also used as Two-state commands/displays, like e.g.::
+They can be also used as Two-state commands/displays, like e.g.::
 
 		TwoState (
 			Type ( ORTS_TCS7 TWO_STATE )
@@ -1768,8 +1784,8 @@ The commands are received asynchronously by the script through this method:
     public override void HandleEvent(TCSEvent evt, string message)
 
 Where evt may be TCSEvent.GenericTCSButtonPressed or TCSEvent.GenericTCSButtonReleased 
-and message is a string ranging from "0" to "31", which correspond to controls from 
-ORTS_TCS1 to ORTS_TCS32.
+and message is a string representing the control number with zero-base indexing
+(e.g. "5" corresponds to ORTS_TCS6).
 The commands may only be triggered by the mouse, except the first two which may also be 
 triggered by key combinations ``Ctrl,`` (comma) and ``Ctrl.`` (period).
 Here's a code excerpt from the script which manages the commands:
@@ -1830,14 +1846,14 @@ To request a display of a cabview control, method:
 
     public Action<int, float> SetCabDisplayControl; 
 
-has to be used, where ``int`` is the index of the cab control (from 0 to 47 
-corresponding from ORTS_TCS1 to ORTS_TCS48), and ``float`` is the value to be 
+has to be used, where ``int`` is the index of the cab control (starting from 0
+which corresponds to ORTS_TCS1), and ``float`` is the value to be 
 used to select among frames.
 
 When the player moves the mouse over the cabview controls linked to commands, 
 the name of such control shortly appears on the display, like e.g. "speedometer", 
 as a reminder to the player. 
-In case of these generic commands, strings from "ORTS_TCS1" to "ORTS_TCS32" would 
+In case of these generic commands, strings like "ORTS_TCS1" or "ORTS_TCS32" would 
 appear, which aren't mnemonic at all. Therefore following method is available:
 
 .. code-block:: csharp

Source/ContentChecker/ContentChecker.csproj

@@ -2159,6 +2159,10 @@ as the compressor and main air reservoir, and some of the diesel effects (as it
 Some of the cab monitoring gauges provide visibility of what is happening on the powered car. To do this OR searches for 
 the "closest" powered car near the Control car and uses its information.
 
+If the Control Car is "linked" with a geared power car then it will be necessary for the control car to have a gear box 
+controller. To get OR to set it up, it will be necessary for the ``GearBoxControllerNumberofGears ( x )``, where x = number 
+of gears in the associated power car, to be added to the engine section of the ENG file.
+
 
 Multiple Units of Locomotives in Same Consist
 =============================================
@@ -4313,12 +4317,16 @@ In real life, the battery switch may not
 close instantly, so you can add a delay with the optional parameter
 ``ORTSBattery( Delay ( ) )`` (by default in seconds).
 
+It is possible for the battery switch to be switched on at the start of the simulation.
+To activate this behaviour, you can add the optional parameter ``ORTSBattery( DefaultOn ( 1 ) )``
+
 Example::
 
     Engine (
       ORTSBattery (
         Mode ( PushButtons )
         Delay ( 2s )
+        DefaultOn ( 1 )
       )
     )
 

Source/Contrib/ActivityEditor/ActivityEditor/ActivityEditor.csproj

@@ -124,6 +124,10 @@ A number of web-pages are included in the Open Rails installation as examples of
 what can be done with the APIs.
 
 Some of these sample pages repeat data from the in-game panels to provide a more convenient display.
+The sample pages can be found in the ``Content\Web`` subfolder of the OR
+program folder and the web server defaults to ``Content\Web\index.html``.
+
+If you choose to develop your own pages, please consider sharing them with the Open Rails community.
 
 - The HUD web page repeats the F5 overlay.
 
@@ -135,15 +139,13 @@ Some of these sample pages repeat data from the in-game panels to provide a more
 
 .. image:: images/web-page-both.png
 
-- The time page shows the simulation time as a digital clock and links to 3 versions of an analogue clock.
+- The Time page shows the simulation time as a digital clock and links to 3 versions of an analogue clock.
 
 .. image:: images/web-page-clock.png
 
+- The Map page shows the position and direction of the train in the real world on the OpenRailwayMap https://www.openrailwaymap.org. Different OpenRailwayMap layers are available. Usability depends on the route, position of the train is not always 100% correct.
 
-The sample pages can be found in the ``Content\Web`` subfolder of the OR
-program folder and the web server defaults to ``Content\Web\index.html``.
-
-If you choose to develop your own pages, please consider sharing them with the Open Rails community.
+.. image:: images/web-page-map.png
 
 .. _web-server-api:
 
@@ -186,6 +188,11 @@ Note: To avoid overloading the simulator, please keep API calls to once or twice
      - | ``/API/TIME``
      - | Retrieves just the simulation time in seconds since midnight.
      - | ``Orts.Viewer3D.WebServices .WebServer.ORTSApiController .ApiTime``
+   * - | GET
+     - | ``/API/MAP``
+     - | Retrieves the postion and direction of the train.
+       | Next to various Open Rails route data.
+     - | ``Orts.Viewer3D.WebServices .WebServer.ORTSApiController .ApiMap``
    * - | GET
      - | ``/API/CABCONTROLS``
      - | Retrieves an array of the cab controls for the player localhost