From VRTool wiki
Revision as of 18:14, 5 February 2015 by Omar (talk | contribs) (Boat data)
Jump to: navigation, search

VRtool needs data to perform calculations. Those have to be loaded in the program before you can use the track designer or the weather routing module, for example. These data files are charts, wind forecasts and polars. All VRTool data files are in text format, to allow easy editing and repairing files.


VRTool uses a custom vector chart format, in ASCII text, with extension .CHT. The program comes with a simple world map (world3.cht).

To load a vector chart, use menu option File > Open Vector Chart... Multiple charts can be open at the same time, by using File > Merge Vector Chart...

A good set of charts covering the whole planet is the GSHHS database (Global Self-consistent, Hierarchical, High-resolution Shoreline Database [1])

Version 2.3.4 of the database was released Jan. 1, 2015.

Translation of the GSHHS files to CHT format are available for download below.

Includes lakes, islands in lakes, antarctic ice front and ground line. Files are zipped.

Intermediate and High quality are OK for virtual regattas. Full resolution is probably too much for most computers. Download, save and unzip to VRTool program folder (p.e. c:\program files (x86)\VRTool).

Note that these charts are NOT intended to be used for real NAVIGATION. Use at your own risk.

Thanks Mr David Taylor for posting the Mapping Tools, used in the conversion [2]

The following image illustrates the level of detail of each file (Guanabara Bay - 20 NM across) [img]

Wind forecasts

These can be obtained from a number of sources. Ultimately, all wind forecasts come from the GFS ( Global Forecast System, a world weather model updated NOAA every six hours), but regatta game providers do some processing in NOAA data. VRTool can use winds from:

  • Downloaded directly from the NOAA server using the vrtool's built-in NOAA import module. This method gives the earliest possible forecast updates, as the NOAA server is also the source for the other methods. This is also the most convenient way to import a grib covering the whole area of a race leg. Once the grib boundaries have been set in the NOAA import module, vrtool remembers them for subesquent imports. This makes subsequent updating of the wind grid a one-click process.
  • Load a GRIB2 file ( p.e. files downloaded by UGrib or ZyGrib). You can use .grb or .grb.bz2 (compressed gribs).
  • If you use the Firefox browser you can extract Virtual Regatta game winds from the browser cache using the Firefox cache importer built into VRTool. (This "back-door" method depends on both the game file format and the browser cache management - it may stop working unexpectedly if either of these changes). Read more about this method in this tutorial.

After loading the wind forecasts you may use buttons to select a given forecast. Use buttons Ctrl-1 to Ctrl-7 or the buttons in the toolbar to display successive wind forecast periods.


Polars allow the calculation of the boat speed for a given wind speed and wind angle.

Vrtool can use two kinds of polar chart databases.

  • Multi-sail polars - This is a new format with a set of polar data for each sail. This is the preferred format. Multi-sail polar database files have extension XML, and can be produced, imported and edited using the vrtool polar studio.
  • Merged sail polars - This compact polar database format is available from internet sites (which?). Extension .CSV.

Select the file and click load. Also select which database type you are using in the Winds > Polars tab.

Boat data

VRTool has advanced features that can import boat data from the following sources, and use it to plot tracks on the chart:

  • VRTool's ToolbarGPS.gif GPS module contains a TCP/IP client that can read an NMEA data stream from on an on-board wired or wireless TCP/IP network. VRTool can plot the position of your boat (using NMEA GPS messages) and nearby boats (using AIS messages).
  • The same facility can read game data streamed as NMEA messages over the internet via a TCP/IP proxy server. Your friends boats can also be plotted if the proxy serves these as NMEA AIS messages.
  • From an on-board NMEA network through a hard-wired COM port.
  • From NMEA messages in a text file.
  • For Virtual Regatta games: VRTool can be configured to poll the game server directly to retrieve the position, course and speed of your boat and your friends.
  • For Virtual Regatta games: VRTool can recover boat positions (and game weather) from the Firefox browser cache, provided you are running the game console in Firefox (obsolete).

Detailed instructions for each of these methods are here.