ClyBot ReadMe 3.0 - 01/05/05
Copyright (C) 2003 Tim Chaplin
Modified by Nemesis
///////////////////////////

SETTING UP:

  QUICK VERSION (for people who know what they're doing):
    -Load clybot.mud
    -Match your prompt to the prompt trigger
    -Configure the 'set' alias
    -Copy desired scripts and itembase.txt into zMUD's
     root directory

  DETAILED VERSION (clarification for the above):

  LOADING CLYBOT.MUD:

  The first thing you'll need to do to set up ClyBot is to place the
  clybot.mud file in the directory zMUD uses for Nodeka - probably 
  \zMUD\nodeka. 
  
  Next, run zMUD, and open your Nodeka character, preferably offline.

  Go to:

    Settings->Load...

  and load clybot.mud.

  SETTING UP THE COMM WINDOW:

  Make sure triggers are enabled, and connect to Nodeka. A second 
  window named "comm" should show up. All MUD communications will be
  displayed in this window. Go to:

    Layout->Quick Tiling->Tiled Vertically

  Then adjust the size of the comm window to your liking. Go to:

    Layout->Save Layout...

  to save the window positions.

  Also go to Layout->Auto Tiling, and select "None".

  Then enable "Lock Layout" in the Layout menu to ensure that the layout
  saves between sessions.

  SETTING THE PROMPT TRIGGER:

  If you know the basics (maybe even some of the advanceds) of zMUD triggering,
  you'll find the prompt trigger in the core_triggers folder. Change it to match your
  prompt. If you don't know how to do this, use Nodeka's default prompt - prompt all
  or prompt allcolor.

  SETTING THE "SET" ALIAS:

  The other important thing that you might want to change is the
  "set" alias, found in the core_aliases class (click Aliases,
  double-click the folder named "core_aliases"). The body of it has
  a few blocks that look like this:

  #IF (%2 = "nim") {
    set pool end
    #VARIABLE attack nim
    #VARIABLE hit_min 700
    #VARIABLE end_min 0    
    #VARIABLE smart_nim 1
    #VARIABLE min_nim 23000

    }

  This defines an attack mode (nim), which, in order:

    uses the endurance pool
    uses the "nim" command (or alias) to attack mobs
    requires that hp be above 700 at all times, or else it ends the run
    has no requirement for endurance
    keeps nimming till mob is empty
    the minimum amount of gold that is stolen from a mob before moving to another

  As a note, if there were an endurance requirement, ClyBot wouldn't shut off
  if endurance dropped below it, it would begin to attack mobs using "k" (for kill).

  Use the above example to configure your own attack settings. If you use
  a multi-worded value for the "attack" variable, you must enclose it in {}'s:

    #VARIABLE attack {cast Oe-Kyf 'firebolt'}

  To change to this setting, you would type "set att nim".
  Other uses of the set alias are:
    set line (shortcut) - allows you to skip ahead to a line in your script
                          that's been labeled with "//shortcut"
    set pool (spi/man/end) - changes the pool that ClyBot monitors for skill usage.
                             I recommend only using "set pool" inside the set alias
                             itself, as it would be too annoying otherwise.

  SLEEPING ON TICKS:

  The only other thing that you might want to change is ClyBot's
  sleeping on ticks.
  
  To disable sleeping type:
  	set sleep 0
  
  Else to set your sleep to lets say 5 seconds before tick:
  	set sleep 5
  	
  To change while the script is running, for a quick change, then type:
  	sleepon 5


	TOGGLING MAP ON AND OFF:
	
	For those who want to run their scripts with the map on, you can toggle the option
	by typing the following command.  You can type this command while the script is
	running and it will adjust.
	
	Turn it on:
		set map on
	Turn it off:
		set map off

	TURNING OFF HEALTH/MANA/SPIRIT/ENDURANCE BARS:
	
	Right click the bar you do not want.  It will highlight an item on triggers window.
	Right click on the highlighted item, and uncheck Enable.
	
	To re-enable a bar, right click on a button on the bar, it will pop up a window with
	the buttons, right click on the grayed out bar you want to enable, and click Enable
	to check it.

  ITEMBASE.TXT:
  
  Just copy this file into zMUD's base directory.

USING CLYBOT'S OTHER COMMANDS:

The other commands that you'll want to use are "load" and "lkup".
Just type either with no arguments to see the usage.

As a note, "lkup" uses the textfile "itembase.txt", which must be
in the main zMUD directory.


SCRIPTING:

  If you just want to download scripts from the ClyBot website, you
  don't need to read this. If you want to write your own, the scripts
  need to follow a certain format:

  MOBDEF #
  MOBILE keyword
  String that's printed when only one of this mob is in the room
  The string that comes either before or after the [ # ] when
    there are multiple mobs of this type in the room
  PATH
  .
  .
  .
  END

  The # after MOBDEF must be the number of MOBILE definitions that
  come after it. The "..." between PATH and END should be a list of
  directions, one direction per line, that will walk you through the
  entire area. While you should only have one direction (n,s,e,w,u,d)
  per line, a line can have two commands - such as "open door;e", for
  the opening of doors and such.

  For examples, see the pre-written scripts at the ClyBot website.

  In the latest version of ClyBot, scripts may include comments, to help
  you keep your place. A commented line will begin with "//", and will be
  ignored by ClyBot during a run. You can also skip ahead to a commented
  line with the "set line" command. If there is a line that reads
  "//NORTHEAST" (such as in the orc_outpost script), you can go to the room
  that you would be at had you run the entire script up to that point, load
  the script, type "set line NORTHEAST", and begin. This is only really
  useful for very large areas, where the first half may be cleared and you
  don't want to run through all of it to get to the good half.

NEW IN 3.0.0:
	
	* "set map" command - toggles the map on and off
	* "set sleep" command - sets the script when to sleep.
	* "sleepon" command - used while running the script as a quick command change
	* "earn" command - displays the current statistics for the run
	* Added bars for health, endurance, mana and spirit
	* Added a smart nim feature for the nimmers to nim a mob more than once.
	* More detailed statistics
	
NEW IN 2.2.0:

	NO CLUE CAUSE I DIDNT HAVE THAT HELP FILE.

NEW IN 1.0.1:

  "set end" command - works like "set line", use to specify a commented line
                      that will end the script when it is reached
  a pause button
  a system to spellup automatically - look at everything in the
    core_triggers->spellups class
    -if you don't make use of this, you'll have to delete the "check_spells"
     call in the "move" alias in the core class
  you can now run without toggling peripheral off
  fixed a few minor bugs dealing with commas in exp/gold strings, and getting
    duplicate messages in the comm window