VSR for VATSIM
MSFS 2020 toolbar app for VATSIM
Click to play promo videoIMPORTANT Notice 21st March 2023
MSFS SU12 appears to render the fonts in VR incorrectly; there is a fix for VSR available as a beta version under the link on the right
The key consideration is that this is a release of both the server and the toolbar app; the latter has changes that allows for the content to be resized.
This will address any issues if SU12 is not fixed by release. However, with the current release, this does allow you to change the size in the config for the default and the VR simulator states. Choosing values between 1 and 1.5 give best results, values are unbounded. If the SU12 bug persists then a value of 2.5 in the VR settings will fix it. Note there are some quirks with resizing, the zoom with mouse wheel on the map for instance needs your cursor to be centred about 25% to the NW of your aircraft!
A major change is that the configuration is now maintained in the registry - if you are familiar with Regedit then the keys are at: HKEY_CURRENT_USER\SOFTWARE\DeltaBravoZulu\VSR. The server will attempt to import your existing config from config.ini if it is in the same directory. To reverse and retry the process delete this key.
New documentation is at https://docs.vsrsoftware.com
Description
VSR is a toolbar app for Microsoft Flight Simulator 2020 that allows you to check which air traffic controllers are online when flying on the VATSIM Network. You can easily change to a frequency with a single click, or place a frequency on standby ready to change when requested to by ATC. The app also send & receives messages to and from the VATSIM network.
This app is not associated or endorsed by the VATSIM Network
Getting Started
*** Please note ***
The install process is now via an installer programme, this will:
- Install latest release of the server
- Install latest release of the VSR Toolbar app
- Install latest release of the VSR/vPilot messaging DLL (and check it is installed correctly)
- Install new vPilot inbound message sounds
- Enable configuration of the server with simBrief, VATSIM and CHECKWX data
Download the zip file under latest release link on the right, unzip & run vsrinstaller,exe from the unzipped folder, as shown:
You can check in the simulator to ensure the toolbar app is installed and loaded:
Running the server
Server will wait for MSFS to start.
Once the flight is started click on the headset icon in the toolbar,
The app should load and get updated with your current position.
To test the app, click on the Unicom frequency 122.800 and your Comm1 radio should change to this frequency.
Virus warnings
Some AV solutions have issues with the installer;
If this occurs, run the installer as administrator and allow the execution
vPilot integration - Important requirement for messages from Vatsim network
The installer should install in the default directory - these instructions are for manual installation:
The server integrates with vPilot using a plug -in DLL - this needs to be copied to the vPilot\plugins\ folder, if vPilot has been installed without changes then this can be found under
C:\Users[your username]\AppData\Local\vPilot\Plugins.
Stop and start vPilot, the reconnect to the network.
If the DLL is correctly installed then the vPilot started message will appear in the message panel in the app; the further message will appear once vPilot is connected to the VATSIM network.
If the messages do not appear then check that correct permissions are set for for the DLL (see below under Known issues)
Dependencies
- Microsoft Flight Simulator 2020
- Windows 10 and above
- vPilot to connect to VATSIM and relay messages
- Newtonsoft.json.dll (for messaging) - installed with vPilot
- SimConnect
Installing
- Download and run latest installer
Executing program
- Run the VSR.EXE in the vs-radio-toolbar\server directory to start the app
- Start MSFS 2020, start a flight, click on VSR headset icon in the toolbat to launch the app
- A splash screen will load, if the server is correctly installed and running it will be displayed
Known issues
-
If you start a new flight after returning to the main simulator menu, then please restart the server from the config menu to ensure the correct aircraft location is shown in VSR.
-
AFTER CTD restart the VSR server. This can be done from U/I using debug menu in left hand header above Airports table. Failure to restart might cause the App from updating frequencies and getting postion updates from Sim.
-
Crash to desktop issues have been reported with the Fenix A320; changing the memory allocations as per these instructions may resolve this issue.
-
Controllers may appear above the Unicom frequency and on the map at 0 miles distance, this is caused by the VATSIM feed data baing out of sync and is designed to ensure that controllers are always visible irrespective of the feed. This is normally shortlived and disappears with a refresh about a few minutes when the controller is assigned the correct location.
-
If you are not receiving messages from Vatsim, then the DLL may require additional permissions to run; right click on the DLL and ensure that the unblock security check box, if shown, has been checked . Stop and start vPilot, the reconnect to the network.
• Some icons do not render correctly in MSFS; this is due to limitations in the MSFS internal browser. This due to the style sheets in the tabulator framework used for the tables; it is on the backlog to resolve (if possible).
Authors
- David Black (main server and app)
- Craig Farrell (vPilot plug-in)
Buy me a Coffee
Discord channel
Acknowledgments
- Craig Farrell for developing the vPilot plug-in
- The Leaflet map libraries
- The Tabulator framework
- The VAT-Spy data project
- Maximus and others for helping simplify the MSFS toolbar app environment
- Ross Carlson's vPilot project
- Last but not least, the amazing group of people who joined and Beta programme and tested this thing until it was good to go !