Hunt Helper Bot for ActiveWorlds

• Each object which triggers a trivia request should have in the action field the word: quiz  (nothing else!)
• Questions can be entered through the "Quiz Questions.." button,
• Each quiz can have up to 4 single word answers (no spaces within!) and they have to be separated by a "," character.
  
• Those answer words which are mandatory for the answer, should be prefixed with the "+" character.
• Each question can have a separate value defined to gain that score.
• e.g.: Who three people build the first reception area in AW Prime world for the CyAwards? A.: +AlphaBitPhalpha, +AlphaPhalpha, +CCTech  ScoreValue: 35
  

Version 3.4.14 (11/28/2002): 
- Fixed several hunting features broken when introducing the voting feature.

Version 3.4.12 (10/22/2002):
  - Added voting features to the bot.
    - The objects supervised should have the category (as number) in the description field and the nominee in create sign="xxx" format in the action field.
  - Changed user tracking to cit# AND names

Version 3.4.3 (5/24/2002):
  - Fixed a bug when the program did not exit while the world query is ongoing.

Version 3.4.2 (5/2/2002):
  - Added several new features like Scoring, improved/simplified enumerations for large worlds, etc.

Version 3.2.1 (4/16/2001):
 - replaced query with enumeration - runs only on world server build 20  or above!
 - increased robot's covering range to 400x400 meter
 - Added scoring window
 - Added database saving so restarting the bot doesn't require another query

Version 2.1.1 (2/13/2000):
 - FaceLifted the user interface
 - Added easy configuration options to add objects to the huntable object list
    - click inside the "Object list" box.
        - press the Insert key to add new object
        - press the Delete key to remove the highlighted object
        - press the Enter key to modify the highlighted object.
 - Added easy modification features to the message the robot whispers to the players
Those functions above are accessible before you start the robot only.
 - Added a sorted score listing button.
 - Reduced the required robot numbers by one!

Note: Due to AWSDK strict query restrictions, the robot center position has to be a multiple of 8 in both direction, otherwise some areas will not be covered!
 
 

Version 2.0.1 (2/7/2000):
- changed "gift" message to object.
 

The program's objective is to help the "Egghunt-like" contests for ActiveWorlds. It logs each click on any predefined object type within it's range and keeps tallying the results for each participitant.
This is a Robot - based on the AW SDK Build 15.
Usage and distribution of this program is free but reverse engineering is not allowed :)

First time users has to fill the bot credentials, set the game control checkboxes

The world(s) in where the hunt will run. Specify the hunted objects with selecting the Object names list and hit the INSERT key to add another object. Those names has to be exactly the same as it appears within the world. Specify the size of the hunted area and the center of it too.
If you do a different game than Gift/Present hunt, modify the bot's messages:

If you use password for tourist identification, you can modify the related messages too.

Start the bot and do a query on the hunted area. It has to display how many target objects found total and you can check by each bot's tab each bot's objects it covers.:

You can set now up all the needed settings for the hunt:

The bot can log several actions, all the char and it's own whisper. It is up to the user if he/she needs it. In the Game Control, you have to check AutoStart and StartStop MSG, so when the bot disconnected from the world, it can restart automatically. To avoud the World query at hunt time, select the AutoLoad feature in the QueryControl. The bot saves all target objects' location, so it is faster to reload it from the disk then reading it from the world. You have to set the Ignore new objects and Ignore Selection if you can't disable the build and object selection for the game's duration.

When you are ready to start the hunt, just click on the StartHunt button. During the game, you can interrogate the current status of the winners by clicking on the Scores button.

You can resort the list by clicking on the appropriate header. Hitting Refresh will refresh the list, it is not a real time list due to the frequent changes. Click on SaveIt when you want to save the current status (and of course at the end of the game) !
The HTML button will create a html formatted table from the winner's list:

It is very important to fill the Winner(from) and Until lines, to properly select the palyers in the list.

This is the exaple html table the bot makes:

This section is somewhat obsolete but I don't have time to finish this tutorial :(

The robot has the following parameters:
Citizen Number - is the AW citizen number for the bot's owner.
Priviledge Password - is the owner's priviledge password (needed for the bot to be able to log into the Universe)
World  - is the world where the bot will be used (the world rights options have to have citizen's number in the "Bots" line.)
Bot Name - is the name each bot is named during operation. You can only use alphanumeric characters.
Bot Avatar Number - is the sequence number of the desired avatar within the target world avatar list. The list starts with 0.
Center Coordinate - Set it for the hunt center.
Covered Area - is the size of the area centered around the Center Coordinate for the hunt. The larger the area the more bots are needed to cover it. Check your "bot limit" with AWCOM if it exceeds 3.

The robot starts with a default INI file (huntbot.ini in the same directory where the robot started). All values you enter onto the parameters above will be registered in the INI file, so next time you start it there will be no need to reenter them again.

The robot creates a click.log file which holds the objects informations already clicked by a certain player. It allways appends any new object found into that file. If you want to reset the tally counter - simply delete the click.log file before you start the robot.

The program supports up to 100 different kind of objects for the hunt.
You have to edit the huntbot.ini file for the desired object names for the game.
The names are under the [HuntObjects] section.
The syntax is:
ObjNamexx=yourobjectfilename
   where xx    - is the sequence number from 00 to 99 (leading zero needed!)
   yourobjectfilename  - is the filename as it appears in the AW Object Editing box (like ground.rwx)
E.g.:
ObjName00=gift1.rwx
ObjName01=egg2.rwx
.
.
.
ObjName17=castle.cob
ObjName18=bmw1.cob
... etc.
The names don't have to be in alphanumerical order but the object names can't finish with white space.

The Hunt Helper Bot supports remote control from a separate PC through the AW Browser. To use the remote control feature, the person has to be on the
"Authorised PS list" of the bot; has to be a PS on the world rights list and has to be wearing one of the 5 special avatars. It is strongly recommended that you add your
name to the list in the INI file under the [AuthorizedPS] section.
Syntax is PS1=yourname.
Authorized persons have additional commands they can use to remotely operate the Hunt Helper Bots. To find out what they are just whisper HELP to the bot.
 

Windows version fixes (not released)
4.2.5
    - Fixed click.log reload when it have crazy empty lines from the description field
4.2.6
    - added reset score command
4.2.8
    - added score limitation
5.0.1
    - fully modified for voting AGAIN
5.0.3
    - fixed welcome session message
5.0.4
    - added MySQL password handling
    - decreased HASH size due to huge memory usage (3500 visitors minimum 370 MBytes memory :( )
    - added wild char for objects:  gift*.rwx  and gift*  format only
    - modified MySQL handling, so no all requests are loaded,
    - refined sequential query for huge amount of bots set # of parallel bots to 8 versus 4
5.0.5
    - added world specific propload feature. If one provides a propdump with the object numbers (YASBB query with ObjNumberForDelete)
      then the bot will read the file instead of querying the world.
    - changed logging method for continuous main log write to the logfile.
5.0.6      - Last Windows version
    - changed ini file boolean values to make it compatible with the linux version.

Change history for the Linux version of the bot (not released).

5.0.7   
    - Added sign modification feature for the results announcment.
        there are the examples of the prize boards.
        The bot will fill the values if they are created properly:
                The description field should end with a newline (Ctrl Enter)
            - the bot will fill the rest with the name/cit and score values.
            The action line should have a";winner=x" string without quotes where the x is the position (as many prizes we have :),
                   so this is how the bot recognizes it.
            If the Action line has a visible off then the bot will change it to visible on, when it fills the sign.
5.0.8
    - Fully redesigned the HTML output feature for the Linux version.
    The program now creates all the HTML files for each worlds and the hunt itself.
    The program will generate comma delimited csv files from the scores.
    - Added ProgramID field to the ini file and the SQL database, so the backup bot can use the same database for the
    click logging and they can be identified by the ID.
5.3
    - fixed quiz reading
    - added world rating (still adding :)
5.4
    - modified world rating messages
5.5
    - fixed Voting reload after the restart
    - modified voting object format:
       Category exists: Action field only: ;category=number description;nominee=string;     
       No Category:  ;nominee=string;
       Cancel vote in category object:  ;category=number;nominee=cancel vote;
    - fixed setwelcomemsg command
    - changed AuthorizedPS to Citname#citnum format (and use only citnum!)
    - refined voting listings
    - added bot citnum/privpass to each world (if not specified, the global one used!)
    - votetop: command has a parameter: MaxPosition within each category
        if 0 or negative is specified, then it will only save the full state to the file
        otherwise it keeps the last MaxPosition value until change
    - consolidate different vote signs if they have identical category and nominee

5.6 (7/4/2005)
    - added makehtml: command to invoke the SQL process. Could be time consuming!
    - added Vote state sign management (refresh manually by showwinnersign: command)
    - added autoupdate: where the Vote state sign is refreshed in every second if they changed

            WinnerSign object format:
            model - should be in the target/voting object list
            action field - create sign color=xxx bcolor=yyy;winner=positionnumber;c=categorynumber;
            description field - overwritten with the current nominees at that position.

5.7 (7/11/2005)
    - modified voting object format AGAIN:
       Category exists: Action field only: ;vote c=categorynumber [categorydescription];n=nomineestring;     
       No Category:  ;vote n=nomineestring;
       Cancel vote in category object:  ;vote c=number;n=cancel vote;

5.8 (12/13/2005)

• - created separate Quiz categories (up to 64)
  
Objects activating the quiz should have in their action line:
;quiz  or ;quiz1 or ;quiz2   up to ;quiz63  which corresponds to the different categories

5.9 (12/20/2006)

Version 2.1.1
    - Added changes so the program can generate the different Quiz categories too.

Version 2.0.1 initial release
    - this program creates the necessary ini file for the huntbot version 5.x