Merge branch 'master' into feature/one-true-wind

Author: twpol

.github/release.yml

@@ -0,0 +1,22 @@
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+    authors:
+      - appveyor
+      - dependabot
+      - github-actions
+  categories:
+    - title: New Features
+      labels:
+        - enhancement
+    - title: Documentation and Localization
+      labels:
+        - documentation
+        - locales
+    - title: Bug Fixes
+      labels:
+        - bug
+    - title: Other Changes
+      labels:
+        - "*"

.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/Policies.md

@@ -0,0 +1,41 @@
+# Project Policies
+
+This document records the policies currently in place under which the Project Team operates.
+
+## License
+
+The [GNU Public License](http://www.gnu.org/licenses/licenses.html) allows a user to use Open Rails in any way, except that you may not distribute software containing part of Open Rails without respecting the license terms. 
+
+## Liability
+
+Open Rails is intended for entertainment purposes only and, to avoid liability, is not suitable for professional applications.
+
+## Code Submissions
+
+[Code contributions](https://github.com/openrails/openrails/blob/master/Docs/Contributing.md) to our repository must be in Microsoft's C# language. An authorised developer may not change content in the official version of Open Rails without approval from another authorised developer.
+
+## Content Compatibility
+
+Open Rails will continue to maintain compatibility with content from previous official versions of Open Rails.
+
+## File Formats
+
+New types of content will use the JavaScript Object Notation (JSON).
+Existing types of content from previous official versions of Open Rails will continue to be loaded without change. 
+
+## Keyboard Assignments
+
+New key assignments should obey the following rules where that is possible.
+
+* Reserve digit keys for camera operations.
+* Reserve Fn keys for pop-up windows.
+* Reserve the Alt modifier for debug operations.
+* Reserve modifier+space (e.g. Ctrl+space) for future expansion using sequences of keys.
+
+Existing key assignments may not be changed without community discussion and approval of the Open Rails Management Team.
+
+## Crashes and Derailments
+
+Open Rails simulates emergency events which bring a train to a standstill, such as a derailment, and provides both a visual indication and a notification of the problem.
+
+Open Rails does not show rolling stock leaving the track due to crashes or derailments. We have many members from the rail industry who have spent their working lives preventing incidents that cause injuries and loss of life and we respect that point of view. 

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)
 
@@ -19,9 +19,10 @@ Open Rails is a free train simulator supporting the world's largest range of dig
 * [Join the community](http://www.openrails.org/share/community/?utm_campaign=documentation&utm_source=readme&utm_medium=referral)
 * [Report bugs or offer suggestions](http://www.openrails.org/contribute/reporting-bugs/?utm_campaign=documentation&utm_source=readme&utm_medium=referral)
 * [Create content](http://www.openrails.org/contribute/building-models/?utm_campaign=documentation&utm_source=readme&utm_medium=referral)
+* [How to propose and submit work](Contributing.md)
 * [Write code](http://www.openrails.org/contribute/developing-code/?utm_campaign=documentation&utm_source=readme&utm_medium=referral)
 * [Join the team](http://www.openrails.org/contribute/joining-the-team/?utm_campaign=documentation&utm_source=readme&utm_medium=referral)
-* [More details](Contributing.md)
+
 
 ## Build status
 

Source/Contrib/TrackViewer/Drawing/DrawColors.cs

@@ -46,6 +46,7 @@ static class DrawColors
         public static ColorScheme colorsRoadsHotlight = new ColorScheme(HighlightType.Hotlight);
         public static ColorScheme colorsPathMain = new ColorScheme();
         public static ColorScheme colorsPathSiding = new ColorScheme();
+        public static ColorScheme colorsEvent = new ColorScheme();
 
         static ColorsGroupTrack trackGroupFlat = new ColorsGroupTrack();
         static ColorsGroupTrack roadTrackGroupFlat = new ColorsGroupTrack();
@@ -212,6 +213,11 @@ private static void SetItemColors(IPreferenceChanger preferenceChanger)
                 TrackViewer.catalog.GetString("Select speedpost color"));
             itemColors.Speedpost = itemColor;
 
+            itemColor = new ColorWithHighlights(Color.DarkGray, 40);
+            itemColor.MakeIntoUserPreference(preferenceChanger, "event",
+                TrackViewer.catalog.GetString("Select event color"));
+            itemColors.Event = itemColor;
+
             itemColor = new ColorWithHighlights(Color.Blue, 40);
             itemColors.CandidateNode = itemColor;
 
@@ -321,6 +327,7 @@ class ColorsGroupBasic {
         public ColorWithHighlights RoadCrossing { get; set; }
         public ColorWithHighlights Speedpost { get; set; }
         public ColorWithHighlights Siding { get; set; }
+        public ColorWithHighlights Event { get; set; }
 
         public ColorWithHighlights Text { get; set; }
         public ColorWithHighlights ClearWindowInset { get; set; }
@@ -362,6 +369,7 @@ class ColorScheme
         public Color RoadCrossing { get { return TrackItemColors.RoadCrossing.Colors[highlightType]; } }
         public Color Speedpost { get { return TrackItemColors.Speedpost.Colors[highlightType]; } }
         public Color Siding { get { return TrackItemColors.Siding.Colors[highlightType]; } }
+        public Color Event { get { return TrackItemColors.Event.Colors[highlightType]; } }
 
         public Color ActiveNode { get { return TrackItemColors.ActiveNode.Colors[highlightType]; } }
         public Color CandidateNode { get { return TrackItemColors.CandidateNode.Colors[highlightType]; } }

Source/Contrib/TrackViewer/Drawing/DrawTrackDB.cs

@@ -45,6 +45,10 @@ public class RouteData
         public RoadTrackDB RoadTrackDB { get; set; }
         /// <summary>The signal config file containing, for instance, the information to distinguish normal and non-normal signals</summary>
         public SignalConfigurationFile SigcfgFile { get; set; }
+        /// <summary>
+        /// <summary>Activity names</summary>
+        /// </summary>
+        public List<string> ActivityNames = new List<string> { };
 
         private string storedRoutePath;
         private Dictionary<uint, string> signalFileNames;
@@ -87,7 +91,7 @@ public RouteData(string routePath, MessageDelegate messageDelegate)
             }
             catch
             {
-            } 
+            }
 
             string ORfilepath = System.IO.Path.Combine(routePath, "OpenRails");
             if (File.Exists(ORfilepath + @"\sigcfg.dat"))
@@ -102,6 +106,72 @@ public RouteData(string routePath, MessageDelegate messageDelegate)
             {
                 //sigcfgFile = null; // default initialization
             }
+
+            // read the activity location events and store them in the TrackDB.TrItemTable
+
+            ActivityNames.Clear();
+            var directory = System.IO.Path.Combine(routePath, "ACTIVITIES");
+            if (System.IO.Directory.Exists(directory))
+            {
+                // counting
+                int cnt = 0;
+
+                foreach (var file in Directory.GetFiles(directory, "*.act"))
+                {
+                    try
+                    {
+                        var activityFile = new ActivityFile(file);
+                        Events events = activityFile.Tr_Activity.Tr_Activity_File.Events;
+                        if (events != null)
+                        {
+                            for (int i = 0; i < events.EventList.Count; i++)
+                            {
+                                if (events.EventList[i].GetType() == typeof(EventCategoryLocation))
+                                {
+                                    cnt++;
+                                }
+                            }
+                        }
+                    }
+                    catch { }
+                }
+
+                // adding
+                uint index = 0;
+                foreach (var file in Directory.GetFiles(directory, "*.act"))
+                {
+                    try
+                    {
+                        var activityFile = new ActivityFile(file);
+                        Events events = activityFile.Tr_Activity.Tr_Activity_File.Events;
+                        bool found = false;
+                        if (events != null)
+                        {
+                            for (int i = 0; i < events.EventList.Count; i++)
+                            {
+                                if (events.EventList[i].GetType() == typeof(EventCategoryLocation))
+                                {
+                                    EventCategoryLocation eventCategoryLocation = (EventCategoryLocation)events.EventList[i];
+                                    EventItem eventItem = new EventItem(
+                                        activityFile.Tr_Activity.Tr_Activity_Header.Name + ":" + eventCategoryLocation.Name,
+                                        eventCategoryLocation.Outcomes.DisplayMessage,
+                                        eventCategoryLocation.TileX, eventCategoryLocation.TileZ,
+                                        eventCategoryLocation.X, 0, eventCategoryLocation.Z,
+                                        index);
+                                    TrackDB.TrItemTable[index] = eventItem;
+                                    index++;
+                                    found = true;
+                                }
+                            }
+                        }
+                        if (found) {
+                            ActivityNames.Add(activityFile.Tr_Activity.Tr_Activity_Header.Name);
+                        }
+                    }
+                    catch { }
+                }
+
+            }
         }
 
         /// <summary>
@@ -176,6 +246,32 @@ public string GetSignalFilename(uint signalIndex)
         }
     }
 
+    /// <summary>
+    /// represents an Activity Location EventItem
+    /// </summary>
+    /// defined in this trackviewer file because I want to keep changes localized to the TrackViewer
+    
+    public class EventItem : TrItem
+    {
+        /// <summary>
+        /// Default constructor, no file parsing used
+        /// </summary>
+        public EventItem(string itemName, string briefing, int tileX, int tileZ, float x, float y, float z, uint trItemId)
+        {
+            // ItemType is trEMPTY on purpose
+            // so that Orts.Formats.Msts.TrItem.trItemType does not need a change
+            ItemType = trItemType.trEMPTY;
+            ItemName = itemName;
+            TileX = tileX;
+            TileZ = tileZ;
+            X = x;
+            Y = y;
+            Z = z;
+            TrItemId = trItemId;
+            SData2 = briefing;
+        }
+    }
+
     /// <summary>
     /// This is a big class where the drawing of everything in the track data base is done. 
     /// This means tracks themselves (meaning so-called vector nodes that contain a number of sections,