Start of image cache implementation... breaks image functionality.
[rodin/chimara.git] / interpreters / glulxe / README
1 Glulxe: the Glulx VM interpreter
2 Version 0.4.4
3
4     Designed by Andrew Plotkin <erkyrath@eblong.com>
5     http://eblong.com/zarf/glulx/index.html
6
7 * Compiling
8
9 Since this is a Glk program, it must be built with a Glk library. See
10 the Glk home page at
11
12 http://eblong.com/zarf/glk/index.html
13
14 The Unix Makefile that comes with this package is designed to link any
15 of the Unix libraries (XGlk, GlkTerm, and CheapGlk.) You'll have to
16 go into the Makefile and set three variables to find the library. There
17 are instructions at the top of the Makefile. Then just type
18
19     make glulxe
20
21 That should suffice. When the program is built, type
22
23     ./glulxe filename.ulx
24
25 where "filename.ulx" is a Glulx game file to execute.
26
27 To build this program on a Macintosh, you'll need the MacGlk library.
28 See the instructions that come with that. It's fairly straightforward;
29 compile the library, the source code, and the "macstart.c" file.
30
31 Ditto for Windows, using "winstart.c".
32
33 * Version
34
35 0.4.4:
36     Added profiling code, which is turned off by default. To compile it 
37     in, define VM_PROFILING in Makefile or in glulxe.h.
38     Added function-accleration feature.
39     Fixed bug where @random 0 was returning only positive numbers.
40
41 0.4.3:
42     Verify the presence of Unicode calls in the Glk library at runtime.
43     (Thanks Simon Baldwin.)
44     Added a compile-time option to check for invalid memory accesses.
45     (This is slower, but safer. Define VERIFY_MEMORY_ACCESS in Makefile
46     or in glulxe.h. Thanks Evin Robertson.)
47     Fixed a memory leak of undo states. (Thanks Matthew Wightman.)
48     Fixed a linked-list handling error for Glk unicode arrays. (Thanks
49     David Kinder.)
50
51 0.4.2:
52     Fixed a bug that preventing compiling with old (pre-Unicode) Glk
53     libraries.
54
55 0.4.1:
56     Added array copy and heap allocation functionality. (Glulx spec 
57     3.1.0.)
58
59 0.4.0:
60     Added Unicode functionality. (Glulx spec 3.0.0.)
61
62 0.3.5:
63     Fixed El-Stupido bug in the modulo opcode.
64
65 0.3.4:
66     Finally supports string arguments to Glk calls.
67
68 0.3.3:
69     Added setiosys, getiosys opcodes.
70     Fixed bug in binarysearch.
71
72 0.3.2:
73     Added search, jumpabs, callf, and gestalt opcodes.
74
75 0.3.1:
76     Startup code now handles Blorb files correctly.
77
78 0.3.0:
79     Added support for compressed strings.
80
81 0.2.2:
82     Another pre-release version.
83
84 0.2.0:
85     A pre-release version.
86
87 * Permissions
88
89 The source code in this package is copyright 1999 by Andrew Plotkin. You
90 may copy and distribute it freely, by any means and under any conditions,
91 as long as the code and documentation is not changed. You may also
92 incorporate this code into your own program and distribute that, or modify
93 this code and use and distribute the modified version, as long as you retain
94 a notice in your program or documentation which mentions my name and the
95 URL shown above.
96