Wiki Le BIK'LAB

Cette page est en lecture seule. Vous pouvez afficher le texte source, mais ne pourrez pas le modifier. Contactez votre administrateur si vous pensez qu'il s'agit d'une erreur.
====== Tamagotchi ======


Le tamagotchi est un jouet électronique portable qui simule un animal de compagnie virtuel, nécessitant des soins et une attention régulière de la part de son propriétaire. Sorti au Japon en 1996, ce jouet a connu un succès planétaire en 1997.



===== Objectifs de l’atelier =====

Cet atelier est destiné à découvrir la programmation python et son environnement de développement en codant un Tamagotchi. Le parti pris de l’auteur est démarrer avec un code objet fonctionnel avec un formalisme assez poussé, notemment par l’utilisation systématiques de docstring pour documenter le code.

==== Éléments de la programmation python abordés dans cet atelier ====

  * **Interactivité** : Créer des interactions entre l'utilisateur et le programme.
  * **Logique conditionnelle** : Utiliser des conditions pour déterminer les actions et les réactions.
  * **Boucles et entrées utilisateur** : Utiliser une boucle infinie ''While True:'' pour continuer à interagir avec l'utilisateur jusqu'à ce qu'il décide de quitter.
  * **utiliser ''print()''** avec des char, des docstrings et de l’interpolation avec ''print(f"{bitin}")''
  * **Gestion des états** (programmation objet): Gérer les différents états d'un animal de compagnie virtuel (faim, bonheur, énergie)

Dans une optique pythoniste, les stagiaires doivent récupérer un code source à modifier depuis un dépôt git en ligne.

===== Fonctionnalités du Tamagotchi =====

  - **Animal de compagnie virtuel** : Le Tamagotchi est un petit animal virtuel. Les utilisateurs doivent prendre soin de cet animal comme s'il s'agissait d'un véritable animal de compagnie.
  - **Interactivité** : Les propriétaires doivent nourrir, jouer avec, et nettoyer leur Tamagotchi. Ils doivent également s'assurer que l'animal dort et reste en bonne santé.
  - **Contrôle** : Le Tamagotchi est contrôlé à l'aide de menus qui permettent de sélectionner différentes actions.
  - **Évolution** : Le Tamagotchi passe par différentes étapes de vie, de l'œuf à l'adulte, et son apparence et son comportement changent en fonction des soins qu'il reçoit.
  - **Notifications** : Le Tamagotchi émet des bips pour notifier son propriétaire lorsqu'il a besoin de quelque chose, comme de la nourriture ou de l'attention.
===== Prérequis =====

  - un [[tutos:hacking:python:editeur-code|éditeur python]]
  - un navigateur connecté à l’Internet

===== Objectifs =====

  - Découvrir l’environnement de développement python (IDE, git)
  - identifier les morceaux (commentaires, fonctions, variables etc.) dans un code python et comprendre le fonctionnement global du script 
  - lire un code source et modifier un code source
  - comprendre les blocs d’exécution et l’indentation

===== Manipulations =====
  - utiliser un IDE et tester son code une fenêtre d’execution
  - récupérer un fichier depuis un dépôt GIT en ligne
  - utiliser un moteur de recherche pour trouver des éléments de syntaxe
  - expérimenter un élément par un mini script isolant le test du reste du programme
  - lire et comprendre un script python téléchargé sur internet
  - modifier un objet python : modification et création de méthodes et ajout d’attribut
  - comprendre les messages d’erreur
 
===== Étape 0 : introduction =====

==== Présentation du Tamagotchi ====

=== Publicité pour une réédition de Tamagotchi par Bandai ===
{{youtube>G4YabCOynXg?}}

=== Archive INA 1997 sur le phénomène Tamagotchi ===
{{youtube>2ND1nfJUxCo?}}

==== Objectifs de l’atelier ====
  - Découvrir l’environnement de programmation python
  - Créer un programme interactif

==== Étape 1 : récupérer le projet à modifier ====
  - avec le navigateur aller sur la page https://gitlab.com/lebiklab/atelier-python/-/blob/main/tamagotchi.py
  - cliquer sur le "Download"  
{{ :tutos:gitlab-dl-file.png?nolink&600 |}}
  - enregistrer le fichier localement sous le nom ''tamagotchi.py '' (par convention on enregistre les fichiers python avec l’extension ''.py'')
  - ouvrir le fichier dans [[tutos:hacking:python:editeur-code##thonny|Thonny]]{{ :tutos:capture_d_ecran_du_2024-08-06_15-21-50.png?nolink&600 |}}
  - lire le code, identifier et distinguer des blocs en se repérant avec les couleurs
  - exécuter le code et interagir avec

==== Étape 2 : ajouter un signal sonore pour le tamagotchi ====

Le Tamagotchi traditionnel se manifeste par un bip. Nous allons ajouter un bip à notre tamagotchi.
Pour cela, nous allons récupérer le son "Alerte" de notre système d’exploitation. Le son produit pourra donc être différent selon la machine sur laquelle nous exécuterons notre script python ''tamagotchi.py ''

Aller à la ligne n°124,     ''while True:'', créer une nouvelle ligne et ajouter le code suivant ''print("\a")''

<note>Attention à bien respecter l’indentation du code

En python, c’est en utilisant des tabulations que l’on délimite les blocs de code, à partir du bord gauche de la "page" (l’écran).

Ta ligne ''print("\a")'' doit donc être alignée avec les instructions qui suivent le ''While True:''
</note>
 
<code python>
    while True:
        # BIP !
        print("\a")
        print("\nChoisis une action: ")
        print("1. Nourrir")
        print("2. Jouer")
        print("3. Dormir")
        print("4. Statut")
        print("5. Quitter")
</code>

Relance le jeu

==== Étape 4 : Améliorations et fonctions à ajouter ====

=== ''sleep'' : ajouter une pause === 
On va ajouter une pause entre chaque action. Pendant cette pause, le Tamagotchi pourra de lui-même soit dormir, soit se nourrir, soit jouer, soit faire ses besoins (et donc salir). Le fait de faire ces actions par lui-même fera varier les niveaux de bonheur, fatigue et faim du Tamogotchi.

=== des seuils ===
On va également ajouter des seuils. Ex : si le Tamagotchi a 10 de faim et 10 de fatigue, il meurt.
Si le Tamagotchi à 0 de bonheur, il refuse de manger et veut jouer 


=== la fonction caliner ===
pour faire un calin à son Tamagotchi la fonction caliner n’existe pas encore ...)

==== Étape 5 : ajout de la pause ===
  - Rechercher dans un moteur de recherches "Comment faire une pause dans un programme python avec sleep"
  - Créer un fichier ''test_sleep.py'' avec un exemple fonctionnel de l’utilisation de sleep, en faisant une pause de 30 secondes.
  - Tester le script ''test_sleep.py''
  - Quand ce script fonctionne, ajouter les élements nécessaires (et aux bons endroits) dans le programme ''tamagotchi.py'' 

=== test_sleep.py ===
exemple de code avec une pause de 30 secondes

<code python>
import time
print("Cela commence ici : %s" % time.ctime())
time.sleep(30)
print("Le temps est maintenant écoulé : %s" % time.ctime())
</code>

Les lignes importantes sont
  * ''import time'' qui permet d’importer la libraire ''time''
  * ''time.sleep(30)'' qui utilise la libraire ''time'' pour faire une pause de 30 secondes


=== Modification du fichier ''tamagotchi.py''===

== import ==

À la ligne 24, avant la déclaration de la ''class Tamagotchi'', ajouter la ligne d’import

<code python>
"""
[...]
Licence:
    Ce programme est distribué sous licence GPL V3. Pour plus de détails, voir https://www.gnu.org/licenses/gpl-3.0.html
"""


import time

class Tamagotchi:
    """
    Classe représentant un Tamagotchi virtuel.
    [...]
    """
</code>

== sleep ==

À la ligne 127, avant l’action ''print("\a")'' (BIP), on va ajouter la pause

<code python>
    while True:
        # pause
        time.sleep(30)
        # BIP !
        print("\a")
</code> 

=== Test ===

  - Exécuter et tester le code
  - Avez-vous des idées d’amélioration ?

Actuellement, la pause s’execute systématiquement : après avoir nommé le tamagotchi et même quand on consulte son statut. On pourrait améliorer ça en faisant une pause uniquement lorsque le tamagotchi effectue une action comme dormir, manger ou jouer ?

==== Amélioration ====
Comment faire pour marquer une pause uniquement dans les actions dormir, manger ou jouer ?

on va déplacer l’instruction sleep(30) dans la définition d’une methode d’action (ex nourrir)
<note warning>
attention à placer l’instruction au bon endroit et à respecter l’indentation !
</note>

<code python>
    def dormir(self):
        """
        Fait dormir le Tamagotchi, augmentant son énergie.

        Si le niveau d'énergie est inférieur à 10, il est augmenté de 2. Si le niveau
        d'énergie est déjà à 10, un message indiquant que le Tamagotchi est déjà plein d'énergie
        est affiché.
        """
        if self.energie < 10:
            self.energie += 2
            sleep(30)
            print(f"{self.name} a dormi. Énergie: {self.energie}")
        else:
            print(f"{self.name} est déjà plein d'énergie!")

</code>

On va maintenant ajouter cette pause à chacune des méthodes dormir(), manger() et jouer().

On va également attribuer un temps de pause différent pour chacune de ces actions

}
==== Étape 6 : Ajout de la fonction ''caliner'' =====

Si le tamagotchi a faim, il refusera le calin. Sinon, grâce au calin, ses niveaux d’energie et de bonheur augmenteront

<note>
Exercice : ajouter la méthode ''caliner()'' dans la ''class Tamagotchi()'' en s’inspirant des méthodes ''nourrir()'', ''dormir()'' ou ''manger()''.

</note>
  * seuil de faim maximum pour un calin : 8
  * un calin ajoute :
    * + 2 de bonheur
    * +1 en energie

<note>
Pour pouvoir utiliser ta fonction tu dois l’ajouter dans le menu de ton application (les instructions affichées à l’écran après le ''While True:'') et prendre en compte le choix de l’utilisateur (''if choice =='') </note>

**Bonus** récupérer des pikachu en ASCII art pour illustrer le mood du Tamagotchi (print de docstring)

{{ :tutos:thonny-tamagotchi.jpg?direct&600 |}}