FrogTools/en

De VlmWiki

Introduction

Inside Frogtools.png

Frogtools is a virtual sailing toolkit to be used on the Virtual Loup de Mer website. This software's concept stemms on two ideas. It should first make your interacting with the VLM interface the most intuitive possible, it should also enable you to operate all elementary tasks in a very limited number of mouse moves, particularly when you're in a hurry. What would be my position in two hours from now? What is the wind's rotation? Can I safely go on errands while my boat is sailing through reefs?

Using Frogtools implies your previous knowledge of VLM's rules and practices. For more information on those, refer to the orignal VLM Wiki.

You should previously be a VLM member and already have created a boat on VLM. Boat1.gif

Installation

Warning: Frogtools is fully operational on PCs (Windows 7, Vista and XP) with Internet Explorer 8 or Firefox 4 and on Mac (OS X, 10.6 and 10.7) with Safari.

Upon your first entering Frogtools on a PC, the system might request you to automatically download an updated version of Silverlight. On a Mac, you need to previously download Silverlight.

Silverlight is the operating language in Frogtools. It is a kind of 'Flash' equivalent with a much more powerful engine. It implies that a number of functions and computing operations will occur on your machine rather than on the VLM mainframe.

For more information:

How to access Frogtools: http://silverlight.virtual-loup-de-mer.org/frogtools.html

Home page

Page d'accueil.jpg

When entering the Frogtools homepage, you need only login on your VLM account. The 'Connexion' button is at the upper right hand on the page.


Connexion.jpg

Connexion

A window opens up for you to enter your VLM ID (an email address) and your VLM password. These two can be memorized on your browser for a rolling seven days by ticking the appropriate checkbox. Click OK to start.


Fenêtre Flotte.jpg

Fleet (Flotte)

A new window opens up which lists your VLM boats, together with a Frogtools bonus: last line is for a spectator boat which would allow you looking at a race even without entering it or following up your opponents when you have already arrived and are enjoying your beer.

If a boat is not enrolled in a race, it is not clickable. It would appear as "Mooring" (Au ponton) in the "Race" (Course) column. You'd first have to choose a race, by clicking the "On-going races" (Les courses à l'affiche) button.

Courses affiche.jpg

A new window opens up displaying all on-going and scheduled races. Click on the race boards to scan them. All rellevant information would show underneath race maps. You can then opt for two different modes. "Onlooker" (Spectateur) if you'd only want to follow-up the on-going race. Should the race already be closed, this would be the only possibility. Or "Join" (Participer), should you want to participate. A list would then display all your presently "Mooring" boats, for you to choose the one to enter the race.

If one of your boats is entered in a race, it shows in the "Race" (Course) column. You can click its line to select the race.

This would open up the Frogtools main page for the just selected boat/race.

Main Page

All tools necessary for sailing your boat are displayed on the Frogtools main page. Let's review them.

Page principale.jpg

MAP

The default map is the " VLM Map " (Carte VLM). It is the most sailproof map, to be used for visual navigation along the coasts. When at large, you could choose the "Reliefs" or the "Géo" maps, which display more information about the sailed through areas. There are specific checkboxes in the upper right corner frame for you to choose them. More fun displays are planned in the future.

Cartes.jpg

In the same frame a toggle button shows for you to get rid of your opponents' pixels (which prooves handy when sailing near to coasts in order not to be overcrowded by their traces). Untick the "Showing opponents" (Concurrents visibles) checkbox for this matter.

Wind arrows have similar caracteristics as those on VLM (color depending on force).

A zoom situated at bottom right corner activates by rollover. You can also double-click at any location in the map to zoom in (beware not to click to fast, for this would place a way-point on the map at the click's location... we'll review this later on). You could also use your mouse wheel for zooming in or out (speed to be tuned in your computer's preference panel). Near to the zoom is an arrowed circle to move the map. You can also move the map by gliding it with a left button down mouse move. On the bottom right of the circle, a number shows the zoom position. The circle allows you to rotate the map on its axis (click on the circle, keep button down, rotate). To get back to North orientation, click the small "Reset North" bottom left arrow. Zoom.jpg

The meteo toolbar is on the right. It displays wind data as available on VLM. You can scan it in three different ways: gliding the cursor by the hour (use the up and down arrows on your keyboard); gliding the cursor in an accelerated move up to 116h (maximum available on VLM); clicking the toolbar, which shows every three hours. Note that the cursor will stop at 8h during the meteo transition (when only provisional data is available for about 40').

Barre MTO.jpg

A last display on the map is the "the Frame" (you can move it with the mouse) which displays the mouse cursor's (not the boat's) coordinates on the map as well as wind direction and force at that location. Cartouche.jpg

Way-points and traces: you can double-click (left for PCs) on any point on the map in order to set a way-point. Its coordinates automatically show in the "WP Perso" display (see further on). Should you want to keep this WP as an aim for your boat, don't forget to check the "Validation WP" checkbox in the vertical toolbar at left. The active WP is shown as a double circled flashing red point whereas an inactive WP shows as a single circled static black point. WP perso.jpg

Showing orthodromic and loxodromic traces from and to any point on the map: right click and gliding the mouse for PCs; ctrl-click and gliding the mouse for Macs. Ortho and loxo bearings would show in "the Frame" together with rellevant nautical mileage. Beware that these indications will stay in "the Frame" if you don't erase them before changing boats. The traces are magnetized on your boat's location cross within 10 pixels of it: should you click within this range, the trace would automatically start from the boat's cross.

Cap ortho.jpg

New in the 0.6.5 version: at the end of the trace are displayed indications of bearing, wind direction and wind speed, which should permit spying on your valued opponents (hardly fair play, Frog!).

Your boat: its icon proudly stands above the ridiculous crowd of your valued opponents' and altogether friends' pixels. The cross displaying its exact location is positioned at its bowsprit end.

Bateau.jpg

Several sets of data start from that cross:

- The boat's wind polar is drawn (solid line) and smothed to the degree.

- Two dotted grey lines show the best upwind and downwind bearings.

- The black dotted line is the reckoning, which ends with a small black circle and an indication of mileage nearby. This esteem can vary on demand (in the upper horizontal green toolbar).

- Red dots on your trace are separated by 12 vacations, generally an hour for races with 5mn vacations, but possibly 12' for races with 1mn vacations, obviously.

You can make a selection of your preferred opponents' pixels to show on your map, by checking their lines in the ranking list (see "Ranking" (Classement) in the upper right corner). They'd show by their names rather than by their numbers.

Gates. You probably noticed that some (vicious?) race artists make a point of locating mandatory gates which constraint you sailing on improbable routes rather than the direct obvious way. These gates show on the race map, complete with their exotic specificities.

So-called "regular" gates can be crossed in any direction, including a touch and go (T&G) :

- next gate to cross in a violet color line

WP prochain.jpg


- further incoming gates in an orange color line

WP orange.jpg


- already crossed gates don't diseppear (as on the VLM interface) but show in a light green color line

WP passé.jpg


- ice gate : the boat has to show up at least once on the North (or South) side of this gate

Porte glaces.jpg


When a gate should be crossed in a mandatory direction, this shows by an arrow:

- mandatory direction gate with possible touch and go

Porte sens.jpg

- mandatory direction gate without u-turn

Porte sens R.jpg

Finally, some gates don't have a mandatory crossing direction but do not allow touch and goes

Porte R.jpg

Gimmick: as the validation status for a gate is a VLM data, whereas a gate is green it means it's been cleared and you can proceed with the end of the race.

For direct access to the VLM website, click the VLM Logo (two red sails) showing at the upper left of the window.


TOOL BARS

The upper horizontal white toolbar includes:

- four left tabs: the default present page Tcv Web, and three others for Routing (Routage), Tools (Outils) and Races (Courses) which we'll review further on BarreHB gauche.jpg

- boat and race data in following order: boat type - boat name - race ranking - race name BarreHB centre.jpg

- four buttons at right: "Wiki", for direct access to this page; "Forum", that all so directly sends you to La Taverne; "Fleet" (Flotte), which opens up the previously reviewed window for you to change boats/races; "Logout" (Deconnexion) (to be used with caution, as Frog would stroke Yikes.gif). At the extreme upper right, a small icon (blue square with blue arrow) leads to full screen mode. Note that Microsoft added a security which disables most keyboard entries in order to prevent accidental data entry when in full screen mode. Mouse data entry is still available. BarreHB droite.jpg

The horizontal green toolbar, right beneath the white toolbar, includes:

At left:

Barre HV gauche.jpg

- The " Refresh " (Actualiser) button for map data, winds, boats positions, that are updated every 5 minutes (or 1 mn, depending on race vacations). When rolling your mouse cursor over this button, your last refresh time will show. This refresh button has two modes: when clicking the orange cross at left, you refresh and re-center on your boat; when clicking on the right side, your refresh at the same position on the map.

- At right of the Refresh button, time is displayed local (your computer's) on the upper line, UTC on the bottom line.

- A countdown to next VLM mainframe vacation. Hey, keep cool, don't refresh at zero Nono.gif, this would cause the map to freeze. Just wait until... 299 (or 59)!

- A Frog, of course, which, when clicked, displays a number of race data. The opening window has three tabs.

The default "Infos" (Bateau) tab, includes your boat's sailing data (distance to your (or next race) WP, ortho bearing and closing speed to this same WP), best upwind and downwind speeds for your boat with present wind conditions, and the mysterious port and starboard VMGs (VMG Babord and VMG Tribord) to be still revealed by Captain.gif Frog star.gif.

The second "Stats" (Course) tab, displays data about your presently on-going race: distance travelled (loch) and average speed since start, ETA on your next WP, date and time of race start, and finally your race duration.

The third "System" (Serveur) tab, shows the race Stop&Go penalty time, or, should you have run aground, a red banner for the time lapse untill possible restart. Name of the mainframe you're connected to also shows, together with -most usefull- the last operational wind data time.

Beware that all times displayed in this Frog are local (your computer's). Clicking the red cross, or the Frog again, would close it.

       Fenêtre grenouille1.jpg          Fenêtre grenouille2.jpg          Fenêtre grenouille3.jpg

- The Reckoning frame is tune to a number of vacations which you can set in two different ways: either step by step by using the up and down arrows beside, or by entering the number of vacations. The time displayed besides is the resulting amount of time for the reckoning, according to vacation duration.

- The Lighthouse icon is the visual and sound alarm for running aground. A red flashing circle would show for the whole Stop&Go duration. A bad weather and seagulls tune would be heared for a while. The Frog window would open up (on the System tab) with display of Tapr.gif Stop&Go remaining time Tapl.gif, to be occasionally refreshed by gamer.


At right on the horizontal green toolbar:

Barre HV droite.jpg

- The " Ghost " (Traces Externes) icon activates (or disables) boat traces you previously saved either as routing ghosts (see "Routing"), or as previous races boat data with the "Save a VLM boat trace" in the "Tools" page. You can decide the type of trace to show (fixed, mixte...), choose its icon and its color.

- The " Podium " (Classement) icon opens up the race ranking page. The top figure data includes "Arrived boats" (Bateaux arrivés), "Running boats" (Bateaux en coure) and "Entered boats" (Concurrents engagés). The right hand menu unfolds for you to choose to display a list of running boats (Bateaux en course), arrived boats (Bateaux Arrivés), timed-out boats (Bateaux hors temps), aborted boats ( Bateaux ABD), etc.

The data shown are those in VLM. Just note that the first column in this list is for checking those boats you want to show on your map. Don't forget to validate at the bottom of the form, and to refresh afterwards. As in native VLM, only 31 boats (including yours) can be shown on the map. Boats aground show in red in the list. No WP ranking is available, as VLM developers are still working on it. To exit this form, click the "Exit" (Quitter) button at the bottom right, or the cross at upper right.

Classement.jpg

- The " Wind Polar " (Polaire) icon directly opens up your boat's wind polar scheme, shortcutting the "Tools" (Outils) page.

- The " Steering Wheel " (Pilototo) icon opens up a left hand window for you to use automatic pilot programming. This works just as the native VLM pilot, with a slightly different display. Entering data has to follow up the line frame, for automatic data entry checks.

The "Date" (Date) column fills in either by entering figures with the keyboard or by selecting the date on the pop-up calender.

The "Time" (Heure) colum has a similar operating process, keyboard entry or pop-up clock clicking. Elevator buttons allow for precise checking on the unfolding time displays. Check the small green arrow when finished.

Beware that all times displayed are your computer's.

The "Order" (Ordre) column has you choosing the type in the unfolding menu. The next columns would show according to the order type selected.

You need then fill in the necessary data. Gimmick: these can be automatically filled in by double-clicking the map at your chosen waypoint's location: WP coordinates for VMG or VBVMG; bearing for Ortho or Fixed bearing (Cap fixe); wind angle for angle regulation (RA).

Similarly to the VLM interface, the Ortho, VMG or VBVMG modes would allow you to enter an exit bearing in the "@WP" column for your boat to sail after the WP has been reached. The default exit bearing (@-1) would lead to next race WP.

The "Status" column would show the order line current operational status, whether pending (en attente), finished (terminé) or void (vide).

The "RAZ" column enables you to erase the data line and return it to "void" status.

Since you filled in the time data, a red banner is showing at the bottom of the pilot window, reading "Modified data to be confirmed" (Données modifiées non validées). You indeed need to confirm the new order data by checking the "validation" (Valider) button, for it to become operational. The red banner would then disappear.

Beware: unvalidated orders would disappear whether you would exit the pilot form (by clicking the small bottom arrow or the steering wheel icon), or change boats, without validating.

Foolproof checks would result in the form to become bright red in case of an "impossible" order, just as showing in the following example where an unamed but nonetheless famous frog is desperately trying to enter a 267 degree wind angle!

The "Show reckoning" (Tracer l'estime) button would allow you to check on the just entered pilot orders, thanks to a tentative trace for your boat drawn on the map (with a dotted purple line)... even when you're absent or asleep! The polygons on this trace display your orders positions, which can easily show a defecting one (if any). This reckoning ends 6 hours after your last order, for a maximum 24 hours. Beware: this is valid at the time you entered the orders. All subsequent meteo changes would alter the routes pertaining to your orders, with regards to wind variations. Once your route is checked, the reckoning can disappear by clicking the "Mask reckoning" (Masquer l'estime) button.

Pilototo.jpg