Open Rails Manual¶
- 1. Legal
- 2. New since previous version of Open Rails (1.3)
- 3. Introduction
- 4. Use of MSTS Files by Open Rails
- 5. Getting Started
- 6. Open Rails Options
- 6.1. General Options
- 6.1.1. Alerter in cab
- 6.1.2. Map window
- 6.1.3. Graduated release air brakes
- 6.1.4. Large address aware binaries
- 6.1.5. Control confirmations
- 6.1.6. Retainer valve on all cars
- 6.1.7. Brake pipe charging rate
- 6.1.8. Language
- 6.1.9. Pressure unit
- 6.1.10. Other units
- 6.1.11. Disable TCS scripts
- 6.1.12. Enable web server
- 6.1.13. Overspeed Monitor
- 6.2. Audio Options
- 6.3. Video Options
- 6.3.1. Dynamic shadows
- 6.3.2. Shadow for all shapes
- 6.3.3. Fast full-screen Alt+Tab
- 6.3.4. Glass on in-game windows
- 6.3.5. Model instancing
- 6.3.6. Overhead wire
- 6.3.7. Double overhead wires
- 6.3.8. Vertical sync
- 6.3.9. % Cab 2D stretch
- 6.3.10. Viewing distance
- 6.3.11. Distant mountains
- 6.3.12. Viewing vertical FOV
- 6.3.13. World object density
- 6.3.14. Window size
- 6.3.15. Ambient daylight brightness
- 6.3.16. Anti-aliasing
- 6.4. Simulation Options
- 6.4.1. Advanced adhesion model
- 6.4.2. Adhesion moving average filter size
- 6.4.3. Break couplers
- 6.4.4. Curve dependent resistance
- 6.4.5. Curve dependent speed limit
- 6.4.6. Tunnel dependent resistance
- 6.4.7. Wind dependent resistance
- 6.4.8. Run electric locos on non-electrified routes
- 6.4.9. Steam locomotive hot start
- 6.4.10. Forced red at station stops
- 6.4.11. Open/close doors on AI trains
- 6.4.12. Location-linked passing path processing
- 6.4.13. Simple control and physics
- 6.5. Keyboard Options
- 6.6. Data Logger Options
- 6.7. Evaluation Options
- 6.8. Content Options
- 6.9. Updater Options
- 6.10. Experimental Options
- 6.10.1. Super-elevation
- 6.10.2. Automatically tune settings to keep performance level
- 6.10.3. Show shape warnings
- 6.10.4. ETCS circular speed gauge
- 6.10.5. Load day/night textures only when needed
- 6.10.6. Signal light glow
- 6.10.7. Correct questionable braking parameters
- 6.10.8. Activity randomization
- 6.10.9. Activity weather randomization
- 6.10.10. Extend object maximum viewing distance to horizon
- 6.10.11. Load DDS textures in preference to ACE
- 6.10.12. MSTS Environments
- 6.10.13. Adhesion factor correction
- 6.10.14. Level of detail bias
- 6.10.15. Adhesion proportional to rain/snow/fog
- 6.10.16. Adhesion factor random change
- 6.10.17. Precipitation Box Size
- 6.1. General Options
- 7. Driving a Train
- 7.1. Game Loading
- 7.2. Entering the Simulation
- 7.3. Open Rails Driving Controls
- 7.4. Driving aids
- 7.4.1. F1 Information Monitor
- 7.4.2. F3
- 7.4.3. F4 Track Monitor
- 7.4.4. F5 Train Driving Info
- 7.4.5. F6 Siding and Platform Names
- 7.4.6. F7 Train Names
- 7.4.7. F8 Switch Monitor
- 7.4.8. F9 Train Operations Monitor
- 7.4.9. F10 Activity Monitor
- 7.4.10. Compass Window
- 7.4.11. Odometer
- 7.4.12. Debrief Evaluation
- 7.4.13. Basic Head Up Display (HUD)
- 7.4.14. Electric Locomotives – Additional information
- 7.4.15. Steam Engine – Additional Information
- 7.4.16. Multiplayer – Additional Information
- 7.5. Map Window
- 7.6. Additional Train Operation Commands
- 7.7. Engaging a turntable or a transfertable
- 7.8. Autopilot Mode
- 7.9. Changing the Train Driven by the Player
- 7.10. Changing the View
- 7.11. Toggling Between Windowed Mode and Full-screen
- 7.12. Modifying the Game Environment
- 7.13. Activity randomization
- 7.14. Screenshot - Print Screen
- 7.15. Suspending or Exiting the Game
- 7.16. Save and Resume
- 7.17. Save and Replay
- 7.18. Analysis Tools
- 7.18.1. Extended HUD for Consist Information
- 7.18.2. Extended HUD for Locomotive Information
- 7.18.3. Extended HUD for Brake Information
- 7.18.4. Extended HUD for Train Force Information
- 7.18.5. Extended HUD for Dispatcher Information
- 7.18.6. Extended HUD for Debug Information
- 7.18.7. Viewing Interactive Track Items
- 7.18.8. Viewing Signal State and Switches
- 7.18.9. Sound Debug Window
- 7.19. OpenRailsLog.txt Log file
- 7.20. Code-embedded Logging Options
- 7.21. Testing in Autopilot Mode
- 8. Open Rails Physics
- 8.1. Train Cars (WAG, or Wagon Part of ENG file)
- 8.2. Engine – Classes of Motive Power
- 8.3. Engines – Multiple Units in Same Consist or AI Engines
- 8.4. Open Rails Braking
- 8.4.1. Train Brake Controller Positions
- 8.4.2. Brake Shoe Adhesion
- 8.4.3. Train Brake Pipe Losses
- 8.4.4. Wheel Skidding due to Excessive Brake Force
- 8.4.5. Using the F5 HUD Expanded Braking Information
- 8.4.6. Dynamic Brakes
- 8.4.7. Native Open Rails Braking Parameters
- 8.4.8. Brake Retainers
- 8.4.9. Emergency Brake Application Key
- 8.4.10. Automatic Vacuum Brakes
- 8.4.11. Non Automatic Vacuum Brakes
- 8.4.12. Manual Brakes
- 8.4.13. Steam Brakes
- 8.4.14. Wheel Slide Protection
- 8.4.15. SME (sometimes also called SEM) Brake System
- 8.5. Dynamically Evolving Tractive Force
- 8.6. Curve Resistance - Theory
- 8.7. Curve Resistance - Application in OR
- 8.8. Super Elevation (Curve Speed Limit) – Theory
- 8.8.1. Introduction
- 8.8.2. 19th & 20th Century vs Modern Day Railway Design
- 8.8.3. Centrifugal Force
- 8.8.4. Effect of Centrifugal Force
- 8.8.5. Use of Super Elevation
- 8.8.6. Limitation of Super Elevation in Mixed Passenger & Freight Routes
- 8.8.7. Limitation of Super Elevation in High Speed Passenger Routes
- 8.8.8. Maximum Curve Velocity
- 8.8.9. Limitation of Velocity on Curved Track at Zero Cross Level
- 8.8.10. Height of Centre of Gravity
- 8.8.11. Calculation of Curve Velocity
- 8.8.12. Typical Super Elevation Values & Speed Impact – Mixed Passenger & Freight Routes
- 8.8.13. Typical Super Elevation Values & Speed Impact – High Speed Passenger Routes
- 8.9. Super Elevation (Curve Speed Limit) Application in OR
- 8.10. Tunnel Friction – Theory
- 8.11. Tunnel Friction – Application in OR
- 8.12. Wind Resistance
- 8.13. Trailing Locomotive Resistance
- 8.14. OR-Specific Include Files for Modifying MSTS File Parameters
- 8.15. Common locomotive subsystems
- 9. Further Open Rails Rolling Stock Features
- 10. Open Rails Train Operation
- 10.1. Open Rails Activities
- 10.2. Open Rails AI
- 10.3. Control Mode
- 10.4. Track Access Rules
- 10.5. Deadlock Processing
- 10.6. Reversal Points
- 10.7. Waiting Points
- 10.8. Signals at Station Stops
- 10.9. Speedposts and Speed Limits Set by Signals
- 10.10. Further Features of AI Train Control
- 10.11. Location-linked Passing Path Processing
- 10.12. Other Comparisons Between Running Activities in ORTS or MSTS
- 10.13. Extended AI Train Shunting
- 10.14. Signal related files
- 10.15. OR-specific Signaling Functions
- 10.15.1. SPEED Signals – a New Signal Function Type
- 10.15.2. Approach control functions
- 10.15.3. TrainHasCallOn, TrainHasCallOn_Advanced Functions
- 10.15.4. TrainHasCallOn_Restricted, TrainHasCallOn_Restricted_Advanced Functions
- 10.15.5. Signalling Function NEXT_NSIG_LR
- 10.15.6. Signalling Function HASHEAD
- 10.15.7. Signalling flag OR_NOSPEEDREDUCTION
- 10.16. OR-Specific Additions to Activity Files
- 10.16.1. Manually modifying the .act file
- 10.16.2. Using the TSRE5 activity editing capabilities
- 10.16.3. Generating an extension activity file
- 10.16.4. No Halt by Activity Message Box
- 10.16.5. AI Train Horn Blow
- 10.16.6. AI Horn Blow at Level Crossings
- 10.16.7. Location Event triggered by AI Train
- 10.16.8. Location Event and Time Event Sound File
- 10.16.9. Weather Change Activity Event
- 10.16.10. AI train Waiting Point modification through event
- 10.16.11. Old formats
- 11. Timetable Mode
- 11.1. Introduction
- 11.2. General
- 11.3. Timetable Definition
- 11.4. Timetable Data Details
- 11.5. Additional Notes on Timetables
- 11.5.1. Static Trains
- 11.5.2. Processing of #dispose Command For Player Train
- 11.5.3. Termination of a Timetable Run
- 11.5.4. Calculation of Running Delay
- 11.5.5. No Automatic Coupling
- 11.5.6. Use of Consists in Shunting Commands
- 11.5.7. Signalling Requirements and Timetable Concept
- 11.5.8. Known Problems
- 11.6. Storing Trains with Pools
- 11.7. Pool Definition
- 11.8. Changing Weather
- 11.9. Example of a Timetable File
- 11.10. What tools are available to develop a Timetable?
- 12. Open Rails Multi-Player
- 12.1. Goal
- 12.2. Getting Started
- 12.3. Requirements
- 12.4. Technical Issues
- 12.5. Technical Support
- 12.6. Starting a Multi-Player Session
- 12.7. In-Game Controls
- 12.8. Summary of Multi-Player Procedures
- 12.9. Possible Problems
- 12.10. Using the Public Server
- 12.11. Save and resume
- 12.12. Setting up a Server from Your Own Computer
- 13. Open Rails Sound Management
- 14. Open Rails Cabs
- 14.1. 2D Cabs
- 14.1.1. Battery switch
- 14.1.2. Master key
- 14.1.3. Service retention
- 14.1.4. Electric train supply
- 14.1.5. Controls to switch on and off diesel engines
- 14.1.6. Cab radio
- 14.1.7. Cab light
- 14.1.8. Dedicated buttons for brake controllers
- 14.1.9. Signed Traction Braking control
- 14.1.10. Signed Traction Total Braking control
- 14.1.11. Animated 2D Wipers
- 14.1.12. Further OR cab controls
- 14.1.13. High-resolution Cab Backgrounds and Controls
- 14.1.14. Configurable Fonts
- 14.1.15. Rotation of Gauges and Digital controls
- 14.2. 3D cabs
- 14.1. 2D Cabs
- 15. OR-Specific Route Features
- 15.1. Modifications to .trk Files
- 15.2. Repetition of Snow Terrain Textures
- 15.3. Snow Textures with Night Textures
- 15.4. Operating Turntables and Transfertables
- 15.5. .w File modifiers
- 15.6. Multiple car spawner lists
- 15.7. Car spawners used for walking people
- 15.8. Route specific TrackSections and TrackShapes
- 15.9. Overhead wire extensions
- 15.10. Loading screen
- 15.11. MSTS-Compatible semaphore indexing
- 15.12. Automatic door open/close on AI trains
- 15.13. Removing forest trees from tracks and roads
- 15.14. Multiple level crossing sounds
- 15.15. Defining Curve Superelevation
- 15.16. Overhead (catenary) wire
- 15.17. Fading signal lamps
- 15.18. Animated clocks
- 16. Developing OR Content
- 17. Version 1.3 Known Issues
- 18. In Case Of Malfunction
- 19. Open Rails Software Platform
- 20. Plans and Roadmap
- 21. Acknowledgements
- 22. Appendices
- 22.1. Units of Measure
- 22.2. Folders used by Open Rails
- 22.3. Signal Functions
- 22.3.1. Original MSTS Functions
- 22.3.2. Extended MSTS Functions
- 22.3.3. SIGNAL IDENT Functions
- 22.3.4. Signal SubObject functions
- 22.3.5. Approach Control Functions
- 22.3.6. CallOn Functions
- 22.3.7. SignalNumClearAhead Functions
- 22.3.8. Local signal variables
- 22.3.9. Functions for Normal Head Subtype
- 22.3.10. Functions to verify full or partial route clearing
- 22.3.11. Miscellaneous functions
- 22.3.12. Timing Functions
- 22.4. OR-specific additions to SIGCFG files