Merge branch 'openrails:master' into Orge

Author: wjcurrey

.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
 
@@ -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,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/Documentation/Manual/cabs.rst

@@ -684,14 +684,16 @@ Air Flow Meter
 
 .. index::
    single:  ORTS_AIR_FLOW_METER
+   single:  ORTS_TRAIN_AIR_FLOW_METER
 
 This cabview control is used on some locomotives, particularly in North America, to show the
 volumetric flow rate of air moving from the main res to the brake pipe during release/recharge.
 Such an indication can be used to determine when brake pipe charging is complete,
 measure the amount of brake pipe leakage, and so on.
 The control will only function on locomotives with air brakes.
 
-Here is an example implementation of ORTS_AIR_FLOW_METER as an analog dial::
+Here is an example implementation of ORTS_AIR_FLOW_METER as an analog dial (display types other
+than analog dials can be used)::
 
 
 		Dial (
@@ -706,8 +708,10 @@ Here is an example implementation of ORTS_AIR_FLOW_METER as an analog dial::
 			DirIncrease ( 0 )
 		)
 
-Applicable user-defined units are CUBIC_FT_MIN, LITERS_S, LITERS_MIN, and CUBIC_M_S. Cubic meters per
-second will be used if no units are specified.
+Alternately, a control type of ORTS_TRAIN_AIR_FLOW_METER can be used to display the total
+air flow rate of all locomotives, useful for distributed power where multiple locomotives can
+charge the brake pipe simultaneously. Applicable user-defined units are CUBIC_FT_MIN, LITERS_S,
+LITERS_MIN, and CUBIC_M_S. Cubic meters per second will be used if no units are specified.
 
 
 Animated 2D Wipers