Discourse Frotz 🧙

[merefield (Robert)]

Uau, um novo plugin! Este é um pouco menos sério, embora.

Discourse Frotz

^{Não é mais necessário mencionar o bot @ a cada passo. Uma vez em jogo, basta responder a ele.}

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

O que é

É um ‘bot’ com o qual você pode jogar ficção interativa, também conhecida como jogos clássicos de aventura de texto, no seu fórum Discourse. Ele funciona essencialmente como um adaptador para o interpretador Z-machine padrão e incrível chamado ‘frotz’, disponível em David Griffith / frotz · GitLab

Como usar

A configuração adiciona dois jogos; você pode adicionar mais nas configurações.

Cada entrada contém um Título e o nome do arquivo da história.

Para iniciar a interação, você precisa mencionar o bot definido nas configurações. Depois disso, responder a uma postagem dele é suficiente.

Para listar os jogos disponíveis, primeiro você precisa mencionar o bot e perguntar:

@meubot listar jogos

Isso fornecerá a variedade de opções.

Para iniciar um jogo, digite:

iniciar jogo x substituindo x pelo número da opção.

Se quiser mudar para outro jogo, você pode fazê-lo; o plugin salva seu progresso a cada movimento, permitindo que você retorne à primeira história a qualquer momento. O plugin mantém um save para cada história para cada usuário que tenta.

Para continuar um jogo existente, digite:

continuar jogo x substituindo x pelo número da opção.

NB: Uma reconstrução completa destruirá todos os arquivos de save. Isso é um compromisso necessário.

Como jogar um jogo de IF?

Muitos “Membros” cresceram com essas coisas. Para aqueles menos familiarizados, confira este guia rápido: Play Some Interactive Fiction

Configuração

Criar o Usuário Bot

(desculpas, automatizar isso está na minha lista!)

Em uma sessão ssh, entre no seu container e no console rails:

./launcher enter app
rails c

Em seguida, faça o seguinte:

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

Seu novo bot estará então disponível para configuração na interface do usuário (UI). Vá para as configurações do usuário na UI através do botão de administrador e desative todas as notificações por e-mail. Atualize o avatar conforme seu gosto.

Instalar Discourse Frotz

Atualize seu app.yml

Isso é um pouco mais invasivo do que um plugin comum.

Adicione isso ao 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

antes de suas outras entradas de plugin.

Agora você também precisa adicionar o plugin Discourse BBCode!!

Reconstrua com o habitual ./launcher rebuild app

Agora vá para as configurações do plugin e selecione o usuário bot que você adicionou anteriormente:

Histórias

Você notará que incluí algumas histórias. Você pode encontrar mais em https://ifdb.tads.org/.
Mas, cuidado com os limites de taxa aqui! Obter muitas histórias do mesmo local pode causar um erro.

Observe também que as histórias não estão hospedadas em servidores protegidos por HTTPS (tut tut).

Se você insistir em carregar mais, adicione-as ao app.yml. Você também pode adicioná-las manualmente no prompt de comando, mas saiba que elas serão apagadas na próxima reconstrução completa.

Habilitar FrotzBot para mensagens privadas (caution advised)

Permite que os usuários joguem em particular, mas o uso será menos transparente. Se você tiver um servidor grande o suficiente, isso pode não ser um problema para você. De qualquer forma, esteja ciente das implicações para a capacidade. Como alternativa, incentive os usuários a jogar em uma Categoria designada.

padrão: DESATIVADO

Se (ele/ela) não estiver habilitado lá, o usuário receberá uma mensagem educada:

Restringir FrotzBot por Categoria

Você pode restringir o bot a uma (lista de) Categoria para evitar encher outras áreas:

Atalhos de teclado!

Isso é realmente importante para melhorar a experiência de ‘jogo’. E você realmente só precisa lembrar de dois:

• Shift-R para responder ao bot

• Ctrl-Enter para enviar sua próxima jogada

Limitações e considerações

Nem todos os formatos de história e jogos são suportados ainda, nem é provável que sejam. Existem muitos jogos que não funcionam devido à natureza de seus protocolos de chamada e resposta. Por causa da forma como interagimos postagem por postagem, temos que pedir ao Frotz para salvar o estado após cada movimento. Se uma etapa do jogo não levar a um prompt no qual o sistema possa salvar (ignorando “pressione qualquer tecla” ou prompts “Mais” que devem ser tratados), a história não funcionará. Por exemplo, em “Act of Murder” (ótimo jogo!), a senhora na porta pergunta se você é um policial. Infelizmente, isso é um estado do jogo que não pode ser salvo, falhando nesse requisito, e não vejo como faríamos isso funcionar.

NB: O modo de lista de e-mails é um desastre com isso, então certifique-se de que isso não é algo que você usa antes de tentar usar este plugin!

É, sem dúvida, um pouco desperdiçador de recursos do fórum, pois requer pelo menos duas postagens para cada ‘jogada’. Obviamente, muitas vezes é mais apropriado jogar esse tipo de jogo usando uma interface de chat, em vez de um fórum, mas você pode argumentar que isso poderia ser usado para criar Walkthroughs?

Para uma solução menos invasiva, considere: Turning a topic into interactive fiction ;)

Feedback

Todo feedback é bem-vindo!

Créditos

Este plugin explora David Griffith / frotz · GitLab, o Frotz Z-Interpreter, que é clonado e ‘compilado’ pelo script de configuração.

Obrigado a @P16 por me permitir usar trechos de código de um chatbot de código fechado no qual trabalhamos juntos.

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

BIG update:

(this has taken months of occasional background work and coordination with Frotz team).

Introducing full colour and monospaced formatting for stories

Bbcode frotz

This big update comes with a bunch of improvements:

• ADDED colour formatting and monospaced text support
• IMPROVED simplified settings: no longer requires calibration of header and footer, just the desired title and story file, whoop!
• IMPROVED uses Open3 gem for system commands, reducing risk of abuse/vulnerabilities.
• IMPROVED internal interaction with command line to remove need for stream files, now copes with more/press any key prompts

Now REQUIRES the Discourse BBCode plugin!!

This required the collaboration of the maintainer of Frotz, David Griffiths and one of the very active members of that community, Borg323 who wrote the BBCode extensions against the BBCode Discourse standard. Many many thanks to them! We had to get a bit creative to get the monospaced text stuff to work, but the solution is really great!

Some examples of the new formatting (I’ve not fully tested these stories, these are just examples of formatting)

and notice the coloured compass here:

KNOWN ISSUES: There are loads of games that don’t work because of the nature of their call and response protocols. If one step of the game doesn’t lead you to a prompt at which you can save (ignoring press any key or More prompts which should be handled), then the story won’t work. e.g. in Act of Murder (great game!) the lady at the door asks if you are a policeman. Unfortunately this is a state of the game that’s unsaveable so fails this requirement and I can’t see a way we would get that to work.

There are probably games that are now compatible with Discourse Frotz that weren’t before … please experiment but note the limitation above!

Let me know if you have any issues getting this to work and I’ll refine the instructions as required.

[merefield (Robert)]

A reminder that you can use keyboard shortcuts to improve your experience with this plugin:

• Shift-R to reply to the bot

• Ctrl-Enter to submit your next move

(Standard out of the box keyboard shortcuts).

[Benjamin_D (Benjamin Decotte)]

Hi Robert !
finally had time to go further, so far so good, it worked right out of the box in prod env

Weirdly frotz is not able to respond in private messages unless I also set it in any category
Next step : to play

[merefield (Robert)]

Thanks for the report!

I’ve gone ahead and fixed that: FIX: behaviour of private messages playing permission setting · merefield/discourse-frotz@34b022e · GitHub

NTS: must add some unit tests!

[Benjamin_D (Benjamin Decotte)]

I tried to add :grin: in a source,

it’s going to be fun !