Skip to content
Extraits de code Groupes Projets
Valider def38710 rédigé par Alexandre Morignot's avatar Alexandre Morignot
Parcourir les fichiers

un README !

parent 3a4fb1cc
Aucune branche associée trouvée
Aucune étiquette associée trouvée
Aucune requête de fusion associée trouvée
# PlayBot
## Description
PlayBot est un bot IRC permettant de manipuler des liens audio :
+ enregistrement des liens dans une base de données ;
+ récupération et publication sur le chan des informations (titre, posteur) ;
+ normalisation du lien ;
+ sauvegarde de liens en favoris ;
+ rappel du lien en query.
## Installation
### Dépendances
PlayBot est codé en Perl. Il dépend des modules suivant :
+ DBI ;
+ DBD::mysql ;
+ JSON ;
+ LWP::UserAgent ;
+ HTML::Parser ;
+ HTML::Entities ;
+ POE ;
+ POE::Component::IRC ;
+ Tie::File.
### Configuration
Pour l'instant, seule la configuration de la base de donnée est externalisée. Vous devez créer un fichier *playbot.json* dans le même dossier que le fichier *PlayBot.pl* contenant les attributs suivant (les noms devraient être assez explicites) :
+ bdd ;
+ host ;
+ user ;
+ passwd.
Le reste de la configuration s'effectue encore directement dans le fichier *PlayBot.pl*. Les variables suivantes sont modifiables :
+ $serveur ;
+ $port ;
+ $nick ;
+ $ircname ;
+ $username ;
+ @channels ;
+ $admin ;
+ $baseurl.
Les noms des variables sont plutôt explicites. *$admin* contient le nick du l'utilisateur qui aura le droit d'administrer le bot (attention, aucune vérification autre que le nick n'est pour l'instant faîte, il est recommandé de l'enregistrer). *$baseurl* contient l'url racine du site permettant de consulter le contenu de la base de données.
## Utilisation
Dès qu'un lien est posté, le bot récupère le nom du contenu et de la personne l'ayant posté, et l'insère dans la base de données (grâce à l'unicité du lien et à sa normalisation, un même contenu ne peut être enregistré deux fois). Il poste ensuite sur le channel les informations récupérées avec l'id du contenu.
Les différentes commandes utilisables sont les suivantes sur le channel où se trouve le PlayBot :
+ !fav [id] : enregistre en favoris le contenu possédant l'identifiant *id*. Si l'identifiant n'est pas préciser, le dernier contenu posté (et non inséré) est utilisé.
+ !later [id [in [Xs|Xm|Xs]]] : demande au PlayBot de rappeler en query un contenu. La durée par défaut est de 6h. Si l'identifant n'est pas précisé, le dernier contenu posté est utilisé.
0% Chargement en cours ou .
You are about to add 0 people to the discussion. Proceed with caution.
Terminez d'abord l'édition de ce message.
Veuillez vous inscrire ou vous pour commenter