Wooah, a new plugin! This one is a little less serious, though.
This is a fully working plugin but will also no doubt evolve as it gets used and I receive feedback.
What is it
It’s a ‘bot’ with which to play interactive fiction aka classic text adventure games on your Discourse forum and is essentially an adaptor to the standard and amazing Z-machine interpreter called ‘frotz’ at David Griffith / frotz · GitLab
How to use it
The setup adds two games, you can add more in settings.
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.
To kick off the interaction you need to @ mention the bot set in settings. After that, replying to a post of theirs is enough.
To list the available games, you first need to mention the bot and ask:
@mybot list games
This will give you the range of options
To start a game type:
start game x substituting x for the option number.
If you want to switch to another game you can do so; the plugin saves your progress on every move so you can return to the first story at any time. The plugin maintains a save for every story for every user that tries it.
To continue an existing game type:
continue game x substituting x for the option number.
NB A full rebuild will destroy all save files. This is a necessary compromise.
How do I play an IF game?
Many “Meta’s” will have grown up with these things. For those less familiar, check out this cheatsheet: Play Some Interactive Fiction
Create the Bot User
(apologies, automating this is on my list!)
In an ssh session, enter your container and the rails console:
./launcher enter app rails c
Then do this:
u = User.create!(username: "Frotz", name: "FrotzBot", id:-5, email: "email@example.com") u.activate
Your new bot will then be available to set up in the UI. Go to the user’s settings in the UI via the admin button and turn off all emailing. Update the avatar to taste.
Install Discourse Frotz
Update your app.yml
This is a little more invasive than a usual plugin.
add this to 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 streams - exec: cd: $home/frotz cmd: - mkdir stories - exec: cd: $home/frotz/stories cmd: - wget --no-check-certificate http://www.batmantis.com/zorks/zork1.z5 - 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
before your other plugin entries.
Rebuild with the usual
./launcher rebuild app
Now go to the plugin settings and select the bot user you added earlier:
You will note I’ve included a couple of stories. You can find more at https://ifdb.tads.org/.
However, watch rate limits here! Getting too many stories from the same location may cause an error.
Also note that the stories are not sitting on https protected servers (tut tut).
If you insist on loading more add them to app.yml. You could also add them manually from the command prompt, but realise these will be wiped on the next full rebuild.
Enable FrotzBot for private messages (caution advised)
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. In any case be aware of implications for capacity. As an alternative, encourage users to play in a designated Category.
If (s)he is not enabled there, the user will get a polite message:
Restrict FrotzBot by Category
You can restrict the bot to a (list of) Category to avoid filling up other areas:
Limitations and considerations
Not all story formats and games are yet supported. I’ve found some that use paged formatting and so don’t work very well.
NB Mailing list mode is a disaster with this, so make sure this is not something you use before attempting to use this plugin!
It is arguably a bit wasteful of forum resources as it requires at least two posts for every ‘move’. It is obviously often more appropriate to play these kind of games using a chat interface, rather than a forum, but you might argue this could be used to create Walkthroughs? Having said that, we have the popular Babble chat plugin which uses the same Topic and Post models and probably generates even more data. I have not tested it with Babble btw.
For a less invasive solution, consider: Turning a topic into interactive fiction ;)
Before I created this, I thought about utilising the existing RESTful service credited below (and in plugin.rb), but I felt this would over complicate the setup. It would require users to set up a separate server. Instead, I decided to port that code into my code and extend it as a local service. I may regret that decision though as clearly there is always a maintenance overhead with these things. I can’t promise I won’t switch to or add a RESTful interface later on.
All feedback is welcome!
This plugin exploits two main repos:
- David Griffith / frotz · GitLab the Frotz Z-Interpreter which is cloned and ‘made’ by the setup script
- GitHub - tlef/restful-frotz: A restful interface to interact with Frotz … the code is not used directly but I’ve ported significant parts of that PHP into Ruby to run it locally in this plugin, making some changes to accommodate the functional specifics. I’ve added a save system.
Thanks to @P16 for allowing me to use excerpts of code from a closed source chatbot we worked on together.