Welcome to the Train Simulator Developer Documentation
This documentation should be considered as a Work in Progress. While we make every effort to be accurate in this documentation, we do not attempt to claim it to be comprehensive. The tools described here are complex, and there are many other variables which affect the behaviour of the software (such as third-party software and your own computer's configuration); therefore it is not possible to document all aspects of the software fully.
This detailed reference follows on from the Creator Manual supplied with Train Simulator, and gives detailed information on how to create your own Routes, Scenarios, Rolling Stock, In-Game Assets, Signalling Systems - in short everything you need to create your own virtual railway.
Using this Documentation
Use the menu to the left for broadly navigating to the section you require. To view a complete list of all the sections in this documentation, click the Reference Manual link.
Each section and subsection has individual tables of contents to drill down into more detail.
Use the Search box to the upper-right to locate information about a specific topic.
The Train Simulator documentation will be updated with new material as we receive feedback. We welcome comments on the information in this documentation by contacting our Customer Support Team.
General Tips
Creating a route to a high degree of realism can be a very exacting process and can significantly affect the performance of the software for those who have a minimal system specification. The following tips outline good working practices when modelling in earnest:
- Examine how the supplied routes or add-on routes are constructed to gain a greater understanding of how they are constructed.
- Try modifying the supplied routes or add-on routes and Scenarios before you start your own route.
- Try practising with a small section of your chosen route.
- Save your route often.
- Make regular backups of your Train Simulator installation to ensure you do not lose routes you've created or progress you've made on your route. It is a good practice to copy all of the installation files regularly. By default these are located at C:Program FilesSteamsteamappscommonrailworksContentRoutes
- If you change something in the supplied routes that causes Train Simulator to stop responding or fail to load, restore the game from a backup or follow these instructions to verify your installation. This is nearly always quicker than trying to diagnose the fault.
- Switch on the Infrastructure Lock (see note below) to prevent accidental amendments to key scenario data.
Please note that if you change any of the routes supplied with Train Simulator, we will not be able to provide you with support for the product until you have reset it back to default.
