La_Syl Studio
Jeux

Janken - Twitch Chat Game

Download
Documentation pour le jeu Twitch du Janken.

Introduction

Description

Le jeu chat du janken est un jeu de pierre feuille ciseaux auquel les viewers de votre chat peuvent jouer soit via commande, soit via les récompenses de points de chaine.

Une fois le défi lancé et accepté, les joueurs doivent choisir un mode de jeu pour définir le nombre de points à avoir pour remporter la partie. Le jeu vient pré-configuré avec 3 modes:

  • Mort Subite (le premier qui remporte un point gagne)
  • 3 points (le premier joueur à 3 points gagne)
  • 5 points (le premier joueur à 5 points gagne)

Une fois la partie commencée, les joueurs doivent envoyer un message en chuchotement Twitch au compte bot du broadcaster avec leur choix pour cette manche (pierre, feuille ou ciseaux).

Pendant la partie, le bot enverra des messages dans le chat du stream pour notifier tout le monde des avancées de la partie, des gagnants et des scores.

À la fin de la partie, des points sont donnés à chaque joueur. Si un achèvement a été débloqué le joueur sera aussi notifié directement dans le chat Twitch.

Mises à jour prévues

  • Interface de jeu pour overlay
  • Leader board des viewers
  • Amélioration du design graphique

Installation et configuration

Prérequis

Afin de pouvoir installer ce jeu sur votre stream vous avez besoin des outils suivants:

  • Streamer bot v1.0 ou supérieur
  • OBS Studio
  • Un compte bot twitch

Importez les actions dans Streamer Bot.

Streamer bot désactive les commandes importées par défaut. Réactivez les commandes suivantes:
  • !janken (si vous voulez déclencher les parties avec la commande, sinon utilisez uniquement la récompense de points de chaîne)
  • !jankenAchievements pour recevoir la liste des achèvements débloqués dans le chat
  • resetJanken pour réinitialiser le jeu

Démarrez le server websocket

  • Servers > WebSocket Server > Start
Le widget utilise la requete SendMessage() qui nécéssite l'authentification pour fonctionner ! Si vous ne voulez pas vous authentifier, le widget utilisera l'action Send Achievements comme fallback.

Connectez votre compte bot à Streamer Bot

Le compte bot est utilisé pour recevoir les messages en dehors du chat Twitch, afin d'éviter que les joueurs sachent ce que l'autre joueur a envoyé. Il est aussi utilisé pour envoyer des messages de notification tout au long de la partie.

Créez une nouvelle récompense de points de chaînes Twitch (optionnel)

Si vous souhaitez que vos viewers déclenchent une nouvelle partie avec les récompenses de point de chaîne.

  • Créez votre nouvelle récompense avec les paramètres que vous voulez.
  • Cliquez sur l'action 1.0 Setup - Initiate Game
  • Double cliquez sur le trigger Reward Redemption et choisissez votre nouvelle récompense.

Ouvrez l'interface de configuration

  • Ouvrez le fichier janken-achievements-editor.html dans votre navigateur.
  • Cliquez sur "charger fichier".
  • Naviguez jusqu'au fichier json inclus dans le dossier du widget et selectionnez-le.

Remplissez vos informations de connexion à Websocket

  • Cliquez sur l'onglet Configuration.
  • Dans websocket settings, entrez vos informations de connexion à websocket.
Si vous avez changé le nom de la commande, des actions ou du fichier, vous devez mettre ces informations à jour dans cette page

Personnalisez les achèvements

  • Cliquez sur l'onglet Achèvements
  • Modifiez les textes des achèvements
  • Ajoutez / Supprimez des lignes comme bon vous semble.
La colonne "threshold" evalue la valeur de la variable globale reçue via streamer bot et déclenche l'achèvement lorsque les valeurs sont égales. Plus de possibilités seront inclues dans une future mise à jour.

Personnalisez les messages

Messages des achèvements

  • Cliquez sur l'onglet Messages
  • Éditez la valeur des messages envoyés par le widget. Les variables disponibles sont listées pour chaque champ.

Messages du jeu Les messages du jeu sont personnalisables dans les actions streamer bot. Chaque action a des dossiers Set Bot Messages qui incluent les arguments utilisés dans l'action pour les messages. Ouvrez les actions les unes après les autres et éditez les arguments dans ces dossiers.

Sauvegardez votre nouvelle config

  • Cliquez sur "sauvegarder" en haut de la page.
  • Écrasez l'ancien fichier de config avec le votre.

Ajoutez une nouvelle source navigateur à OBS

  • Ajoutez une nouvelle source navigateur à OBS.
  • Entrez-y le chemin du fichier janken-achievements-widget.html avec le protocole absolute comme ceci: http://absolute/C:/your/path/to/janken-achievements-widget.html
  • Les dimensions n'ont pas d'importance : cette source n'est pas visible, elle agit comme backend.
  • Assurez-vous que la source reste active tout au long de votre stream sinon elle ne pourra pas communiquer avec streamer bot.
Si vous n'entrez pas le chemin du fichier avec le protocole absolute il y aura des erreurs !

C'est tout. Vous pouvez tester une nouvelle partie pour confirmer que tout marche comme prévu.


Commandes & Contrôles Disponibles

Tous les contrôles du jeu passent via des commandes à envoyer dans le chat Twitch à l'exception des commandes pierre, feuille et ciseaux qui elles sont à envoyer en message privé au compte bot connecté dans Streamer Bot. Vous pouvez voir ici la liste complète des commandes configurées.

Ces commandes sont accessibles à des moments précis du lancement d'une partie.

CommandeDescriptionDisponibilité
!janken [username]Défier un viewer au janken (optionnel)Entre les parties
!acceptJankenLe joueur défié accepte la partie de jankenAprès qu'un viewer aie commencé une partie
!refuseJankenLe joueur défié refuse la partie de jankenAprès qu'un viewer aie commencé une partie
!modeChoix du mode de la partie par joueur 1 ou 2Après qu'un joueur aie accepté une partie de Janken

Système de scores et d'achèvements integré

Le jeu inclus un système de scores et d'achèvements personnalisable via l'interface fournie dans le widget. Vous trouverez ici les informations de la configuration par défaut.

Scores des joueurs

Tout au long de la partie le jeu enregistre les scores des viewers dans les variables globales utilisateur. Les points suivants sont comptés :

  • Nombre de parties
  • Nombre de victoires
  • Nombre de parties perdues
  • Nombre de parties abandonnées
  • Nombre d'utilisations de pierre / papier / ciseaux

Succès déblocables

Le jeu est pré-configuré avec 20 succès déblocables par les viewers selon les points accumulés pendant les parties. Les succès sont bien entendu personnalisables, vous pouvez ajouter et modifier ce que vous voulez comme bon vous semble !

SuccèsMessageGroupeVariableCondition
A joué 10 partiesNovice au Janken.Achievement - Janken 10 GamesjankenGamesQuand jankenGames est égal à 10
A joué 25 partiesHabitué du Janken.Achievement - Janken 25 GamesjankenGamesQuand jankenGames est égal à 25
A joué 50 partiesJanken Pro Player.Achievement - Janken 50 GamesjankenGamesQuand jankenGames est égal à 50
A joué 100 partiesAccro au Janken.Achievement - Janken 100 GamesjankenGamesQuand jankenGames est égal à 100

Dépannage

Le widget ne se connecte pas

  • Vérifier que le serveur WebSocket est bien démarré
  • Si vous utilisez l'authentification, confirmez que votre mot de passe est correct dans l'éditeur, et que vous avez bien sauvegardé votre configuration.
  • Confirmez que le fichier .json est bien présent dans le dossier et que son nom est le même que dans l'éditeur.
  • Vérifiez que l'URL a été entré correctement dans la source navigateur OBS précédé de http://absolute/.

Les achievements ne se débloquent pas

  • Vérifier que la source OBS est active pendant votre stream.
  • Confirmez que les variables configurées sont correctes dans l'éditeur et que vous avez bien sauvegardé votre configuration.