Discourse Frotz 🧙

[merefield (Robert)]

Wooah, ein neues Plugin! Dieses ist jedoch etwas weniger ernst.

Discourse Frotz

^{Es ist nicht mehr notwendig, den Bot bei jedem Schritt zu erwähnen (@ mention). Sobald das Spiel läuft, antworte einfach darauf.}

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

Was ist das?

Es ist ein „Bot", mit dem du interaktive Fiktion, auch bekannt als klassische Text-Abenteuer-Spiele, auf deinem Discourse-Forum spielen kannst. Er fungiert im Wesentlichen als Adapter für den Standard- und fantastischen Z-Machine-Interpreter namens „frotz" unter David Griffith / frotz · GitLab

Wie man es benutzt

Das Setup fügt zwei Spiele hinzu; du kannst weitere in den Einstellungen hinzufügen.

Jeder Eintrag enthält einen Titel und den Namen der Story-Datei.

Um die Interaktion zu starten, musst du den in den Einstellungen festgelegten Bot erwähnen (@ mention). Danach reicht es aus, auf einen seiner Beiträge zu antworten.

Um die verfügbaren Spiele aufzulisten, musst du zuerst den Bot erwähnen und folgendes fragen:

@meinbot Spiele auflisten

Dies gibt dir die Auswahlmöglichkeiten.

Um ein Spiel zu starten, tippe:

Spiel x starten und ersetze x durch die Optionsnummer.

Wenn du zu einem anderen Spiel wechseln möchtest, kannst du dies tun; das Plugin speichert deinen Fortschritt bei jedem Zug, sodass du jederzeit zur ersten Story zurückkehren kannst. Das Plugin führt für jede Story und jeden Benutzer, der es ausprobiert, eine separate Speicherung durch.

Um ein bestehendes Spiel fortzusetzen, tippe:

Spiel x fortsetzen und ersetze x durch die Optionsnummer.

NB: Ein vollständiger Neuaufbau zerstört alle Speicherdaten. Dies ist ein notwendiger Kompromiss.

Wie spiele ich ein IF-Spiel?

Viele „Meta-Nutzer" sind mit diesen Dingen aufgewachsen. Für diejenigen, die weniger vertraut sind, schau dir diese Spickzettel an: Play Some Interactive Fiction

Setup

Bot-Benutzer erstellen

(Entschuldigung, die Automatisierung davon steht auf meiner Liste!)

Gib in einer SSH-Sitzung deinen Container und die Rails-Konsole ein:

./launcher enter app
rails c

Führe dann Folgendes aus:

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

Dein neuer Bot ist dann in der Benutzeroberfläche verfügbar. Gehe über den Admin-Button zu den Einstellungen des Benutzers in der UI und schalte alle E-Mails aus. Passe das Avatar nach Belieben an.

Discourse Frotz installieren

Deine app.yml aktualisieren

Dies ist etwas invasiver als ein übliches Plugin.

Füge dies zu app.yml hinzu:

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

vor deinen anderen Plugin-Einträgen.

Du musst nun auch das Discourse BBCode-Plugin hinzufügen!!

Baue mit dem üblichen ./launcher rebuild app neu auf.

Gehe nun zu den Plugin-Einstellungen und wähle den zuvor hinzugefügten Bot-Benutzer aus:

Geschichten

Du wirst feststellen, dass ich ein paar Geschichten hinzugefügt habe. Weitere findest du unter https://ifdb.tads.org/.
Aber beachte hier die Ratenbegrenzungen! Zu viele Geschichten von derselben Quelle zu erhalten, kann einen Fehler verursachen.

Beachte auch, dass die Geschichten nicht auf https-geschützten Servern liegen (tut tut).

Wenn du darauf bestehst, weitere zu laden, füge sie zu app.yml hinzu. Du könntest sie auch manuell über die Eingabeaufforderung hinzufügen, aber beachte, dass diese beim nächsten vollständigen Neuaufbau gelöscht werden.

FrotzBot für private Nachrichten aktivieren (Vorsicht geboten)

Ermöglicht Benutzern das private Spielen, aber die Nutzung ist weniger transparent. Wenn du einen ausreichend großen Server hast, ist dies möglicherweise kein Problem für dich. In jedem Fall sei dir der Einfluss auf die Kapazität bewusst. Als Alternative kannst du Benutzer ermutigen, in einer ausgewiesenen Kategorie zu spielen.

Standard: AUS

Wenn (er/sie) dort nicht aktiviert ist, erhält der Benutzer eine höfliche Meldung:

FrotzBot nach Kategorie einschränken

Du kannst den Bot auf eine (Liste von) Kategorie(n) beschränken, um andere Bereiche nicht zu füllen:

Tastenkürzel!

Dies ist wirklich wichtig, um das „Gaming"-Erlebnis zu verbessern. Und du musst wirklich nur zwei merken:

• Shift-R, um dem Bot zu antworten

• Ctrl-Enter, um deinen nächsten Zug einzureichen

Einschränkungen und Überlegungen

Nicht alle Story-Formate und Spiele werden unterstützt, und es ist auch unwahrscheinlich, dass sie es jemals sein werden. Es gibt viele Spiele, die nicht funktionieren, weil sie Art und Weise ihrer Anruf- und Antwortprotokolle. Aufgrund der Art und Weise, wie wir postweise interagieren, müssen wir Frotz nach jedem Zug auffordern, den Zustand zu speichern. Wenn ein Schritt des Spiels nicht zu einer Eingabeaufforderung führt, bei der das System speichern kann (wobei „Drücke eine beliebige Taste" oder „Mehr"-Aufforderungen ignoriert werden, die behandelt werden sollten), funktioniert die Story nicht. Zum Beispiel: In „Act of Murder" (ein großartiges Spiel!) fragt die Dame an der Tür, ob du ein Polizist bist. Leider ist dies ein Spielzustand, der nicht gespeichert werden kann, was diese Anforderung nicht erfüllt, und ich sehe keinen Weg, dies zum Laufen zu bringen.

NB: Der Mailinglisten-Modus ist mit diesem ein Desaster, also stelle sicher, dass du dies nicht verwendest, bevor du versuchst, dieses Plugin zu nutzen!

Es ist wohl etwas verschwenderisch mit Forum-Ressourcen, da für jeden „Zug" mindestens zwei Beiträge erforderlich sind. Offensichtlich ist es oft angemessener, solche Spiele über eine Chat-Schnittstelle statt über ein Forum zu spielen, aber man könnte argumentieren, dass dies zur Erstellung von Walkthroughs genutzt werden könnte?

Für eine weniger invasive Lösung betrachte: Turning a topic into interactive fiction ;)

Feedback

Alle Rückmeldungen sind willkommen!

Credits

Dieses Plugin nutzt David Griffith / frotz · GitLab, den Frotz Z-Interpreter, der vom Setup-Skript geklont und „gebaut" wird.

Danke an @P16, der mir erlaubt hat, Code-Auszüge aus einem Closed-Source-Chatbot zu verwenden, an dem wir gemeinsam gearbeitet haben.

[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)]

Hi Robert! Thank you, I really like this plugin !
I tried to install it on dev environment (without docker) and my system asked for the ncursesw lib when making dfrotz, after installing that it worked, will it be the case with a prod env with docker?

[merefield (Robert)]

I tested on Production and building on Docker (to my surpirse) worked out of the box. Feel free to deploy to a Production instance and let me know how you get on.

Glad you like it!!

[Benjamin_D (Benjamin Decotte)]

For those like me, who might loose their last few hairs about that:

@merefield

Each entry contains a Title, name of the story file, and three calibration settings to cull the returned text to remove the housekeeping text so users see just the story text.

hhgg.z3,9,7,3
that’s :

  story_header_lines = 9
  story_load_lines = 7
  story_save_lines = 3

and now, how to adapt it… , that’s an adventure inside an adventure…!

[merefield (Robert)]

I’m currently working with the maintainer of Frotz to see if we can do away with those. It’s an approach I ported from restful-Frotz but hardly perfect

[Benjamin_D (Benjamin Decotte)]

Yes ! found it !
kheper.z8,20,15,4 almost works
for this one :

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

it’s nothing, but there is something weird

) Line-type display OFF
Compression mode MAX, hiding top 0 lines

is displayed once by Pause() with

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

[merefield (Robert)]

Ha, yeah, there are lots of quirks and a considerable amount of variety in the stories. I cannot promise to support all.

Right now my focus is on:

1. simplifying code
2. making the code more secure
3. adding formatting where pragmatic.

#3 is surprisingly hard.

[merefield (Robert)]

I’ve pushed some improvements to a feature branch:

GitHub - merefield/discourse-frotz at formatting_security_and_simplification

This does away with the silly suppression settings, introduces translation to BBCode to support formatting and colour, leverages the Dumb Frotz command line options better, obviates the need to write to a text stream and squashes a vulnerability.

This branch requires the official BBCode plugin to be installed.

I’m still experimenting with it. Feel free to do so too.

I’ll probably merge after some significant trials.

[elijah (Eli the Bearded)]

Does the plugin need the whole frotz repo clone or does it just need $home/frotz/dfrotz to exist? Because I’d rather just compile it once and save the binary between rebuilds.

[merefield (Robert)]

Not sure why you would care? The resources we are talking about are comparatively tiny. (6MB for the entire repo post make versus Gigabytes for the forum?). It clones the whole repo, then just makes dfrotz. Perhaps that is slightly wasteful, but the simplicity and repeatability is more important I feel. I could go into greater detail and perform a sparse clone, but that would make the build script more complex and less robust. Would it be worth it? Feel free to suggest an optimisation. This is all building inside the container, so will get cleaned whenever the container does.

[elijah (Eli the Bearded)]

I’m just trying to optimize for my tiny server, not asking you to change the general install.

[Chaboi_3000]

This is a really cool plugin! This reminds me of a “classic” computer game that was created years ago(I forgot the name).

[merefield (Robert)]

It’s a great suggestion for a future optimisation if I can keep it simple and robust. Thanks!

[merefield (Robert)]

Yes there are many playable classics. More via the link in the OP.

[merefield (Robert)]

Großes Update:

(Das hat Monate an gelegentlicher Hintergrundarbeit und Koordination mit dem Frotz-Team erfordert.)

Einführung von Vollfarbe und monospaced Formatierung für Geschichten

Bbcode frotz (#2)

Dieses große Update bringt eine Reihe von Verbesserungen mit sich:

• HINZUGEFÜGT: Farbformatierung und Unterstützung für monospaced Text
• VERBESSERT: Vereinfachte Einstellungen: Keine Kalibrierung von Kopf- und Fußzeile mehr erforderlich, nur noch gewünschter Titel und Story-Datei, whoop!
• VERBESSERT: Verwendet die Open3-Bibliothek für Systembefehle, wodurch das Risiko von Missbrauch/Sicherheitslücken reduziert wird.
• VERBESSERT: Interne Interaktion mit der Kommandozeile, um die Notwendigkeit von Stream-Dateien zu eliminieren; bewältigt nun auch „mehr/Drücken Sie eine beliebige Taste“-Aufforderungen

Erfordert jetzt das Discourse BBCode-Plugin!!

Dies erforderte die Zusammenarbeit des Betreuers von Frotz, David Griffiths, und eines der sehr aktiven Mitglieder dieser Community, Borg323, der die BBCode-Erweiterungen gemäß dem BBCode-Discourse-Standard geschrieben hat. Vielen, vielen Dank an beide! Wir mussten etwas kreativ werden, um die monospaced-Text-Funktion zum Laufen zu bringen, aber die Lösung ist wirklich großartig!

Einige Beispiele für die neue Formatierung (ich habe diese Geschichten noch nicht vollständig getestet, dies sind nur Beispiele für die Formatierung):

Und beachten Sie den farbigen Kompass hier:

BEKANNTEN PROBLEME: Es gibt viele Spiele, die aufgrund der Art ihrer Anruf- und Antwortprotokolle nicht funktionieren. Wenn ein Schritt des Spiels nicht zu einer Aufführung führt, an der Sie speichern können (wobei „Drücken Sie eine beliebige Taste“ oder „Mehr“-Aufforderungen ignoriert werden, die verarbeitet werden sollten), funktioniert die Geschichte nicht. Zum Beispiel: In „Act of Murder“ (tolles Spiel!) fragt die Dame an der Tür, ob Sie ein Polizist sind. Leider ist dies ein Zustand des Spiels, der nicht gespeichert werden kann, sodass diese Anforderung nicht erfüllt wird, und ich sehe keinen Weg, dies zum Laufen zu bringen.

Es gibt wahrscheinlich Spiele, die jetzt mit Discourse Frotz kompatibel sind, die es vorher nicht waren … bitte experimentieren Sie, aber beachten Sie die oben genannte Einschränkung!

Lassen Sie mich wissen, wenn Sie Probleme haben, dies zum Laufen zu bringen, und ich werde die Anweisungen bei Bedarf verfeinern.

[merefield (Robert)]

Eine Erinnerung: Du kannst Tastenkürzel verwenden, um deine Erfahrung mit diesem Plugin zu verbessern:

• Shift-R, um auf den Bot zu antworten

• Strg-Enter, um deinen nächsten Zug einzureichen

(Standard-Tastenkürzel aus dem Lieferumfang).

[Benjamin_D (Benjamin Decotte)]

Hallo Robert!
Endlich hatte ich Zeit, weiterzumachen. Bisher läuft alles gut, es hat in der Produktionsumgebung sofort funktioniert

Seltsamerweise kann frotz keine privaten Nachrichten beantworten, es sei denn, ich stelle es auch in einer Kategorie ein
Nächster Schritt: Spielen

[merefield (Robert)]

Danke für den Bericht!

Ich habe das bereits behoben: FIX: behaviour of private messages playing permission setting · merefield/discourse-frotz@34b022e · GitHub

NTS: Ich muss noch ein paar Unit-Tests hinzufügen!

[Benjamin_D (Benjamin Decotte)]

Ich habe versucht, :grin: in einer Quelle hinzuzufügen,

es wird Spaß machen!