====== Python Irc Bot ======

==== Ce qu'il vous faut ====

Pour que le bot fonctionne, il va vous falloir installer une dependance : <code bash>python-twisted</code>

==== Configuration ====
Dans suckerserv/python_bot vous trouverez un fichier config.py. Il vous permet de configurer votre bot.

=== Identité sur IRC ===
^ Nom                ^ Valeur par défaut     ^ Description ^
| servername       | gamesurge         | Nom du serveur irc (GameSurge, Freenode,...) |
| host             | 195.8.250.180     | Addresse ip du serveur irc |
| port             | 6667              | Port de connection du serveur irc |
| channels         | #suckerserv       | Channel irc où le bot se trouvera |
| default_channel  | #suckerserv       | Vous pourrez contrôler votre serveur via irc seulement sur ce channel ci|

=== Serveurs ===
^ Nom                ^ Valeur par défaut     ^ Description ^
| nom              | server1           | Nom du serveur de jeux sur irc |
| host             | localhost         | Addresse ip du serveur de jeu |
| password         |                   | Mot de passe que vous aurez écrit dans votre server.conf (partie python bot) |
| format           | \003**01**%s\003      | Couleurs qui seront donner au nom de votre serveur de jeu sur irc |
| default_channel  | #suckerserv       | Vous pourrez contrôler votre serveur via irc seulement sur se channel ci  |

----

==== Commandes ====

Pour utiliser les commandes du bot irc, vous devez avoir le status d'opérateur. Pour utiliser une commande, vous devez écrire ".nomduserver <commande>"

''Exemple: mon serveur s'appelle //suckerserv//, j'écris **.suckerserv pause** ''

=== Liste des commandes ===
^ commande           ^ Description ^
| ping              | Permet de vérifier si le serveurs est bien relié au bot irc |        
| say <text>        | Permet de parler du serveur irc => serveur de jeu |        
| players           | Permet de lister les joueurs connecté sur votre server de jeu |
| restart           | Permet de redémarer le serveur |
| uptime            | Vous affiche depuit combien de temp de serveur à été lancé |
| stats <cn>        | Permet de regarder les stats d'un joueur qui se trouve sur le serveur |        
| mute <cn>         | Permet de mute un joueur qui se trouve sur le serveur de jeu |     
| unmute <cn>       | Permet de unmute un joueur qui se trouve sur le serveur de jeu |
| disconnect <cn>   | Permet de déconnecter volontairement quelqu'un se trouvant sur le serveur |
| spec <cn>         | Permet de mettre quelqu'un qui se trouve sur le serveur de jeu dans les spectateurs |
| unspec <cn>       | Permet d'enlever des spectateurs quelqu'un qui se trouve sur le serveur |
| slay <cn>         | Commande inutile qui vous permet de tuer quelqu'un se trouvant sur le serveur |
| pause             | Permet de mettre le jeu en pause |
| resume            | Permet de relancer le jeu après une pause |
| specall           | Permet de mettre tout les joueur du serveur de jeu dans les spectateurs |
| unspecall         | Permet de d'enlever des spectateurs tout les spectateurs du serveur |
| recorddemo        | Permet de lancer l'enregistrement d'une demo |
| stopdemo          | Permet d’arrêter l'enregistrement de la demo |
| ip <cn>           | Permet de montrer l'ip d'un joueur |
| map <map>         | Permet de lancer la map <map> |
| changetime <time> | Permet de régler les minutes de jeu de la partie en cours |
| reload            | Permet de recharger les scripts du serveur |

Vous pouvez utiliser **.all <commande>** si vous vouler activer la commande sur tout vos serveurs actuelles.

''Exemple: Je souhaite utiliser la commande //players// sur tout mes servers, je fait : **.all players** ''