Bot IRC :: CspBot

By :: Fab, Tetsuo, mcAllan
Date :: 16-08-2006
Version :: 0.3
Last Updated :: 15-04-2007

Bot IRC - Utilisation

Préambule.

Ce bot doit tourner grâce à PHP en ligne de commande, afin qu'il tourne comme un daemon.

Attention
N'utilisez-pas ce bot sur un hébergement mutualisé, au mieux il ne marcherait simplement pas, au pire vous seriez renvoyé par votre hébergeur.

Installation

Décompressez l'archive contenant les scripts et plugins et copiez le tout dans un répertoire de votre serveur.
Editez le fichier bot.conf.php situé dans le répertoire include et modifiez les valeurs des différents paramètres.

$botOp = array des nick autorisés à se promouvoir bot operator
IRC_SERVER = serveur IRC ex: "IRC.mydomain.com"
IRC_PORT = Port du serveur IRC ex: "6670"
IRC_CHAN = Nom du channel (sans #) ex: "csp"
MY_IP = Adresse IP du bot ex: "127.0.0.1"
MY_DOMAIN = Domaine du bot ex: "scriptsphp.net"
MY_EMAIL = Email du propriétaire du bot ex: "moi@mydomain.com"
BOT_UNAME = Nom du bot ex: "CspBot"
BOT_NICK = Pseudo du bot ex: "TafioleDuZizi"
BOT_PWD = Mot de passe du bot ex: "fabounet"
BOT_VERSION = Version du bot ex: "0.3"
LOG_CHAN = true|false indique si le chan est loggé;
LOG_BOT = true|false indique si les actions du bot sont loggées
STAT_CHAN = true|false indique si un fichier stat est préparé
LOG_DIR = dirrectory des logs ex: "logs/"
JOIN_MESS = message à l'arrivé du bot (vide si rien à dire)
QUIT_MESS = message à la déconnection du bot (vide si rien à dire)
MYSQL_HOST = serveur mySql si utilisé par plugin
MYSQL_USER = user mySql si utilisé par plugin
MYSQL_PWD = password mySql si utilisé par plugin
MYSQL_BASE = base mySql si utilisé par plugin

Sachant qu'il est assez mal vu de tester votre bot sur des canaux IRC déjà existants, vous pouvez, a cet effet, (sans abuser) vous servir de notre canal IRC :

Hôte : irc.planespells.net
Port : 6670
Canal : #csp

Editez ensuite le fichier bot.sh, c'est le script shell qui lance le bot et lui permet de se reconnecter en cas de mort accidentelle.
Vous devez vérifier et éventuellement rectifier les chemins d'accés au script bot.php ainsi qu'au client php.

Le fichier bot.sh :

#!/bin/sh
#
# fichier : bot.sh :
# Shell de lancement du Bot
#
# @package Cspbot
# @since 2006/08/10
# @version 0.3
# @author Fabrice Lezoray - Tetsuo - Alain Nicolas (mcAllan)
# @copyright See licence.txt

# Chemin vers le client PHP5
# A vérifier impérativement

#Exemple 1
#PHP5_CLI=/usr/bin/php5

#Exemple 2
#PHP5_CLI=/usr/local/php5/bin/php

#Exemple 3
PHP5_CLI=php

#
# boucle infinie qui relance le script si il est tué
while [ 1 ] ; do

$PHP5_CLI -f /chemin_vers/bot.php

done
#

Le bot est prèt à être utilisé.

Mise en service.

Pour lancer le bot, vous devez passer la commande suivante depuis la console :

sh bot.sh

Dans le répertoire du bot.
Vous devez alors voir apparaitre le bot sur le chan.
Tapez alors sur IRC :

/msg botnick !botop password

en remplaçant botnick par le nick du bot et password par le mot de passe défini précédement.
Si vous n'avez pas oublié de définir votre pseudo dans la liste des opérateurs du bot, celui-ci doit vous répondre par un petit message de politesse. Vous pouvez alors tester les différentes commandes des plugins installés.

Pour les commandes des différents plugin reportez vous au chapitre plugin.