The OpenBveAts Plugin

OpenBveAts is the default train plugin used by OpenBVE when trains lack their own plugin. It simulates a basic version of ATS-SN, ATS-P and ATC. If you want to use this plugin in your train, then simply don’t include the ats.cfg file. This plugin will then be used automatically.

■ 1. Panel Indices

The following panel indices are exposed:

ATS-SN

Panel Index Description Value Range
256 ATS power (ATS電源) 0 - 1
257 ATS actuation (ATS動作) 0 - 2
258 ATS actuation (ATS動作) 0 - 1

ATS-P

Panel Index Description Value Range
259 P power (P電源) 0 - 1
260 pattern approach (パターン接近) 0 - 1
261 brake release (ブレーキ開放) 0 - 1
262 brake application (ブレーキ動作) 0 - 1
263 ATS-P 0 - 1
264 failure (故障) 0 - 1

ATC speed indicator (panel index 271)

Value Description
0 ATC not available
1 0 km/h
2 15 km/h
3 25 km/h
4 45 km/h
5 55 km/h
6 65 km/h
7 75 km/h
8 90 km/h
9 100 km/h
10 110 km/h
11 120 km/h
12 ATS is active

■ 2. Sounds

The following sound indices are exposed:

Index File Description Type
0 ats.wav ATS bell looping
1 atscnt.wav ATS chime looping
2 ding.wav ATS-P/ATC bell once
3 toats.wav ATC to ATS once
4 toatc.wav ATS to ATC once
5 eb.wav EB bell looping

■ 3. Beacons

The following beacon types are supported:

Beacon Type 0 (S-Long)

Track.Beacon 0; Object; Signal ; Optional
Object: A positive integer (>=1) representing the beacon structure index to be displayed. Use -1 for no object.
Signal: An integer ranging from 0 to 255 representing the green component of the ambient light. The default value is 160.
Optional: If the optional data is 0, the train switches from ATS-P to ATS-SN. If the optional data is -1, the train stays in its current mode.

When passing this beacon:

Beacon Type 1 (SN-Immediate Stop)

Track.Beacon 1; Object; Signal ; Optional
Object: A positive integer (>=1) representing the beacon structure index to be displayed. Use -1 for no object.
Signal: An integer ranging from 0 to 255 representing the green component of the ambient light. The default value is 160.
Optional: If the optional data is 0, the train switches from ATS-P to ATS-SN. If the optional data is -1, the train stays in its current mode.

When passing this beacon:

Beacon Type 2 (Accidental Departure)

Track.Beacon 2; Object; Signal ; Optional
Object: A positive integer (>=1) representing the beacon structure index to be displayed. Use -1 for no object.
Signal: An integer ranging from 0 to 255 representing the green component of the ambient light. The default value is 160.
Optional: If the optional data is 0, the train switches from ATS-P to ATS-SN. If the optional data is -1, the train stays in its current mode. If the optional data is greater than zero, the beacon only triggers for trains with at most the specified number of cars, and the train switches from ATS-P to ATS-SN.

When passing this beacon:

Beacon Type 3 (ATS-P Pattern Renewal)

Track.Beacon 3; Object; Signal ; Optional
Object: A positive integer (>=1) representing the beacon structure index to be displayed. Use -1 for no object.
Signal: An integer ranging from 0 to 255 representing the green component of the ambient light. The default value is 160.
Optional: If the optional data is 0, the train switches from ATS-SN to ATS-P. If the optional data is -1, the train stays in its current mode.

When passing this beacon:

Beacon Type 4 (ATS-P Immediate Stop)

Track.Beacon 2; Object; Signal ; Optional
Object: A positive integer (>=1) representing the beacon structure index to be displayed. Use -1 for no object.
Signal: An integer ranging from 0 to 255 representing the green component of the ambient light. The default value is 160.
Optional: If the optional data is 0, the train switches from ATS-SN to ATS-P. If the optional data is -1, the train stays in its current mode.

When passing this beacon:

■ 4. Special Beacons

Note: The following beacon types cannot be used directly in routes - They are automatically created by the CSV/RW parser to provide backward compatibility with ATS-P and ATC.

Beacon type 0xFF000001 (ATC track status)

Marks the status of ATC. The optional data has the following meaning:

0 ATC not available
1 ATC available, switch from ATS to ATC
2 ATC available
3 ATC available, switch from ATC to ATS

Beacon type 0xFF000002 (ATC speed limit)

Sets up an ATC speed limit. The optional data has the following meaning:

bits 0-11 Speed in km/h
bits 12-31 Distance in m

Note: All speed limits in the entire route are communicated to the plugin at the beginning of the route, so the plugin keeps a database of known speed limits and then applies them as necessary.

Beacon type 0xFF000003 (ATS-P temporary speed limit)

Sets up an ATS-P temporary speed limit. The optional data has the following meaning:

bits 0-11 Speed in km/h
bits 12-31 Distance in m

Note: All speed limits in the entire route are communicated to the plugin at the beginning of the route, so the plugin keeps a database of known speed limits and then applies them as necessary.

Beacon type 0xFF000004 (ATS-P permanent speed limit)

Sets up an ATS-P permanent speed limit. The optional data is the speed limit in km/h.

■ 5. Keyboard Assignments

The OpenBveAts Plugin uses the following keyboard assignments:

Virtual Key Default Assignment Description
S space Cancels the ATS-SN bell.
A1 insert Cancels the ATS-SN chime.
A2 delete Cancels the EB.
B1 home Cancels the ATS-SN or ATS-P brake application.
B2 delete Activates the temporary ATS-P brake release.
C1 page up Switches from ATC to ATS.
C2 page down Switches from ATS to ATC.
D 2 Enables the safety systems.
E 3 Disables the safety systems.