Skip to content

Commit e787b78

Browse files
committed
Finalise README
I think this is good enough to go public with for now.
1 parent 3f5b6f0 commit e787b78

File tree

4 files changed

+19
-5
lines changed

4 files changed

+19
-5
lines changed

README.md

+19-5
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,17 @@ The "frotzs5" folder can be deleted after installation to save disk space.
5353

5454
Inform6 is not an all-in-one app like other EPOC32 apps (help wanted!), so you will need to use an edit->compile->test workflow.
5555

56-
### Edit: ###
56+
Since you will be switching regularly between three different apps, I **strongly** recommend installing _FileSwitch_; a utility that let's you switch between open apps using <kbd>CTRL+SPC</kbd>.
57+
58+
### 1. Edit: ###
5759

5860
You can write your story files on the device using Editor (mentioned in Installation above) or your plain-text editor of choice (for large games, you might want to try out DSTEdit which can manage multiple files at once).
5961

6062
_How_ to write story files is not covered here, you'll need to read the [Inform Designers Manual 4th Edition](https://www.inform-fiction.org/manual/download_dm4.html) which covers the Inform6 language and the [PunyInform manual](https://github.com/johanberntsson/PunyInform/wiki/manual) which covers adjustments required for the PunyInform library.
6163

6264
(There's nothing stopping you from using the [standard Inform6 library](https://ifarchive.org/indexes/if-archive/infocom/compilers/inform6/library/) but it will produce larger, slower-running binaries.)
6365

64-
### Compile: ###
66+
### 2. Compile: ###
6567

6668
*Inform6 isn't an app with a GUI*, it's a command-line executable! You will need a shell to be able to invoke "inform6.exe" with the desired parameters. EPOC32 doesn't come with a command-line shell, but one is provided in the download for you ("shell.exe").
6769

@@ -81,17 +83,29 @@ Full command-line parameters for Inform6 are described in "usage.txt".
8183

8284
**NOTE:** The Inform6 binary will *always* open a new console window (instead of re-using the Shell) and there's no way to pause or scroll the output. This is a limitation of the EPOC32 C Standard Library. I would like to resolve this but it requires tricky C / C++ interop that I don't have the knowledge for.
8385

84-
***If you have skills with interfacing C & C++, or Symbian programming experience in general, your help would greatly be appreciated; please contact me at <kroc@camendesign.com>***
86+
***If you have skills with interfacing C & C++, or Symbian programming experience in general, your help would greatly be appreciated; please contact me at <kroc@camendesign.com>.***
87+
88+
### 3. Test: ###
89+
90+
If there are no errors with the compilation, a "z5" (Z-machine) file will be produced using the source file name, i.e. "mystory.z5".
91+
92+
To play the game, open _FrotzS5_:
93+
94+
**NOTE:** You cannot open Z-machine files directly from the file-manager at the moment, an updated version of _FrotZ5_ with file-recognizer support is being worked on.
8595

86-
### Test: ###
96+
![Screenshot of FrotzS5, a text-adventure interpreter for Psion devices](readme_frotzs5.png)
8797

98+
Tap "Open Story" and select the ".z5" file to begin playing.
99+
100+
Note that you must quit FrotzS5 or terminate the story (use the button, or type `quit`) before you can run the compiler again.
88101

89102

90103
## Compiling Inform6 From Source ##
91-
### Prerequisites: ###
92104

93105
If you want to toy with the source code, you'll need to set up a period-accurate EPOC32 development environment; caveat emptor.
94106

107+
### Prerequisites: ###
108+
95109
You will need:
96110

97111
* A Windows NT4, 2000 or Windows XP PC or Virtual Machine (e.g. [VirtualBox]), with 256 MB or more RAM.

readme_activeconfig.png

-1.26 KB
Loading

readme_frotzs5.png

11.2 KB
Loading

readme_informer.png

-1.49 KB
Loading

0 commit comments

Comments
 (0)