Merged "master" into working branch

Author: Chris Jakeman

.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

Build.cmd

@@ -163,7 +163,7 @@ IF "%Mode%" == "Stable" (
 REM Create binary and source zips.
 CALL :delete "OpenRails-%Mode%*.zip" || GOTO :error
 PUSHD "Program" && 7za.exe a -r -tzip -x^^!*.xml "..\OpenRails-%Mode%.zip" . && POPD || GOTO :error
-7za.exe a -r -tzip -x^^!.* -x^^!obj -x^^!lib -x^^!_build -x^^!*.bak -x^^!Website "OpenRails-%Mode%-Source.zip" "Source" || GOTO :error
+7za.exe a -r -tzip -x^^!.* -x^^!obj -x^^!lib -x^^!_build -x^^!*.bak "OpenRails-%Mode%-Source.zip" "Source" || GOTO :error
 
 ENDLOCAL
 GOTO :EOF

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
 
@@ -29,6 +52,22 @@ The threading in Open Rails has two key threads working together (Render and Upd
 - Web Server process
   - Handle all web and API requests
 
+## Projects, assemblies, namespaces
+
+Open Rails is made up of several component projects which are organised into subdirectories with the following naming pattern:
+
+- `Orts.Component\Orts.Component.csproj` (project file)
+- `Orts.Component.dll` (assembly name)
+- `Orts.Component` (default namespace)
+
+The namespaces used within code files should match the directory structure like this:
+
+| *Filename* | *Namespace*
+|---|---|
+| `Orts.Component\File.cs` | `Orts.Component` |
+| `Orts.Component\Section\File.cs` | `Orts.Component.Section` |
+| `Orts.Component\Section\Subsection\File.cs` | `Orts.Component.Section.Subsection` |
+
 ## Simulator object relationships
 
 This tree is a summary of the important object relationships (aggregation) inside the simulation. Each entry is a class whose instances can be accessed from the parent item.

Docs/Contributing.md

@@ -18,21 +18,35 @@ 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 start your work from the "master" branch and merged pull requests back into the "master" branch, unless we direct you otherwise.
+**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.
+
+**Note:** You should do your work on separate branches; they must be created from the "master" branch and pull requests must merge back into the "master" branch, unless we direct you otherwise.
 
 ### Documentation and translations
 
 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 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:
 
@@ -154,7 +168,7 @@ When we start preparing for a new Stable Version, all code in the Testing Versio
 
 ### Submitting your code
 
-When you're done writing code, you should make a pull request on GitHub. The title and description of the requests should concisely indicate what bug or feature you've implemented and you will need to include links to whichever of the following are appropriate:
+When you're done writing code, you should make a pull request on GitHub from your fork's branch back to the official repository's "master" branch. The title and description of the requests should concisely indicate what bug or feature you've implemented and you will need to include links to whichever of the following are appropriate:
 
 * Bug report
 * Road-map card

Docs/Readme.md

@@ -10,7 +10,7 @@ Open Rails is a free train simulator supporting the world's largest range of dig
 ## Documentation
 
 * [Read the FAQ](http://www.openrails.org/learn/faq/?utm_campaign=documentation&utm_source=readme&utm_medium=referral)
-* [Read the manual online](https://open-rails.readthedocs.io/en/1.3.1/) or the PDF included with the program, found in the main menu under "Documents"
+* [Read the manual online](https://open-rails.readthedocs.io/en/latest/) or the PDF included with the program, found in the main menu under "Documents"
 * [Get additional materials, including tutorials, from our website](http://www.openrails.org/learn/manual-and-tutorials/?utm_campaign=documentation&utm_source=readme&utm_medium=referral)
 * [Read more about the project on our website](http://www.openrails.org/discover/open-rails/?utm_campaign=documentation&utm_source=readme&utm_medium=referral)
 

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>

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>