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, wieder da!

Neue Feature-ettes

FrotzBot für private Nachrichten aktivieren (auf eigene Gefahr! ;))

Ermöglicht Benutzern das Spielen im privaten Bereich, die Nutzung ist jedoch weniger transparent. Wenn Sie einen ausreichend großen Server haben, ist dies möglicherweise kein Problem für Sie.

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

Standard: AUS

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

Auf eine Liste von Kategorien beschränken oder alle zulassen:

FEATURE: restrict public games by Category

Standard: FÜR ALLE KATEGORIEN AKTIVIERT

[Benjamin_D (Benjamin Decotte)]

Hallo Robert! Vielen Dank, dieses Plugin gefällt mir wirklich gut!
Ich habe versucht, es in einer Dev-Umgebung (ohne Docker) zu installieren, und mein System hat beim Kompilieren von dfrotz nach der ncursesw-Bibliothek gefragt. Nach der Installation funktionierte es. Wird das in einer Prod-Umgebung mit Docker ebenfalls der Fall sein?

[merefield (Robert)]

Ich habe es in der Produktion getestet, und der Build auf Docker hat (zu meiner Überraschung) sofort funktioniert. Fühlen Sie sich frei, es auf einer Produktionsinstanz bereitzustellen und lassen Sie mich wissen, wie es läuft.

Freut mich, dass es Ihnen gefällt!!

[Benjamin_D (Benjamin Decotte)]

Für diejenigen unter uns, die vielleicht noch ein paar Haare darüber verlieren:

@merefield

Jeder Eintrag enthält einen Titel, den Namen der Story-Datei und drei Kalibrierungseinstellungen, um den zurückgegebenen Text zu bereinigen und den Hauskeeping-Text zu entfernen, sodass die Benutzer nur den Story-Text sehen.

hhgg.z3,9,7,3
Das bedeutet:

  story_header_lines = 9
  story_load_lines = 7
  story_save_lines = 3

Und nun, wie man das anpasst… , das ist ein Abenteuer im Abenteuer…!

[merefield (Robert)]

Ich arbeite derzeit mit dem Betreuer von Frotz zusammen, um zu prüfen, ob wir diese abschaffen können. Es ist ein Ansatz, den ich von restful-Frotz portiert habe, aber er ist alles andere als perfekt

[Benjamin_D (Benjamin Decotte)]

Ja! Ich habe es gefunden!
kheper.z8,20,15,4 funktioniert fast.
Für diese hier:

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

Es ist nichts Ernstes, aber etwas ist seltsam:

) Zeilenanzeige AUS
Kompressionsmodus MAX, versteckt die obersten 0 Zeilen

wird einmal von Pause() angezeigt mit:

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

[merefield (Robert)]

Ha, ja, die Geschichten weisen zahlreiche Eigenheiten und eine beträchtliche Vielfalt auf. Ich kann nicht versprechen, alle zu unterstützen.

Derzeit konzentriere ich mich auf:

1. Vereinfachung des Codes
2. Erhöhung der Sicherheit des Codes
3. Hinzufügen von Formatierung, wo es sinnvoll ist.

Punkt 3 ist überraschend schwierig.

[merefield (Robert)]

Ich habe einige Verbesserungen in einen Feature-Branch gepusht:

GitHub - merefield/discourse-frotz at formatting_security_and_simplification

Dadurch werden die albernen Unterdrückungseinstellungen abgeschafft, die Übersetzung nach BBCode eingeführt, um Formatierung und Farben zu unterstützen, die Dumb-Frotz-Command-Line-Optionen besser genutzt, das Schreiben in einen Textstream überflüssig gemacht und eine Sicherheitslücke geschlossen.

Dieser Branch setzt die Installation des offiziellen BBCode-Plugins voraus.

Ich experimentiere noch damit. Fühlen Sie sich frei, das auch zu tun.

Ich werde ihn wahrscheinlich nach einigen wesentlichen Tests zusammenführen.

[elijah (Eli the Bearded)]

Benötigt das Plugin den vollständigen Klon des frotz-Repos oder reicht es, wenn $home/frotz/dfrotz existiert? Ich würde es lieber einmal kompilieren und das Binär zwischen den Neukompilierungen speichern.

[merefield (Robert)]

Ich bin mir nicht sicher, warum dir das wichtig sein sollte? Die Ressourcen, über die wir sprechen, sind vergleichsweise winzig (6 MB für das gesamte Repository nach dem Make-Vorgang gegenüber Gigabytes für das Forum?). Es klonen das gesamte Repository und erstellen dann nur dfrotz. Das mag etwas verschwenderisch sein, aber für mich sind Einfachheit und Wiederholbarkeit wichtiger. Ich könnte zwar ins Detail gehen und einen Sparse-Clone durchführen, doch das würde das Build-Skript komplexer und weniger robust machen. Würde es sich lohnen? Du kannst gerne eine Optimierung vorschlagen. Dies läuft alles innerhalb des Containers ab und wird daher immer dann bereinigt, wenn der Container das tut.

[elijah (Eli the Bearded)]

Ich versuche nur, meine kleine Server zu optimieren und bitte dich nicht, die allgemeine Installation zu ändern.

[Chaboi_3000]

Das ist ein wirklich cooler Plugin! Das erinnert mich an ein „klassisches

[merefield (Robert)]

Das ist ein großartiger Vorschlag für eine zukünftige Optimierung, falls ich es einfach und robust halten kann. Danke!

[merefield (Robert)]

Ja, es gibt viele spielbare Klassiker. Weitere über den Link im 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!