The right companion for your virtual regattas on the so called online game.
Report bug
·
Request feature
·
Discuss
The Chart Application has been developed to display the boats polars of the Virtual Regatta Offshore® online game. It also provides a custom polars generator for those using third-party routers.
The Chart Application provides an HTTP GET API so you can call it from a third party application or from an extension like the VR Dashboard.
However, it is not designed nor expected to be used in real life navigation.
- Quick start
- Bugs and feature requests
- Documentation
- HTTP GET API
- Contributing
- Versioning
- Related repositories
- Copyright and license
All you have to do is to go to the VRPolarsChart homepage, and then:
- Pick up a race in the upper race selector,
- Select the sails you are currently racing with,
- Select the boat options subscribed,
- Set the TWS (True Wind Speed),
- Drag the blue radius to set the TWA (True Wind Angle),
- Read the Boat Speed.
OR
make your life easy, if you use the VR Dashboard Chrome Extension, by simply click on the ⛵ icon to get the Polars Chart ready with your actual ingame setup.
Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.
The Apps come along with an Help section which attempts to describe how to use the Apps and answer the questions I mostly receive. Before requesting some help, please read the Help section and search for answers there first. If your questions remain unanswered, only then contact me here.
The Chart Application can be call with HTTP Parameters over its URL.
Accepted URL Parameters :
| Parameter | Type | Description |
|---|---|---|
race_id |
String | Set the current race to the race with the provided Id |
twa |
Integer | Set the TWA to the provided value. Rounded to the closest integer |
tws |
Decimal | Set the TWS to the provided value. Rounded to the closest hundredth (2 decimal digits) |
light |
Boolean | Set the Light wind sails option to checked |
reach |
Boolean | Set the Reaching sail option to checked |
heavy |
Boolean | Set the Strong wind sails option to checked |
foil |
Boolean | Set the Foils option to checked |
hull |
Boolean | Set the Hull polish option to checked |
utm_source |
String | Unique Source Name |
Numerical parameters expect the dot character . as the decimal separator.
Boolean parameters are case insensitive, and considers the following to be truthy: true, yes, y, 1.
Any other value is falsy.
Please read through the contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.
All HTML, CSS and Javascript should conform to the Code Guide.
Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org/.
For transparency into the release cycle and in striving to maintain backward compatibility, The Polars Chart and Polars Generator Apps are maintained under the Semantic Versioning guidelines.
See the Releases section of the GitHub project for changelogs for each release version of VRPolarsChart.
The dedicated data files such as the boat polars, the races have been moved to the VRPolarsChartData GitHub repository. When investigating on a particuliar issue, please check to gather the latest data files, and check if the bug is related to the application source code or related to the data. If the bug is not yet created/documented, then make sure to create the issue on the right repository.
Code and documentation Copyright 2017–2020 VRPolarsChart Authors. Code and docs released under the GNU General Public License v3.0.