Eggdrop Tcl Archive

Extended Description File

File:		acro.tcl
Version:	1.0.1, 14 Apr 2002
Requires:	Only tested on eggdrop 1.6.x & Tcl 8.3.x.
Author: 	Graeme Donaldson
WWW:		http://www.eggdrop.za.net/
IRC:		Souperman @ #eggdrop @ Undernet

============================================================

1. Description
2. Installation
3. Usage
4. Issues
5. History

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

1. Description
~~~~~~~~~~~~~~

There are probably several different variations of this game 
to be found on IRC. This is my variation.

The game starts when the bot generates a string of letters 
(the ACRO), from which players must try to make a meaningful 
phrase. For example if the ACRO generated is "MTAGR", a 
meaningful phrase could be "man this acro game rocks". 
Players are given a limited period in which to submit a 
phrase, whereafter the bot will read all the submissions, 
and players will have the opportuniy to vote for the phrase 
they think is best. A player receives 1 point for every 
vote his/her phrase receives. After the voting time expires, 
the bot read the scores and the next round begins. After a 
pre-determined number of rounds the game ends and the total 
score for each player is tallied.

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

2. Installation
~~~~~~~~~~~~~~~

Installation is pretty straightforward:
 - edit the acro.tcl file to your liking 
 - put the acro.tcl file somewhere where your bot can get to 
   it
 - make sure you are loading alltools.tcl (1.6 or higher)
   before loading acro.tcl
 - add a 'source /path/to/scripts/acro.tcl' line to your 
   bot's config file
 - rehash your bot (you should see a message saying that 
   acro.tcl has been loaded or a message saying that it has 
   not been loaded and a reason why).

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

3. Usage
~~~~~~~~

Playing the game is simple:
 - join the channel you specified for the game to run on
 - type the start command (default is '!acro')
 - the bot generates a random string of letters
 - players then have a fixed amount of time in which to
   give their phrase, using the /msg botnick acro command
 - after the time runs out, the phrases will be read to the
   channel and then channel members can vote for their
   favourite using the /msg botnick vote command
 - after the voting time runs out, the bot tallies the votes
   and reads the scores for that round and a new round
   begins

The game runs for a specified number of rounds (default 10),
after which the grand totals for the game are tallied and
read to the channel and a new game may be started.

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

4. Issues
~~~~~~~~~

* The method used to track who has played/votedalready is
  not perfect. The way I've done it is to record a user's
  ident@hostname when they play/vote to ensure they only
  do so once in a round. It is possible that two people on
  the channel using some forms of internet connection
  sharing will have identical ident@hostname's, in which
  case only one of them will be able to play.

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

5. History
~~~~~~~~~~

### 14 Apr 2002	 v1.0.1 ###
* Fixed stupid bug which prevented the game from working.


### 12 Apr 2002	 v1.0.0 ###
* Cleaned up the files and released it. The script is
  nowhere near as polished as it should be, but what
  the hell... experience has taught me that people
  will tell me what they want.


### ? ??? 2001	 v0.0.0 ###
* The game was originally written in approximately 8
  hours and never released.

EOF