gmninkle

what is it?

gmninkle is a nodejs script that tries to transform an inklewriter JSON file into a series of Gemini docs:

stories pulled from the web

None of these stories have been tested.

caveats

The stories linked above don't use these attributes, but others do, and gmninkle doesn't support them:

• allowCheckpoints
• ifConditions
• notIfConditions
• flagName

These are likely to rely on per-user session state, persisted via the query component of the Gemini URI, and/or managed on the server for each user, so maybe one could develop this with something like Jetforce.

running it

Running the script successfully should output how many Gemini documents were created and which file represents the initial stitch:

$ gmninkle.js content/gmninkle/JSON/bqfx.json content/gmninkle/bqfx

 gmninkle.js generated 125 gemini documents.
 content/gmninkle/bqfx/i.gmi

$ 

If you run the script with the DEBUG environmental variable set, the script should output a line for each file it attempts to create:

$ DEBUG=1 gmninkle.js content/gmninkle/JSON/6000.json content/gmninkle/6000
writing content/gmninkle/6000/its_a_fine_autumn_da.gmi...done.
writing content/gmninkle/6000/the_school_becomes.gmi...done.
writing content/gmninkle/6000/you_pump_your_legs_h.gmi...done.
writing content/gmninkle/6000/locking_your_bike_p.gmi...done.
writing content/gmninkle/6000/based_on_your_previ.gmi...done.
writing content/gmninkle/6000/youre_not_yet_a_girl.gmi...done.
writing content/gmninkle/6000/the_door_opens_with.gmi...done.
writing content/gmninkle/6000/maybe_all_of_feldme.gmi...done.
writing content/gmninkle/6000/you_reassure_yours.gmi...done.
...
writing content/gmninkle/6000/creeping_up_to_the_d.gmi...done.
writing content/gmninkle/6000/peering_down_the_st.gmi...done.

 gmninkle.js generated 168 gemini documents.
 content/gmninkle/6000/its_a_fine_autumn_da.gmi

sample JSON files

This folder contains inklewriter interactive stories, encoded in the JSON format, downloaded from the web, and prettified.

Stories that rely on inklewriter features that gmninkle doesn't currently support are in a subfolder called missing_features:

todo

• Maybe deal with conditional mood text in braces by extracting the first word/phrase in the list and removing all the others, plus the braces.

thanks

• Norm MacLennan (creator of GemIF) and Nick Thomas for the idea

__________________________________________

❃ 双子座 ❃ gamiri Apr 25 06:42:52 UTC 2021