Open Rails Manual

• Legal
  • Warranty
  • Properties Acknowledgment
  • Copyright Acknowledgment and License
• New in This Release
  • Operation Additions
  • Locomotive Additions
  • General Improvements
  • System Additions
  • Bug Fixes
• Introduction
  • What is Open Rails?
  • About Open Rails
  • Does Open Rails Require You to Have MSTS Installed?
  • Community
  • Raildriver Support
  • Highlights of the Current Version
    • Focus on Compatibility
    • Focus on Operations
    • Focus on Realistic Content
• Use of MSTS Files by Open Rails
  • Overview
    • Your MSTS Installation and Custom Installations for Open Rails
  • MSTS Directories Used by Open Rails
  • MSTS Files Used in Whole or Part by Open Rails
    • Route Files
    • Environment .env files
    • Activities
  • Using a Non-MSTS Folder Structure
  • Original MSTS Files Usually Needed for Added MSTS-Compatible Content
    • Original MSTS Files Usually Needed for a Non-MSTS-Folder Structure
• Getting Started
  • Installation Profiles
  • Updating OR
  • Further General Buttons
    • Tools
    • Documents
    • Preliminary Selections
  • Gaming Modes
    • Traditional Activity and Explore modes
    • Timetable Mode
    • Run!
    • Multiplayer Mode
    • Replay
• Open Rails Options
  • General Options
    • Alerter in Cab
    • Dispatcher window
    • Graduated release air brakes
    • Large address aware binaries
    • Control confirmations
    • Retainer valve on all cars
    • Brake pipe charging rate
    • Language
    • Pressure unit
    • Other units
    • Disable TCS scripts
  • Audio Options
  • Video Options
    • Dynamic shadows
    • Fast full-screen Alt+Tab
    • Glass on in-game windows
    • Model instancing
    • Overhead wire
    • Vertical sync
    • % Cab 2D Stretch
    • Viewing distance
    • Distant Mountains
    • Viewing vertical FOV
    • World object density
    • Window size
    • Ambient daylight brightness
  • Simulation Options
    • Advanced adhesion model
    • Adhesion moving average filter size
    • Break couplers
    • Curve dependent resistance
    • Curve dependent speed limit
    • Tunnel dependent resistance
    • Override non-electrified route line-voltage
    • Steam locomotive hot start
  • Keyboard Options
  • Data Logger Options
  • Evaluation Options
  • Content Options
  • Updater Options
  • Experimental Options
    • Super-elevation
    • Automatically tune settings to keep performance level
    • Double overhead wires
    • Show shape warnings
    • Forced red at station stops
    • Load night textures only when needed
    • Signal light glow
    • Extended AI train shunting
    • Autopilot
    • ETCS circular speed gauge
    • Extend object maximum viewing distance to horizon
    • Load DDS textures in preference to ACE
    • Location-linked passing path processing
    • MSTS Environments
    • Adhesion factor correction
    • Level of detail bias
    • Adhesion proportional to rain/snow/fog
    • Adhesion factor random change
    • Precipitation Box Size
    • Correct questionable braking parameters
• Driving a Train
  • Game Loading
  • Entering the Simulation
  • Open Rails Driving Controls
    • Throttle Control
    • Dynamic Braking
    • Combined Control
    • Blended Dynamic Brake
    • Refill
    • Specific Features to Optimize Locomotive Driving
    • Examples of Driving Controls
  • Driving aids
    • Basic Head Up Display (HUD)
    • Electric Locomotives – Additional information
    • Steam Engine – Additional Information
    • Multiplayer – Additional Information
    • Compass Window
    • F1 Information Monitor
    • F4 Track Monitor
    • F6 Siding and Platform Names
    • F7 Train Names
    • F8 Switch Monitor
    • F9 Train Operations Monitor
    • F10 Activity Monitor
    • Odometer
  • Dispatcher Window
  • Additional Train Operation Commands
    • Diesel Power On/Off
    • Initialize Brakes
    • Connect/Disconnect Brake Hoses
    • Doors and Mirror Commands
    • Wheelslip Reset
    • Toggle Advanced Adhesion
    • Request to Clear Signal
    • Train Oscillation
  • Engaging a turntable
  • Autopilot Mode
  • Changing the Train Driven by the Player
    • General
    • Switching to a static train
    • Waiting point considerations
  • Changing the View
  • Toggling Between Windowed Mode and Full-screen
  • Modifying the Game Environment
    • Time of Day
    • Weather
    • Modifying Weather at Runtime
    • Season
  • Screenshot - Print Screen
  • Suspending or Exiting the Game
  • Save and Resume
    • Saves from Previous OR Versions
  • Save and Replay
    • Exporting and Importing Save Files
  • Analysis Tools
    • Extended HUD for Consist Information
    • Extended HUD for Locomotive Information
    • Extended HUD for Brake Information
    • Extended HUD for Train Force Information
    • Extended HUD for Dispatcher Information
    • Extended HUD for Debug Information
    • Viewing Interactive Track Items
    • Viewing Signal State and Switches
    • Sound Debug Window
  • OpenRailsLog.txt Log file
  • Code-embedded Logging Options
  • Testing in Autopilot Mode
• Open Rails Physics
  • Train Cars (WAG, or Wagon Part of ENG file)
    • Resistive Forces
    • Coupler Slack
    • Adhesion of Locomotives – Settings Within the Wagon Section of ENG files
  • Engine – Classes of Motive Power
    • Diesel Locomotives in General
    • Diesel-Electric Locomotives
    • Diesel-Hydraulic Locomotives
    • Diesel-Mechanical Locomotives
  • Electric Locomotives
    • Pantographs
    • Circuit breaker
    • Power supply
  • Steam Locomotives
    • General Introduction to Steam Locomotives
    • Steam Locomotive Operation
    • Steam Locomotives – Physics Parameters for Optimal Operation
    • Special Steam Effects for Steam Locomotives
    • Auxiliary Water Tenders
  • Engines – Multiple Units in Same Consist or AI Engines
  • Open Rails Braking
    • Brake Shoe Adhesion
    • Train Brake Pipe Losses
    • Wheel Skidding due to Excessive Brake Force
    • Using the F5 HUD Expanded Braking Information
    • Dynamic Brakes
    • Native Open Rails Braking Parameters
    • Brake Retainers
    • Emergency Brake Application Key
  • Dynamically Evolving Tractive Force
  • Curve Resistance - Theory
    • Introduction
    • Factors Impacting Curve Friction
    • Impact of Rigid Wheelbase
    • Impact of Super Elevation
    • Calculation of Curve Resistance
    • Calculation of Curve Speed Impact
    • Further background reading
  • Curve Resistance - Application in OR
    • OR Parameter Values
    • OR Default Values
    • Typical Rigid Wheelbase Values
  • Super Elevation (Curve Speed Limit) – Theory
    • Introduction
    • 19th & 20th Century vs Modern Day Railway Design
    • Centrifugal Force
    • Effect of Centrifugal Force
    • Use of Super Elevation
    • Limitation of Super Elevation in Mixed Passenger & Freight Routes
    • Limitation of Super Elevation in High Speed Passenger Routes
    • Maximum Curve Velocity
    • Limitation of Velocity on Curved Track at Zero Cross Level
    • Height of Centre of Gravity
    • Calculation of Curve Velocity
    • Typical Super Elevation Values & Speed Impact – Mixed Passenger & Freight Routes
    • Typical Super Elevation Values & Speed Impact – High Speed Passenger Routes
  • Super Elevation (Curve Speed Limit) Application in OR
    • OR Super Elevation Parameters
    • OR Super Elevation Default Values
  • Tunnel Friction – Theory
    • Introduction
    • Factors Impacting Tunnel Friction
    • Importance of Tunnel Profile
    • Calculation of Tunnel Resistance
  • Tunnel Friction – Application in OR
    • OR Parameters
    • OR Defaults
  • OR-Specific Include Files for Modifying MSTS File Parameters
    • Modifications to .eng and .wag Files
    • Modifications to .trk Files
  • Train Control System
• Further Open Rails Rolling Stock Features
  • Train Engine Lights
  • Tilting trains
  • Freight animations and pickups
    • OR implementation of MSTS freight animations and pickups
    • OR specific freight animations and pickups
• Open Rails Train Operation
  • Open Rails Activities
    • Player Paths, AI Paths, and How Switches Are Handled
  • Open Rails AI
  • Control Mode
    • Auto Mode
    • Manual Mode
    • Out-of-Control Mode
    • Explorer Mode
  • Track Access Rules
  • Deadlock Processing
  • Reversal Points
  • Waiting Points
    • General
    • Absolute Waiting Points
  • Signals at Station Stops
  • Speedposts and Speed Limits Set by Signals
  • Further Features of AI Train Control
  • Location-linked Passing Path Processing
  • Other Comparisons Between Running Activities in ORTS or MSTS
    • End of run of AI trains
    • Default Performance and Performance Parameters
    • Calculation of Train Speed Limit
    • Start of Run of AI train in a Section Reserved by Another Train
    • Stop Time at Stations
    • Restricted speed zones defined in activities
  • Extended AI Train Shunting
    • General
    • Activity Design for Extended AI Train Shunting Functions
  • Signal related files
    • SignalNumClearAhead
    • Location of OR-specific sigcfg and sigscr files
    • OR-unique values for SignalNumClearAhead ()
  • OR-specific Signaling Functions
    • SPEED Signals – a New Signal Function Type
    • Approach control functions
    • TrainHasCallOn Function
    • TrainHasCallOn_Restricted Function
    • Signalling Function NEXT_NSIG_LR
    • Signalling Function HASHEAD
    • Signalling flag OR_NOSPEEDREDUCTION
  • OR-Specific Additions to Activity Files
    • No Halt by Activity Message Box
    • AI Train Horn Blow
    • AI Horn Blow at Level Crossings
    • Location Event and Time Event Sound File
    • Weather Change Activity Event
• Timetable Mode
  • Introduction
  • General
    • Data definition
    • File structure
    • File and train selection
  • Timetable Definition
    • General
    • Column definitions
    • Row definitions
    • Timing details
  • Timetable Data Details
    • Timetable Description
    • Train Details
    • Location Details
    • Timing Details
    • Special Columns
    • Special rows
    • Control commands
    • Dispose Commands
  • Additional Notes on Timetables
    • Static Trains
    • Processing of #dispose Command For Player Train
    • Termination of a Timetable Run
    • Calculation of Running Delay
    • No Automatic Coupling
    • Signalling Requirements and Timetable Concept
    • Known Problems
  • Example of a Timetable File
  • What tools are available to develop a Timetable?
• Open Rails Multi-Player
  • Goal
  • Getting Started
  • Requirements
  • Technical Issues
  • Technical Support
  • Starting a Multi-Player Session
    • Starting as Server
    • Starting as Client
  • In-Game Controls
  • Summary of Multi-Player Procedures
  • Possible Problems
  • Using the Public Server
    • Additional info on using the Public Server
  • Setting up a Server from Your Own Computer
    • IP Address
    • Port Forwarding
• Open Rails Sound Management
  • OpenRails vs. MSTS Sound Management
  • .sms Instruction Set
    • Discrete Triggers
    • OR-Specific Discrete Triggers
    • Variable Triggers
    • Sound Loop Management
    • Testing Sound Files at Runtime
• Open Rails Cabs
  • 2D Cabs
  • High-resolution Cab Backgrounds and Controls
    • Configurable Fonts
  • 3D cabs
    • Development Rules
    • A Practical Development Example For a Digital Speedometer
• OR-Specific Route Features
  • Repetition of Snow Terrain Textures
  • Operating Turntables
    • Path laying and operation considerations
  • .w File modifiers
  • Multiple car spawner lists
  • Route specific TrackSections and TrackShapes
  • Overhead wire extensions
    • Double wire
    • Triphase lines
  • Loading screen
  • MSTS-Compatible semaphore indexing
• Developing OR Content
  • Rolling Stock
  • Routes
  • Activities
  • Testing and Debugging Tools
  • Open Rails Best Practices
    • Polys vs. Draw Calls – What's Important
  • Support
• Version 1.2 Known Issues
  • Empty Effects Section in .eng File
  • Curly brackets in file sigscr.dat
• In Case Of Malfunction
  • Introduction
  • Overview of Bug Types
  • Maybe-Bugs
  • Decided bugs
  • Additional Notes
  • Summary: Bug Report Checklists
  • Bug Status in Launchpad
  • Disclaimer
• Open Rails Software Platform
  • Architecture
  • Open Rails Game Engine
  • Frames per Second (FPS) Performance
  • Game Clock and Internal Clock
  • Resource Utilization
  • Multi-Threaded Coding
• Plans and Roadmap
  • User Interface
  • Operations
  • Open Rails Route Editor
• Acknowledgements
• Appendices
  • Units of Measure
• Indices and tables