------------------------+------------------------
            the
                __      __
               /__)  / (  _ _ ' _/ _
              / ( ()/)__)( / //)/_)
                             /
                               for zMUD        

            distribution version 1.1
     http://www.benturner.com/mud/scripts/

------------------------+------------------------

                     GENERAL

   These generic ROM/Merc scripts, available at
<URL:http://www.benturner.com/stick/scripts/>,
have been made to work with the latest version of
zMUD, which can be found at Zugg's site,
<URL:http://www.zuggsoft.com/zmud/>.

   I'm only going to bother keeping the scripts
updated with the latest version, as it'll allow me
to do more with less worry.  If you crash, upgrade
your version of zMUD.  Most likely, the old version
of zMUD didn't like the scripts written for a newer
one.  If something doesn't work, just remove it in
your own version.  Don't know how?  Good way to
learn.  I am not obligated to help you figure out
these scripts.

   Why am I doing this?  Because I want to contribute
to the zMUD/MUD community, as that's really the only
reason I still play on MUDs.  The scripts are so you
have some ideas for new things to add yourself, and
so you don't have to add things already done by
someone else.  You're not getting the SpellBot or
the Ozycoaster though, or the (ooh) immortal version.
Sorry! ;)


                       -*-

                  AUTHOR CREDITS

   Anyone who uses existing scripting I've done
myself must retain credits to me if distributed
in any form or fashion, whether it be for someone
else's version of the scripts, or for passing one's
scripts to a friend.  I know it may seem a hassle,
but claiming ownership for something you didn't make
is cheesy.

   Anyone and everyone are allowed to modify the
scripts to their liking.  However, I will not be
held accountable for any mistakes which someone
else makes in editing my scripts.  I don't want
someone blaming me for their editing an alias
causing a spam on a public channel.  'Kay?


                       -*-

                      ABUSE

   No one is allowed to abuse the scripts either as
a user or as someone attacking someone using the
scripts.  Since scripts rely on textual input for
processing, it is easy to fool scripts into doing
stupid things.  Since I should have your e-mail
address for you to receive the scripts, I should
be able to take action against the abuser via e-mail
if I can't do it through the MUD.

   It ain't cool to fuck with other people.  Leave
other people alone.  Or I'll fuck with you. :)  And
you really, really do not want that.


                       -*-

                   INSTALLATION

   To install, just unzip into the zMUD directory
and set your character's inherited settings to
rs11.mud (what the settings come as).  Use your
own settings file for the primary settings.  You
don't want to overwrite the base settings.  Place
all of the included files in the .zip file into
your zMUD directory.  These files are necessary to
have, as the absence of them will cause an I/O error
if zMUD tries to access them.

   You'll need to uncheck under General settings the
eval [] box.  Turn Strip " Quotes ON under General.

   Also, set your special characters this way.  If
they're different, you'll have to manually adjust
the script.  I tried to choose characters that
interfere very little with normal operation.  You
can turn off parsing temporarily if you have to,
remember.  First column is whether it's activated
or not (Y/N), second is the character, third is
what it is.

 Y # Command Char
 Y | Separator Char
 Y ` Variable Char
 Y % Parameter Char
 N   Focus Char
 N   Movement Char
 N   History Char
 Y ^ Quote Char

   Go to the menu Actions -> Make Button... and
then select the Location tab.  Select it to
anything except "None" so your buttons will show.

   Remove the variable `Rob altogether.  Remove
Rob from `Member and `Tester.

   Run the 'configure' alias when you start, to
set up your variables and files for your script.
I'm trying to make the scripts easier to configure
for people, so if you have any ideas, please send
them my way.

                       -*-

                      USAGE

   One thing to remember when using the aliases
is that aliases marked "#NOOP Script" are used
by the script and not by the user.  Only use
the aliases marked "#NOOP User" or even
"#NOOP Script or User" or else something is
bound to go wrong.  By the way, #NOOP is the
command in zMUD which does nothing.  Think of
it as a programming language comment.

                       -*-

                     FEATURES

   The scripts include the following features:

. Extra AFK (Away From Keyboard) support not
  available in this version of ROM.  Saves tells
  sent to you while you're AFK.  Shows your saved
  tells to you when you return.  Also gives you a
  choice to select a saved title or a random
  title from a text file.

. Aliases like trash (drop and sac equipment),
  door (opens door and goes through it), bulk
  (buys items in bulk, although zMUD allows this
  with the #x command), examples of how to make
  aliases for spells, and spellup (a quick way to
  get ready for battle).

. Example of how to set up a private channel.
  See the "testtell" alias.

. Many speedwalk paths for certain areas.  Not
  complete, for sure, but useful until you make
  your own.

. Spell/skill practicing.  Press the "Prac on"
  button and select which spells and skills
  you'd like automatically used every interval
  of time you specify yourself.

. A useful keypad for lazy adventuring and
  exploring.  Make sure NumLock is on, and use
  the keypad.

. Auto rearm weapon.  Auto-login and reconnect.
  Stay connected.  Tracking of sleep and
  blindness status.  Much more.  See for yourself.

. Tasteful color and font settings (in my
  opinion).

. Examples of how to make a social (explode) and
  how to have random emotes after certain time
  periods elapse.

. Alternative color support.  Here are the colors:

     W1 : plain white, or light grey
     W2 : bright white
     R1 : red
     R2 : bright red/pink
     G1 : green
     G2 : bright green
     B1 : blue
     B2 : dark blue
     Y1 : orange/dark yellow
     Y2 : bright yellow

  Use these by typing `{W1}blahblah.  The curly
  braces are for expanding the variable and ` is
  to signify that it IS a variable.  I myself find
  the MUD's color support easier.


. IRC-like commands, like autofinger, autowhyafk
  (uses 'afkmessage.txt'), and autoreport.  The
  'auto' prefix is to avoid complications.  These
  commands have a user list built in, and you can
  maintain it with the adduser, addsec, userlist,
  and deleteuser commands.  You can disallow
  access to these commands with the Auto Off
  button.  Only permitted people can use the
  commands unless you change it.  For more info
  on how to use these, study the scripts or look
  at the version history at the bottom of this
  document.  Thanks, Stasis, for the ideas.

. Many more features, but I won't list them here.
  Just the main ones.

   I really need your help for adding new features!
If you have ideas, send them to
sitmscripts@benturner.com.  You will receive credit.

   Did you know that using the zMUD editor (Window
-> Editor) is a great way to make good-looking notes?
I had a suggestion to build a GUI for note writing,
but it's already there. :)  And it will send all of
it to the MUD automatically.


                       -*-

                 VERSION CHANGES

v.1.0 beta 1
  -Removed some lingering SpellBot variables.
  -Added better documentation for script installation.
  -Removed some info from my test character,
   ManaMan.  Oops. ;)
  -Changed the highlight name feature to check for
   the variable LoginName instead of %char.
  -The variable Password changed to FingerPW.

v.1.0 beta 2
  -Added 'configure' alias for setting up variables
   at installation.
  -Removed default settings from personal variables
   so they wouldn't be overwritten (oops).
  -Added the detect invis/hidden triggers again.
   They got lost somehow.  Man, these scripts are
   tricky if you aren't careful.
  -Lingering problem in the AFK script fixed.
  -Security improved.  A lot of messages won't
   be parsed as triggers unless sent by the MUD,
   now.  Put ^ in front of the pattern to tell it
   only to trigger if it's at the beginning of a
   line.  I can't get this to work with everything.
  -IRC-like commands like finger, whyafk, report,
   web, e-mail, etc.  Stasis gets credit for ideas.
  -Explode social added.  Timer emotes added for
   each class.
  -Some other little changes which may have screwed
   things up.  Please recheck as much as possible.

v.1.0 beta 3
  -Added some speed menu functions.  Right click on
   the output window to see them.
  -Added example for having a private channel of
   sorts.  Try 'testtell <message>' after adding
   a fellow tester (please change the name of
   the alias if it's to be used for another
   channel you make).
  -Added message notification for adding and
   removing users.
  -When you go blind, the spell 'detect invis'
   won't be cast repeatedly anymore because of
   the ^Someone trigger.  Problems may arise
   if you go link-dead and the blindness wears
   off.
  -Added the picklock alias.
  -Added speed menu commands for adding users,
   deleting users, and viewing the user list.  Can
   also ignore and listen to selected people.
  -Removed the LoginName variable.  Hope this
   doesn't cause problems.  If any LoginName
   references are still around, please notify me.
  -Changed the time variables to reflect the
   MUD's time, not your system time.  There may
   be a problem if you are lagging, since this
   depends on the 'time' command.  This is
   pretty cool, because it takes the MUD's 'time'
   command and converts abbreviations to full
   month/day names.
  -Autoversion command added for the autonomy
   functions.  Tells the person which version of
   the scripts you're currently using.
  -Speed menu button for a spell list.  Make it
   an alias or a button if you prefer.  Stasis's
   idea.
  -Alternative color support added.  There's no
   way to make it easier than it is, except to
   change the names of the variables.
  -Re-equips light source after reconnecting, to
   work around the darkness bug which has yet to
   be fixed.

v.1.0 beta 4
  -The 'configure' alias is more powerful now.
   It sets up all the needed files when you run
   it, so please do that first thing after starting
   zMUD.  Also checks whether you want to
   overwrite your title file, since you may have
   replaced the default titles.  Tell me if you
   have problems using this.
  -Changed the 'door' alias to a picklist, which is
   much more flexible for the many things you can
   do to doors.
  -The immortal version is coming along nicely.
   Considering auto-nochannel, but that's kind of
   dangerous so I remain hesitant.
  -Made a small change to the example for personal
   channels.  Color for the testtell alias, so
   it's easier to distinguish.
  -Experimenting with the #PICK and #CASE commands.
   These are fun for randomizing messages and
   stuff like that. :)
  -Changed 'adduser' alias to 'addmember'.
  -Finally got security levels added for autonomy
   commands.  What occurs is you use this syntax
   to add a player to a security level:

      addsec <playername> <security level>

   The security levels are 1 through 4.

      1:  autoemail, autoweb
      2:  autoreport, autoversion
      3:  autofinger, autowhyafk
      4:  autopage
  -Added a way to check for zMUD scripts.
   Use the 'check' alias on someone.  This will
   trigger the 'Check' class of triggers, using
   the variable Version.
  -Added 'autohelp', 'autoabout', and 'automenu'
   to provide an interface for all those
   autonomy commands.

v.1.0 beta 5
  -Fixed the AFK support so that it asks whether
   you want to load your saved title or load a
   random one.
  -Use the alias 'savedtitle' to either change
   your old saved title and then load it as
   your current title, or just load your
   saved title.
  -Fixed a little problem in some autonomy
   commands.
  -Gave aliases some scripter's comments,
   marking them as 'User', 'Script', or
   'User or Script'.  This is to let you know
   whether that alias is meant to be used by
   the user or if it is called by a trigger
   in the script, or both.
  -No wonder.  I think Zugg changed the alarm
   syntax.  Timers should work now (like the
   emotes for each class, which are triggered).
  -'title' now saves the title to `SavedTitle.
  -You look when you rest or wake.
  -Spell practicing in.  Press the Prac off
   button to initiate.  All variables and
   aliases and whatnot are named SpellPrac*
   or SkillPrac* or something similar.  You
   can disable temporarily with the button
   and set fixed intervals for practicing.
   That was the only way it would work.
   Sorry.

v.1.0 final
  -The Prac on button was looping the first
   time run.  I added the SpellPracTime and
   SkillPracTime variables to compensate.
   Also, the trigger checks if any skills
   or spells have been selected -- if none,
   it will avoid calling the skill or
   spell alias altogether.  So if you cast
   detect invis but no skill, it won't
   call skillprac.
  -Added LastTarget and LastSpell variables.
   Oops.
  -Door trigger moved to General so that
   the door alias could be used.  Added
   option to "do nothing."
  -Your title will have quotation marks
   in it unless you check Strip " Quotes
   under General.  Thanks, Illusion.
  -Removed the "Verbatim" option from
   a lot of triggers.  Was causing some
   things not to work.

v.1.1 Maintenance
  -Fixed the autonomy triggers so that they
   accept security levels.  Apparently, no
   one uses these because I found it myself.
   Come on, guys...it IS useful!
  -Added some sounds for tells, replies, and
   entrances.  The beep on my new motherboard
   isn't loud enough, so I have sounds now.
   Problem is that if zMUD plays a sound, it
   doesn't properly close the wavplayer or
   something, because the sound dampens and
   the sound files are inaccessible until
   zMUD is closed.
  -Separate version for The Foundation MUD.
  -Disabled wizardry triggers so that they
   don't bother you unless you want them.
  -Updated the configure alias.  More useful.
  -Minor change to AFK button so that you
   could just press ENTER through all the
   yes/no boxes when you come back to keyboard.

                       -*-