Odyssée est un bot Discord pour jeux de rôles. Il répond à un besoin particulier puisque que ce bot vient en complément d'un véritable maître du jeu. En d'autre terme, ce bot ne gère en aucun cas le scénario.
Ce bot va donc avant tout servir à aider le maître du jeu, notamment en intégrant un système complet d'achat d'objets, de sorts et de système de combat. Les statistiques des joueurs sont sauvegardées ce qui permet de ne pas avoir à écrire sur des papiers pendant le jeu. La possibilité de sauver des notes sur sa fiche de personnage va dans ce sens.
Le (ou les) maître(s) du jeu ont également accès à des commandes de modération qui permettent, entre autre, de kicker un joueur (cela supprime le joueur existant, et l'utilisateur kické ne peux pas créer de nouveau joueur).
Le bot et tous les fichiers de ce dépôt sont soumis à une licence GNU General Public Licence v3.0.
L'installation se déroule comme suit :
- Installation des dépendances
- Clonage du dépôt
- Création du bot
- Ajout du bot à un serveur et configuration
Vous devez impérativement avoir git d'installer sur votre ordinateur. Savoir s'en servir n'est pas nécessaire, toutes les commandes à taper seront explicement notées.
Pour installer git il y a plein de tutos très bien fait : https://www.atlassian.com/fr/git
Dans les grandes lignes, soit vous passez pas un gestionnaire de paquet (brew pour MacOS, pacman pour Arch…) soit vous allez directement sur le site de git pour le télécharger.
Pip3 est un gestionnaire de paquet pour les modules Python. Il vous permet d'accéder à la base de données Pypi qui concentre une très grande quantité de modules (numpy, scipy, requests, discord…)
De même que pour git, l'installation ne pose pas de problème particulier et est bien documentée.
Il est impératif d'avoir une version de Python 3. Le bot a été programmé et testé avec Python 3.9.5.
Encore une fois, les procédures sont multiples et diffèrent de beaucoup suivant votre OS.
Ouvrez un terminal et entrez la commande :
$ sudo pip3 install discord
Le terminal devrait vous demander le mot de passe administrateur et installer le module discord.py
Les achats sont gérés avec une base de données SQLite3, vous devez impérativement avoir installé la librairie sqlite3. Pour installer via le terminal :
$ sudo pip3 install sqlite3
Le bot a également besoin de quelques autres dépendances pour fonctionner :
$ sudo pip3 install requests bs4
requests est une librairie qui permet au bot de communiquer avec Internet (faire des requêtes etc). bs4 est une librairie qui permet d'analyser le code de sites web et d'extraire des informations à partir du code html du site.
Dans un terminal, entrez :
$ git clone https://github.com/antoine-royer/Odyssee.git
Cette commande va copier l'intégralité du dépôt à la racine de votre répertoire personnel.
Rendez-vous sur le site Discord Developer Portal et identifiez-vous. Cliquez sur le bouton 'New Application', en haut à droite. Dans la colonne de gauche, allez dans l'onglet bot, puis selectionnez 'Add Bot'. Confirmez.
Dans l'onglet OAuth2, descendez au niveau du cadre 'SCOPES' et selectionnez la case 'bot' un second cadre nommé 'BOT PERMISSIONS' devrait appraître en dessous, sélectionnez 'Administrator'. Ouvrez le lien situé dans le champ, en bas du cadre 'SCOPES' et laissez-vous guider par Discord. (Identification, sélection du serveur, vérification)
Avant de fermez la fenêtre, retournez dans l'onglet Bot et copiez le token.
Dans votre répertoire personnel, allez dans le dossier Odyssee et créez un fichier config.json. Ouvrez-le et insérez-y le code suivant :
{
"TOKEN": < le token opié à l'étape précédente >,
"PREFIX": "+",
"ADMIN": {}
}
À noter que le token doit être entre guillemets et doit rester secret.
Le préfix vous permettra d'appeller le bot lorsque vous jouerez, prenez un charactère simple, de préférence unique, évitez les charactères déjà pris (*, /, _…).
Le dictionnaire ADMIN est composé des identifiants des serveurs en clefs (sous forme de chaînes de caractères) et des idenfiants des maîtres du jeux en valeurs. Ces derniers auront ainsi accès à quelques commandes supplémentaires (surtout pour modérer et modifier les joueurs). Pour connaître l'idenfiant d'une personne, activez le mode développeur de Discord et faîtes clique droit sur la personne, dernière ligne 'copier l'identifiant'. Il s'agit bien d'un chiffre et non d'une chaîne de caractères.
Ouvrez un terminal et entrez :
$ cd Odyssee && python odyssee.py && exit
Si vous avez un doute sur la version de python installée sur votre ordinateur, vous pouvez forcer l'utilisation de python 3 en entrant :
$ cd Odyssee && python3 odyssee.py && exit
Si vous avez changé de place le répertoire Odyssee il faut préciser le chemin relatif en partant de la racine de votre répertoire personnel ($ cd pour placer le répertoire courant du terminal sur votre répertoire personnel).
Par exemple si le répertoire Odyssee est stocké dans un dossier bots_discord situé sur le bureau, la commande devient :
$ cd Bureau/bots_discord/Odyssee && python odyssee.py && exit
Passons sur Discord !
La commande pour accéder à l'assistance est affichée dans le status personnalisé du bot. Par défaut la commande est +aide.
Pour accéder à la documentation des commandes administrateur : +aide_admin
Si votre version du bot n'est plus à jour, vous pouvez mettre à jour votre dépôt local en entrant :
$ cd Odyssee && git pull
dans un terminal.
Les seuls fichiers créés par le bot sont les sauvegardes dans le dossier saves. Les sauvegardes sont au format json et contiennent toutes les statistiques des joueurs. Ce fichier n'est pas crypté et est tout à fait modifiable à la main. Lorsque le bot est éteint, ce fichier constitue sa seule mémoire, le supprimer revient à détruire la partie.
Normalement, si le fichier n'est pas corrompu, il ne devrait pas y avoir de problème de lecture. Mais faire un duplicata du fichier peut-être judicieux en cas de modification manuelle du fichier.
La base de donnée est tout à fait modifiable à la main, et une commande administrateur permet de rajouter des objets directement pendant le jeu. Vous pourrez utilisez, par exemple, le logiciel DB Browser for SQLite pour éditer la base de donnée.