Merge branch 'master' into gltf2

Author: pzgulyas

.gitignore

@@ -365,4 +365,5 @@ ASALocalRun/
 healthchecksdb
 
 # Backup folder for Package Reference Convert tool in Visual Studio 2017
-MigrationBackup/
+MigrationBackup/
+/Source/RunActivity/Properties/launchSettings.json

.readthedocs.yaml

@@ -0,0 +1,21 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+python:
+  install:
+    - requirements: Source/Documentation/Manual/requirements.txt
+
+sphinx:
+  configuration: Source/Documentation/Manual/conf.py
+
+formats:
+  - htmlzip
+  - pdf
+  - epub

Docs/Architecture.md

@@ -1,6 +1,29 @@
 # Open Rails Architecture
 
-This document will describe the overall structure of Open Rails and how we expect different areas of the program to work together.
+This document describes the overall structure of Open Rails and how we expect different areas of the program to work together.
+
+## Player application model
+
+The player application model describes the desired components and their relationships which make up Open Rails. Each of these will be formed from one or more libraries, as needed, and each library may contain distinct but critically linked subfunctions.
+
+```mermaid
+flowchart TB
+  Formats["Orts.Formats"]
+  Game["Orts.Game"]
+  Input["Orts.Input"]
+  Multiplayer["Orts.Multiplayer"]
+  Parsers["Orts.Parsers"]
+  Player["Player"]
+  Simulation["Orts.Simulation"]
+  Sound["Orts.Sound"]
+  UI["Orts.UI"]
+  Viewer["Orts.Viewer"]
+  Web["Orts.Web"]
+  Player --- Game --- UI --- Viewer --- Simulation & Formats
+  Player --- Input --- UI & Simulation
+  Sound --- Simulation --- Formats & Multiplayer & Web
+  Formats --- Parsers
+```
 
 ## Threading model
 

Docs/Contributing.md

@@ -18,7 +18,7 @@ If you've got a feature suggestion for Open Rails, please report it in [our road
 
 You are free to make any modifications to the Open Rails code that you like; that's how open source works. However, if you'd like your feature to be included in the official version, there is a process to ensure that the community agrees and to review the code for potential issues prior to inclusion.
 
-In most cases, you can get started immediately with making the changes and creating a pull request. We do ask for some additional steps to be taken for some bugs and all new features, but they can come before or after the pull request. Please feel free to share ideas and proposals as pull requests!
+In most cases, you can get started immediately with making the changes and creating a pull request. We have _additional requirements_ for some bugs and all new features, but they can come before or after the pull request is created. Please feel free to share ideas and proposals as pull requests!
 
 **Note:** You must fork the Open Rails repository before you start working on it. We do not allow you to push branches to the official repository.
 
@@ -28,19 +28,25 @@ In most cases, you can get started immediately with making the changes and creat
 
 If you'd like to improve the [documentation](./), [manual](../Source/Documentation/Manual), or [translations](../Source/Locales) you can get started immediately.
 
-There are no requirements for the pull request.
+There are no additional requirements for the pull request.
 
 ### Contributed projects
 
 If you'd like to improve the [contributed projects](../Source/Contrib) you can get started immediately.
 
-There are no requirements for the pull request.
+There are no additional requirements for the pull request.
+
+### Refactoring process
+
+If you'd like to refactor the existing code you can get started immediately, but please have a look at our [architecture requirements](#architecture-requirements). We welcome architectural discussions on our [forum](http://www.elvastower.com/forums/index.php?/forum/256-developing-features/).
+
+There are no additional requirements for the pull request.
 
 ### Bug process
 
 If you'd like to fix a bug, you can get started immediately. If the fix turns out to be very small, you do not even need a bug report. Otherwise, you will need to make sure it has been reported on [our bug tracker on Launchpad](https://bugs.launchpad.net/or). If it has not, you can report the bug *and* fix it!
 
-There are no requirements for creating the pull request.
+There are no additional requirements for _creating_ the pull request.
 
 These things must be done in the required order:
 

Source/ContentChecker/ContentChecker.csproj

@@ -1,9 +1,8 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFramework>net472</TargetFramework>
+    <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>
@@ -13,7 +12,7 @@
     <PackageLicenseExpression>GPL-3.0-or-later</PackageLicenseExpression>
   </PropertyGroup>
   <ItemGroup>
-    <ProjectReference Include="..\ORTS.Content\ORTS.Content.csproj" />
+    <ProjectReference Include="..\Orts.Content\Orts.Content.csproj" />
     <ProjectReference Include="..\Orts.Formats.Msts\Orts.Formats.Msts.csproj" />
     <ProjectReference Include="..\Orts.Formats.OR\Orts.Formats.OR.csproj" />
     <ProjectReference Include="..\Orts.Parsers.Msts\Orts.Parsers.Msts.csproj" />

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/ActivityEditor/ActivityEditor/ActivityEditor.csproj

@@ -1,6 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFramework>net472</TargetFramework>
+    <TargetFramework Condition="'$(BuildDotNet)' == 'true'">net6-windows</TargetFramework>
+    <TargetFramework Condition="'$(TargetFramework)' == ''">net472</TargetFramework>
     <OutputType>WinExe</OutputType>
     <AssemblyName>Contrib.ActivityEditor</AssemblyName>
     <ApplicationIcon>..\..\..\ORTS.ico</ApplicationIcon>
@@ -77,8 +78,8 @@
     <ProjectReference Include="..\..\..\Orts.Formats.Msts\Orts.Formats.Msts.csproj" />
     <ProjectReference Include="..\..\..\Orts.Formats.OR\Orts.Formats.OR.csproj" />
     <ProjectReference Include="..\..\..\Orts.Parsers.Msts\Orts.Parsers.Msts.csproj" />
-    <ProjectReference Include="..\..\..\ORTS.Common\ORTS.Common.csproj" />
-    <ProjectReference Include="..\..\..\ORTS.Settings\ORTS.Settings.csproj" />
+    <ProjectReference Include="..\..\..\Orts.Common\Orts.Common.csproj" />
+    <ProjectReference Include="..\..\..\Orts.Settings\Orts.Settings.csproj" />
     <ProjectReference Include="..\LibAE\LibAE.csproj" />
   </ItemGroup>
   <ItemGroup>

Source/Contrib/ActivityEditor/LibAE/LibAE.csproj

@@ -1,6 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFramework>net472</TargetFramework>
+    <TargetFramework Condition="'$(BuildDotNet)' == 'true'">net6-windows</TargetFramework>
+    <TargetFramework Condition="'$(TargetFramework)' == ''">net472</TargetFramework>
     <OutputType>Library</OutputType>
     <AssemblyName>Contrib.LibAE</AssemblyName>
     <IsPublishable>False</IsPublishable>
@@ -25,9 +26,9 @@
     <ProjectReference Include="..\..\..\Orts.Formats.Msts\Orts.Formats.Msts.csproj" />
     <ProjectReference Include="..\..\..\Orts.Formats.OR\Orts.Formats.OR.csproj" />
     <ProjectReference Include="..\..\..\Orts.Parsers.Msts\Orts.Parsers.Msts.csproj" />
-    <ProjectReference Include="..\..\..\ORTS.Common\ORTS.Common.csproj" />
-    <ProjectReference Include="..\..\..\ORTS.Content\ORTS.Content.csproj" />
-    <ProjectReference Include="..\..\..\ORTS.Settings\ORTS.Settings.csproj" />
+    <ProjectReference Include="..\..\..\Orts.Common\Orts.Common.csproj" />
+    <ProjectReference Include="..\..\..\Orts.Content\Orts.Content.csproj" />
+    <ProjectReference Include="..\..\..\Orts.Settings\Orts.Settings.csproj" />
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.355802">

Source/Contrib/ContentManager/ContentInfo.cs

@@ -27,11 +27,18 @@
 using System.Runtime.Serialization.Formatters.Binary;
 using System.Text;
 using Path = ORTS.ContentManager.Models.Path;
+using ORTS.Common;
 
 namespace ORTS.ContentManager
 {
     public static class ContentInfo
     {
+        // will be set from ConntentManagerGUI constructor
+        public static bool IsMetric = false;
+        public static bool IsUK = false;
+        public static bool IsImperialBHP = false; // using default; seems only used for steam locos
+        public static bool IsImperialBTUpS = false;  // using default; seems only be used for steam locos
+
         public static string GetText(Content content)
         {
             var details = new StringBuilder();
@@ -179,16 +186,39 @@ public static string GetText(Content content)
                 {
                     var data = new Consist(content);
                     details.AppendFormat("Name:\t{1}{0}", Environment.NewLine, data.Name);
-                    details.AppendFormat("Car ID:\tDirection:\tName:\t{0}", Environment.NewLine);
+                    details.AppendFormat("NumEngines:\t{1}{0}", Environment.NewLine, data.NumEngines);
+                    details.AppendFormat("NumCars:\t{1}{0}", Environment.NewLine, data.NumCars);
+                    details.AppendFormat("MaxSpeed:\t{1}{0}", Environment.NewLine, FormatStrings.FormatSpeedLimit(data.MaxSpeedMps, IsMetric));
+                    details.AppendFormat("Weight:\t{1}{0}", Environment.NewLine, FormatStrings.FormatLargeMass(data.MassKG, IsMetric, IsUK));
+                    details.AppendFormat("Length:\t{1}{0}", Environment.NewLine, FormatStrings.FormatShortDistanceDisplay(data.LengthM, IsMetric));
+                    details.AppendFormat("Power:\t{1}{0}", Environment.NewLine, FormatStrings.FormatPower(data.MaxPowerW, IsMetric, IsImperialBHP, IsImperialBTUpS));
+                    details.AppendFormat("MaxTE:\t{1}{0}", Environment.NewLine, FormatStrings.FormatForce(data.MaxTractiveForceN, IsMetric));
+                    details.AppendFormat("MinCouplerStrength:\t{1}{0}", Environment.NewLine, FormatStrings.FormatForce(data.MinCouplerStrengthN, IsMetric));
+                    if (!IsMetric && !IsUK) { details.AppendFormat("HPT:\t{1}{0}", Environment.NewLine, FormatHPT(data.MaxPowerW, data.MassKG)); }
+                    if (!IsMetric && !IsUK) { details.AppendFormat("TPOB:\t{1}{0}", Environment.NewLine, FormatTPOB(data.MassKG, data.NumOperativeBrakes)); }
+                    details.AppendLine();
+                    details.AppendFormat("Car ID:\tDirection:\tWeight:\tName:\t{0}", Environment.NewLine);
                     foreach (var car in data.Cars)
-                        details.AppendFormat("{1}\t{2}\t\u0001{3}\u0002Car\u0001{0}", Environment.NewLine, car.ID, car.Direction, car.Name);
+                        details.AppendFormat("{1}\t{2}\t{3}\t\u0001{4}\u0002Car\u0001{0}", Environment.NewLine, car.ID, car.Direction, car.IsEngine ? "Engine" : FormatMassBar(car.MassKG), car.Name);
                     details.AppendFormat("{0}", Environment.NewLine);
                 }
                 else if (content.Type == ContentType.Car)
                 {
                     var data = new Car(content);
                     details.AppendFormat("Type:\t{1}{0}", Environment.NewLine, data.Type);
+                    details.AppendFormat("SubType:\t{1}{0}", Environment.NewLine, data.SubType);
                     details.AppendFormat("Name:\t{1}{0}", Environment.NewLine, data.Name);
+                    details.AppendFormat("Weight:\t{1} ({2}){0}", Environment.NewLine, FormatStrings.FormatMass(data.MassKG, IsMetric), FormatStrings.FormatLargeMass(data.MassKG, IsMetric, IsUK));
+                    details.AppendFormat("Length:\t{1}{0}", Environment.NewLine, FormatStrings.FormatShortDistanceDisplay(data.LengthM, IsMetric));
+                    if (data.Type == CarType.Engine)
+                    {
+                        details.AppendFormat("MaxPowerW:\t{1}{0}", Environment.NewLine, FormatStrings.FormatPower(data.MaxPowerW, IsMetric, IsImperialBHP, IsImperialBTUpS));
+                        details.AppendFormat("MaxForce:\t{1}{0}", Environment.NewLine, FormatStrings.FormatForce(data.MaxForceN, IsMetric));
+                        details.AppendFormat("MaxSpeed:\t{1}{0}", Environment.NewLine, FormatStrings.FormatSpeedLimit(data.MaxSpeedMps, IsMetric));
+                    }
+                    details.AppendFormat("MaxBrakeF:\t{1}{0}", Environment.NewLine, FormatStrings.FormatForce(data.MaxBarkeForceN, IsMetric));
+                    details.AppendFormat("MinCouplerStrength:\t{1}{0}", Environment.NewLine, FormatStrings.FormatForce(data.MinCouplerStrengthN, IsMetric));
+                    details.AppendLine();
                     details.AppendFormat("Description:\t{0}{0}{1}{0}{0}", Environment.NewLine, data.Description);
                 }
                 else if (content is ContentMSTSCab)
@@ -215,5 +245,46 @@ static string FormatDateTime(DateTime dateTime)
         {
             return String.Format("{0} {1}", dateTime.Day - 1, dateTime.ToLongTimeString());
         }
+
+        /// <summary>
+        /// Create a simple bar graph (string of asterisk) for the car mass.
+        /// </summary>
+        /// <param name="massKg"></param>
+        /// <returns>String of asterisk representing the mass.</returns>
+        static string FormatMassBar(float massKg)
+        {
+            string massBar;
+            var range = (int)Math.Ceiling(massKg / 20000);
+            if (massKg < 1.0) { massBar = "?";  }
+            else if (range > 8) { massBar = new string('*', 8) + '>'; }
+            else { massBar = new string('*', range); }
+            return massBar;
+        }
+
+        /// <summary>
+        /// Calculate and format horsepower per ton for consist, rounded to one decimal.
+        /// </summary>
+        /// <param name="consistPowerW"></param>
+        /// <param name="consistMassKG"></param>
+        /// <returns>horsepower-per-ton formated to one decimal.</returns>
+        //TODO: implement UK and metric version
+        static string FormatHPT(float consistPowerW, float consistMassKG)
+        {
+            var hpt = consistMassKG > 0 ? W.ToHp(consistPowerW) / Kg.ToTUS(consistMassKG) : 0;
+            return string.Format("{0:0.0}", hpt);
+        }
+
+        /// <summary>
+        /// Calculate and format tons per operative brake for consist, rounded to an integer.
+        /// </summary>
+        /// <param name="consistMassKG"></param>
+        /// <param name="consistNumOpBrakes"></param>
+        /// <returns>tons-per-operative-brake formated to an integer.</returns>
+        //TODO: implement UK and metric version
+        static string FormatTPOB(float consistMassKG, float consistNumOpBrakes)
+        {
+            var tpob = consistNumOpBrakes > 0 ? Kg.ToTUS(consistMassKG) / consistNumOpBrakes : 0;
+            return string.Format("{0:0}", tpob);
+        }
     }
 }