hugoif / hugo-unix Goto Github PK

Just letting you all know about my recent changes.

I've pulled in the branches I had gathered at https://github.com/curiousdannii/hugo. I've merged in the changes from garglk so that we now have the Glk source in this repository. I've left the v3.2 and hugor branches as is. I think the changes from hugor have probably already been incorporated, in which case we can delete that branch. (Edit: it's deleted.) I'm now going to mark my repository as archived. Long live hugo-unix!

I've added guard calls to glk_stream_open_file to avoid the common interpreter behaviour (but wrong according to the spec) of throwing a fatal error when reading a non-existent file.

I've increased MAXUNDO if not set because this seemed to be required for some larger games like Cryptozookeeper.

@juhana started an organisation for Hugo: @hugoif.

We could move this repository there?

Could also consider just renaming it to "hugo" if you'd be happy allowing for other OSes ports to be included too?

The Glk port, to provide graphics and sound, writes out individual PIC and SND files, as suggested by the Blorb specification, and supported by Gargoyle (and xglk should at least support PIC files).

However, it also uses Glk to open these files, but Glk doesn't provide the ability to open arbitrary files. It used to work with Gargoyle, but when I synced Gargoyle with the latest cheapglk, things broke: this is because cheapglk, as recommended by the Glk spec, adds extensions to all files opened by it. Specifically for data files, .glkdata is added, meaning files are called something like PIC0.glkdata. As such these files no longer have valid names for Gargoyle (or any other implementation which uses the suggested names).

I've got a hacky solution in a pull request: garglk/garglk#649. Part of the issue is that it requires the non-standard glkunix_stream_open_pathname function to directly open a file. This is part of the glkunix startup, not Glk itself. Since this repo is called hugo-unix, that may not matter, but it's worth pointing out. The function does exist in cheapglk, xglk, glkterm, remglk, and Gargoyle, at least.

The other thing is that, in my fix, I'm guarding this all with #ifdef GARGLK since it deviates from upstream here. However, it'd be better to get a proper upstream solution in place that works for all (Unix) Glks. If we can assume that glkunix_stream_open_pathame is OK to use, then I think my approach is no worse than the existing one. I use stdio to write out the files, to guarantee working filenames. This avoids any mangling that may be done by the Glk implementation.

My use of the hugo_path_to_game is also gnarly, and should be improved if it's going to actually be used upstream.