jsutWaypoints

-----------------------------------------------------------

SYNOPSIS

This script allows a person to create their own customized waypoints while
hosting a game, and save them to disk for later retrieval.

-----------------------------------------------------------

INSTALL

drop the jsutwaypoints.vl2 file in your gamedata/base directory.  set up the
keybinds you want to use.

-----------------------------------------------------------

INSTRUCTIONS

### CREATING WAYPOINTS (only works if hosting)

Bind a key to the jsut Create Waypoint thinger that is added into the 
keybinds.  Host a game.  go stand in a position where you would like to have
a waypoint.  Hit the key you binded to jsut Create Waypoint.  You should 
now have a waypoint that has a number for a name.

### RENAMING WAYPOINTS (only works if hosting)

The number isn't exactly that meaningful, so to rename the number to something
more useful, hit your global chat button, and in the window type

!rename <oldLABEL> <newLABEL>

Where <oldLABEL> is the current label of the waypoing, and <newLABEL> is what you 
want to change the label to.  Alternatively, you can edit the text files that this 
script creates when you save waypoints to fix the names

### SAVING YOUR WAYPOINTS (only works if hosting)

To save all the waypoints that you have created with the keybind (note: waypoints
created using the CC won't be saved correctly), type

!save <FILENAME> <TITLECOMMENT>

in the global or team chat window.  This will write out your waypoints to a file
at jsut/waypoint/<GAMETYPE>/<MAPNAME>/<TEAMNUMBER>/<FILENAME>.wp
This file is plain text and can be edited by the user.

The <TITLECOMMENT> is an optional description of your waypoint file that is displayed 
when you cycle using through waypoints.

### LOADING WAYPOINTS. (works all the time)

To load a set of waypoints for a map, just type

!load <FILENAME>

if you previously saved your o waypoints using "!save o", you can load that same file
by typing "!load o"

alternatively, you can cycle through your waypoint files using the next and previous
waypoint keybinds

### CLEARING WAYPOINTS

!clear

clears all waypoints

### DELETING WAYPOINTS

!delete <LABEL>

Deletes a waypoints using the given label or number.  or you can right click the waypoint
on the CC to delete it.

### Cycle Keybinds

jsutWP Next File
jsutWP Prev File

These two keybinds will cycle you through all the *.wp files in your directory.

### Overlay Keybinds

jsutWP Set Overlay

This keybind will make your current waypoint file in your cycle set always loaded 
and remove it from the cycle set selection.  

WARNING - you can still only have 16 waypoints on the screen at a time, so if you are 
using this, make sure that your overlay file waypoints + the largest non-overlay
file doesn't have more then 16 points.  otherwise points from the non-overlay file
will not appear.

### Master keybinds

jsutWP Set Master
jsutWP Load Master

The set keybind will make your current waypoint file your master waypoint file.  
Later when you cycle onto other waypoint files you can hit the load master keybind to instantly redisplay the set master.

-----------------------------------------------------------

WP FILE LAYOUT

pretty simple, basically it's this:

postition^label

you can also comment out lines by prefixing them with a '#' , like

#this is a comment


The first line of the file is where the Title Comment is stored, and is displayed in the msg hud as you cycle through your waypoints.

-----------------------------------------------------------

LIMITATIONS

I can't figure out how to extract a position from a waypoint created using the CC, or
from any normally created waypoint for that matter.   So you have to create waypoints
using the keybind.

You can only have 16 waypoints.  This is in the t2 code in the executable.  Nothing to 
be done about it.

-----------------------------------------------------------

BUGS

creating waypoints in observer mode, or before you spawn are untested.  I have no idea 
what will happen if you try doing weird shit, so don't blame me if it screws up.  you can
tell me about weird stuff that happens and i'll do my best to fix it though.

i'm sure there is other stuff too.  /msg jsut on irc.dynamix.com, or email jsut@kabob.ca