----------------------------------
WELCOME to MinscBot 28 readme.txt
----------------------------------

This document overviews as many of the areas of the bot as I could think of


---------------------
Important Information
---------------------

+ The bot need Super Moderator access or SysOp as a security feature.
+ While it might work without being a Smod/Sysop it might crash alot

-----------
Setup Guide
-----------

1)  Extract all files in MinscBot.zip to a new folder.
2)  Open SSBot.ini by double-clicking.
4)  In the [Login] section, fill in:
     DefaultName=Bob the Bot (Someone may have taken this name already)
     DefaultArena=The arena which your bot will start in.  Set to nothing for public arena
     IP=(Dotted quad Internet Protocol address. Read on..)
     Port=(Remote SubGame port. One more line..)
         You can find these two in FAVORITE.LST in your SubSpace folder.
         ie.                           (IP)     (Port)
         USD KHAOS Destruction !,  63.164.45.4,  7100
         #A zone built for Destruction !!!  by Coconut Emulator
5)  In the [Access] secion, fill in:
     IP:Port=The zone's super moderator password.  Make sure the bot is on your smod.txt list
            The IP and Port are the ones you got from FAVORITE.LST
     Sysop=If you set the Password to your sysop password and the bot is in sysop.txt, then put "yes" here
6)  In the [Password] section, fill in:
     Bob the Bot=Bob's password.   

7) In the [Login] section fill in:
    DefaultType = enter the letter of the bot type you want ( W for War_Ref
    L for Eliza_Bot)

8)  Close SSBot.ini and save changes.

6)  You are almost ready to run MinscBot!  Just one more thing: you need to choose who can use the bot.
8)  Open Operators.txt by double-clicking.
9)  Take a look at the KEY a the top and erase/add operators as you need.
10) The operator names are NOT case sensitive. (gravitron = GrAvItRoN = GRAVITRON)
11) Close Operators.txt and save changes.

12) Run MinscBot.
13) It's reccommended that you send a copy of this file to anyone who is an operator.

---------
Bot Usage
---------

E(L)iza Bot
+  A bot that chats to players, WARNING: SHE CAN'T CHAT VERY WELL
+ !t <text> to say <text> to bot

(W)ar Bot
+  A  bot that fights like a god
+ Only account or super operators can control it
------------
Command List
------------

(KEY)      |  -User must have this level of access at least to use the commands-
P: Public  |  Normal Player
I: Simple  |  Moderator
A: Account |  Super Moderator
S: Super   |  SysOp

+ All MinscBot flavors
P:!help            - Display a list of help catagories.
P:!help <catagory> - Display commands in the given catagory.
P:!status          - Show game status.
P:!rules           - Lists game rules.
P:!listops - Public access only sees online 'ops. Simple to Super may view all. An '#' in place of a ':' means he is online and has 'op abilities.
P:!lag     - Display bot lag. Accuracy is only shown from Simple to Super access (higher = better)
I:!ballnotify < off / 1 / 2 > - Announces team/player/coord of pball owner.
                                1 = Announces whenever the ball changes player owner
                                2 = Announces whenever the ball changes team owner
I:!suicide < on / off >       - Allow anyone to use the !exit command.
I:!eventeams < off, 1-10 >    - If a team has <the given number> or more players than the other, then the bot switches until the teams are even.
I:!enable                     - Turn on the bot's game feature/ship-checking function.
I:!disable                    - Turn off the bot's game feature/ship-checking function.
I:!go < arena name >          - Move the bot to a new arena.
I:!spec < off, 1-10 >         - Spec's players with deaths greater than or equal to the number given.
I:!ship < off, 1-8 >          - Keeps players in the ship-type given.
I:!advertise <message>        - Sends a *zone message with a -Name tag at the end.
I:!door < 0-255 >             - Sets Door:DoorMode=What you want.  0 = all doors off, 255 = all doors on.  Requires SysOp
A:!op < name >                    - Add a simple operator.
A:!dop < name >                   - Delete a simple operator.
A:!setprize < number >            - Change the periodic prize. (Will only echo this with an *arena message if periodic prizes are enabled)
A:!prizetime < seconds >          - Change the time in seconds after which each prize is given. (Ditto)
A:!prizes < on / off >            - Turn periodic prizes on or off.
A:!killprize < off / -28 to 28 >  - When someone gets a kill, prize them with this.
S:!op < operator level > < name >     - Add an operator of the given type.
S:!spawn < bot type > < bot name >    - Create a new bot of the type and name given. New bots will spawn in the arena of their parent.
                                        Choices: |!spawn (W/L) <name>|  
                                        [(W)ar Ref, E(L)iza Bot]
S:!spawnex < IP:Port > < type > < name > - Spawn to a custom zone, not necessarily the current one.  The new [Access] format is to better support this feature.
S:!close                              - Close the target bot spawn. If it is the last spawn, the bot will not close.
S:!terminate                          - Close all bot spawns and the program.
S:!closeall                           - Close all other bot spawns.
S:!write                              - Save Operators.txt, PlayerData.txt, Rank.txt and Scores.txt
S:!say < :Minsc & Boo:Hi, //Hi, ;X;Hi, Hi > - Make it say something; this is a good reason not to give non-SysOps Super Access.
S:!attach < on/off/platername >                  - Attach or dettach. Must be in a ship on the player's freq.
S:!error < chat channel >             - Dump red server error messages to the channel given.
S:!logscores < on/off >               - Log wins/losses/flag victories to Scores.txt
S:!set < section > : < key > : < value >   - Set any key in SSBot.ini
S:!get < section > : < key >               - Retrieve a SSBot.ini variable. (Not AppendPassword)
S:!password < new password >               - Change bot password in SSBot.ini and on the server.

-------------BOT SPECIFIC COMMANDS------------------------------------------

+ Eliza Bot
P: !t<text> say <text> to bot

+War Bot

A: !warp x, y  - warps bot to x,y Note: 8200,8200 is center
A: !move <?> - moves bot in <?> direction. <?> can be a combo of either: up, down, right, or left
A: !facing <?> - <?> can be a number from 0 to 39, it controls which way bot is facing
A: !follow <playername> - makes the bot follow <playername>
A: !movedelay <?> - most be over 0, says how fast bot moves, 1 is fastest, 100 is slow

A: !patroldirec <?> - which direction should the bot patrol (same choices as !move command)
A: !patrollength <#> - how far should the bot go before turning back?
A: !patrol <on/off> - should the bot patrol (uses settings of commands above)

A: !spin <on/off> - toggles spin, if on spins the bot around
A: !aim<on/off/playername> - makes the bot aim 
A: !info <move/fight/patrol/me/misc> - tells you information about the bot
A: !stop - makes the bot stop moving, shooting, and spining
A: !use - first type the level (l1, l2, l3, l4) then if it's bullet or bomb i.e. !use l3 bomb or !use l4 bullet. You can add bounce or prox to the end of command for bouncing bullets or proximity bombs. Other weapons you can type are: repel, decoy, burst, thor, or nothing (to stop) .  NOTE: in some zones the proximity bombs don't hurt at all..... I DUNNO WHY!
A: !fire <#> - <#> is the weapons packet number, don't use this unless you know what your doing
A: !firedelay <?> - most be over 0, says how fast bot shoots, 1 is fastest,  100 is slow

A:!myship <#> - sets the bots ship to # (1 is Warbird etc. do !myship 9 to spec it )


S: !lock - toggels lock, if locked  all of the above commands are locked from working

-----------
MinscBot FAQ
-----------

Q: What is a MinscBot?
A: MinscBot is a server-side bot, which can fight and talk

Q: How do I use the other bots built into MinscBot?
A: Log in as a SuperOp in Operators.txt and use the !spawn command listed above.

Q: Players get kicked by too many ship-type changes.
A: Type |?set:Security:MaxShipTypeSwitchCount:32767| as a sysop.

Q: !ballnotify repeatedly sends the current ball owners.
A: This command is built for zones with a single ball.

Q: I have problems connecting or "Winsock could not be loaded."  HELP!
A: Try this link for a Winsock update:
   http://www.microsoft.com/windows95/downloads/contents/wuadmintools/s_wunetworkingtools/w95sockets2/

Q: I added someone as an operator but he doesn't show up with a # next to his name in !listops.
A: Ask him to reenter the arena. If he is still not an operator, check spelling.

Q: Will the bot respond to remote private messages from another arena?
A: No and it will not respond to macros. However, it will respond to public, private, team, or team-private messages.

Q: I have the bot set up, but nothing happens.  What's wrong?
A: 1) Be sure you are a SuperOp on the bot.  (Read the quick setup guide above)
   2) Make sure it's a SMod by typing |/!say *zone I am SMod|.
   3) Type |/!enable|.
  
Q: How do I make the bot go to a public arena?
A: Set |Login:DefaultArena=| in SSBot.ini before you run it, or type |/!go|

Q: I need help with something not explained above
A: look below
------------
Tech Support
------------

Email: ZapBrain22@emailaccount.com


--------------
Special Thanks
--------------

Catid - for the core version of the bot
Hades!! - for 'BETA' testing my bot!!!!
Grimstar - for putting it up on subspacedownloads to begin with!