Yamazaki93 / TSWRDConnector

GNU General Public License v3.0
12 stars 0 forks source link

TSWRDConnector

RailDriver connector for Train Sim World. This program connects to RailDriver via USB, reads control lever value on RailDriver and from TSW and synchornizes them by applying keystrokes.

As such:

Hopefully, this makes your TSW experience better, more realistic and exciting.

⚠ ACHTUNG: READ FIRST BEFORE STARTING ⚠

Prerequisites

Getting Started

Alt text Alt text

You do NOT need MacroWorks running for this to work. In fact, it may not work if MacroWorks is running so exit it first.

Note, you will need to switch the TSW keyboard mappings back to default if you have adjusted them. Otherwise it won't work.

  1. Dowload the program from Release page, unzip it.
  2. Run TSW 2020.
  3. Run TSWMod.exe under administrator mode.
  4. Click Load RailDriver Calibration and browse to the RailDriver calibration file ModernCalibration.rdm. (It should be under <Your MacroWorks Install Location>/Devices/RailDriver).
  5. Load up a game in TSW.
  6. IMPORTANT: In a moment, observe your RailDriver LED, it should read "CL"
  7. After the game loads, while the RailDriver reads "CL". Sit down at the train you are controlling and honk the horn. You will need to do it just a couple times, probalby 2-3.
  8. If the train is supported (see below for full list of supported trains), your RailDriver will return to display "rd". You may switch window to the connector and see the name of the train being displayed.
  9. That's it. Enjoy.

RailDriver Key Legends

See here for key legeneds for RailDriver function keys. Download and open the file with Google Docs.

FAQ & Common Issues

How to switch train/cab during a session?

  1. To switch train/cab in session. Click the top right most function key (to the left of the "UP" key of the up-down combo key.)
  2. Observe the RailDriver LED display "CL" again.
  3. You can now sit down in another train and repeat the calibration step (step 7. above).

The lever ran away or does not respond to commanded position

This should only happen in rare cases and intermittent. In this case, simply tapping the keyboard key assoicated with the lever should re-sync it. For example, if the automatic brake lever ran away, tapping automatic brake increase/decrease key on the keyboard should get it back in sync.

If this happens consistently for a certain train, please report it in Issues.

TSW status shows "Waiting For Session" while in session

Sometimes the connector will fail to connect to TSW. Simply restart the connector mid-session should fix this. The connector will directly enter calibration mode and you can proceed with step 7. in Getting Started.

This should be improved in following releases.

The connector mis-identifies my train

Unfortunately, due to the nature of the program, this may happen. This can be solved by restarting the connector and re-calibrate.

Supported Trains and Functionalities

For now, the focus has been on supporting the control levers in the train. Limited buttons are supported (Alerter, Bell, Sand etc.). More supports are yet to come.

The full list of supported trains and their respective packages:

Known Issues and Limitations

Building

To build this from source, Visual Studio 2019, C# WindowsForm Development Option is needed.

Credits

Thanks to:

For their contributions and feedbacks.

Big shout-out to crrispy on Steam. The detailed scripts really inspired this work. You can find them at here. Thread on RailsimFR (in french)

Related Links

Train Sim World on Steam

Steam TSW RailDriver Thread

Railsim-FR Discussion For TSWRDConnector

RailDriver Website

Memory.dll Library (GPL-3.0 Licensed)

License

GPL-3