Discourse Frotz 🧙

[merefield (Robert)]

Ouaip, un nouveau plugin ! Celui-ci est un peu moins sérieux, cependant.

Discourse Frotz

^{Il n’est plus nécessaire de mentionner le bot @ à chaque étape. Une fois en jeu, il suffit de lui répondre.}

Dépôt Git : GitHub - merefield/discourse-frotz: A plugin that uses Frotz to give you an interactive fiction experience on your Discourse forum · GitHub

Qu’est-ce que c’est

C’est un « bot » avec lequel jouer à de la fiction interactive, aka des jeux d’aventure textuels classiques, sur votre forum Discourse. Il agit essentiellement comme un adaptateur pour l’interpréteur Z-machine standard et incroyable appelé « frotz » à l’adresse David Griffith / frotz · GitLab

Comment l’utiliser

La configuration ajoute deux jeux ; vous pouvez en ajouter d’autres dans les paramètres.

Chaque entrée contient un titre et le nom du fichier de l’histoire.

Pour lancer l’interaction, vous devez mentionner le bot défini dans les paramètres avec @. Après cela, répondre à l’un de leurs messages suffit.

Pour lister les jeux disponibles, vous devez d’abord mentionner le bot et demander :

@monbot list games

Cela vous donnera la gamme d’options.

Pour démarrer un jeu, tapez :

start game x en remplaçant x par le numéro de l’option.

Si vous souhaitez passer à un autre jeu, vous pouvez le faire ; le plugin sauvegarde votre progression à chaque mouvement, vous permettant de revenir à la première histoire à tout moment. Le plugin maintient une sauvegarde pour chaque histoire pour chaque utilisateur qui l’essaie.

Pour continuer un jeu existant, tapez :

continue game x en remplaçant x par le numéro de l’option.

NB Une reconstruction complète détruira tous les fichiers de sauvegarde. C’est un compromis nécessaire.

Comment jouer à un jeu d’IF ?

De nombreux « Meta’s » ont grandi avec ces choses. Pour ceux qui sont moins familiers, consultez cette aide-mémoire : Play Some Interactive Fiction

Configuration

Créer l’utilisateur Bot

(désolé, l’automatisation de cela est sur ma liste !)

Dans une session ssh, entrez dans votre conteneur et la console rails :

./launcher enter app
rails c

Ensuite, faites ceci :

u = User.create!(username: "Frotz", name: "FrotzBot", id:-5, email: "not@really.valid")
u.activate

Votre nouveau bot sera alors disponible pour être configuré dans l’interface utilisateur. Accédez aux paramètres de l’utilisateur dans l’interface via le bouton administrateur et désactivez tous les courriels. Mettez à jour l’avatar selon vos goûts.

Installer Discourse Frotz

Mettre à jour votre app.yml

C’est un peu plus intrusif qu’un plugin habituel.

Ajoutez ceci à app.yml :

hooks:
  after_code:
    - exec:
        cd: $home
        cmd:
          - git clone https://gitlab.com/DavidGriffith/frotz
    - exec:
        cd: $home/frotz
        cmd:
          - make dfrotz
    - exec:
        cd: $home/frotz
        cmd:
          - mkdir savegames
    - exec:
        cd: $home/frotz
        cmd:
          - mkdir stories
    - exec:
        cd: $home/frotz/stories
        cmd:
          - wget -O zork1.z3 https://eblong.com/infocom/gamefiles/zork1-r119-s880429.z3
    - exec:
        cd: $home/frotz/stories
        cmd:
          - wget --no-check-certificate http://www.douglasadams.com/creations/hhgg.z3
    - exec:
        cd: $home/plugins
        cmd:
          - git clone https://github.com/merefield/discourse-frotz

avant vos autres entrées de plugins.

Vous devez maintenant également ajouter le plugin Discourse BBCode !!

Reconstruisez avec la commande habituelle ./launcher rebuild app

Allez maintenant dans les paramètres du plugin et sélectionnez l’utilisateur bot que vous avez ajouté précédemment :

Histoires

Vous remarquerez que j’ai inclus quelques histoires. Vous pouvez en trouver d’autres sur https://ifdb.tads.org/. Cependant, surveillez les limites de débit ici ! Obtenir trop d’histoires depuis le même emplacement peut provoquer une erreur.

Notez également que les histoires ne sont pas hébergées sur des serveurs protégés par HTTPS (tut tut).

Si vous insistez pour en charger davantage, ajoutez-les à app.yml. Vous pourriez également les ajouter manuellement depuis l’invite de commande, mais sachez qu’elles seront effacées lors de la prochaine reconstruction complète.

Activer FrotzBot pour les messages privés (prudence conseillée)

Permet aux utilisateurs de jouer en privé, mais l’utilisation sera moins transparente. Si vous avez un serveur assez puissant, cela pourrait ne pas être un problème pour vous. Dans tous les cas, soyez conscient des implications pour la capacité. En alternative, encouragez les utilisateurs à jouer dans une Catégorie désignée.

par défaut : OFF

Si (il/elle) n’est pas activé(e) là-bas, l’utilisateur recevra un message poli :

Restreindre FrotzBot par Catégorie

Vous pouvez restreindre le bot à une (liste de) Catégorie(s) pour éviter de remplir d’autres zones :

Raccourcis clavier !

C’est vraiment important pour améliorer l’expérience de « jeu ». Et vous n’avez vraiment besoin de retenir que deux raccourcis :

• Shift-R pour répondre au bot

• Ctrl-Enter pour soumettre votre prochain mouvement

Limitations et considérations

Tous les formats d’histoires et jeux ne sont pas encore pris en charge, ni susceptibles de l’être. De nombreux jeux ne fonctionnent pas en raison de la nature de leurs protocoles d’appel et de réponse. En raison de la manière dont nous interagissons message par message, nous devons demander à Frotz de sauvegarder l’état après chaque mouvement. Si une étape du jeu ne conduit pas à une invite à laquelle le système peut sauvegarder (en ignorant les invites « appuyez sur une touche » ou « Plus » qui devraient être gérées), alors l’histoire ne fonctionnera pas. Par exemple, dans Act of Murder (excellent jeu !), la dame à la porte demande si vous êtes un policier. Malheureusement, c’est un état du jeu qui ne peut pas être sauvegardé, ce qui échoue à cette exigence, et je ne vois pas comment nous pourrions faire fonctionner cela.

NB Le mode liste de diffusion est un désastre avec cela, alors assurez-vous que ce n’est pas quelque chose que vous utilisez avant d’essayer d’utiliser ce plugin !

On pourrait dire que c’est un peu gaspilleur de ressources du forum car cela nécessite au moins deux messages pour chaque « mouvement ». Il est évidemment souvent plus approprié de jouer à ce type de jeux en utilisant une interface de chat plutôt qu’un forum, mais vous pourriez argumenter que cela pourrait être utilisé pour créer des guides de jeu ?

Pour une solution moins intrusive, considérez : Turning a topic into interactive fiction ;)

Commentaires

Tous les commentaires sont les bienvenus !

Crédits

Ce plugin exploite David Griffith / frotz · GitLab, l’interpréteur Z Frotz, qui est cloné et « compilé » par le script de configuration.

Merci à @P16 de m’avoir permis d’utiliser des extraits de code d’un chatbot propriétaire sur lequel nous avons travaillé ensemble.

[merefield (Robert)]

Wooah, back again!

New Feature-rettes

Enable FrotzBot for private messages (at your peril! )

Allows users to play in private, but usage will be less transparent. If you have a big enough server this may not be an issue for you.

various fixes, code improvements and new feature to control use in private messages

default: OFF

If (s)he is not enabled there, the user will get a polite message:

Restrict to a list of Categories, or allow all:

FEATURE: restrict public games by Category

default: ON for all Categories

[Benjamin_D (Benjamin Decotte)]

Salut Robert ! Merci, j’apprécie vraiment ce plugin !
J’ai essayé de l’installer dans un environnement de développement (sans Docker) et mon système a demandé la bibliothèque ncursesw lors de la compilation de dfrotz. Après l’avoir installée, tout a fonctionné. Est-ce que ce sera le cas dans un environnement de production avec Docker ?

[merefield (Robert)]

J’ai testé en production et la construction sur Docker (à ma surprise) a fonctionné sans problème. N’hésitez pas à déployer sur une instance de production et faites-moi savoir comment cela se passe.

Content que cela vous plaise !!

[Benjamin_D (Benjamin Decotte)]

Pour ceux comme moi, qui pourraient perdre leurs derniers cheveux à ce sujet :

@merefield

Chaque entrée contient un titre, le nom du fichier de l’histoire et trois paramètres d’étalonnage pour filtrer le texte renvoyé et supprimer le texte de gestion, afin que les utilisateurs ne voient que le texte de l’histoire.

hhgg.z3,9,7,3
c’est :

  story_header_lines = 9
  story_load_lines = 7
  story_save_lines = 3

et maintenant, comment l’adapter… , c’est une aventure dans une aventure… !

[merefield (Robert)]

Je travaille actuellement avec le mainteneur de Frotz pour voir si nous pouvons nous passer de ceux-ci. C’est une approche que j’ai portée depuis restful-Frotz, mais loin d’être parfaite

[Benjamin_D (Benjamin Decotte)]

Oui ! Je l’ai trouvé !
kheper.z8,20,15,4 fonctionne presque
pour celui-ci :

Kheper – Une aventure égyptienne – Fiction-interactive.fr

Ce n’est rien, mais il y a quelque chose d’étrange

) Affichage par ligne DÉSACTIVÉ
Mode de compression MAX, masquant les 0 premières lignes

est affiché une fois par Pause() avec

[Pause notNeeded;
@read_char 1 notNeeded;
rtrue;
];

[merefield (Robert)]

Ha, oui, il y a beaucoup de particularités et une variété considérable dans les histoires. Je ne peux pas promettre de toutes les prendre en charge.

Actuellement, mon objectif est de :

1. simplifier le code
2. rendre le code plus sécurisé
3. ajouter de la mise en forme lorsque c’est pragmatique.

Le point n°3 est étonnamment difficile.

[merefield (Robert)]

J’ai poussé quelques améliorations sur une branche de fonctionnalité :

GitHub - merefield/discourse-frotz at formatting_security_and_simplification

Cela élimine les paramètres de suppression absurdes, introduit la traduction vers BBCode pour prendre en charge le formatage et les couleurs, exploite mieux les options de ligne de commande de Dumb Frotz, rend inutile l’écriture dans un flux de texte et corrige une vulnérabilité.

Cette branche nécessite que le plugin BBCode officiel soit installé.

Je suis encore en train d’expérimenter avec. N’hésitez pas à faire de même.

Je ferai probablement la fusion après quelques tests significatifs.

[elijah (Eli the Bearded)]

Le plugin a-t-il besoin de cloner l’ensemble du dépôt frotz ou suffit-il que $home/frotz/dfrotz existe ? Je préférerais le compiler une seule fois et conserver le binaire entre les reconstructions.

[merefield (Robert)]

Je ne sais pas vraiment pourquoi cela vous importe ? Les ressources dont nous parlons sont comparativement minuscules (6 Mo pour l’ensemble du dépôt après make, contre des gigaoctets pour le forum ?). Il clone l’intégralité du dépôt, puis compile simplement dfrotz. Peut-être que c’est un peu gaspilleur, mais la simplicité et la reproductibilité sont, selon moi, plus importantes. Je pourrais entrer dans plus de détails et effectuer un clone partiel, mais cela rendrait le script de construction plus complexe et moins robuste. En vaudrait-il la peine ? N’hésitez pas à suggérer une optimisation. Tout cela est construit à l’intérieur du conteneur, donc sera nettoyé à chaque fois que le conteneur l’est.

[elijah (Eli the Bearded)]

Je cherche simplement à optimiser pour mon petit serveur, je ne vous demande pas de modifier l’installation générale.

[Chaboi_3000]

C’est vraiment un super plugin ! Cela me rappelle un jeu d’ordinateur « classique » créé il y a des années (j’ai oublié le nom).

[merefield (Robert)]

C’est une excellente suggestion pour une future optimisation, à condition que je puisse la garder simple et robuste. Merci !

[merefield (Robert)]

Oui, il existe de nombreux classiques jouables. Davantage via le lien dans le message original.

[merefield (Robert)]

Grosse mise à jour :

(Cela a nécessité plusieurs mois de travail occasionnel en arrière-plan et de coordination avec l’équipe Frotz).

Présentation du formatage couleur complet et du texte en police à chasse fixe pour les histoires

Bbcode frotz (#2)

Cette importante mise à jour s’accompagne de nombreuses améliorations :

• AJOUT du support du formatage couleur et du texte en police à chasse fixe
• AMÉLIORATION des paramètres simplifiés : plus besoin de calibrer l’en-tête et le pied de page, il suffit de spécifier le titre souhaité et le fichier d’histoire, ouaou !
• AMÉLIORATION : utilisation de la gemme Open3 pour les commandes système, réduisant ainsi les risques d’abus et de vulnérabilités.
• AMÉLIORATION de l’interaction interne avec la ligne de commande pour supprimer le besoin de fichiers de flux ; le système gère désormais les invites « plus » ou « appuyez sur une touche ».

Cette mise à jour REQUIERT désormais le plugin Discourse BBCode !!

Cela a nécessité la collaboration du mainteneur de Frotz, David Griffiths, et d’un membre très actif de cette communauté, Borg323, qui a écrit les extensions BBCode conformément à la norme BBCode de Discourse. Un immense merci à eux ! Nous avons dû faire preuve de créativité pour faire fonctionner le texte en police à chasse fixe, mais la solution est vraiment excellente !

Quelques exemples du nouveau formatage (je n’ai pas entièrement testé ces histoires, il s’agit simplement d’exemples de formatage)

et remarquez la boussole colorée ici :

PROBLÈMES CONNUS : De nombreux jeux ne fonctionnent pas en raison de la nature de leurs protocoles de requête et de réponse. Si une étape du jeu ne vous mène pas à une invite où vous pouvez sauvegarder (en ignorant les invites « appuyez sur une touche » ou « plus » qui devraient être gérées), l’histoire ne fonctionnera pas. Par exemple, dans Act of Murder (excellent jeu !), la femme à la porte vous demande si vous êtes policier. Malheureusement, c’est un état du jeu qui ne peut pas être sauvegardé, ce qui échoue à respecter cette exigence, et je ne vois pas de moyen de faire fonctionner cela.

Il existe probablement des jeux qui sont désormais compatibles avec Discourse Frotz alors qu’ils ne l’étaient pas auparavant… n’hésitez pas à expérimenter, mais notez la limitation mentionnée ci-dessus !

Faites-moi part de tout problème que vous rencontreriez pour faire fonctionner cela, et j’affinerai les instructions selon les besoins.

[merefield (Robert)]

Rappel : vous pouvez utiliser des raccourcis clavier pour améliorer votre expérience avec ce plugin :

• Maj-R pour répondre au bot

• Ctrl-Entrée pour soumettre votre prochain coup

(Raccourcis clavier standard fournis par défaut).

[Benjamin_D (Benjamin Decotte)]

Salut Robert !
J’ai enfin eu le temps d’aller plus loin. Jusqu’ici, tout va bien, ça a fonctionné directement en environnement de production

Étrangement, frotz ne parvient pas à répondre aux messages privés sauf si je le configure également dans une catégorie quelconque
Prochaine étape : jouer

[merefield (Robert)]

Merci pour le rapport !

J’ai corrigé le problème : FIX: behaviour of private messages playing permission setting · merefield/discourse-frotz@34b022e · GitHub

NTS : il faut ajouter quelques tests unitaires !

[Benjamin_D (Benjamin Decotte)]

J’ai essayé d’ajouter :grin: dans une source,

Ça va être amusant !