Abi's Carting Hud Manual v3

My simple Ponyplay HUD, there are many like it but this one is mine. ^.^ This hud is designed for issuing whip commands while carting, or running whip circle and other training exercises. The HUD features a menu as well as a configuration notecard for easy customisation.

HUD Overview


Whip commands are issued with the arrow icons and centre icon. ▲ for go (1 whip crack,) ⬣ the centre icon for stop (2 whip cracks,) ◀ for left (3 whip cracks,) ▶ for right (4 whip cracks,) ▼ for reverse (5 whip cracks.) ↶ ↷ either side of the ▲ (go) are rein commands for left and right.

The stopwatch icon on the right is for the “go faster” command, while the little turtle is for slow down. The bottom right icon is the trainer whistle. This is intended for signalling sim crossings and warning of danger, but it can be used for basically anything you like.

Top Bar


The icons on the top bar toggle several features on and off. The two icons on the top right of the hud are for minimising and quickly detaching the HUD.

The cog icon opens the main menu allowing quick customisation options.

The little teacher hat icon activates training mode. While in training mode the hud will show hints in OOC when missing whip commands to help newcomers to sl ponyplay.

The crossing warning shows a red icon when near a sim crossing. This is designed for mainland carting and will only function while seated to reduce lag.

Emote toggle will disable the text emotes when clicking on any of the commands, instead only playing the sound effect.

Animation toggle will disable the animations when using whip commands.

Riding crop toggle will add or remove an rlv folder containing your whip or riding crop. This feature requires rlv enabled in your viewer and a folder defined in the notecard to function.

The two icons on the top right of the hud are for minimising and quickly detaching the HUD.


The menu can be accessed by clicking the little cog icon on the very top left of the hud. This menu allows some limited customisation on the fly.

Both the whip and reins sound effect volume can be changed via their respective menu. Your preferred pronoun can be easily changed with each button.

The trainer roleplay name and pronoun can be changed and reset via the identity menu. This changes the name that is shown when a whip command is issued. (by default your second life display name is used.)

The UI menu allows you to change the hud texture and colour scheme from a list of predefined options. Further customisation is possible via the settings notecard inside the hud.

Speed Panel


Included with the hud is the cart speedometer script, this is intended to be placed inside a mg brand pony cart. The speedometer feature of the hud will only function while seated on an mg brand cart with the script installed.

When activated a panel on the side of the hud will open showing the speed and direction of each pony strapped into the cart. Each icon can be clicked for the pony’s name to avoid any confusion. (pony names are not in the rc1 build but are intended to be added later on the full release version.)

Panel examples on a 1, 2, 3 and 4 pony cart.

By default this panel opens on the right side of the hud but this can be customised in the settings notecard. It can be set to open on any of the four sides of the hud, top, bottom, left or right.

Setup

To set up you just need to place the script inside the root prim of a MG Dogcart, MG Sulky, MG Phaeton or MG Chariot pony cart. For custom carts you must ensure each strap of the cart is named in the following format. (not case sensitive)

1 pony cart

Strap Name = Strap

2 pony cart

Pony 1 strap name = Left
Pony 2 Strap name = Right

3 pony cart

Pony 1 strap name = Middle
Pony 2 strap name = right
ony 3 strap name = left

4 pony cart

Pony 1 = front left
Pony 2 = front right
pony 3 = rear left
pony 4 = rear right

Cart Lights


When seated on a compatible cart the headlight icon will appear on the bottom right next to the whistle icon. Pressing it will toggle the headlights on and off.

Setup

The cart light system requires some setup and advanced building knowledge and is intended for custom cart builds. It will not work on a default mg brand pony cart.

The provided light script and settings notecard must be placed in a linked prim to act as a light switch. DO NOT place these in the carts root prim. Please see the provided build example for help setting up.

Each light consists of two parts, a light emitter and a “glass” piece for glow effects. These can be the same prim depending on your build.

The following keywords must be in the description of the prim acting as the glass (for the glow effect) and/or point light.

Type Glass Light Emitter
Headlight glass light
Brake light bl_glass bl_light
Indicator light (left) id_glass_l id_light_l
Indicator light (right) id_glass_r id_light_r
Indicator light (both) id_glass id_light
Reverse light rev_glass rev_light

API


It was requested I add an api for controlling scripted devices with whip commands. It's a fairly simple api with only a few messages outputted on the below channel in the below format.

API CHANNEL = -1887702080

REINS|<3/4/5>|<Training Mode>

WHIP SIGNAL|<1/2/3/4/5/6/7>|<Training Mode>