############################################################# Date: 31Jan09 ##
## Game-Pool version 1 beta3 by SpiKe^^ The Ultimate Tcl Game-Pool Script ##
##############################################################################
## ##
## Game-Pool is a customizable random team generator for online ##
## game channels. ##
## ##
## Allows a user with the correct flags to open a pool for users to join ##
## the next online game. Messages players thier team, ip/port and password ##
## info when pool is full and game play can begin. ##
## ##
## 1. Run multiple game pools with this single script. ##
## 2. Admin & Users set by flags. ##
## 3. Private & Public commands. ##
## 4. Set or change the number of players for each game. ##
## 5. Pass Admin to another user if needed. ##
## 6. Cancel Game Pool ##
## ##
## This is the 2nd beta release. All feedback and suggestions are welcome ##
## Contact Options to report bugs, comments & suggestions ##
## http://www.mytclscripts.com ##
## irc: undernet: #pc-mIRC-help ##
## email: spike@mytclscripts.com ##
##############################################################################
##############################################################################
## ##
## Version 1 beta3 Release Notes ##
## ##
## 1. Fixed an issue when adding/removing nicks with tcl special characters ##
## Thanks to [air]traffic for finding and reporting this bug! ##
## ##
## 2. Added a setting to limit the number of simultaneous open game-pools. ##
## set gpool(pmax) "" ##
## # limit maximum number of open game-pools? ("" = no maximum) # ##
## ##
##############################################################################
##############################################################################
# Game-Pool Command Overview: All Game-Pool Commands #
# #
# -> Game-Pool can keep track of any number of different game-pools, #
# as provided in the script setting: gpool(games) #
# -> So, in our example: ff Fortress Forever #
# tfc Team Fortress Classic #
# tf2 Team Fortress 2 #
# We have three different games, #
# represented by the game codes: ff, tfc, & tf2 #
# -> That would make the actual !pool commands something more like: #
# !poolff :to open a Fortress Forever game-pool #
# !pooltfc :to open a Team Fortress Classic game-pool #
# !pooltf2 :to open a Team Fortress 2 game-pool #
# -> This same system applies to all of the below Game-Pool commands. #
# Some more examples: #
# !poolff 4 :to open a Fortress Forever game-pool with 4 players #
# !addtfc :to join the Team Fortress Classic game-pool #
# !iptf2 :see the server ip for the Team Fortress 2 game-pool #
# -> Any command given without a game code, #
# tries to follow the open game-pool. #
# #
##############################################################################
##############################################################################
# Working Game-Pool Commands List Version 1 beta3 #
##############################################################################
##############################################################################
# Open A Game-Pool (always done in the channel) Admin Only #
# #
# !pool :Open a Game-Pool with the Default Number of Players, Or... #
# !pool 6 :Open a Game-Pool with 6 Players #
# #
##############################################################################
# Private Message Game Setup #
# (can keep login info private) Current Pool Admin Only #
# #
# !serverip / !server / !ip Set/Change the Server IP of the Game #
# USE: !ip <serverip:port> EX. !ip 11.22.111.242:5524 #
# OR TRY: !ip <serverip:port> pass <password> #
# #
# !password / !pass Set/Change the Server Password #
# USE: !pass <password> EX. !pass thePassWord #
# OR TRY: !pass <password> ip <serverip:port> #
# #
# !onjoin / !join Add an On-Join Message for the Current Game-Pool #
# USE: !onjoin <message> EX. !join A short message. #
# NOTE: Send this message to anyone joining the pool, #
# and to everyone already in the pool. #
# #
##############################################################################
# Public Game-Pool Setup (done in the channel) Current Pool Admin Only #
# #
# !pool <number> Change the Game-Pool Size to <number> Players #
# EX. !pool 10 (change the game-pool size to 10 players) #
# #
# !pool server / !pool s Set/Change the Server IP of the Game, #
# & Make It Public #
# !pool ip / !pool i USE: !ip <serverip:port> #
EX. !ip 11.22.111.242:5524 #
# !serverip / !server / !ip OR TRY: !ip <serverip:port> pass <password> #
# to also make the server password public. #
# #
# !pool pass / !pool p Set/Change the Server Password, & Make It Public #
# USE: !pool p <password> EX. !pool p thePassWord #
# #
# !pool quit / !pool q Cancel the Currently Open Game-Pool #
# !pool cancel / !pool c USE: !pool quit EX. !pool c #
# !cancel / !quit EX. !cancel #
# #
# !pool admin / !pool a Give the Current Game-Pool Admin to Someone Else #
# !admin USE: !pool admin <nick> EX. !pool a SomeNick #
# EX: !admin SomeNick #
# NOTE: New admin Must have correct userfile flags #
# #
# !pool remove / !pool r Remove A Player from the Game-Pool #
# !pool boot / !pool b USE: !pool remove <nick> EX. !pool r SomeNick #
# !remove / !rem EX: !remove BadGuy #
# OR TRY: !rem badguy somenick thug #
# #
##############################################################################
# Advanced !pool Commands Available to the Current Pool Admin: #
# #
# The !pool command can take any number of command options from above. #
# This makes many interresting run-on command combinations possible: #
# #
# EX 1: To open a pool with 6 players, #
# set the ip & password and make them public, #
# -> !pool 6 ip 11.22.12.23:4620 pass MyPassword #
# #
# EX 2: We have 7 players & can't get an 8th. #
# I could remove a player & start the game #
# with the 6 remaining players, #
# -> !pool remove SomeNick 6 #
# #
# Important "!pool remove" Command NOTES: The "!pool remove" command #
# can take any number of nicks to remove. So in a run-on command, #
# everything after the "remove" option is considered a nick to be removed #
# from the pool. That behavior can be interrupted by setting the pool #
# size with a number, as in EX 2 above. Or make sure to always put the #
# remove option last if it won't be closed with a number, see EX 3. #
# #
# EX 3: Set the server ip and remove two nicks from the pool, #
# -> !pool ip 11.22.12.23:4620 remove badguy somenick #
# #
##############################################################################
# Emergency Take Game-Pool Admin Command #
# (always done in the channel) Admin Only #
# #
# !admin -me / !admin +me Take Game-Pool Admin if Current Admin Gets Lost! #
# USE: !admin -me EX. !admin -me #
# OR TRY: !admin -me quit #
# To Cancel an Abandoned Pool #
# #
##############################################################################
##############################################################################
# Public Game Commands (done in the channel) Admin & Player #
# #
# !add Add Yourself to the Current Game-Pool #
# USE: !add EX. !add #
# #
# !remove / !rem Remove Yourself from the Current Game-Pool #
# USE: !remove EX. !rem #
# #
# !serverip / !server / !ip Show the Server IP to the Channel #
# USE: !serverip EX. !ip #
# NOTE: If done by the admin, #
# this makes the ip public. #
# #
##############################################################################