Introduction

Ce tutoriel présente la première étape pour utiliser le LeelaBot : l'installer. Pour cela, il est décrit ci-dessous les méthodes pour l'installer sous les différents systèmes d'exploitation existants.

Vous avez aussi bien évidemment besoin d'un serveur Urban Terror qui marche. Pour le configurer pour pouvoir recevoir correctement le bot, il suffit d'aller dans q3ut4/server.cfg et de rajouter/modifier les lignes g_log,g_logsync,g_logroll comme ceci :

• set g_log "games.log"
• set g_logsync "1"
• set g_logroll "0"

Vous avez aussi (et surtout) besoin d'un ordinateur prêt à rester allumé 24h/24 (généralement le serveur dédié sur lequel est installé votre serveur de jeu). Le bot n'est pas un vulgaire script pour Urban Terror, c'est un programme externe à part entière qui se connecte au serveur, et qui nécessite donc un ordinateur pour fonctionner (vous pouvez cependant être dessus pendant que le bot travaille, ceci n'est pas censé trop influencer) ! C'est tout ce dont vous avez besoin pour lancer le LeelaBot, on peut donc installer directement le bot en lui-même.

Linux

Introduction

Pour cette partie, je prendrai comme exemple une distribution Debian, connecté en tant qu'utilisateur root, où je me situerais dans son dossier personnel (/root). Vous devriez avoir juste à changer les parties concernant le gestionnaire de paquets si votre distribution n'est pas basée Debian (ou n'est pas une Linux).

Pré-requis

Avant d'installer le bot en lui-même, vous devez d'abord installer quelques programmes (si vous avez déjà, pour une raison ou pour une autre, installé les programmes nécessaires pour LeelaBot, vous pouvez sauter cette étape). Pour installer le LeelaBot, vous devez d'abord installer PHP5 ainsi que PHP5-CLI. Vous devez donc installer les paquets nécéssaires sur votre système. Pour l'exemple de Debian avec Aptitude (en console), la commande ressemble à ceci : 

• root@Fry:~# apt-get install php5 php5-cli

Téléchargement et extraction

Pour commencer, créez un nouveau dossier, qui sera notre dossier de travail, puis déplacez-vous dans ledit dossier (pour l'exemple, je l'appelle leelabot, mais vous pouvez l'appeler comme vous le voulez) : 

• root@Fry:~# mkdir leelabot
• root@Fry:~# cd leelabot

Ensuite, téléchargez l'archive de la dernière version du bot (à l'heure où j'écris ces lignes, c'est la 0.1.1.0 Patrick) sur le site, où, si celui-ci n'est pas disponible, sur le sujet du bot sur le forum d'Urban Terror France. Sous Debian en console, vous pouvez le faire via la commande wget : 

• root@Fry:~/leelabot# wget  http://www.leelabot.com/latest.html

Décompressez l'archive avec un décompresseur supportant les archives de type .tar.gz (le programme tar, installé par défaut sur Debian, permet de faire ceci). Pour le décompresser avec tar, vous devez utiliser par exemple cette commande : 

• root@Fry:~/leelabot# tar -xzf LeelaBot_0.2.6.2_Carlo.tar.gz

Maintenant, votre bot est correctement extrait dans le dossier, vous pouvez supprimer le dossier compressé de votre dossier d'installation, par la commande : 

• root@Fry:~/leelabot# rm LeelaBot_0.2.6.2_Carlo.tar.gz

Windows

Introduction

Pour cette partie, je prendrai comme exemple Windows XP.

Pré-requis

Avant d'installer le bot en lui-même, vous devez d'abord installer quelques programmes (Si vous avez déjà, pour une raison ou pour une autre, installé les programmes nécessaires pour LeelaBot, vous pouvez sauter cette étape.) Pour installer le LeelaBot, vous devez d'abord installer PHP5. Pour cela, rendez-vous à cette adresse pour télécharger PHP5 : ICI. Puis ensuite de l'installer en suivant la méthode classique : Suivant » Suivant » … » Terminer.

Téléchargement et extraction

Pour commencer, créez un nouveau dossier, qui sera notre dossier de travail, puis déplacez-vous dans ledit dossier (pour l'exemple, je l'appelle leelabot, mais vous pouvez l'appeler comme vous le voulez) : Ensuite, téléchargez l'archive de la dernière version du bot (à l'heure où j'écris ces lignes, c'est la 0.2.6.5 Carlo) sur le site, où, si celui-ci n'est pas disponible, sur le sujet du bot sur le forum d'Urban Terror France : ICI. Ensuite décompressez l'archive avec un décompresseur supportant les archives de type .tar.gz (Exemple avec 7-zip :http://downloads.sourceforge.net/sevenzip/7z465.exe). Maintenant, votre bot est correctement extrait dans le dossier, vous pouvez supprimer le dossier compressé de votre dossier d'installation.

Le bot

Configuration

Maintenant, il nous faut configurer le bot, et pour cela, nous devons aller voir du côté des fichiers .ini du dossier conf.

Fichier principal

Sous Linux, il nous faut donc que nous changions de dossier pour le dossier conf, comme montré précedemment : 

• root@Fry:~/leelabot# cd conf

Maintenant, nous allons devoir modifier le fichier de configuration principal, nommé leelabot.ini. Pour ce faire, ouvrez-le avec votre éditeur de texte favori (en console ou pas), ou si vous ne savez pas quel éditeur utiliser, je vous conseille nano (sous Linux) ou Bloc Notes/Notepad ++ (sous Windows). Vous obtenez le fichier suivant :

;Fichier de configuration de LeelaBot
;
;Lisez attentivement les commentaires avant d'éditer !

;Adresse du serveur (par défaut localhost)
addr=localhost;
;Port du serveur (par défaut 27960)
port=27960;
;Mot de pase RCon
password=;
;Chemin absolu vers le fichier de log d'Urban Terror
logfile=;
;Chemin vers la liste de plugins à charger par défaut
pluginsfile=;
;Chemin vers la liste des administrateurs à charger par défaut
adminfile=;
;Réglage du premier lancement (permettant ou non l'utilisation de la commande !setadmin); 0=desactivé, 1=activé
firstrun=1;
;Mot de passe de la commande !setadmin
setadminpassword=;

L'aide donnée dans ce fichier me paraît suffisante pour que vous puissiez vous débrouiller seul. Notez juste que, comme dit dans le server.cfg par défaut d'Urban Terror, le répertoire par défaut pour les logs sous Linux est~/.q3a/q3ut4/ (le ~ signifie le répertoire utilisateur sur les systèmes Linux) et sous Windows est C:\Program Files\UrbanTerror\q3ut4\ (selon où vous avez installé Urban Terror). Comme c'est la première fois que nous l'exécutons, nous aurons besoin de mettre la variable setadmin à 1 (pour pouvoir vous ajouter en tant qu'admin).

Plug-in de gestion de droits

Pour que le bot marche, il faut aussi que vous ayez activé un plugin de gestion d'administrateurs. Il en existe aujourd'hui 2 :

• basicrights
• extrarights

Ces deux plugins se différencient par la manière dont ils gèrent les droits, sensiblement différente. Vous pourrez trouver plus d'informations sur la page decomparatif des plugins d'authentification. Une fois que vous avez choisi le bon plugin d'authentification, il suffit de l'ajouter à la liste des plugins par défaut pour qu'il soit chargé au démarrage du bot et que celui-ci soit pleinement fonctionnel. Pour cela éditez le fichier plugins-default.conf dans le dossier conf (ou celui que vous avez réglé dans leelabot.ini), et rajoutez sur une nouvelle ligne le nom du plugin (basicrights ou extrarights). Par ailleurs, je précise que c'est toujours de cette manière qu'il faudra procéder si vous souhaitez activer un nouveau plugin, le mettre sur une nouvelle ligne (et supprimer la ligne si vous voulez supprimer un plugin). Maintenant, vérifiez que le fichier admin.conf soit bien vide, et c'est tout. Voilà, le bot est maintenant configuré, nous allons pouvoir l'initialiser !

Initialisation

Maintenant nous pouvons lancer le bot, et pour cela, nous allons revenir au dossier racine du bot. Sous Linux en refaisant cd :

• root@Fry:~/leelabot/conf# cd ../

Et nous pouvons donc maintenant exécuter le bot avec la simple commande : 

• Sous Linux : php bot.php
• Sous Windows : C:\php\php.exe bot.php

Le chemin C:\php\php.exe est celui où vous avez installé PHP. 

Attention à bien lancer le bot à partir du dossier d'installation du bot, sinon il n'arrivera pas à se lancer ! 

Et maintenant vous pouvez voir les messages d'initialisation du bot défiler sur l'écran. Attention, vous devez laisser cette console ouverte pour que le bot continue à tourner. Si vous obtenez une erreur, regardez les paramètres de configuration. Si l'initialisation échoue lors de la connexion au RCon, essayez de mettre dans le champ addr l'adresse renseignée par votre serveur Urban Terror à la place de localhost. 

Maintenant, nous allons pouvoir nous rajouter en tant qu'admin du bot. Pour cela, ouvrez votre client Urban Terror, allez sur votre serveur, joignez une équipe, puis utilisez la commande !setadmin avec comme paramètre le mot de passe que vous avez défini dans la configuration. Si le message répondu par le bot est favorable, cela veut dire que vous avez maintenant tous les droits et que vous pouvez commencer à gérer votre serveur normalement (en donnant des droits aux personnes le méritant par exemple), et bien sûr remettre la variable setadmin du fichier de configuration leelabot.ini à 0 pour éviter à n'importe qui de s'octroyer tous les droits sur votre serveur. Voilà, votre serveur est maintenant prêt à être utilisé en production !

Optionnel : automatiser le lancement avec un script (sous Linux)

Cette partie sert si vous êtes un gros flemmard qui n'a pas envie de taper plusieurs lignes de code pour lancer le bot, ou mieux, qui veut lancer son bot en même temps que son serveur. Elle vous montrera comment créer un fichier de configuration à placer dans votre /etc/init.d/ (ou tout autre dossier ayant la même utilité à vos yeux), permettant de démarrer automatiquement votre bot. Pour l'exemple, je le placerai dans le dossier /etc/init.d/, mais vous êtes libres de le mettre où vous le voulez. Attention cependant si vous choisissez comme moi de le mettre dans /etc/init.d/, il vous faudra les droits d'accès root, car ce dossier est un dossier système. Pour ce script, je choisirai d'utiliser un script différent pour démarrer le serveur Urban Terror et le LeelaBot, mais vous pouvez faire un script qui lance le bot et le serveur en même temps. Je choisis aussi d'utiliser pour lancer automatiquement et “discrètement” (sans avoir la console devant nous qui nous bloque) le bot l'utilitaire screen. Pensez donc à l'installer, il n'est pas forcément présent sur votre machine.

Tout d'abord, déplacez-vous dans le dossier, un petit cd ne fait pas de mal : 

• root@Fry:~# cd /etc/init.d/

Ensuite, ouvrez en édition le fichier de configuration leelabot (pour respecter la coutûme, je ne mets pas d'extension au fichier). Comme il n'existe pas, nano (l'éditeur) nous le créera gentiment : 

• root@Fry:/etc/init.d# nano leelabot

Ensuite, écrivez (ou copiez-collez) ce joli script de démarrage écrit par votre serviteur (j'utilise ma propre manière d'écrire mes scripts, ici l'important n'est pas de critiquer ma manière de coder) :

#!/bin/bash

# Ici mettez le chemin absolu vers votre bot
botpath=/root/LeelaBot/
# Ici mettez la configuration à charger par défaut
config=conf/leelabot.ini

case "$1" in
    'start')
        cd $botpath
        if [ $2 ]
        then
            screen -d -m php bot.php --config $2
        else
            screen -d -m php bot.php --config $config
        fi
        ;;
    *)
        echo 'Usage : leelabot {start} <config>'
        ;;
esac

Enfin, pour que l'on puisse lancer ce script, vous devez le rendre exécutable. Pour cela, rien de tel que la commande chmod :

• root@Fry:/etc/init.d# chmod +x leelabot

Et maintenant, vous pouvez démarrer votre bot en exécutant simplement :

• root@Fry:/etc/init.d# /etc/init.d/leelabot start

Et votre bot démarre, mais attention, vous ne le voyez pas (il est détaché).

Bonus : démarrer le bot à chaque démarrage du système

Cette toute petite commande permet d'exécuter le script que nous venons d'écrire à chaque démarrage du système, mais faites attention à bien démarrer le serveur Urban Terror avant, sinon le bot ne marchera pas : 

• root@Fry:/etc/init.d# update-rc.d leelabot defaults