GameShell (gash) est le résultat d'une réflexion sur comment enseigner les rudiments (et un peu plus) du shell à des étudiants en première année à l'université Savoie Mont Blanc.

L'idée initiale, due à Rodolphe Lepigre, était de lancer un shell bash avec un fichier de configuration qui permettait d'effectuer des "missions", qui seraient "validées" pour avancer.

N'hésitez pas à m'envoyer vos remarques, questions ou suggestions autour de GameShell. En particulier, je suis preneur de nouvelles missions !

GameShell est soumis à la licence GPLv3 https://www.gnu.org/licenses/gpl-3.0.en.html

GameShell devrait (??) fonctionner sur un système Linux standard. Pour Debian/Ubuntu, il faut avoir les paquets suivants :

• psmisc
• nano
• tree
• x11-apps
• bsdmainutils (pour la mission 12)
• python3 (pour générer la mission 33, mais conseillé de toute façon)

Pour macOS, il faut installer coreutils et md5sha1sum. Le plus simple est d'utiliser le gestionnaire de paquets homebrew :

$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

puis d'installer les paquets nécessaires avec

$ brew install coreutils
$ brew install md5sha1sum

Pierre Hyvernat

http://www.lama.univ-smb.fr/~hyvernat

[email protected]

En récupérant l'archive du dépot

$ rm -rf GameShell && mkdir GameShell && wget  https://api.github.com/repos/phyver/GameShell/tarball -O -  |  tar -xz -C GameShell --strip-components 1
$ ./phyver-GameShell-*/start.sh

ou, si votre version de tar ne supporte pas l'option --strip-components

$ rm -rf phyver-GameShell-* && wget  https://api.github.com/repos/phyver/GameShell/tarball -O -  |  tar -xz
$ ./phyver-GameShell-*/start.sh
...
...

Après avoir cloné le dépot :

$ git clone https://github.com/phyver/GameShell.git
$ ./GameShell/start.sh -F
...
...

Après avoir cloné le dépot :

$ cd GameShell
$ ./bin/archive.sh -M"*find*"
copie des missions choisies
    /export/home/hyvernat/src/Shell/GameShell/missions/20_find_1  --> 01_find_1
    /export/home/hyvernat/src/Shell/GameShell/missions/31_find_2  --> 02_find_2
    /export/home/hyvernat/src/Shell/GameShell/missions/32_find_3_xargs -->  03_find_3_xargs
suppression des scripts 'auto.sh' des missions
choix du mode de lancement
création de l'archive
suppression du répertoire temporaire
$ ls
GameShell.tgz  README  World/  bin/  doc/  lib/  missions/  start.sh*

Le fichier GameShell.tgz contient une instance de GameShell avec uniquement les 3 missions autour de la commande find.

On peut maintenant copier cette archive n'importe où et lancer le jeu:

$ mv GameShell.tgz /tmp
$ cd /tmp
$ tar -xf GameShell.tar
$ ./GameShell/start.sh
...
...

L'idée de GameShell est d'avoir une session "la plus proche possible" d'une session shell "standard". Je l'utilise donc sur des machines Linux "standard", ou sur une machine virtuelle.

Il est possible de créer une image Docker en utilisant le fichier Dockerfile fourni pour lancer GameShell sans s'occuper des dépendances :

Création de l'image :

$ docker build -t gash .

Lancement de l'image, si vous avez un serveur X :

host +"local:docker@" \
&& docker run -it \
     -e DISPLAY=${DISPLAY} \
     -v /tmp/.X11-unix:/tmp/.X11-unix \
     gash

Lancement de l'image, sans serveur X :

docker run -it gash

GameShell est simplement une instance de bash avec des fonctions supplémentaires. Ces fonctionnalités passent par la commande gash.

• gash help : affiche une petite liste des commandes
• gash HELP : affiche une liste plus complète des commandes
• gash show : affiche l'objectif de la mission courante
• gash check : vérifie si la mission actuelle est validée
• gash reset : recommence la mission courante

Chaque mission est contenue dans un répertoire dédié et peut fournir les fichiers suivants

• bashrc fichier ajouté à la configuration globale de la session utilisé pour la partie Ce fichier peut contenir des variables, aliases, etc. qui seront disponibles pendant toute la partie. (fichier bash, facultatif)

• static.sh fichier lu par bash au lancement de GameShell. C'est par exemple dans ce fichier que l'on peut créer des répertoires qui existeront pour toutes les missions. Remarque : ce fichier est lu par bash (source static.sh) et peut donc par exemple définir des variables d'environnement.

• bin répertoire contenant des exécutables utilisés pendant la partie Les fichiers contenus dans ce répertoire sont recopiés dans un répertoire caché $GASH_HOME/.bin, qui est ajouté au PATH global. (répertoire, facultatif)

• deps.sh pour vérifier si le système contient les dépendances de la mission Il doit renvoyer 0 si les dépendances sont satisfaites, et une valeur non nulle sinon. Remarque : ce fichier est lancé au début de la mission, et en cas de dépendance non satisfaite, la mission est annulée. (fichier bash, facultatif)

• init.sh fichier lu par bash au lancement de la mission. C'est par exemple dans ce fichier qu'on peut (re)générer des parties dynamiques de la mission. Remarque : ce fichier est lu (source init.sh) et peut donc créer des variables d'environnement. (fichier bash, facultatif)

• goal.txt petite description de la mission, affichée par gash show (fichier texte, obligatoire)

• check.sh fichier lu par bash pour vérifier que la mission est validée. Remarque : ce fichier est lu par bash (source check.sh) et doit se terminer par une commande renvoyant la valeur 0 (typiquement, true) en cas de succès, et par une commande renvoyant une valeur différente de 0 (typiquement false) en cas d'échec. (fichier bash, obligatoire)

• treasure.sh fichier bash lu par bash après validation de la mission. Cela permet d'ajouter des fonctionnalités comme "récompense" à certaines missions. (fichier bash, facultatif)

• treasure.txt fichier texte affiché par bash après validation de la mission (fichier texte, facultatif)

• auto.sh fichier lu par bash pour valider automatiquement la mission Remarque : ce fichier est lu par bash (source auto.sh). (fichier bash, facultatif)

• Pierre Hyvernat
• Rodolphe Lepigre
• Christophe Raffalli
• Xavier Provencal
• Clovis Eberhart
• Sébastien Tavenas
• Tiemen Duvillard

Ce code est distribué sous licence GPL.

Merci de pointer vers ce dépôt si vous l'utilisez.