...Is a REST-style web server that provides access to the RailDriver API provided with Dovetail Games' Train Simulator (formerly "RailWorks") games. This API allows external programs to not only manipulate the train's controls, but also read status information such as the current speed and position of the train. This information powers apps like Train Maps Live.
Rail Sim Remote represents the latest in a very, very, very long line of previous similar projects. So, why create yet another one?
- HTTP/JSON-style API that any web browser can speak
- Design is transparent enough to interoperate with every locomotive
- Support for writing to, not just reading controls
- Support for the "virtual controls" (speed, position, heading, etc.)
- (Exclusive) support for the 64-bit version of Train Simulator
- Turnkey web server for easy web app hosting
The server serves files out of .\wwwroot and by default listens on
http:https://localhost:8888. You can change the latter with the --urls <URL(s)>
parameter.
| method | path | description |
|---|---|---|
| GET | api/railworks/loco | Read the provider, product, and name of the current locomotive. Controls are guaranteed to be stable so long as this value remains constant. |
| GET | api/railworks/controls | Enumerate all of the controls available for the current locomotive. |
| GET | api/railworks/control/Name | Get the current value of the control Name. |
| PUT | api/railworks/control/Name?value=v | Set the current value of the control Name to v. |
| GET | api/railworks/virtual/Name | Get the current value of the virtual control Name, where Name is one of identifiers listed below. |
| virtual control name | meaning |
|---|---|
| Latitude | Current latitude. |
| Longitude | Current longitude. |
| Fuel | Current fuel level (absolute value). |
| Tunnel | Is train inside tunnel, 1 for yes, 0 for no. |
| Gradient | Current track gradient. |
| Heading | Current bearing. |
| Hours | Current time, hours. |
| Minutes | Current time, minutes. |
| Seconds | Current time, seconds. |