README

Acronymph Acromania Bot for IRC 
-------------------------------

Acronymph is an acronym game bot for IRC. The game has different names, including Acromania, Acrophiba and simply "The Acronym Game." 

For IRC, it uses the "irc" library from pypi. you can probably install it with the command:

pip3 install irc

Usage:

./irc-bot.py <server> <nick> <username> <channel>

Public commands to be ran in the channel:
!help           - shows commands
!startacro      - starts a game
!stopacro       - stops a game
!acrohelp       - explains the game to the user (not yet implemented)

Then run it with:
./irc-bot.py <server[:port]> <channel> <nickname> <-ssl>

If you  need your bot to register with nickserv, create a file called mysecrets.py containing the line:

nickservRegString  = 'identify nick password'

Example game:

<player1> !startacro
<acrobot> Welcome to haxroMania.  For game instructions type !acrohelp
<acrobot> The game is starting. You have 30 seconds per round.
<acrobot> Round #1: The current acronym is: WTYM
(player1>acrobot) word to your mother
<acrobot> Acronym #1 accepted!
(player2>acrobot) whats the yonkel, man?
<acrobot> Acronym #2 accepted!
(player3>acrobot) Windows trashes your memory
<acrobot> Acronym #3 accepted!
<acrobot> Time's up! Here are the results:
<acrobot> #1: whats the yonkel, man?
<acrobot> #2: word to your mother
<acrobot> #3: Windows trashes your memory
<acrobot> Plase vote for your favorite with /msg acrobot vote #.  
<acrobot> vote #1 received
<acrobot> vote #2 received
<acrobot> 10 seconds left...
<acrobot> vote #3 received
<acrobot> All the votes are in! results:
<acrobot> player1's acronym: "word to your mother" received 1 votes
<acrobot> player2's acronym: "whats the yonkel, man?" received 0 votes
<acrobot> player3's acronym: "Windows trashes your memory" received 2 votes
<acrobot> Scoreboard:  player1: 1, player2: 0, player3: 2
<acrobot> The next round starts in 15 seconds.  Get ready

Copyright 2008,2022 Sam Foster <samfoster@gmail.com>

See LICENSE for licensing