Skip to content

Commit 0f4342d

Browse files
mbm-ORmbm-OR
committed
Merge branch 'master' into bugfix/Fix-F9-CarId-bug
2 parents 4a0a657 + 8fb3285 commit 0f4342d

File tree

26 files changed

+1087
-611
lines changed

26 files changed

+1087
-611
lines changed

‎Source/Contrib/SettingsExporter/Program.cs‎

Lines changed: 256 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,256 @@
1+
// COPYRIGHT 2025 by the Open Rails project.
2+
//
3+
// This file is part of Open Rails.
4+
//
5+
// Open Rails is free software: you can redistribute it and/or modify
6+
// it under the terms of the GNU General Public License as published by
7+
// the Free Software Foundation, either version 3 of the License, or
8+
// (at your option) any later version.
9+
//
10+
// Open Rails is distributed in the hope that it will be useful,
11+
// but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
// GNU General Public License for more details.
14+
//
15+
// You should have received a copy of the GNU General Public License
16+
// along with Open Rails. If not, see <http://www.gnu.org/licenses/>.
17+
18+
// Export the Settings in the Registry into an INI file, or vice versa.
19+
// In order to support multiple installations with different settings,
20+
// OpenRails supports using an INI file for the settings (instead of
21+
// the registry entries that are shared by all installations).
22+
// OpenRails creates a default INI file when the file exists, but has no
23+
// settings. This tool exports the current settings from the registry to
24+
// the INI file. It also allows the reverse.
25+
26+
// Important: UpdateSettings, part of UpdateManager has its own file,
27+
// Updater.ini.
28+
//
29+
// FUTURE: New settings classes that are not part of UserSettings need to
30+
// be added to the exporter. See FUTURE tag below.
31+
32+
using System;
33+
using System.Collections.Generic;
34+
using System.IO;
35+
using System.Linq;
36+
using Microsoft.Win32;
37+
using ORTS.Common;
38+
using ORTS.Settings;
39+
40+
namespace ORTS.SettingsExporter
41+
{
42+
class Program
43+
{
44+
static int Main(string[] args)
45+
{
46+
string fromArg = null; string toArg = null;
47+
48+
#region Parse Args
49+
// parse arguments
50+
foreach (string arg in args)
51+
{
52+
if (arg.Equals("/h") || arg.Equals("/help")) { ShowHelp(); Environment.Exit(1); }
53+
else if (arg.StartsWith("/")) { Console.WriteLine("ERROR: Invalid option {0}.", arg); ShowHelp(); Environment.Exit(1); }
54+
else if (fromArg == null) { fromArg = arg; }
55+
else if (toArg == null) { toArg = arg; }
56+
else { Console.WriteLine("ERROR: extraneous argument {0}.", arg); ShowHelp(); Environment.Exit(1); }
57+
}
58+
if (String.IsNullOrEmpty(fromArg) || String.IsNullOrEmpty(toArg))
59+
{ Console.WriteLine("ERROR: Missing from or to argument."); ShowHelp(); Environment.Exit(1); }
60+
else if (fromArg.Equals(toArg))
61+
{ Console.WriteLine("ERROR: From {0} and to {1} must not be the same.", fromArg, toArg); ShowHelp(); Environment.Exit(1); }
62+
#endregion
63+
64+
string loadFilePath = null; string loadRegistryKey = null;
65+
66+
#region Determine From
67+
// determine where to load from
68+
if (fromArg.Equals("INI")) { loadFilePath = SettingsBase.DefaultSettingsFileName; }
69+
else if (fromArg.Equals("REG")) { loadRegistryKey = SettingsBase.DefaultRegistryKey; }
70+
else if (fromArg.Contains(".ini")) { loadFilePath = fromArg; }
71+
else { loadRegistryKey = fromArg; }
72+
73+
// check that source exists
74+
if (!String.IsNullOrEmpty(loadFilePath))
75+
{
76+
var iniFilePath = Path.Combine(ApplicationInfo.ProcessDirectory, loadFilePath);
77+
if (!File.Exists(iniFilePath))
78+
{
79+
Console.WriteLine("ERROR: INI file {0} to export from does not exist.", iniFilePath);
80+
Environment.Exit(1);
81+
}
82+
}
83+
else if (!String.IsNullOrEmpty(loadRegistryKey))
84+
{
85+
using (var regKey = Registry.CurrentUser.OpenSubKey(loadRegistryKey))
86+
{
87+
if (regKey == null)
88+
{
89+
Console.WriteLine("ERROR: Reg key {0} to export from does not exist.", loadRegistryKey);
90+
Environment.Exit(1);
91+
}
92+
}
93+
}
94+
else
95+
{
96+
Console.WriteLine("ERROR: No source to export from found");
97+
Environment.Exit(1);
98+
}
99+
#endregion
100+
101+
// instantiate the static part of SettingsBase
102+
UserSettings userSettings;
103+
104+
// then override
105+
SettingsBase.OverrideSettingsLocations(loadFilePath, loadRegistryKey);
106+
107+
Console.WriteLine("Info: Loading from {0}.", SettingsBase.RegistryKey + SettingsBase.SettingsFilePath);
108+
109+
// load the user settings and its sub-settings from the default location
110+
IEnumerable<string> options = Enumerable.Empty<string>();
111+
userSettings = new UserSettings(options);
112+
var updateState = new UpdateState();
113+
// FUTURE: add here when a new settings class is added (that is not handled by UserSettings)
114+
115+
Console.WriteLine("Info: Successfully loaded settings from {0}.", userSettings.GetSettingsStoreName());
116+
117+
string saveFilePath = null; string saveRegistryKey = null;
118+
119+
#region Determine To
120+
// determine where to save to
121+
if (toArg.Equals("INI")) { saveFilePath = SettingsBase.DefaultSettingsFileName; }
122+
else if (toArg.Equals("REG")) { saveRegistryKey = SettingsBase.DefaultRegistryKey; }
123+
else if (toArg.Contains(".ini"))
124+
{
125+
// save to a custom ini file, do some basic verification
126+
saveFilePath = toArg;
127+
var dir = Path.GetDirectoryName(Path.Combine(ApplicationInfo.ProcessDirectory, saveFilePath));
128+
if (!Directory.Exists(dir)) { Console.WriteLine("ERROR: Directory {0} to save to does not exist.", dir); Environment.Exit(1); }
129+
}
130+
else if (toArg.StartsWith("SOFTWARE")) { saveRegistryKey = toArg; }
131+
else
132+
{
133+
Console.WriteLine("ERROR: Invalid destination {0}.", toArg);
134+
Console.WriteLine("ERROR: Registry key must start with \"SOFTWARE\", or INI path must include \".ini\".");
135+
Environment.Exit(1);
136+
}
137+
#endregion
138+
139+
#region Backup
140+
if (!String.IsNullOrEmpty(saveFilePath))
141+
{
142+
// backup the file if it already exists
143+
string settingsFilePath = Path.Combine(ApplicationInfo.ProcessDirectory, saveFilePath);
144+
string backupFilePath = Path.Combine(ApplicationInfo.ProcessDirectory, saveFilePath + ".bak");
145+
if (File.Exists(settingsFilePath))
146+
{
147+
File.Delete(backupFilePath);
148+
File.Move(settingsFilePath, backupFilePath);
149+
Console.WriteLine("Info: Backed up existing INI file as {0}.", backupFilePath);
150+
}
151+
152+
// create an empty file (required by SettingsStore)
153+
using (File.Create(settingsFilePath)) { };
154+
155+
}
156+
else if (!String.IsNullOrEmpty(saveRegistryKey))
157+
{
158+
// backup the registry key if it already exists
159+
using (var regKey = Registry.CurrentUser.OpenSubKey(saveRegistryKey))
160+
{
161+
if (regKey != null)
162+
{
163+
using (var backupRegKey = Registry.CurrentUser.CreateSubKey(saveRegistryKey + "-Backup"))
164+
{
165+
CopyRegistryKey(regKey, backupRegKey);
166+
Console.WriteLine("Info: Backed up existing Registry key as {0}.", backupRegKey.Name);
167+
}
168+
}
169+
}
170+
}
171+
else
172+
{
173+
Console.WriteLine("ERROR: No destination to export to.");
174+
Environment.Exit(1);
175+
}
176+
#endregion
177+
178+
// change the settings store
179+
userSettings.ChangeSettingsStore(saveFilePath, saveRegistryKey, null); // section is defined in SettingsStoreLocalIni
180+
updateState.ChangeSettingsStore(saveFilePath, saveRegistryKey, UpdateState.SectionName);
181+
// FUTURE: add here when a new settings class is added (that is not handled by UserSettings)
182+
183+
Console.WriteLine("Info: Saving to {0}.", userSettings.GetSettingsStoreName());
184+
185+
// save the settings
186+
userSettings.Save();
187+
updateState.Save();
188+
// FUTURE: add here when a new settings class is added (that is not handled by UserSettings)
189+
190+
Console.WriteLine("Info: Successfully saved to {0}.", userSettings.GetSettingsStoreName());
191+
192+
if (toArg.Equals("REG") || toArg.Equals(SettingsBase.DefaultRegistryKey))
193+
{
194+
Console.WriteLine();
195+
Console.WriteLine("To use the settings in the registry, manually delete the INI file in the OpenRails folder.");
196+
Console.WriteLine(" eg: {0}", Path.Combine(ApplicationInfo.ProcessDirectory, SettingsBase.DefaultSettingsFileName));
197+
}
198+
199+
return 0;
200+
}
201+
202+
static void ShowHelp()
203+
{
204+
string cmd = Path.GetFileNameWithoutExtension(ApplicationInfo.ProcessFile);
205+
Console.WriteLine();
206+
Console.WriteLine("Usage: {0} <from> <to>", cmd);
207+
Console.WriteLine(" <from> Specify the source to load settings from. It may be:");
208+
Console.WriteLine(" INI : use the default INI file {0}.", SettingsBase.DefaultSettingsFileName);
209+
Console.WriteLine(" REG : use the default registry key {0}.", SettingsBase.DefaultRegistryKey);
210+
Console.WriteLine(" path : a specific INI file, relative to the OpenRails main folder. Must include \".ini\".");
211+
Console.WriteLine(" key : a specific registry key, relative to the HKEY_CURRENT_USER key. Must start with \"SOFTWARE\".");
212+
Console.WriteLine(" <to> Specify the destination to save the settings to. Similar to <from>.");
213+
Console.WriteLine(" /h, /help Show this help.");
214+
Console.WriteLine();
215+
Console.WriteLine("Important: Close all OpenRails instances before exporting the settings. Otherwise the exported settings may be stale.");
216+
Console.WriteLine();
217+
Console.WriteLine("This utility reads the Settings (Options) from one location, and exports them to another location.");
218+
Console.WriteLine("It creates a backup of any settings that will be overwritten. Example:");
219+
Console.WriteLine(" <installfolder>\\OpenRails.ini.bak");
220+
Console.WriteLine(" HKEY_CURRENT_USER\\SOFTWARE\\OpenRails\\ORTS-Backup");
221+
Console.WriteLine("This utility is intended to:");
222+
Console.WriteLine("- Create an INI file that has the same settings as what is in the registry.");
223+
Console.WriteLine(" Example: {0} REG INI", cmd);
224+
Console.WriteLine("- Copy the settings from an INI file back into the registry, so that other installations");
225+
Console.WriteLine(" use the same settings.");
226+
Console.WriteLine(" Example: {0} INI REG", cmd);
227+
Console.WriteLine("- Backup the settings, before making temporary changes (and restore afterwards).");
228+
Console.WriteLine(" Example: {0} REG SOFTWARE\\OpenRails-Saved\\ORTS", cmd);
229+
Console.WriteLine();
230+
}
231+
232+
/// <summary>
233+
/// Recursively copy the values of a registry key to another registry key.
234+
/// </summary>
235+
/// <param name="fromKey">the key to copy from; must exist</param>
236+
/// <param name="toKey">the key to copy to; should not exist</param>
237+
static void CopyRegistryKey(RegistryKey fromKey, RegistryKey toKey)
238+
{
239+
// copy the values
240+
foreach (var name in fromKey.GetValueNames())
241+
{
242+
toKey.SetValue(name, fromKey.GetValue(name), fromKey.GetValueKind(name));
243+
}
244+
245+
// copy the subkeys
246+
foreach (var name in fromKey.GetSubKeyNames())
247+
{
248+
using (var fromSubKey = fromKey.OpenSubKey(name))
249+
{
250+
var toSubKey = toKey.CreateSubKey(name);
251+
CopyRegistryKey(fromSubKey, toSubKey);
252+
}
253+
}
254+
}
255+
}
256+
}

‎Source/Contrib/SettingsExporter/SettingsExporter.csproj‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
<PropertyGroup>
3+
<TargetFramework Condition="'$(BuildDotNet)' == 'true'">net6-windows</TargetFramework>
4+
<TargetFramework Condition="'$(TargetFramework)' == ''">net472</TargetFramework>
5+
<OutputType>Exe</OutputType>
6+
<RootNamespace>Orts.SettingsExporter</RootNamespace>
7+
<AssemblyName>Contrib.SettingsExporter</AssemblyName>
8+
<ApplicationIcon>..\..\ORTS.ico</ApplicationIcon>
9+
<IsPublishable>False</IsPublishable>
10+
<AssemblyTitle>Open Rails Settings Exporter (Contributed)</AssemblyTitle>
11+
<Description>Export ORTS Settings from the Registry to the INI file, or vice versa.</Description>
12+
<Company>Open Rails</Company>
13+
<Product>Open Rails</Product>
14+
<Copyright>Copyright © 2009 - 2025</Copyright>
15+
<PackageLicenseExpression>GPL-3.0-or-later</PackageLicenseExpression>
16+
</PropertyGroup>
17+
<ItemGroup>
18+
<ProjectReference Include="..\..\ORTS.Common/ORTS.Common.csproj" />
19+
<ProjectReference Include="..\..\ORTS.Settings/ORTS.Settings.csproj" />
20+
</ItemGroup>
21+
<ItemGroup>
22+
<PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.355802">
23+
<PrivateAssets>all</PrivateAssets>
24+
</PackageReference>
25+
</ItemGroup>
26+
</Project>

‎Source/Documentation/Manual/appendices.rst‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -738,12 +738,23 @@ INI File and User Settings
738738
==========================
739739

740740
By default, Open Rails keeps the user's settings and options in the Windows Registry.
741+
The settings in the registry are shared by all Open Rails installations.
741742

742743
If you want to have a set of alternative settings which bypass the settings kept in the Registry,
743744
then you can use an INI text file for this.
745+
The INI file, named "OpenRails.ini", must be in the same directory as the main executable (OpenRails.exe),
746+
and will only be used by that installation of Open Rails.
744747

745-
Create an empty file OpenRails.ini in the same folder as OpenRails.exe and start Open Rails.
748+
Use the contributed "Settings Exporter" to copy the existing settings from the registry to the INI file.
749+
The Settings Exporter is accessible from the "Tools" button in the main window.
750+
The Settings Exporter may also be used to create a backup of the settings, or to copy the settings from
751+
the INI file back into the registry.
752+
753+
Important: Close all OpenRails instances before exporting the settings.
754+
Otherwise the exported settings may be stale.
755+
756+
Alternatively, create an empty file "OpenRails.ini" in the same folder as "OpenRails.exe" and start Open Rails.
746757
The program will attempt to load settings from the file, using default values for settings that
747758
cannot be found and populates the INI file with these settings.
748759

749-
If you change the settings and options, then these will be saved automatically to the INI file.
760+
Once an "OpenRails.ini" file exists, any changes to the settings and options will be saved to the INI file (not the registry).

‎Source/ORTS.sln‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ContentChecker", "ContentCh
5353
EndProject
5454
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SimulatorTester", "Contrib\SimulatorTester\SimulatorTester.csproj", "{792B01A1-5C43-4FFA-A4C0-BBDC95A4A178}"
5555
EndProject
56+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SettingsExporter", "Contrib\SettingsExporter\SettingsExporter.csproj", "{FAD444CE-3EA7-47AC-A771-792E34BCE7DC}"
57+
EndProject
5658
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MultiPlayerServer", "MultiPlayerServer\MultiPlayerServer.csproj", "{A86A52C2-07B9-47A6-BCF4-622440E1A64E}"
5759
EndProject
5860
Global
@@ -161,6 +163,10 @@ Global
161163
{792B01A1-5C43-4FFA-A4C0-BBDC95A4A178}.Debug|Any CPU.Build.0 = Debug|Any CPU
162164
{792B01A1-5C43-4FFA-A4C0-BBDC95A4A178}.Release|Any CPU.ActiveCfg = Release|Any CPU
163165
{792B01A1-5C43-4FFA-A4C0-BBDC95A4A178}.Release|Any CPU.Build.0 = Release|Any CPU
166+
{FAD444CE-3EA7-47AC-A771-792E34BCE7DC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
167+
{FAD444CE-3EA7-47AC-A771-792E34BCE7DC}.Debug|Any CPU.Build.0 = Debug|Any CPU
168+
{FAD444CE-3EA7-47AC-A771-792E34BCE7DC}.Release|Any CPU.ActiveCfg = Release|Any CPU
169+
{FAD444CE-3EA7-47AC-A771-792E34BCE7DC}.Release|Any CPU.Build.0 = Release|Any CPU
164170
{A86A52C2-07B9-47A6-BCF4-622440E1A64E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
165171
{A86A52C2-07B9-47A6-BCF4-622440E1A64E}.Debug|Any CPU.Build.0 = Debug|Any CPU
166172
{A86A52C2-07B9-47A6-BCF4-622440E1A64E}.Release|Any CPU.ActiveCfg = Release|Any CPU

‎Source/Orts.Simulation/Common/Scripting/PowerSupply/LocomotivePowerSupply.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -606,7 +606,7 @@ protected T LoadParameter<T>(string sectionName, string keyName, T defaultValue)
606606

607607
if (length > 0)
608608
{
609-
buffer.Trim();
609+
buffer = buffer.Trim('\0').Trim();
610610
return (T)Convert.ChangeType(buffer, typeof(T), System.Globalization.CultureInfo.InvariantCulture);
611611
}
612612
}

‎Source/Orts.Simulation/Simulation/RollingStocks/MSTSDieselLocomotive.cs‎

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ public override void Parse(string lowercasetoken, STFReader stf)
178178
var transmissionType = stf.ReadString();
179179
try
180180
{
181-
DieselTransmissionType = (DieselTransmissionTypes)Enum.Parse(typeof(DieselTransmissionTypes), transmissionType.First().ToString().ToUpper() + transmissionType.Substring(1));
181+
DieselTransmissionType = (DieselTransmissionTypes)Enum.Parse(typeof(DieselTransmissionTypes), transmissionType, true);
182182
}
183183
catch
184184
{
@@ -699,27 +699,12 @@ protected override void UpdateTractionForce(float elapsedClockSeconds)
699699
{
700700
if (DieselEngines.HasGearBox && (TractiveForceCurves == null || DieselTransmissionType == MSTSDieselLocomotive.DieselTransmissionTypes.Mechanic))
701701
{
702-
TractiveForceN = TractionForceN = DieselEngines.TractiveForceN;
702+
TractionForceN = DieselEngines.TractiveForceN;
703703
return;
704704
}
705705
base.UpdateTractionForce(elapsedClockSeconds);
706706
}
707707

708-
protected override void UpdateAxleDriveForce()
709-
{
710-
/* TODO: connect different engines to different axles
711-
if (DieselEngines.HasGearBox && DieselTransmissionType == MSTSDieselLocomotive.DieselTransmissionTypes.Mechanic)
712-
{
713-
foreach (var de in DieselEngines)
714-
{
715-
}
716-
}
717-
else */
718-
{
719-
base.UpdateAxleDriveForce();
720-
}
721-
}
722-
723708
/// <summary>
724709
/// This function updates periodically the locomotive's sound variables.
725710
/// </summary>

0 commit comments

Comments
 (0)