ShiFuMi (Pierre-Feuille-Ciseaux)

ShiFuMi est une implémentation en Node.js du célèbre jeu Pierre-Feuille-Ciseaux (ou Shi Fu Mi). Ce package permet de jouer contre l'ordinateur et peut être utilisé à la fois en ligne de commande ou intégré dans vos projets Node.js.

Fonctionnalités

• Jouer une partie contre l'ordinateur.
• Gestion des règles du jeu.
• Retour des résultats : Gagné, Perdu ou Égalité.
• Interface CLI pour jouer directement en ligne de commande.
• Facilement intégrable dans d'autres projets.

Installation

npm install shifumi

Utilisation

En tant que module Node.js

Vous pouvez importer la classe ShiFuMi pour l'utiliser dans vos projets :

const ShiFuMi = require("shifumi");

const game = new ShiFuMi();
const result = game.play("pierre");

console.log(`Vous avez choisi : ${result.userChoice}`);
console.log(`L'ordinateur a choisi : ${result.computerChoice}`);
console.log(`Résultat : ${result.result}`);

En CLI

Après installation globale ou clonage du projet, utilisez la commande suivante :

shifumi

Puis entrez votre choix (pierre, feuille, ou ciseaux) lorsque l'invite apparaît.

Exemple de sortie

Bienvenue au jeu Shi Fu Mi (Pierre-Feuille-Ciseaux)!
Entrez votre choix (pierre, feuille, ciseaux) : pierre
Vous avez choisi : pierre
L'ordinateur a choisi : feuille
Résultat : Perdu

API

Classe ShiFuMi

Méthodes

1. play(userChoice: string): object

   • Permet de jouer une partie.
   • Paramètres :
     • userChoice (string) : Le choix de l'utilisateur (pierre, feuille, ou ciseaux).
   • Retour :
     • userChoice (string) : Le choix de l'utilisateur.
     • computerChoice (string) : Le choix généré par l'ordinateur.
     • result (string) : Le résultat (Gagné, Perdu, ou Égalité).

2. generateComputerChoice(): string

   • Retourne un choix aléatoire pour l'ordinateur.

3. isValidChoice(choice: string): boolean

   • Valide si un choix est correct (pierre, feuille, ou ciseaux).

Contribution

Les contributions sont les bienvenues ! Si vous trouvez un bug ou souhaitez proposer une amélioration, n'hésitez pas à ouvrir une issue ou une pull request sur GitHub.

Licence

Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus d'informations.