ModdingWiki - User contributions [en-gb]

ZZT

2024-11-18T21:02:58Z

SaxxonPike: /* Versions */ Some details about version differences

{{Game Infobox
| Levels = Edit
| Tiles = No
| Sprites = No
| Fullscreen = No
| Sound = No
| Music = No
| Text = No
| Story = No
| Interface = No
}}

== Game info ==

'''ZZT''' is a game creation system created by Tim Sweeney in 1991, the first game developed and published by Potomac Computer Systems (later Epic Megagames, now Epic Games.) There were 4 worlds released with the commercial version of the game: TOWN, CAVES, CITY, and DUNGEONS. The shareware version of ZZT came with just TOWN. In all versions of the game, the built-in world editor is fully functional (however, it will not edit saved games or locked worlds natively.)

Later, [[Super ZZT]] was released based on this engine.

== Debug mode ==

In all versions, the cheat menu can be opened by pressing ? and typing in a code. In versions prior to v3.2, standard cheats will not work until the +debug cheat is used. This also enables the display of how much memory is available on the heap, in bytes. In the upper-right corner, it will show the letter 'm' followed by this value. OOP code on the currently shown board and the game's entire compressed board data consume heap memory.

== Versions ==

The latest version of the game is v3.2. Other versions of the game that can be found are v3.1, v3.0, and v2.0. Aside from improvements in input handling and visual appearance, cheat availability and copyright messages, there are no observable differences between these versions.

{| class="wikitable"
|-
! Version
! File Size (decompressed)
|-
| 2.0
| 89,792 (89,792)
|-
| 3.0
| 47,473 (95,440)
|-
| 3.1
| 47,471 (95,616)
|-
| 3.2
| 47,764 (96,080)
|}

=== Version 2.0 ===

The first available version. Uses standard text mode with disconnected block graphics (1 empty pixel column between characters). The standard keyboard buffer is used, so holding down arrows and other such keys will cause the action to be repeated even after the key is released. Cheats require the ?+debug code to be entered.

=== Version 3.0 ===

In this version, a refined keyboard buffer is used, so releasing arrow keys will stop the player from continuing to move after the key is released.

=== Version 3.1 ===

The ZZT.CFG format has changed, nothing else noticeable.

=== Version 3.2 ===

This is the final official version. The ZZT.CFG format changed again. A connected graphics mode is used (no empty pixel column) making board art a lot easier on the eyes. ?+debug is no longer required to use cheats. This is the version most recommended for playing any game worlds, official or otherwise.

== File formats ==

* [[ZZT Format#Board Format|BRD Format]] - Board format. This is stored exactly the same as in a world, but it's just one board.
* [[CFG Format (ZZT)|CFG Format]] - ZZT.CFG contains the startup configuration and serial number.
* [[DAT Format (ZZT)|DAT Format]] - In 3.0 and later, ZZT.DAT contains help files and end screen messages. This is not present in 2.0; the files are stored in the directory.
* [[HI Format (ZZT)|HI Format]] - High scores.
* [[Binary Text Format (ZZT)|HLP Format]] - In 2.0, these are standard text files. In 3.0 and later, they are encoded differently.
* [[Binary Text Format (ZZT)|MSG Format]] - In 2.0, these are standard text files. In 3.0 and later, they are encoded differently.
* [[ZZT Format|SAV Format]] - Saved games, 100% identical to world files except a byte in the header.
* [[ZZT Format]] - World format.

[[Category:Epic Megagames]]
[[Category:ZZT]]

OPL chip

2024-11-18T20:45:05Z

SaxxonPike: /* BLASTER Environment Variable */ Type 6 is valid for SB16/32/64

= Programmer's Guide to Yamaha YMF 262/OPL3 FM Music Synthesizer =
Version 1.00 Nov-24-1994

Written by Vladimir Arnost, QA-Software
Internet: xarnos00@dcse.fee.vutbr.cz

This manual can be distributed freely if not modified.

=== Disclaimer ===

I assume no responsibility for any damages arising out of use or inability to use this text. No warranty is provided about correctness of any information in this file. You are on your own.

== Introduction ==

The chip I am going to describe is getting more and more common, but programming information is still scarce, so I have decided to fill in this gap. All information contained in this file is a result of my experience in Adlib programming, research (read: reverse engineering) and finally of my effort to write down everything necessary to understand and use this piece of hardware. No official sources (i.e. development kits, books about this topic, etc.) were available to me except:

: Adlib Programming Guide - by Tero Töttö, and
: The PC Games Programmers Encyclopedia V1.0

The information below is a combination of known features of Adlib (alias Yamaha YM 3812/OPL2) and my own uncountable experiments and failures, which brought out a lot of important details you have to know about the chip.

As far as I know, there are four major sound cards based on OPL3 chip:

* Sound Blaster Pro II (not Sound Blaster Pro I)
* Sound Blaster 16
* Adlib Gold
* Pro Audio Spectrum Plus/16

I currently have a Sound Blaster Pro II-compatible card only, so all the programming info I provide will be based on this card. (The other cards are quite similar, however. They are just wired at different I/O-port addresses.)

Note: I assume some knowledge of FM music programming (mainly Adlib FM synthesizer) in this manual. If you are new to this topic I recommend you try Adlib first before going higher. Anyway, OPL3 is a direct descendant of OPL2 (what a surprise), so most features of OPL2 are also present on OPL3.

== Description of the Synthesizer ==

My card's user manual says: "[this card contains] ... a stereo music FM synthesizer with 20 channels consisting of four (4) operators each ... " I thought: "Wow -- that's together eighty operators. This must be a GOOD sound-card." I was wrong. Just another advertising lie.

So let's clear some facts. First, OPL3 has only thirty-six (36) operators which can be combined in several ways:

* 18 FM channels (36 operators), or
* 15 FM channels (30 ops) and 5 percussion instruments (6 ops), giving us 20 channels altogether, or
* up to 6 four-operator FM channels (max 24 ops), the rest again being divided into two-operator FM channels and drums.

From the table above you can see that not all channels can be used in four-operator (4-OP) mode -- only a part of the synthesizer is really capable of making 4-OP sounds -- the rest uses traditional two-operator (2-OP) mode.

Second, the manual states this card is capable of "stereo" music. Yes, the quotes are necessary, because the stereo capabilities are very limited. You are given ability to control output going to left or right channel by turning it on and off. That's all. So the sound can flow from very left side, center and very right side. No sound panning, no special stereo effects. :-(

Well, flaming apart, back to the main topic.

The OPL3 chip is capable of making sounds in several ways:

=== Two-operator Additive Synthesis ===

Output of both operators is simply added. It is the simplest way to make any sound, and it works on both OPL2 and OPL3. The diagram should make it clear.

<pre>
┌────────────┐
│ │
│ Operator 1 ├────────┐
│ │ │
└────────────┘ │
├────────> Output
┌────────────┐ │
│ │ │
│ Operator 2 ├────────┘
│ │
└────────────┘
</pre>

=== Two-operator Frequency Modulation (FM) Synthesis ===

Output from the first operator (Modulator) is sent to the input of the second one (Carrier) and is used to modulate (alter) frequency of the second operator. Only the second operator produces sound. Most of interesting sounds are made this way. This also works on OPL2. Hope the picture helps.

<pre>
┌────────────┐ ┌────────────┐
│ │ │ │
│ Operator 1 ├────────>│ Operator 2 ├────────> Output
│(Modulator) │ │ (Carrier) │
└────────────┘ └────────────┘
</pre>

=== Four-operator "Mess" Modulation Synthesis ===

All of OPL3's 4-OP configurations are combinations of the above two modes of synthesis. OPL3 combines these two modes in four ways. I have no words to describe these four ways. Only the pictures can show their principle.

<pre>
a) FM-FM Mode

┌───────┐ ┌───────┐ ┌───────┐ ┌───────┐
│ │ │ │ │ │ │ │
│ Op. 1 ├─────>│ Op. 2 ├─────>│ Op. 3 ├─────>│ Op. 4 ├─────> Output
│ │ │ │ │ │ │ │
└───────┘ └───────┘ └───────┘ └───────┘

b) AM-FM Mode

┌───────┐
│ │
│ Op. 1 ├───────────────────────────────────┐
│ │ │
└───────┘ │
│
┌───────┐ ┌───────┐ ┌───────┐ │
│ │ │ │ │ │ │
│ Op. 2 ├─────>│ Op. 3 ├─────>│ Op. 4 ├─────┴─────> Output
│ │ │ │ │ │
└───────┘ └───────┘ └───────┘

c) FM-AM Mode

┌───────┐ ┌───────┐
│ │ │ │
│ Op. 1 ├─────>│ Op. 2 ├─────┐
│ │ │ │ │
└───────┘ └───────┘ │
├─────> Output
┌───────┐ ┌───────┐ │
│ │ │ │ │
│ Op. 3 ├─────>│ Op. 4 ├─────┘
│ │ │ │
└───────┘ └───────┘

d) AM-AM Mode

┌───────┐
│ │
│ Op. 1 ├────────────────────┐
│ │ │
└───────┘ │
│
┌───────┐ ┌───────┐ │
│ │ │ │ │
│ Op. 2 ├─────>│ Op. 3 ├─────┼─────> Output
│ │ │ │ │
└───────┘ └───────┘ │
│
┌───────┐ │
│ │ │
│ Op. 4 ├────────────────────┘
│ │
└───────┘
</pre>

Nice, aren't they?

The only way I think this can be written is a math formula. Symbol + (plus) means additive synthesis, and * (asterisk) means frequency modulation (Op1 * Op2 means operator 1 modulates operator 2, not vice versa). Here they are:

# FM-FM Mode: (Op1 * Op2 * Op3 * Op4) ────> Output
# AM-FM Mode: Op1 + (Op2 * Op3 * Op4) ───> Output
# FM-AM Mode: (Op1 * Op2) + (Op3 * Op4) ──> Output
# AM-AM Mode: Op1 + (Op2 * Op3) + Op4 ───> Output

=== Percussion Mode ===

In this mode 6 operators are used to produce five different percussion instruments:

* Bass Drum (2 operators)
* Snare Drum (1 operator)
* Tom-Tom (1 operator)
* Cymbal (1 operator)
* Hi-Hat (1 operator)

Based on notes from MAME's OPL emulator, the following points hold true:

* Setting the block/fnum on each percussive channel may affect multiple instruments.
** The pitch on channel 6 affects just the bass drum
** The pitch on channel 7 affects the hihat, cymbal and snare
** The pitch on channel 8 affects the hihat, cymbal and tomtom
* The modulator/carrier output level is used to set the volume of each instrument.
** channel 6 carrier controls the volume of the bass drum
** channel 7 modulator controls the volume of the hi-hat
** channel 7 carrier controls the volume of the snare
** channel 8 modulator controls the volume of the tomtom
** channel 8 carrier controls the volume of the cymbal
* Panning L/R bits set via register 0xC0 affect instruments as follows:
** channel 6 affects the bass drum
** channel 7 affects hi-hat and snare
** channel 8 affects cymbal and tomtom

The ''AdLib Programmer's Manual'' contains playback code that uses the Tom-Tom frequency for all percussion instruments. It is possible this is the source of the confusion. Here, when a note is played on the Tom-Tom channel, that note will of course cause the Top Cymbal to change as well because of the shared channel. But the code increases this pitch by seven semitones and sets that frequency for channel 7 at the same time, ensuring the Hi-Hat and Snare Drum are always set to seven semitones above the last Tom-Tom note. (See [[AdLib MIDI Format]] for details.)

This mode is identical with that of OPL2. For more details see ADLIB.DOC.

== Programming the Synthesizer ==

OPL3 may be found at the following addresses:

{|class="wikitable"
| Sound Blaster Pro II || 220h or 240h (selectable), also 388h
|-
| Adlib Gold || 388h
|-
| Pro Audio Spectrum Plus/16 || ? (if you have a PAS you should know it)
|}

The base address of the synthesizer will be called "base".

The chip occupies four I/O addresses:

{|class="wikitable"
| base+0 || Primary index register (write), Status register (read)
|-
| base+1 || Primary data register (write-only)
|-
| base+2 || Secondary index register (write)
|-
| base+3 || Secondary data register (write-only)
|}

The index registers are used to select internal registers and data registers are used to write to them. Status register returns the state of two timers built in the chip.

OPL3 contains two sets of registers. The Primary set maps to channels 0-8 (operators 0-17) and the secondary maps to channels 9-17 (operators 18-35). The reason for this is simple: all these registers wouldn't fit into single register set.

Unlike Adlib (OPL2), OPL3 doesn't need delay between register writes. With OPL2 you had to wait 3.3 µs after index register write and another 23 µs after data register write. On the contrary OPL3 doesn't need (almost) any delay after index register write and only 0.28 µs after data register write. This means you can neglect the delays and slightly speed up your music driver. But using reasonable delays will certainly do no harm.

The data registers can't be read (they are write-only) on both OPL2 and OPL3.

== Register Map ==

The registers are grouped in the same manner as in the OPL2 chip. Programs using both OPL2 and OPL3 chips may use the same code provided that their direct I/O interface is well written. The only thing you have to change is operator-to-register mapping, which must accomodate the fact that registers are spread between two register sets.

(The register map is nearly the same so I dared to copy it from ADLIB.DOC.)

=== Status Register (base+0) ===

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| IRQFlag || T1Flag || T2Flag || || || || ||
|}

=== Data Registers (base+1, base+3) ===

{|class="wikitable centred fixed-width"
! REG !! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| 01 ||colspan=2| Test Register ||style="background-color: #CCFFCC;"|(WSEnable)||colspan=5| Test Register
|-
| 02 ||colspan=8| Timer 1 Count (80 µsec resolution)
|-
| 03 ||colspan=8| Timer 2 Count (320 µsec resolution)
|-
| 04* ||IRQReset|| T1Mask || T2Mask ||colspan=3| ||T2 Start||T1 Start
|-
| 04** ||colspan=2| ||style="background-color: #CCFFCC;"|4-OP B-E||style="background-color: #CCFFCC;"|4-OP A-D||style="background-color: #CCFFCC;"|4-OP 9-C||style="background-color: #CCFFCC;"|4-OP 2-5||style="background-color: #CCFFCC;"|4-OP 1-4||style="background-color: #CCFFCC;"|4-OP 0-3
|-
| 05** ||colspan=7| ||style="background-color: #CCFFCC;"| OPL3
|-
| 08 ||style="background-color: #CCFFCC;"| (CSW) ||style="background-color: #CCFFCC;"|NOTE-SEL||colspan=6|
|-
| 20-35 ||style="background-color: #CCCCFF;"|Tremolo ||style="background-color: #CCCCFF;"|Vibrato ||style="background-color: #CCCCFF;"|Sustain ||style="background-color: #CCCCFF;"| KSR ||colspan=4 style="background-color: #CCCCFF;"| Frequency Multiplication Factor
|-
| 40-55 ||colspan=2 style="background-color: #CCCCFF;"| Key Scale Level ||colspan=6 style="background-color: #CCCCFF;"| Output Level
|-
| 60-75 ||colspan=4 style="background-color: #CCCCFF;"| Attack Rate ||colspan=4 style="background-color: #CCCCFF;"| Decay Rate
|-
| 80-95 ||colspan=4 style="background-color: #CCCCFF;"| Sustain Level ||colspan=4 style="background-color: #CCCCFF;"| Release Rate
|-
| A0-A8 ||colspan=8 style="background-color: #FFE0CC;"| Frequency Number (Lower 8 bits)
|-
| B0-B8 ||colspan=2| ||style="background-color: #FFE0CC;"| KEY-ON ||colspan=3 style="background-color: #FFE0CC;"| Block Number ||colspan=2 style="background-color: #FFE0CC;"| F-Num (hi bits)
|-
| BD* ||style="background-color: #CCFFCC;"|Trem Dep||style="background-color: #CCFFCC;"|Vibr Dep||style="background-color: #FFCCDD;"|PercMode||style="background-color: #FFCCDD;"| BD On ||style="background-color: #FFCCDD;"| SD On ||style="background-color: #FFCCDD;"| TT On ||style="background-color: #FFCCDD;"| CY On ||style="background-color: #FFCCDD;"| HH On
|-
| C0-C8 ||style="background-color: #FFE0CC;"| OutCh_D ||style="background-color: #FFE0CC;"| OutCh_C ||style="background-color: #FFE0CC;"| Right ||style="background-color: #FFE0CC;"| Left ||colspan=3 style="background-color: #FFE0CC;"|FeedBack Modulation Factor||style="background-color: #FFE0CC;"|SynthTyp
|-
| E0-F5 ||colspan=5| ||colspan=3 style="background-color: #CCCCFF;"| Waveform Select
|}

{|
|style="background-color: #CCFFCC;"| Chip-wide setting
|style="background-color: #CCCCFF;"| Per operator
|style="background-color: #FFE0CC;"| Per channel
|style="background-color: #FFCCDD;"| Rhythm-mode only
|}

:<nowiki>*</nowiki> This applies only to port base+1 (OPL2)
:<nowiki>**</nowiki> This applies only to port base+3 (OPL3, second register set)

For register bases A0, B0 and C0 there is one register per output channel. The primary register set holds the first nine channels (0-8) and the secondary holds last nine channels (9-17). For bases 20, 40, 60, 80 and E0 there are two registers per channel. Each register maps to one operator. Unfortunately the operator's register numbers are not continuous. The following table shows which operator maps to which register set and offset (in hex).

{|class="wikitable centred"
! Op. !! Set/Offset !! Op. !! Set/Offset
|-
| 0 || 0/00 || 18 || 1/00
|-
| 1 || 0/01 || 19 || 1/01
|-
| 2 || 0/02 || 20 || 1/02
|-
| 3 || 0/03 || 21 || 1/03
|-
| 4 || 0/04 || 22 || 1/04
|-
| 5 || 0/05 || 23 || 1/05
|-
| 6 || 0/08 || 24 || 1/08
|-
| 7 || 0/09 || 25 || 1/09
|-
| 8 || 0/0A || 26 || 1/0A
|-
| 9 || 0/0B || 27 || 1/0B
|-
| 10 || 0/0C || 28 || 1/0C
|-
| 11 || 0/0D || 29 || 1/0D
|-
| 12 || 0/10 || 30 || 1/10
|-
| 13 || 0/11 || 31 || 1/11
|-
| 14 || 0/12 || 32 || 1/12
|-
| 15 || 0/13 || 33 || 1/13
|-
| 16 || 0/14 || 34 || 1/14
|-
| 17 || 0/15 || 35 || 1/15
|}

The following tables summarize which operators form a channel in various modes:

1. Two-operator Melodic Mode

{|class="wikitable centred"
! Channel !! 0 !! 1 !! 2 !! 3 !! 4 !! 5 !! 6 !! 7 !! 8 !! 9 !! 10 !! 11 !! 12 !! 13 !! 14 !! 15 !! 16 !! 17
|-
| Operator 1 || 0 || 1 || 2 || 6 || 7 || 8 || 12 || 13 || 14 || 18 || 19 || 20 || 24 || 25 || 26 || 30 || 31 || 32
|-
| Operator 2 || 3 || 4 || 5 || 9 || 10 || 11 || 15 || 16 || 17 || 21 || 22 || 23 || 27 || 28 || 29 || 33 || 34 || 35
|}

2. Two-operator Melodic and Percussion Mode

{|class="wikitable centred"
! Channel !! 0 !! 1 !! 2 !! 3 !! 4 !! 5 !! BD !! SD !! TT !! CY !! HH !! 9 !! 10 !! 11 !! 12 !! 13 !! 14 !! 15 !! 16 !! 17
|-
| Operator 1 || 0 || 1 || 2 || 6 || 7 || 8 || 12 || 16 || 14 || 17 || 13 || 18 || 19 || 20 || 24 || 25 || 26 || 30 || 31 || 32
|-
| Operator 2 || 3 || 4 || 5 || 9 || 10 || 11 || 15 ||colspan=4| - || 21 || 22 || 23 || 27 || 28 || 29 || 33 || 34 || 35
|}

3. Four-operator Melodic Mode

{|class="wikitable centred"
! Channel !! 0 !! 1 !! 2 !! 6 !! 7 !! 8 !! 9 !! 10 !! 11 !! 15 !! 16 !! 17
|-
| Operator 1 || 0 || 1 || 2 || 12 || 13 || 14 || 18 || 19 || 20 || 30 || 31 || 32
|-
| Operator 2 || 3 || 4 || 5 || 15 || 16 || 17 || 21 || 22 || 23 || 33 || 34 || 35
|-
| Operator 3 || 6 || 7 || 8 ||colspan=3| - || 24 || 25 || 26 ||colspan=3| -
|-
| Operator 4 || 9 || 10 || 11 ||colspan=3| - || 27 || 28 || 29 ||colspan=3| -
|}

Channels 3, 4, 5 and 12, 13, 14 can't be used separately because their operators became part of channels 0, 1, 2 and 9, 10, 11 respectively. For instance a four-operator channel 1 consists of two two-operator channels number 1 and 4. (The second 2-OP channel number is always the first 2-OP channel number plus three.)

OPL3 allows you to enable/disable 4-OP mode separately for any of channels 0, 1, 2, 9, 10 and 11 (see register 104h in the reference below). This means for instance when you switch only channel 2 into 4-OP mode, channels number 0, 1, 3, 4, 6, 7, 8, 9, etc. will be still independent 2-OP channels.

Channels 6, 7, 8 and 15, 16, 17 are always two-operator ones. They can't be grouped to form four-operator channels.

4. Four-operator Melodic and Percussion Mode

{|class="wikitable centred"
! Channel !! 0 !! 1 !! 2 !! BD !! SD !! TT !! CY !! HH !! 9 !! 10 !! 11 !! 15 !! 16 !! 17
|-
| Operator 1 || 0 || 1 || 2 || 12 || 16 || 14 || 17 || 13 || 18 || 19 || 20 || 30 || 31 || 32
|-
| Operator 2 || 3 || 4 || 5 || 15 ||colspan=4| - || 21 || 22 || 23 || 33 || 34 || 35
|-
| Operator 3 || 6 || 7 || 8 ||colspan=5| - || 24 || 25 || 26 ||colspan=3| -
|-
| Operator 4 || 9 || 10 || 11 ||colspan=5| - || 27 || 28 || 29 ||colspan=3| -
|}

Examples:

Two-operator channel #14 consists of operators 26 and 29 which occupy these registers (all are in the secondary register set):

{|class="wikitable"
| 12A || Operator 1 || Tremolo/Vibrato/Sustain/KSR/Multiplication
|-
| 12D || Operator 2 || Tremolo/Vibrato/Sustain/KSR/Multiplication
|-
| 14A || Operator 1 || Key Scale Level/Output Level
|-
| 14D || Operator 2 || Key Scale Level/Output Level
|-
| 16A || Operator 1 || Attack Rate/Decay Rate
|-
| 16D || Operator 2 || Attack Rate/Decay Rate
|-
| 18A || Operator 1 ||Sustain Level/Release Rate
|-
| 18D || Operator 2 || Sustain Level/Release Rate
|-
| 1A5 || || Frequency Number (low)
|-
| 1B5 || || Key On/Block Number/Frequency Number (high)
|-
| 1C5 || || FeedBack/Synthesis Type
|-
| 1EA || Operator 1 || Waveform Select
|-
| 1ED || Operator 2 || Waveform Select
|}

Four-operator channel #1 consists of operators 1, 4, 7 and 10. All registers except register 104h are in the primary set:

{|class="wikitable"
|-
| 104 || bit 1 = 1 || Enable Four-Operator Synthesis in channel #1
|-
| 21 || Operator 1 || Tremolo/Vibrato/Sustain/KSR/Multiplication
|-
| 24 || Operator 2 || Tremolo/Vibrato/Sustain/KSR/Multiplication
|-
| 29 || Operator 3 || Tremolo/Vibrato/Sustain/KSR/Multiplication
|-
| 2C || Operator 4 || Tremolo/Vibrato/Sustain/KSR/Multiplication
|-
| 41 || Operator 1 || Key Scale Level/Output Level
|-
| 44 || Operator 2 || Key Scale Level/Output Level
|-
| 49 || Operator 3 || Key Scale Level/Output Level
|-
| 4C || Operator 4 || Key Scale Level/Output Level
|-
| 61 || Operator 1 || Attack Rate/Decay Rate
|-
| 64 || Operator 2 || Attack Rate/Decay Rate
|-
| 69 || Operator 3 || Attack Rate/Decay Rate
|-
| 6C || Operator 4 || Attack Rate/Decay Rate
|-
| 81 || Operator 1 || Sustain Level/Release Rate
|-
| 84 || Operator 2 || Sustain Level/Release Rate
|-
| 89 || Operator 3 || Sustain Level/Release Rate
|-
| 8C || Operator 4 || Sustain Level/Release Rate
|-
| A1 || || Frequency Number (low)
|-
| A4 || || Unused
|-
| B1 || || Key On/Block Number/Frequency Number (high)
|-
| B4 || || Unused
|-
| C1 || || FeedBack/Synthesis Type (part 1)
|-
| C4 || || Synthesis Type (part 2)
|-
| E1 || Operator 1 || Waveform Select
|-
| E4 || Operator 2 || Waveform Select
|-
| E9 || Operator 3 || Waveform Select
|-
| EC || Operator 4 || Waveform Select
|}

NOTE: If a register number is greater than 100h, then it belongs into the secondary register set. (I use this numbering to emphasize the fact that the particular register MUST be written to the secondary set.) See the example code below for details.

== OPL3 Register Reference ==

Because the registers of OPL3 are almost the same as of OPL2, I have copied their descriptions from file ADLIB.DOC.

=== Status Register ===

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| IRQ || T1 || T2 ||colspan=5| -
|}

* bit 7: IRQ Flag. Set whenever any timer has elapsed.
* bit 6: Timer 1 Flag. Set every time the preset time in Timer 1 has elapsed.
* bit 5: Timer 2 Flag. Set every time the preset time in Timer 2 has elapsed.

Timer interrupts are not wired to any IRQ (why??). The timers can be used to detect the OPL2/OPL3 chip (see Appendix B).

=== Data Registers ===

==== 01: Test Register / Waveform Select Enable ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
|colspan=2| Test Register
| (WSE)
|colspan=5| Test Register
|}

* bits 7-6: Test Register. Must be reset to zero before any operation.
* bit 5: Waveform Select Enable. If clear, all channels will use normal sine wave. If set, register E0-F5 (Waveform Select) contents will be used.
* bits 0-4: Test Register. Must be reset to zero before any operation.

OPL3 does not implement WSE bit, and it should be left clear. In OPL2 mode all four waveforms are always available, and in OPL3 mode all eight waveforms are always available. For compatibility with OPL2, when a program is finished using an OPL3, the waveform select registers should be set to 0, if the next program assumes that by setting WSE bit to 0 the waveform is always sine like on a real OPL2.

==== 02: Timer 1 Count ====

Upward 8 bit counter with a resolution of 80 µsec. If an overflow occurs, the status register bit is set, and the preset value is loaded into the timer again.

==== 03: Timer 2 Count ====

Same as Timer 1, but with a resolution of 320 µsec.

==== 004 (port: base+1): IRQ-Reset / Mask / Start ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| Rst
| T1M
| T2M
|colspan=3| -
| T2S
| T1S
|}

* bit 7: IRQ-Reset. Resets timer and IRQ flags in status register. All other bits are ignored when this bit is set.
* bit 6: Timer 1 Mask. If 1, status register is not affected in overflow.
* bit 5: Timer 2 Mask. Same as above.
* bit 1: Timer 2 Start. Timer on/off.
* bit 0: Timer 1 Start. Same as above.

==== 104 (port: base+3): Four-Operator Enable ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
|colspan=2| -
| ChB
| ChA
| Ch9
| Ch2
| Ch1
| Ch0
|}

* bit 5: Enable four-operator synthesis for channel pair 11 - 14 (decimal).
* bit 4: Same as above for channel pair 10 - 13.
* bit 3: Same as above for channel pair 9 - 12.
* bit 2: Same as above for channel pair 2 - 5.
* bit 1: Same as above for channel pair 1 - 4.
* bit 0: Same as above for channel pair 0 - 3.

If reset to zero, OPL3 can produce 18 two-operator sounds at a time. If nonzero, OPL3 produces four-operator sound in appropriate channel pair.

==== 105 (port: base+3): OPL3 Mode Enable ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
|colspan=7| -
| OPL3
|}

* bit 0: OPL3 Mode Enable. When set, OPL3 extensions (36 operators, 4-OP synthesis, 8 waveforms, stereo output) can be used. When reset, the chip behaves as an ordinary OPL2. This bit is zero by default for compatibility with OPL2.

==== 08: CSW / NOTE-SEL ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| (CSW)
| N-S
|colspan=6| -
|}

* bit 7: Composite sine wave mode on/off. All KEY-ON bits must be clear in order to use this mode. The card is unable to create any other sound when in CSW mode. (Unfortunately, I have no info how to use this mode :-< ). The CSW mode is not implemented on an OPL3 and this bit is ignored.
* bit 6: NOTE-SEL. Controls the split point of the keyboard. When 0, the keyboard split is the second bit from the bit 8 of the F-Number. When 1, the MSb of the F-Number is used. (???)

The Note Select bit defines what kind of F-NUM values are used within an octave so the chip knows how to split an octave into two parts. When Note Select bit is 0, F-NUM values used within an octave all have their MSB bit (bit 9) set, ranging from 0x200 to 0x3FF, so the second most significant bit, bit 8 is used to determine if currently playing note belongs to lower (0x200-0x2FF) or upper (0x300-0x3FF) half within an octave. When Note Select bit is 1, the F-NUM value MSB bit, bit 9, is used to determine if the note belongs to lower (0x000-0x1FF) or upper (0x200-0x3FF) half within an octave.

==== 20-35: Tremolo / Vibrato / Sustain / KSR / Frequency Multiplication Factor ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| Tre
| Vib
| Sus
| KSR
|colspan=4| Multiplication
|}

* bit 7: Tremolo (Amplitude vibrato) on/off.
* bit 6: Frequency vibrato on/off.
* bit 5: Sound Sustaining. When 1, operator's output level will be held at its sustain level until a KEY-OFF is done.
* bit 4: Envelope scaling (KSR) on/off. When 1, higher notes are shorter than lower notes.
* bits 0-3: Frequency Multiplication Factor (MULTI). Operator's frequency is set to (see registers A0, B0) F-Number * Factor.

{|class="wikitable"
! MULTI !! Factor
|-
| 0 || 0.5
|-
| 1 || 1
|-
| 2 || 2
|-
| 3 || 3
|-
| 4 || 4
|-
| 5 || 5
|-
| 6 || 6
|-
| 7 || 7
|-
| 8 || 8
|-
| 9 || 9
|-
| 10 || 10
|-
| 11 || 10
|-
| 12 || 12
|-
| 13 || 12
|-
| 14 || 15
|-
| 15 || 15
|}

==== 40-55: Key Scale Level / Output Level ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
|colspan=2| KSL
|colspan=6| Output level
|}

* bits 6-7: Key Scale Level. Attenuates output level towards higher pitch:

{|class="wikitable centred fixed-width"
! KSL !! Attenuation
|-
| 0 || -
|-
| 1 || 3.0 dB/oct
|-
| 2 || 1.5 dB/oct
|-
| 3 || 6.0 dB/oct
|}

The attenuation level is based on the 3-bit octave (block number) value and top four bits of the FNUM value, so each octave is subdivided into 16 parts.

* bits 0-5: Output Level. Attenuates the operator output level. 0 is the loudest, 3F is the softest. Attenuation range is 48dB with 0.75dB resolution.
{|class="wikitable centred fixed-width"
! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| 24dB || 12dB || 6dB || 3dB || 1.5dB || 0.75dB
|}

* In additive synthesis, varying the output level of any operator varies the volume of its corresponding channel. In FM synthesis, varying the output level of the carrier varies the volume of the channel. Varying the output of the modulator will change the frequency spectrum produced by the carrier. The following table summarizes which operators' output levels should be updated when trying to change channel output level.

{|class="wikitable centred fixed-width"
! Mode !! Op 1 !! Op 2 !! Op 3 !! Op 4
|-
| AM || Y || Y || N/A || N/A
|-
| FM || - || Y || N/A || N/A
|-
| FM-FM || - || - || - || Y
|-
| AM-FM || Y || - || - || Y
|-
| FM-AM || - || Y || - || Y
|-
| AM-AM || Y || - || Y || Y
|}

==== 60-75: Attack Rate / Decay Rate ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
|colspan=4| Attack rate
|colspan=4| Decay rate
|}

* bits 4-7: Attack Rate. Determines the rising time for the sound. The higher the value, the faster the attack. If value is 0, the sound will never attack, and if value is 15, the volume jumps directly from minimum to maximum.
* bits 0-3: Decay Rate. Determines the diminishing time for the sound. The higher the value, the shorter the decay. If value is 0, the sound does not decay towards sustain level and stays at maximum volume after attack.

==== 80-95: Sustain Level / Release Rate ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
|colspan=4| Sustain level
|colspan=4| Release rate
|}

* bits 4-7: Sustain Level. Determines the point at which the sound ceases to decay and chages to a sound having a constant level. The sustain level is expressed as a fraction of the maximum level. 15 is the softest and 0 is the loudest sustain level. Note that the Sustain-bit in the register 20-35 must be set for this to have an effect. Otherwise the sound will continue with release phase after hitting sustain level.

{|class="wikitable centred fixed-width"
! SL3 !! SL2 !! SL1 !! SL0
|-
| -24dB || -12dB || -6dB || -3dB
|}

There is an exception when all bits are set (value=15), the actual level is -93dB instead, matching as if the value were 31.

* bits 0-3: Release Rate. Determines the rate at which the sound disappears after KEY-OFF. The higher the value, the shorter the release. Value of 0 causes the sound not to release at all, it will continue to produce sound at level before KEY-OFF.

Some songs (e.g. <tt>LAME intro tune for Xerox of INC.raw</tt>) set the sustain and release values to the shortest (0xFF) while the note is still playing in order to immediately silence a note that would otherwise linger after keyoff.

==== A0-A8: Frequency Number ====

Determines the pitch of the note. Highest bits of F-Number are stored in the register below.

==== B0-B8: Key On / Block Number / F-Number(hi bits) ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
|colspan=2| -
| Note on
|colspan=3| Block number
|colspan=2| Frequency num.
|}

The '''note on''' bit is set to 1 to play a note on the channel, and 0 to silence the note. Setting this value to 1 when a note is already playing has no effect (it does not retrigger the note.)

The '''block number''' is often referred to as the octave, but this is a misleading description. The value of the block controls the frequency range spanned by the frequency numbers. A larger block allows higher frequencies (pitch) to be reached, at the expense of there being a greater difference in pitch of two adjacent frequency numbers. This works out well, since a low block number allows a very high pitch accuracy for deep notes where it is most noticeable, while high block numbers mean the coarse pitch settings need only be used at high frequencies where the coarseness is unnoticeable.

The following table illustrates the effect of different block numbers.

{|class="wikitable"
!rowspan=2| Block !!colspan=2| Note frequency !!rowspan=2| Difference between adjacent notes (Hz)
|-
! F-num=1 !! F-num=1023
|-
|align=center| 0 ||align=right| 0.047 Hz ||align=right| 48.503 Hz ||align=right| 0.048 Hz
|-
|align=center| 1 ||align=right| 0.094 Hz ||align=right| 97.006 Hz ||align=right| 0.095 Hz
|-
|align=center| 2 ||align=right| 0.189 Hz ||align=right| 194.013 Hz ||align=right| 0.190 Hz
|-
|align=center| 3 ||align=right| 0.379 Hz ||align=right| 388.026 Hz ||align=right| 0.379 Hz
|-
|align=center| 4 ||align=right| 0.758 Hz ||align=right| 776.053 Hz ||align=right| 0.759 Hz
|-
|align=center| 5 ||align=right| 1.517 Hz ||align=right| 1,552.107 Hz ||align=right| 1.517 Hz
|-
|align=center| 6 ||align=right| 3.034 Hz ||align=right| 3,104.215 Hz ||align=right| 3.034 Hz
|-
|align=center| 7 ||align=right| 6.068 Hz ||align=right| 6,208.431 Hz ||align=right| 6.069 Hz
|}

This shows that block 7 is capable of reaching the highest note (6.2kHz) but since there are 6Hz between notes the accuracy suffers. Note A-4 is 440Hz but in this block, the two closest frequency numbers are 72 and 73, which create tones at 437Hz and 443Hz respectively, neither of which is particularly accurate. Blocks 3 and below are unable to reach as high as 440Hz, but block 4 can. With block 4, frequency numbers 579 and 580 produce 439.4Hz and 440.2Hz, considerably closer to the intended frequency.

In other words, when calculating notes, the best accuracy is achieved by selecting the lowest possible block number that can reach the desired note frequency.

The '''frequency number''' is split between registers A0 and B0, with the upper two bits being stored here. The full frequency number is a value between 0 and 1023 inclusive. The following formula is used to determine the frequency number for a given note frequency (in Hertz) and block:

: f-num = freq * 2^(20 - block) / 49716

This formula can produce frequency numbers outside of the allowed 0-1023 range if the block number is too low, or the frequency is higher than the hardware can produce.

The sampling frequency of OPL2 and OPL3 chips is approximately 49716 Hz, leading to the constant in the formula. Occasionally this is rounded to 50000 leading to a small pitch variation if the wrong constant is used to play these songs. OPL2 cards like Adlib and early Sound Blasters used the 14.31818 MHz oscillator signal from ISA bus slot and divided it by four on card, thus running the OPL2 chip at 3.579545 MHz, which gets divided internally by 72 to get the sampling rate. OPL3 cards had to be compatible, and mostly the sound cards have separate 14.31818 MHz oscillator on board which the OPL3 uses directly, and this gets divided internally by 288 to get the sampling rate.

NOTE: In four-operator mode only the register value of Operators 1 and 2 is used, value of Operators 3 and 4 in this register is ignored. In other words: one channel uses only one frequency, block and KEY-ON value at a time, regardless whether it is a two- or four-operator channel.

Setting the frequency and/or block has an immediate effect, regardless of the state of the ''note on'' bit. By changing the values gradually, pitch bends can be achieved.

{{TODO|Is a delay needed between setting the keyon bit to 0 and then back to 1 to retrigger a note?}}

==== BD: Tremolo Depth / Vibrato Depth / Percussion Mode / BD/SD/TT/CY/HH On ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| Tre
| Vib
| Per
| BD
| SD
| TT
| CY
| HH
|}

* bit 7: Tremolo (Amplitude Vibrato) Depth. 0 = 1.0dB, 1 = 4.8dB.
* bit 6: Frequency Vibrato Depth. 0 = 7 cents, 1 = 14 cents. A "cent" is 1/100 of a semi-tone.
* bit 5: Percussion Mode. 0 = Melodic Mode, 1 = Percussion Mode.
* bit 4: BD On. KEY-ON of the Bass Drum channel.
* bit 3: SD On. KEY-ON of the Snare Drum channel.
* bit 2: TT On. KEY-ON of the Tom-Tom channel.
* bit 1: CY On. KEY-ON of the Cymbal channel.
* bit 0: HH On. KEY-ON of the Hi-Hat channel.

NOTE: KEY-ON bits of channels 6, 7 and 8 must be clear and their F-Nums, Attack/Decay/Release rates, etc. must be set properly to use percussion mode.

This register only exists in the first register set (OPL2) and does not exist in the second register set (OPL3 upper registers). Rhythm mode only affects the lower register set, the upper registers are not affected by rhythm mode.

{{TODO|On an OPL3, does the value set here apply to all 18 channels or only the OPL2-compatible first 9 channels?}}

==== C0-C8: FeedBack Modulation Factor / Synthesis Type ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| OutCh_D
| OutCh_C
| R
| L
|colspan=3| Feedback
| Syn
|}

* bit 7: CHD, Output Channel D Enable. When set, channel output goes to fourth digital audio output channel.
* bit 6: CHC, Output Channel C Enable. When set, channel output goes to third digital audio output channel.
* bit 5: Right Speaker Enable. When set, channel output goes to second digital audio output channel, connected to right speaker.
* bit 4: Left Speaker Enable. When set, channel output goes to first digital audio output channel, connected to left speaker.
** In OPL3 mode, at least one of the left/right bits must be set to hear the channel.
** In OPL2 mode, these bits are ignored and audio is sent to all channels for compatibility reasons.
** Left/Right bits can be used to realize sound "panning", but this method offers only three pan positions (left/center/right).
** These bits apply only to operators producing sound (Carriers). Modulators are not affected by their setting.
** Sound cards use only one stereo DAC, so only two of the four digital output channels are available.
* bits 1-3: FeedBack Modulation Factor. If 0, no feedback is present. If 1-7, operator 1 will send a portion of its output back into itself.

{|class="wikitable centred fixed-width"
! FeedBack !! Factor
|-
| 0 || 0
|-
| 1 || π/16
|-
| 2 || π/8
|-
| 3 || π/4
|-
| 4 || π/2
|-
| 5 || π
|-
| 6 || 2π
|-
| 7 || 4π
|}

When in four-operator mode, the FeedBack value is used only by Operator 1, value of Operators 2, 3 and 4 is ignored.

* bit 0: Synthesis Type. 1 = Additive synthesis, 0 = Frequency Modulation. In four-operator mode, there are two bits controlling the synthesis type. Both are the bit 0 of register C0, one of Operators 1 and 2 and the second of Operators 3 and 4.

{|class="wikitable centred fixed-width"
! Op 1&2 !! Op 3&4 !! Type
|-
| 0 || NONE || FM
|-
| 1 || NONE || AM
|-
| 0 || 0 || FM-FM
|-
| 1 || 0 || AM-FM
|-
| 0 || 1 || FM-AM
|-
| 1 || 1 || AM-AM
|}

==== E0-F5: Waveform Select ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
|colspan=5| -
|colspan=3| Waveform
|}

* bits 0-2: WaveForm Select (WS): <gallery widths=300px heights=150px perrow=4>
Image:OPL_Wave0_Digital.svg|Waveform 0: Sine
Image:OPL_Wave1_Digital.svg|Waveform 1: Half-sine
Image:OPL_Wave2_Digital.svg|Waveform 2: Abs-sine
Image:OPL_Wave3_Digital.svg|Waveform 3: Pulse-sine
Image:OPL_Wave4_Digital.svg|Waveform 4: Sine - even periods only
Image:OPL_Wave5_Digital.svg|Waveform 5: Abs-sine - even periods only
Image:OPL_Wave6_Digital.svg|Waveform 6: Square
Image:OPL_Wave7_Digital.svg|Waveform 7: Derived square
</gallery>

* NOTE: Bit 5 of register 01 must be set to use waveforms other than sine. Waveforms 4-7 are available only on OPL3.

== Examples ==

These examples show a few working routines used in my MUS Player. They are written in Borland C++ 3.1 but should be easy to translate to any other language.

<source lang="C">
// I prefer using these Assembler-like types
typedef unsigned int WORD;
typedef unsigned char BYTE;

/*
* FM Synthesizer base port. SB Pro II - 0x220, Adlib 0x388
*/
WORD FMport = 0x220;

/*
* Enables OPL3 extensions.
*/
WORD OPL3 = 1;

/*
* Direct write to any Adlib/SB Pro II FM synthetiser register.
* reg - register number (range 0x001-0x0F5 and 0x101-0x1F5). When high byte
* of reg is zero, data go to port FMport, otherwise to FMport+2
* data - register value to be written
*/
BYTE FMwriteReg(WORD reg, BYTE data)
{
asm {
mov dx,FMport
mov ax,reg
or ah,ah // high byte is nonzero -- write to port base+2
jz out1
inc dx
inc dx
}
out1: asm {
out dx,al
mov cx,6
}
loop1:asm { // delay between writes
in al,dx
loop loop1

inc dx
mov al,data
out dx,al
dec dx
mov cx,36
}
loop2:asm { // delay after data write
in al,dx
loop loop2
}
return _AL;
}

/*
* Write to an operator pair. To be used for register bases of 0x20, 0x40,
* 0x60, 0x80 and 0xE0.
*/
void FMwriteChannel(BYTE regbase, BYTE channel, BYTE data1, BYTE data2)
{
static BYTE adlib_op[] = {0, 1, 2, 8, 9, 10, 16, 17, 18};
static BYTE sbpro_op[] = { 0, 1, 2, 6, 7, 8, 12, 13, 14,
18, 19, 20, 24, 25, 26, 30, 31, 32};
static WORD rg[] = {0x000,0x001,0x002,0x003,0x004,0x005,
0x008,0x009,0x00A,0x00B,0x00C,0x00D,
0x010,0x011,0x012,0x013,0x014,0x015,
0x100,0x101,0x102,0x103,0x104,0x105,
0x108,0x109,0x10A,0x10B,0x10C,0x10D,
0x110,0x111,0x112,0x113,0x114,0x115};

if (OPL3)
{
register WORD reg = sbpro_op[channel];
FMwriteReg(rg[reg]+regbase, data1);
FMwriteReg(rg[reg+3]+regbase, data2);
} else {
register WORD reg = regbase+adlib_op[channel];
FMwriteReg(reg, data1);
FMwriteReg(reg+3, data2);
}
}

/*
* Write to channel a single value. To be used for register bases of
* 0xA0, 0xB0 and 0xC0.
*/
void FMwriteValue(BYTE regbase, BYTE channel, BYTE value)
{
static WORD ch[] = {0x000,0x001,0x002,0x003,0x004,0x005,0x006,0x007,0x008,
0x100,0x101,0x102,0x103,0x104,0x105,0x106,0x107,0x108};
register WORD chan;

if (OPL3)
chan = ch[channel];
else
chan = channel;
FMwriteReg(regbase + chan, value);
}
</source>

== Detection Methods ==

An official method of Adlib (OPL2) detection is:

# Reset Timer 1 and Timer 2: write 60h to register 4.
# Reset the IRQ: write 80h to register 4.
#* NOTE: Steps 1 and 2 can't be combined together.
# Read status register: read port base+0 (388h). Save the result.
# Set Timer 1 to FFh: write FFh to register 2.
# Unmask and start Timer 1: write 21h to register 4.
# Wait in a delay loop for at least 80 µsec.
# Read status register: read port base+0 (388h). Save the result.
# Reset Timer 1, Timer 2 and IRQ as in steps 1 and 2.
# Test the results of the two reads: the first should be 0, the second should be C0h. If either is incorrect, then the OPL2 is not present.

* NOTE1: You should AND the result bytes with E0h because the unused bits are undefined.
* NOTE2: This testing method doesn't work in some SoundBlaster compatible cards.

=== OPL3 Detection ===
--------------

The datasheet for the YMF289B (OPL3-L) describes the following method:

# Detect OPL2. All OPL3 devices should succeed OPL2 checks.
# Read status register: read port base+0.
# AND the result with 06h.
# If the result is zero, you have OPL3, otherwise OPL2.

The OPL3-L can further be discerned from OPL3 by attempting to read registers on the OPL3-L. This is not possible on the OPL3.

Another possible detection method for distinguishing between SB Pro I and SB Pro II would be to try to detect OPL2 at I/O port base+0 and then at port base+2. The first test should succeed and the second should fail if OPL3 is present. (Remember: SB Pro I contains twin OPL2 chips at addresses base+0 and base+2, while SB Pro II contains one OPL3 chip at I/O address base+0 thru base+3).

== BLASTER Environment Variable ==

Perhaps the most recommended "detection" method. Reading this variable avoids blindfold I/O port scanning and possible device conflicts. The user is responsible for its proper setting.

The variable has this format:

BLASTER=Aaddr Iirq Ddma Ttype

* A: Base I/O address given in hex. For most Sound Blasters the default is 220.
* I: IRQ Number (decimal). Default 7.
* D: DMA Number (decimal). Default 1.
* T: Card Type (decimal):
** 1 - Sound Blaster 1.5
** 2 - Sound Blaster Pro I
** 3 - Sound Blaster 2.0
** 4 - Sound Blaster Pro II
** 6 - Sound Blaster 16, AWE32/64

Example:

BLASTER=A220 I7 D1 T4

== References ==

''The PC Games Programmers Encyclopedia'', Mark Feldman and many others on Usenet and Internet, http://bespin.org/~qz/pc-gpe/
: ... you can find (almost) everything you need there

''Sound Blaster - The Official Book'', Richard Heimlich, David M. Golden, Ivan Luk, Peter M. Ridge, Osborne/McGraw Hill, ISBN 0-07-881907-5
: ... this is a number-one in my book-wishlist. If anyone wanted to get rid of the book, I wouldn't scorn it ... :-)

''The SoundBlaster Developer Kit'', Creative Labs Inc, Creative Technology PTE LTD
: ... I wonder if you can find something comprehensible in that.

OPL chip

2024-11-18T20:42:17Z

SaxxonPike: /* OPL3 Detection */ The detection method is indeed "official" but only printed in another product datasheet (OPL3-L)

= Programmer's Guide to Yamaha YMF 262/OPL3 FM Music Synthesizer =
Version 1.00 Nov-24-1994

Written by Vladimir Arnost, QA-Software
Internet: xarnos00@dcse.fee.vutbr.cz

This manual can be distributed freely if not modified.

=== Disclaimer ===

I assume no responsibility for any damages arising out of use or inability to use this text. No warranty is provided about correctness of any information in this file. You are on your own.

== Introduction ==

The chip I am going to describe is getting more and more common, but programming information is still scarce, so I have decided to fill in this gap. All information contained in this file is a result of my experience in Adlib programming, research (read: reverse engineering) and finally of my effort to write down everything necessary to understand and use this piece of hardware. No official sources (i.e. development kits, books about this topic, etc.) were available to me except:

: Adlib Programming Guide - by Tero Töttö, and
: The PC Games Programmers Encyclopedia V1.0

The information below is a combination of known features of Adlib (alias Yamaha YM 3812/OPL2) and my own uncountable experiments and failures, which brought out a lot of important details you have to know about the chip.

As far as I know, there are four major sound cards based on OPL3 chip:

* Sound Blaster Pro II (not Sound Blaster Pro I)
* Sound Blaster 16
* Adlib Gold
* Pro Audio Spectrum Plus/16

I currently have a Sound Blaster Pro II-compatible card only, so all the programming info I provide will be based on this card. (The other cards are quite similar, however. They are just wired at different I/O-port addresses.)

Note: I assume some knowledge of FM music programming (mainly Adlib FM synthesizer) in this manual. If you are new to this topic I recommend you try Adlib first before going higher. Anyway, OPL3 is a direct descendant of OPL2 (what a surprise), so most features of OPL2 are also present on OPL3.

== Description of the Synthesizer ==

My card's user manual says: "[this card contains] ... a stereo music FM synthesizer with 20 channels consisting of four (4) operators each ... " I thought: "Wow -- that's together eighty operators. This must be a GOOD sound-card." I was wrong. Just another advertising lie.

So let's clear some facts. First, OPL3 has only thirty-six (36) operators which can be combined in several ways:

* 18 FM channels (36 operators), or
* 15 FM channels (30 ops) and 5 percussion instruments (6 ops), giving us 20 channels altogether, or
* up to 6 four-operator FM channels (max 24 ops), the rest again being divided into two-operator FM channels and drums.

From the table above you can see that not all channels can be used in four-operator (4-OP) mode -- only a part of the synthesizer is really capable of making 4-OP sounds -- the rest uses traditional two-operator (2-OP) mode.

Second, the manual states this card is capable of "stereo" music. Yes, the quotes are necessary, because the stereo capabilities are very limited. You are given ability to control output going to left or right channel by turning it on and off. That's all. So the sound can flow from very left side, center and very right side. No sound panning, no special stereo effects. :-(

Well, flaming apart, back to the main topic.

The OPL3 chip is capable of making sounds in several ways:

=== Two-operator Additive Synthesis ===

Output of both operators is simply added. It is the simplest way to make any sound, and it works on both OPL2 and OPL3. The diagram should make it clear.

<pre>
┌────────────┐
│ │
│ Operator 1 ├────────┐
│ │ │
└────────────┘ │
├────────> Output
┌────────────┐ │
│ │ │
│ Operator 2 ├────────┘
│ │
└────────────┘
</pre>

=== Two-operator Frequency Modulation (FM) Synthesis ===

Output from the first operator (Modulator) is sent to the input of the second one (Carrier) and is used to modulate (alter) frequency of the second operator. Only the second operator produces sound. Most of interesting sounds are made this way. This also works on OPL2. Hope the picture helps.

<pre>
┌────────────┐ ┌────────────┐
│ │ │ │
│ Operator 1 ├────────>│ Operator 2 ├────────> Output
│(Modulator) │ │ (Carrier) │
└────────────┘ └────────────┘
</pre>

=== Four-operator "Mess" Modulation Synthesis ===

All of OPL3's 4-OP configurations are combinations of the above two modes of synthesis. OPL3 combines these two modes in four ways. I have no words to describe these four ways. Only the pictures can show their principle.

<pre>
a) FM-FM Mode

┌───────┐ ┌───────┐ ┌───────┐ ┌───────┐
│ │ │ │ │ │ │ │
│ Op. 1 ├─────>│ Op. 2 ├─────>│ Op. 3 ├─────>│ Op. 4 ├─────> Output
│ │ │ │ │ │ │ │
└───────┘ └───────┘ └───────┘ └───────┘

b) AM-FM Mode

┌───────┐
│ │
│ Op. 1 ├───────────────────────────────────┐
│ │ │
└───────┘ │
│
┌───────┐ ┌───────┐ ┌───────┐ │
│ │ │ │ │ │ │
│ Op. 2 ├─────>│ Op. 3 ├─────>│ Op. 4 ├─────┴─────> Output
│ │ │ │ │ │
└───────┘ └───────┘ └───────┘

c) FM-AM Mode

┌───────┐ ┌───────┐
│ │ │ │
│ Op. 1 ├─────>│ Op. 2 ├─────┐
│ │ │ │ │
└───────┘ └───────┘ │
├─────> Output
┌───────┐ ┌───────┐ │
│ │ │ │ │
│ Op. 3 ├─────>│ Op. 4 ├─────┘
│ │ │ │
└───────┘ └───────┘

d) AM-AM Mode

┌───────┐
│ │
│ Op. 1 ├────────────────────┐
│ │ │
└───────┘ │
│
┌───────┐ ┌───────┐ │
│ │ │ │ │
│ Op. 2 ├─────>│ Op. 3 ├─────┼─────> Output
│ │ │ │ │
└───────┘ └───────┘ │
│
┌───────┐ │
│ │ │
│ Op. 4 ├────────────────────┘
│ │
└───────┘
</pre>

Nice, aren't they?

The only way I think this can be written is a math formula. Symbol + (plus) means additive synthesis, and * (asterisk) means frequency modulation (Op1 * Op2 means operator 1 modulates operator 2, not vice versa). Here they are:

# FM-FM Mode: (Op1 * Op2 * Op3 * Op4) ────> Output
# AM-FM Mode: Op1 + (Op2 * Op3 * Op4) ───> Output
# FM-AM Mode: (Op1 * Op2) + (Op3 * Op4) ──> Output
# AM-AM Mode: Op1 + (Op2 * Op3) + Op4 ───> Output

=== Percussion Mode ===

In this mode 6 operators are used to produce five different percussion instruments:

* Bass Drum (2 operators)
* Snare Drum (1 operator)
* Tom-Tom (1 operator)
* Cymbal (1 operator)
* Hi-Hat (1 operator)

Based on notes from MAME's OPL emulator, the following points hold true:

* Setting the block/fnum on each percussive channel may affect multiple instruments.
** The pitch on channel 6 affects just the bass drum
** The pitch on channel 7 affects the hihat, cymbal and snare
** The pitch on channel 8 affects the hihat, cymbal and tomtom
* The modulator/carrier output level is used to set the volume of each instrument.
** channel 6 carrier controls the volume of the bass drum
** channel 7 modulator controls the volume of the hi-hat
** channel 7 carrier controls the volume of the snare
** channel 8 modulator controls the volume of the tomtom
** channel 8 carrier controls the volume of the cymbal
* Panning L/R bits set via register 0xC0 affect instruments as follows:
** channel 6 affects the bass drum
** channel 7 affects hi-hat and snare
** channel 8 affects cymbal and tomtom

The ''AdLib Programmer's Manual'' contains playback code that uses the Tom-Tom frequency for all percussion instruments. It is possible this is the source of the confusion. Here, when a note is played on the Tom-Tom channel, that note will of course cause the Top Cymbal to change as well because of the shared channel. But the code increases this pitch by seven semitones and sets that frequency for channel 7 at the same time, ensuring the Hi-Hat and Snare Drum are always set to seven semitones above the last Tom-Tom note. (See [[AdLib MIDI Format]] for details.)

This mode is identical with that of OPL2. For more details see ADLIB.DOC.

== Programming the Synthesizer ==

OPL3 may be found at the following addresses:

{|class="wikitable"
| Sound Blaster Pro II || 220h or 240h (selectable), also 388h
|-
| Adlib Gold || 388h
|-
| Pro Audio Spectrum Plus/16 || ? (if you have a PAS you should know it)
|}

The base address of the synthesizer will be called "base".

The chip occupies four I/O addresses:

{|class="wikitable"
| base+0 || Primary index register (write), Status register (read)
|-
| base+1 || Primary data register (write-only)
|-
| base+2 || Secondary index register (write)
|-
| base+3 || Secondary data register (write-only)
|}

The index registers are used to select internal registers and data registers are used to write to them. Status register returns the state of two timers built in the chip.

OPL3 contains two sets of registers. The Primary set maps to channels 0-8 (operators 0-17) and the secondary maps to channels 9-17 (operators 18-35). The reason for this is simple: all these registers wouldn't fit into single register set.

Unlike Adlib (OPL2), OPL3 doesn't need delay between register writes. With OPL2 you had to wait 3.3 µs after index register write and another 23 µs after data register write. On the contrary OPL3 doesn't need (almost) any delay after index register write and only 0.28 µs after data register write. This means you can neglect the delays and slightly speed up your music driver. But using reasonable delays will certainly do no harm.

The data registers can't be read (they are write-only) on both OPL2 and OPL3.

== Register Map ==

The registers are grouped in the same manner as in the OPL2 chip. Programs using both OPL2 and OPL3 chips may use the same code provided that their direct I/O interface is well written. The only thing you have to change is operator-to-register mapping, which must accomodate the fact that registers are spread between two register sets.

(The register map is nearly the same so I dared to copy it from ADLIB.DOC.)

=== Status Register (base+0) ===

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| IRQFlag || T1Flag || T2Flag || || || || ||
|}

=== Data Registers (base+1, base+3) ===

{|class="wikitable centred fixed-width"
! REG !! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| 01 ||colspan=2| Test Register ||style="background-color: #CCFFCC;"|(WSEnable)||colspan=5| Test Register
|-
| 02 ||colspan=8| Timer 1 Count (80 µsec resolution)
|-
| 03 ||colspan=8| Timer 2 Count (320 µsec resolution)
|-
| 04* ||IRQReset|| T1Mask || T2Mask ||colspan=3| ||T2 Start||T1 Start
|-
| 04** ||colspan=2| ||style="background-color: #CCFFCC;"|4-OP B-E||style="background-color: #CCFFCC;"|4-OP A-D||style="background-color: #CCFFCC;"|4-OP 9-C||style="background-color: #CCFFCC;"|4-OP 2-5||style="background-color: #CCFFCC;"|4-OP 1-4||style="background-color: #CCFFCC;"|4-OP 0-3
|-
| 05** ||colspan=7| ||style="background-color: #CCFFCC;"| OPL3
|-
| 08 ||style="background-color: #CCFFCC;"| (CSW) ||style="background-color: #CCFFCC;"|NOTE-SEL||colspan=6|
|-
| 20-35 ||style="background-color: #CCCCFF;"|Tremolo ||style="background-color: #CCCCFF;"|Vibrato ||style="background-color: #CCCCFF;"|Sustain ||style="background-color: #CCCCFF;"| KSR ||colspan=4 style="background-color: #CCCCFF;"| Frequency Multiplication Factor
|-
| 40-55 ||colspan=2 style="background-color: #CCCCFF;"| Key Scale Level ||colspan=6 style="background-color: #CCCCFF;"| Output Level
|-
| 60-75 ||colspan=4 style="background-color: #CCCCFF;"| Attack Rate ||colspan=4 style="background-color: #CCCCFF;"| Decay Rate
|-
| 80-95 ||colspan=4 style="background-color: #CCCCFF;"| Sustain Level ||colspan=4 style="background-color: #CCCCFF;"| Release Rate
|-
| A0-A8 ||colspan=8 style="background-color: #FFE0CC;"| Frequency Number (Lower 8 bits)
|-
| B0-B8 ||colspan=2| ||style="background-color: #FFE0CC;"| KEY-ON ||colspan=3 style="background-color: #FFE0CC;"| Block Number ||colspan=2 style="background-color: #FFE0CC;"| F-Num (hi bits)
|-
| BD* ||style="background-color: #CCFFCC;"|Trem Dep||style="background-color: #CCFFCC;"|Vibr Dep||style="background-color: #FFCCDD;"|PercMode||style="background-color: #FFCCDD;"| BD On ||style="background-color: #FFCCDD;"| SD On ||style="background-color: #FFCCDD;"| TT On ||style="background-color: #FFCCDD;"| CY On ||style="background-color: #FFCCDD;"| HH On
|-
| C0-C8 ||style="background-color: #FFE0CC;"| OutCh_D ||style="background-color: #FFE0CC;"| OutCh_C ||style="background-color: #FFE0CC;"| Right ||style="background-color: #FFE0CC;"| Left ||colspan=3 style="background-color: #FFE0CC;"|FeedBack Modulation Factor||style="background-color: #FFE0CC;"|SynthTyp
|-
| E0-F5 ||colspan=5| ||colspan=3 style="background-color: #CCCCFF;"| Waveform Select
|}

{|
|style="background-color: #CCFFCC;"| Chip-wide setting
|style="background-color: #CCCCFF;"| Per operator
|style="background-color: #FFE0CC;"| Per channel
|style="background-color: #FFCCDD;"| Rhythm-mode only
|}

:<nowiki>*</nowiki> This applies only to port base+1 (OPL2)
:<nowiki>**</nowiki> This applies only to port base+3 (OPL3, second register set)

For register bases A0, B0 and C0 there is one register per output channel. The primary register set holds the first nine channels (0-8) and the secondary holds last nine channels (9-17). For bases 20, 40, 60, 80 and E0 there are two registers per channel. Each register maps to one operator. Unfortunately the operator's register numbers are not continuous. The following table shows which operator maps to which register set and offset (in hex).

{|class="wikitable centred"
! Op. !! Set/Offset !! Op. !! Set/Offset
|-
| 0 || 0/00 || 18 || 1/00
|-
| 1 || 0/01 || 19 || 1/01
|-
| 2 || 0/02 || 20 || 1/02
|-
| 3 || 0/03 || 21 || 1/03
|-
| 4 || 0/04 || 22 || 1/04
|-
| 5 || 0/05 || 23 || 1/05
|-
| 6 || 0/08 || 24 || 1/08
|-
| 7 || 0/09 || 25 || 1/09
|-
| 8 || 0/0A || 26 || 1/0A
|-
| 9 || 0/0B || 27 || 1/0B
|-
| 10 || 0/0C || 28 || 1/0C
|-
| 11 || 0/0D || 29 || 1/0D
|-
| 12 || 0/10 || 30 || 1/10
|-
| 13 || 0/11 || 31 || 1/11
|-
| 14 || 0/12 || 32 || 1/12
|-
| 15 || 0/13 || 33 || 1/13
|-
| 16 || 0/14 || 34 || 1/14
|-
| 17 || 0/15 || 35 || 1/15
|}

The following tables summarize which operators form a channel in various modes:

1. Two-operator Melodic Mode

{|class="wikitable centred"
! Channel !! 0 !! 1 !! 2 !! 3 !! 4 !! 5 !! 6 !! 7 !! 8 !! 9 !! 10 !! 11 !! 12 !! 13 !! 14 !! 15 !! 16 !! 17
|-
| Operator 1 || 0 || 1 || 2 || 6 || 7 || 8 || 12 || 13 || 14 || 18 || 19 || 20 || 24 || 25 || 26 || 30 || 31 || 32
|-
| Operator 2 || 3 || 4 || 5 || 9 || 10 || 11 || 15 || 16 || 17 || 21 || 22 || 23 || 27 || 28 || 29 || 33 || 34 || 35
|}

2. Two-operator Melodic and Percussion Mode

{|class="wikitable centred"
! Channel !! 0 !! 1 !! 2 !! 3 !! 4 !! 5 !! BD !! SD !! TT !! CY !! HH !! 9 !! 10 !! 11 !! 12 !! 13 !! 14 !! 15 !! 16 !! 17
|-
| Operator 1 || 0 || 1 || 2 || 6 || 7 || 8 || 12 || 16 || 14 || 17 || 13 || 18 || 19 || 20 || 24 || 25 || 26 || 30 || 31 || 32
|-
| Operator 2 || 3 || 4 || 5 || 9 || 10 || 11 || 15 ||colspan=4| - || 21 || 22 || 23 || 27 || 28 || 29 || 33 || 34 || 35
|}

3. Four-operator Melodic Mode

{|class="wikitable centred"
! Channel !! 0 !! 1 !! 2 !! 6 !! 7 !! 8 !! 9 !! 10 !! 11 !! 15 !! 16 !! 17
|-
| Operator 1 || 0 || 1 || 2 || 12 || 13 || 14 || 18 || 19 || 20 || 30 || 31 || 32
|-
| Operator 2 || 3 || 4 || 5 || 15 || 16 || 17 || 21 || 22 || 23 || 33 || 34 || 35
|-
| Operator 3 || 6 || 7 || 8 ||colspan=3| - || 24 || 25 || 26 ||colspan=3| -
|-
| Operator 4 || 9 || 10 || 11 ||colspan=3| - || 27 || 28 || 29 ||colspan=3| -
|}

Channels 3, 4, 5 and 12, 13, 14 can't be used separately because their operators became part of channels 0, 1, 2 and 9, 10, 11 respectively. For instance a four-operator channel 1 consists of two two-operator channels number 1 and 4. (The second 2-OP channel number is always the first 2-OP channel number plus three.)

OPL3 allows you to enable/disable 4-OP mode separately for any of channels 0, 1, 2, 9, 10 and 11 (see register 104h in the reference below). This means for instance when you switch only channel 2 into 4-OP mode, channels number 0, 1, 3, 4, 6, 7, 8, 9, etc. will be still independent 2-OP channels.

Channels 6, 7, 8 and 15, 16, 17 are always two-operator ones. They can't be grouped to form four-operator channels.

4. Four-operator Melodic and Percussion Mode

{|class="wikitable centred"
! Channel !! 0 !! 1 !! 2 !! BD !! SD !! TT !! CY !! HH !! 9 !! 10 !! 11 !! 15 !! 16 !! 17
|-
| Operator 1 || 0 || 1 || 2 || 12 || 16 || 14 || 17 || 13 || 18 || 19 || 20 || 30 || 31 || 32
|-
| Operator 2 || 3 || 4 || 5 || 15 ||colspan=4| - || 21 || 22 || 23 || 33 || 34 || 35
|-
| Operator 3 || 6 || 7 || 8 ||colspan=5| - || 24 || 25 || 26 ||colspan=3| -
|-
| Operator 4 || 9 || 10 || 11 ||colspan=5| - || 27 || 28 || 29 ||colspan=3| -
|}

Examples:

Two-operator channel #14 consists of operators 26 and 29 which occupy these registers (all are in the secondary register set):

{|class="wikitable"
| 12A || Operator 1 || Tremolo/Vibrato/Sustain/KSR/Multiplication
|-
| 12D || Operator 2 || Tremolo/Vibrato/Sustain/KSR/Multiplication
|-
| 14A || Operator 1 || Key Scale Level/Output Level
|-
| 14D || Operator 2 || Key Scale Level/Output Level
|-
| 16A || Operator 1 || Attack Rate/Decay Rate
|-
| 16D || Operator 2 || Attack Rate/Decay Rate
|-
| 18A || Operator 1 ||Sustain Level/Release Rate
|-
| 18D || Operator 2 || Sustain Level/Release Rate
|-
| 1A5 || || Frequency Number (low)
|-
| 1B5 || || Key On/Block Number/Frequency Number (high)
|-
| 1C5 || || FeedBack/Synthesis Type
|-
| 1EA || Operator 1 || Waveform Select
|-
| 1ED || Operator 2 || Waveform Select
|}

Four-operator channel #1 consists of operators 1, 4, 7 and 10. All registers except register 104h are in the primary set:

{|class="wikitable"
|-
| 104 || bit 1 = 1 || Enable Four-Operator Synthesis in channel #1
|-
| 21 || Operator 1 || Tremolo/Vibrato/Sustain/KSR/Multiplication
|-
| 24 || Operator 2 || Tremolo/Vibrato/Sustain/KSR/Multiplication
|-
| 29 || Operator 3 || Tremolo/Vibrato/Sustain/KSR/Multiplication
|-
| 2C || Operator 4 || Tremolo/Vibrato/Sustain/KSR/Multiplication
|-
| 41 || Operator 1 || Key Scale Level/Output Level
|-
| 44 || Operator 2 || Key Scale Level/Output Level
|-
| 49 || Operator 3 || Key Scale Level/Output Level
|-
| 4C || Operator 4 || Key Scale Level/Output Level
|-
| 61 || Operator 1 || Attack Rate/Decay Rate
|-
| 64 || Operator 2 || Attack Rate/Decay Rate
|-
| 69 || Operator 3 || Attack Rate/Decay Rate
|-
| 6C || Operator 4 || Attack Rate/Decay Rate
|-
| 81 || Operator 1 || Sustain Level/Release Rate
|-
| 84 || Operator 2 || Sustain Level/Release Rate
|-
| 89 || Operator 3 || Sustain Level/Release Rate
|-
| 8C || Operator 4 || Sustain Level/Release Rate
|-
| A1 || || Frequency Number (low)
|-
| A4 || || Unused
|-
| B1 || || Key On/Block Number/Frequency Number (high)
|-
| B4 || || Unused
|-
| C1 || || FeedBack/Synthesis Type (part 1)
|-
| C4 || || Synthesis Type (part 2)
|-
| E1 || Operator 1 || Waveform Select
|-
| E4 || Operator 2 || Waveform Select
|-
| E9 || Operator 3 || Waveform Select
|-
| EC || Operator 4 || Waveform Select
|}

NOTE: If a register number is greater than 100h, then it belongs into the secondary register set. (I use this numbering to emphasize the fact that the particular register MUST be written to the secondary set.) See the example code below for details.

== OPL3 Register Reference ==

Because the registers of OPL3 are almost the same as of OPL2, I have copied their descriptions from file ADLIB.DOC.

=== Status Register ===

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| IRQ || T1 || T2 ||colspan=5| -
|}

* bit 7: IRQ Flag. Set whenever any timer has elapsed.
* bit 6: Timer 1 Flag. Set every time the preset time in Timer 1 has elapsed.
* bit 5: Timer 2 Flag. Set every time the preset time in Timer 2 has elapsed.

Timer interrupts are not wired to any IRQ (why??). The timers can be used to detect the OPL2/OPL3 chip (see Appendix B).

=== Data Registers ===

==== 01: Test Register / Waveform Select Enable ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
|colspan=2| Test Register
| (WSE)
|colspan=5| Test Register
|}

* bits 7-6: Test Register. Must be reset to zero before any operation.
* bit 5: Waveform Select Enable. If clear, all channels will use normal sine wave. If set, register E0-F5 (Waveform Select) contents will be used.
* bits 0-4: Test Register. Must be reset to zero before any operation.

OPL3 does not implement WSE bit, and it should be left clear. In OPL2 mode all four waveforms are always available, and in OPL3 mode all eight waveforms are always available. For compatibility with OPL2, when a program is finished using an OPL3, the waveform select registers should be set to 0, if the next program assumes that by setting WSE bit to 0 the waveform is always sine like on a real OPL2.

==== 02: Timer 1 Count ====

Upward 8 bit counter with a resolution of 80 µsec. If an overflow occurs, the status register bit is set, and the preset value is loaded into the timer again.

==== 03: Timer 2 Count ====

Same as Timer 1, but with a resolution of 320 µsec.

==== 004 (port: base+1): IRQ-Reset / Mask / Start ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| Rst
| T1M
| T2M
|colspan=3| -
| T2S
| T1S
|}

* bit 7: IRQ-Reset. Resets timer and IRQ flags in status register. All other bits are ignored when this bit is set.
* bit 6: Timer 1 Mask. If 1, status register is not affected in overflow.
* bit 5: Timer 2 Mask. Same as above.
* bit 1: Timer 2 Start. Timer on/off.
* bit 0: Timer 1 Start. Same as above.

==== 104 (port: base+3): Four-Operator Enable ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
|colspan=2| -
| ChB
| ChA
| Ch9
| Ch2
| Ch1
| Ch0
|}

* bit 5: Enable four-operator synthesis for channel pair 11 - 14 (decimal).
* bit 4: Same as above for channel pair 10 - 13.
* bit 3: Same as above for channel pair 9 - 12.
* bit 2: Same as above for channel pair 2 - 5.
* bit 1: Same as above for channel pair 1 - 4.
* bit 0: Same as above for channel pair 0 - 3.

If reset to zero, OPL3 can produce 18 two-operator sounds at a time. If nonzero, OPL3 produces four-operator sound in appropriate channel pair.

==== 105 (port: base+3): OPL3 Mode Enable ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
|colspan=7| -
| OPL3
|}

* bit 0: OPL3 Mode Enable. When set, OPL3 extensions (36 operators, 4-OP synthesis, 8 waveforms, stereo output) can be used. When reset, the chip behaves as an ordinary OPL2. This bit is zero by default for compatibility with OPL2.

==== 08: CSW / NOTE-SEL ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| (CSW)
| N-S
|colspan=6| -
|}

* bit 7: Composite sine wave mode on/off. All KEY-ON bits must be clear in order to use this mode. The card is unable to create any other sound when in CSW mode. (Unfortunately, I have no info how to use this mode :-< ). The CSW mode is not implemented on an OPL3 and this bit is ignored.
* bit 6: NOTE-SEL. Controls the split point of the keyboard. When 0, the keyboard split is the second bit from the bit 8 of the F-Number. When 1, the MSb of the F-Number is used. (???)

The Note Select bit defines what kind of F-NUM values are used within an octave so the chip knows how to split an octave into two parts. When Note Select bit is 0, F-NUM values used within an octave all have their MSB bit (bit 9) set, ranging from 0x200 to 0x3FF, so the second most significant bit, bit 8 is used to determine if currently playing note belongs to lower (0x200-0x2FF) or upper (0x300-0x3FF) half within an octave. When Note Select bit is 1, the F-NUM value MSB bit, bit 9, is used to determine if the note belongs to lower (0x000-0x1FF) or upper (0x200-0x3FF) half within an octave.

==== 20-35: Tremolo / Vibrato / Sustain / KSR / Frequency Multiplication Factor ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| Tre
| Vib
| Sus
| KSR
|colspan=4| Multiplication
|}

* bit 7: Tremolo (Amplitude vibrato) on/off.
* bit 6: Frequency vibrato on/off.
* bit 5: Sound Sustaining. When 1, operator's output level will be held at its sustain level until a KEY-OFF is done.
* bit 4: Envelope scaling (KSR) on/off. When 1, higher notes are shorter than lower notes.
* bits 0-3: Frequency Multiplication Factor (MULTI). Operator's frequency is set to (see registers A0, B0) F-Number * Factor.

{|class="wikitable"
! MULTI !! Factor
|-
| 0 || 0.5
|-
| 1 || 1
|-
| 2 || 2
|-
| 3 || 3
|-
| 4 || 4
|-
| 5 || 5
|-
| 6 || 6
|-
| 7 || 7
|-
| 8 || 8
|-
| 9 || 9
|-
| 10 || 10
|-
| 11 || 10
|-
| 12 || 12
|-
| 13 || 12
|-
| 14 || 15
|-
| 15 || 15
|}

==== 40-55: Key Scale Level / Output Level ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
|colspan=2| KSL
|colspan=6| Output level
|}

* bits 6-7: Key Scale Level. Attenuates output level towards higher pitch:

{|class="wikitable centred fixed-width"
! KSL !! Attenuation
|-
| 0 || -
|-
| 1 || 3.0 dB/oct
|-
| 2 || 1.5 dB/oct
|-
| 3 || 6.0 dB/oct
|}

The attenuation level is based on the 3-bit octave (block number) value and top four bits of the FNUM value, so each octave is subdivided into 16 parts.

* bits 0-5: Output Level. Attenuates the operator output level. 0 is the loudest, 3F is the softest. Attenuation range is 48dB with 0.75dB resolution.
{|class="wikitable centred fixed-width"
! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| 24dB || 12dB || 6dB || 3dB || 1.5dB || 0.75dB
|}

* In additive synthesis, varying the output level of any operator varies the volume of its corresponding channel. In FM synthesis, varying the output level of the carrier varies the volume of the channel. Varying the output of the modulator will change the frequency spectrum produced by the carrier. The following table summarizes which operators' output levels should be updated when trying to change channel output level.

{|class="wikitable centred fixed-width"
! Mode !! Op 1 !! Op 2 !! Op 3 !! Op 4
|-
| AM || Y || Y || N/A || N/A
|-
| FM || - || Y || N/A || N/A
|-
| FM-FM || - || - || - || Y
|-
| AM-FM || Y || - || - || Y
|-
| FM-AM || - || Y || - || Y
|-
| AM-AM || Y || - || Y || Y
|}

==== 60-75: Attack Rate / Decay Rate ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
|colspan=4| Attack rate
|colspan=4| Decay rate
|}

* bits 4-7: Attack Rate. Determines the rising time for the sound. The higher the value, the faster the attack. If value is 0, the sound will never attack, and if value is 15, the volume jumps directly from minimum to maximum.
* bits 0-3: Decay Rate. Determines the diminishing time for the sound. The higher the value, the shorter the decay. If value is 0, the sound does not decay towards sustain level and stays at maximum volume after attack.

==== 80-95: Sustain Level / Release Rate ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
|colspan=4| Sustain level
|colspan=4| Release rate
|}

* bits 4-7: Sustain Level. Determines the point at which the sound ceases to decay and chages to a sound having a constant level. The sustain level is expressed as a fraction of the maximum level. 15 is the softest and 0 is the loudest sustain level. Note that the Sustain-bit in the register 20-35 must be set for this to have an effect. Otherwise the sound will continue with release phase after hitting sustain level.

{|class="wikitable centred fixed-width"
! SL3 !! SL2 !! SL1 !! SL0
|-
| -24dB || -12dB || -6dB || -3dB
|}

There is an exception when all bits are set (value=15), the actual level is -93dB instead, matching as if the value were 31.

* bits 0-3: Release Rate. Determines the rate at which the sound disappears after KEY-OFF. The higher the value, the shorter the release. Value of 0 causes the sound not to release at all, it will continue to produce sound at level before KEY-OFF.

Some songs (e.g. <tt>LAME intro tune for Xerox of INC.raw</tt>) set the sustain and release values to the shortest (0xFF) while the note is still playing in order to immediately silence a note that would otherwise linger after keyoff.

==== A0-A8: Frequency Number ====

Determines the pitch of the note. Highest bits of F-Number are stored in the register below.

==== B0-B8: Key On / Block Number / F-Number(hi bits) ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
|colspan=2| -
| Note on
|colspan=3| Block number
|colspan=2| Frequency num.
|}

The '''note on''' bit is set to 1 to play a note on the channel, and 0 to silence the note. Setting this value to 1 when a note is already playing has no effect (it does not retrigger the note.)

The '''block number''' is often referred to as the octave, but this is a misleading description. The value of the block controls the frequency range spanned by the frequency numbers. A larger block allows higher frequencies (pitch) to be reached, at the expense of there being a greater difference in pitch of two adjacent frequency numbers. This works out well, since a low block number allows a very high pitch accuracy for deep notes where it is most noticeable, while high block numbers mean the coarse pitch settings need only be used at high frequencies where the coarseness is unnoticeable.

The following table illustrates the effect of different block numbers.

{|class="wikitable"
!rowspan=2| Block !!colspan=2| Note frequency !!rowspan=2| Difference between adjacent notes (Hz)
|-
! F-num=1 !! F-num=1023
|-
|align=center| 0 ||align=right| 0.047 Hz ||align=right| 48.503 Hz ||align=right| 0.048 Hz
|-
|align=center| 1 ||align=right| 0.094 Hz ||align=right| 97.006 Hz ||align=right| 0.095 Hz
|-
|align=center| 2 ||align=right| 0.189 Hz ||align=right| 194.013 Hz ||align=right| 0.190 Hz
|-
|align=center| 3 ||align=right| 0.379 Hz ||align=right| 388.026 Hz ||align=right| 0.379 Hz
|-
|align=center| 4 ||align=right| 0.758 Hz ||align=right| 776.053 Hz ||align=right| 0.759 Hz
|-
|align=center| 5 ||align=right| 1.517 Hz ||align=right| 1,552.107 Hz ||align=right| 1.517 Hz
|-
|align=center| 6 ||align=right| 3.034 Hz ||align=right| 3,104.215 Hz ||align=right| 3.034 Hz
|-
|align=center| 7 ||align=right| 6.068 Hz ||align=right| 6,208.431 Hz ||align=right| 6.069 Hz
|}

This shows that block 7 is capable of reaching the highest note (6.2kHz) but since there are 6Hz between notes the accuracy suffers. Note A-4 is 440Hz but in this block, the two closest frequency numbers are 72 and 73, which create tones at 437Hz and 443Hz respectively, neither of which is particularly accurate. Blocks 3 and below are unable to reach as high as 440Hz, but block 4 can. With block 4, frequency numbers 579 and 580 produce 439.4Hz and 440.2Hz, considerably closer to the intended frequency.

In other words, when calculating notes, the best accuracy is achieved by selecting the lowest possible block number that can reach the desired note frequency.

The '''frequency number''' is split between registers A0 and B0, with the upper two bits being stored here. The full frequency number is a value between 0 and 1023 inclusive. The following formula is used to determine the frequency number for a given note frequency (in Hertz) and block:

: f-num = freq * 2^(20 - block) / 49716

This formula can produce frequency numbers outside of the allowed 0-1023 range if the block number is too low, or the frequency is higher than the hardware can produce.

The sampling frequency of OPL2 and OPL3 chips is approximately 49716 Hz, leading to the constant in the formula. Occasionally this is rounded to 50000 leading to a small pitch variation if the wrong constant is used to play these songs. OPL2 cards like Adlib and early Sound Blasters used the 14.31818 MHz oscillator signal from ISA bus slot and divided it by four on card, thus running the OPL2 chip at 3.579545 MHz, which gets divided internally by 72 to get the sampling rate. OPL3 cards had to be compatible, and mostly the sound cards have separate 14.31818 MHz oscillator on board which the OPL3 uses directly, and this gets divided internally by 288 to get the sampling rate.

NOTE: In four-operator mode only the register value of Operators 1 and 2 is used, value of Operators 3 and 4 in this register is ignored. In other words: one channel uses only one frequency, block and KEY-ON value at a time, regardless whether it is a two- or four-operator channel.

Setting the frequency and/or block has an immediate effect, regardless of the state of the ''note on'' bit. By changing the values gradually, pitch bends can be achieved.

{{TODO|Is a delay needed between setting the keyon bit to 0 and then back to 1 to retrigger a note?}}

==== BD: Tremolo Depth / Vibrato Depth / Percussion Mode / BD/SD/TT/CY/HH On ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| Tre
| Vib
| Per
| BD
| SD
| TT
| CY
| HH
|}

* bit 7: Tremolo (Amplitude Vibrato) Depth. 0 = 1.0dB, 1 = 4.8dB.
* bit 6: Frequency Vibrato Depth. 0 = 7 cents, 1 = 14 cents. A "cent" is 1/100 of a semi-tone.
* bit 5: Percussion Mode. 0 = Melodic Mode, 1 = Percussion Mode.
* bit 4: BD On. KEY-ON of the Bass Drum channel.
* bit 3: SD On. KEY-ON of the Snare Drum channel.
* bit 2: TT On. KEY-ON of the Tom-Tom channel.
* bit 1: CY On. KEY-ON of the Cymbal channel.
* bit 0: HH On. KEY-ON of the Hi-Hat channel.

NOTE: KEY-ON bits of channels 6, 7 and 8 must be clear and their F-Nums, Attack/Decay/Release rates, etc. must be set properly to use percussion mode.

This register only exists in the first register set (OPL2) and does not exist in the second register set (OPL3 upper registers). Rhythm mode only affects the lower register set, the upper registers are not affected by rhythm mode.

{{TODO|On an OPL3, does the value set here apply to all 18 channels or only the OPL2-compatible first 9 channels?}}

==== C0-C8: FeedBack Modulation Factor / Synthesis Type ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
| OutCh_D
| OutCh_C
| R
| L
|colspan=3| Feedback
| Syn
|}

* bit 7: CHD, Output Channel D Enable. When set, channel output goes to fourth digital audio output channel.
* bit 6: CHC, Output Channel C Enable. When set, channel output goes to third digital audio output channel.
* bit 5: Right Speaker Enable. When set, channel output goes to second digital audio output channel, connected to right speaker.
* bit 4: Left Speaker Enable. When set, channel output goes to first digital audio output channel, connected to left speaker.
** In OPL3 mode, at least one of the left/right bits must be set to hear the channel.
** In OPL2 mode, these bits are ignored and audio is sent to all channels for compatibility reasons.
** Left/Right bits can be used to realize sound "panning", but this method offers only three pan positions (left/center/right).
** These bits apply only to operators producing sound (Carriers). Modulators are not affected by their setting.
** Sound cards use only one stereo DAC, so only two of the four digital output channels are available.
* bits 1-3: FeedBack Modulation Factor. If 0, no feedback is present. If 1-7, operator 1 will send a portion of its output back into itself.

{|class="wikitable centred fixed-width"
! FeedBack !! Factor
|-
| 0 || 0
|-
| 1 || π/16
|-
| 2 || π/8
|-
| 3 || π/4
|-
| 4 || π/2
|-
| 5 || π
|-
| 6 || 2π
|-
| 7 || 4π
|}

When in four-operator mode, the FeedBack value is used only by Operator 1, value of Operators 2, 3 and 4 is ignored.

* bit 0: Synthesis Type. 1 = Additive synthesis, 0 = Frequency Modulation. In four-operator mode, there are two bits controlling the synthesis type. Both are the bit 0 of register C0, one of Operators 1 and 2 and the second of Operators 3 and 4.

{|class="wikitable centred fixed-width"
! Op 1&2 !! Op 3&4 !! Type
|-
| 0 || NONE || FM
|-
| 1 || NONE || AM
|-
| 0 || 0 || FM-FM
|-
| 1 || 0 || AM-FM
|-
| 0 || 1 || FM-AM
|-
| 1 || 1 || AM-AM
|}

==== E0-F5: Waveform Select ====

{|class="wikitable centred fixed-width"
! D7 !! D6 !! D5 !! D4 !! D3 !! D2 !! D1 !! D0
|-
|colspan=5| -
|colspan=3| Waveform
|}

* bits 0-2: WaveForm Select (WS): <gallery widths=300px heights=150px perrow=4>
Image:OPL_Wave0_Digital.svg|Waveform 0: Sine
Image:OPL_Wave1_Digital.svg|Waveform 1: Half-sine
Image:OPL_Wave2_Digital.svg|Waveform 2: Abs-sine
Image:OPL_Wave3_Digital.svg|Waveform 3: Pulse-sine
Image:OPL_Wave4_Digital.svg|Waveform 4: Sine - even periods only
Image:OPL_Wave5_Digital.svg|Waveform 5: Abs-sine - even periods only
Image:OPL_Wave6_Digital.svg|Waveform 6: Square
Image:OPL_Wave7_Digital.svg|Waveform 7: Derived square
</gallery>

* NOTE: Bit 5 of register 01 must be set to use waveforms other than sine. Waveforms 4-7 are available only on OPL3.

== Examples ==

These examples show a few working routines used in my MUS Player. They are written in Borland C++ 3.1 but should be easy to translate to any other language.

<source lang="C">
// I prefer using these Assembler-like types
typedef unsigned int WORD;
typedef unsigned char BYTE;

/*
* FM Synthesizer base port. SB Pro II - 0x220, Adlib 0x388
*/
WORD FMport = 0x220;

/*
* Enables OPL3 extensions.
*/
WORD OPL3 = 1;

/*
* Direct write to any Adlib/SB Pro II FM synthetiser register.
* reg - register number (range 0x001-0x0F5 and 0x101-0x1F5). When high byte
* of reg is zero, data go to port FMport, otherwise to FMport+2
* data - register value to be written
*/
BYTE FMwriteReg(WORD reg, BYTE data)
{
asm {
mov dx,FMport
mov ax,reg
or ah,ah // high byte is nonzero -- write to port base+2
jz out1
inc dx
inc dx
}
out1: asm {
out dx,al
mov cx,6
}
loop1:asm { // delay between writes
in al,dx
loop loop1

inc dx
mov al,data
out dx,al
dec dx
mov cx,36
}
loop2:asm { // delay after data write
in al,dx
loop loop2
}
return _AL;
}

/*
* Write to an operator pair. To be used for register bases of 0x20, 0x40,
* 0x60, 0x80 and 0xE0.
*/
void FMwriteChannel(BYTE regbase, BYTE channel, BYTE data1, BYTE data2)
{
static BYTE adlib_op[] = {0, 1, 2, 8, 9, 10, 16, 17, 18};
static BYTE sbpro_op[] = { 0, 1, 2, 6, 7, 8, 12, 13, 14,
18, 19, 20, 24, 25, 26, 30, 31, 32};
static WORD rg[] = {0x000,0x001,0x002,0x003,0x004,0x005,
0x008,0x009,0x00A,0x00B,0x00C,0x00D,
0x010,0x011,0x012,0x013,0x014,0x015,
0x100,0x101,0x102,0x103,0x104,0x105,
0x108,0x109,0x10A,0x10B,0x10C,0x10D,
0x110,0x111,0x112,0x113,0x114,0x115};

if (OPL3)
{
register WORD reg = sbpro_op[channel];
FMwriteReg(rg[reg]+regbase, data1);
FMwriteReg(rg[reg+3]+regbase, data2);
} else {
register WORD reg = regbase+adlib_op[channel];
FMwriteReg(reg, data1);
FMwriteReg(reg+3, data2);
}
}

/*
* Write to channel a single value. To be used for register bases of
* 0xA0, 0xB0 and 0xC0.
*/
void FMwriteValue(BYTE regbase, BYTE channel, BYTE value)
{
static WORD ch[] = {0x000,0x001,0x002,0x003,0x004,0x005,0x006,0x007,0x008,
0x100,0x101,0x102,0x103,0x104,0x105,0x106,0x107,0x108};
register WORD chan;

if (OPL3)
chan = ch[channel];
else
chan = channel;
FMwriteReg(regbase + chan, value);
}
</source>

== Detection Methods ==

An official method of Adlib (OPL2) detection is:

# Reset Timer 1 and Timer 2: write 60h to register 4.
# Reset the IRQ: write 80h to register 4.
#* NOTE: Steps 1 and 2 can't be combined together.
# Read status register: read port base+0 (388h). Save the result.
# Set Timer 1 to FFh: write FFh to register 2.
# Unmask and start Timer 1: write 21h to register 4.
# Wait in a delay loop for at least 80 µsec.
# Read status register: read port base+0 (388h). Save the result.
# Reset Timer 1, Timer 2 and IRQ as in steps 1 and 2.
# Test the results of the two reads: the first should be 0, the second should be C0h. If either is incorrect, then the OPL2 is not present.

* NOTE1: You should AND the result bytes with E0h because the unused bits are undefined.
* NOTE2: This testing method doesn't work in some SoundBlaster compatible cards.

=== OPL3 Detection ===
--------------

The datasheet for the YMF289B (OPL3-L) describes the following method:

# Detect OPL2. All OPL3 devices should succeed OPL2 checks.
# Read status register: read port base+0.
# AND the result with 06h.
# If the result is zero, you have OPL3, otherwise OPL2.

The OPL3-L can further be discerned from OPL3 by attempting to read registers on the OPL3-L. This is not possible on the OPL3.

Another possible detection method for distinguishing between SB Pro I and SB Pro II would be to try to detect OPL2 at I/O port base+0 and then at port base+2. The first test should succeed and the second should fail if OPL3 is present. (Remember: SB Pro I contains twin OPL2 chips at addresses base+0 and base+2, while SB Pro II contains one OPL3 chip at I/O address base+0 thru base+3).

== BLASTER Environment Variable ==

Perhaps the most recommended "detection" method. Reading this variable avoids blindfold I/O port scanning and possible device conflicts. The user is responsible for its proper setting.

The variable has this format:

BLASTER=Aaddr Iirq Ddma Ttype

* A: Base I/O address given in hex. For most Sound Blasters the default is 220.
* I: IRQ Number (decimal). Default 7.
* D: DMA Number (decimal). Default 1.
* T: Card Type (decimal):
** 1 - Sound Blaster 1.5
** 2 - Sound Blaster Pro I
** 3 - Sound Blaster 2.0
** 4 - Sound Blaster Pro II

Example:

BLASTER=A220 I7 D1 T4

== References ==

''The PC Games Programmers Encyclopedia'', Mark Feldman and many others on Usenet and Internet, http://bespin.org/~qz/pc-gpe/
: ... you can find (almost) everything you need there

''Sound Blaster - The Official Book'', Richard Heimlich, David M. Golden, Ivan Luk, Peter M. Ridge, Osborne/McGraw Hill, ISBN 0-07-881907-5
: ... this is a number-one in my book-wishlist. If anyone wanted to get rid of the book, I wouldn't scorn it ... :-)

''The SoundBlaster Developer Kit'', Creative Labs Inc, Creative Technology PTE LTD
: ... I wonder if you can find something comprehensible in that.

User:SaxxonPike

2024-04-19T22:06:27Z

SaxxonPike: Not using Twitter these days.

I'm SaxxonPike. I like to decipher game formats and write programs that modify game files. My ongoing interest in deciphering Bemani game formats has led me to discover a lot of tricks as well as techniques to more quickly discover formats and encryption schemes.

My recent interests that pertain to this Wiki are [[ZZT]], [[Jill of the Jungle]], [[Kiloblaster]], and [[Xargon]].

== Did I miss something? ==

Contact me.

E-mail: [mailto:saxxonpike@gmail.com saxxonpike@gmail.com]

Social links: [https://saxxon.carrd.co saxxon.carrd.co]

Crunched Screen Image

2019-03-06T17:54:09Z

SaxxonPike: Describe where the format came from.

Crunched Screen Image is an exported format from an ASCII graphics editing program called [[TheDraw]].

This format is also used to store compressed text screens in various titles by Epic Megagames, including [[Super ZZT]], [[Jill of the Jungle]], [[Kiloblaster]] and [[Xargon]] where the hardware configuration screens (and sometimes ending screens) are stored in this format. Some menu programs also use this format to store text-based menu, ordering info and ending screens.

The [[Xargon]] source code refers to this data format as "TheDraw C Crunched Screen Image" in <tt>CFG_WIN.H</tt>. [[Kiloblaster]]'s source code uses the same name in <tt>BEGIN.H</tt>.

== Format ==

There is no header information for this format. It is read as a stream of bytes until the Y-position goes off the bottom (row 25). The <tt>uncrunch</tt> algorithm found in the [[Xargon]] and [[Kiloblaster]] source code takes the length of the compressed block as a parameter and stops decompressing once all bytes have been processed.

The <tt>uncrunch</tt> decompression starts with the text attributes set to 0 (black text on black background, not blinking). The text usually appears at the top left corner of the text screen.

{|class="wikitable"
!Value!!Description
|-
|00-0F||Set the foreground color of following output to this value.
|-
|10-17||Set the background color of following output to the lower 4 bits of this value.
|-
|18||Go to the beginning of the following text line.
|-
|19||Read one more byte ''n'', and output a space character ''n''+1 times.
|-
|1A||Read two more bytes ''n'' and ''char'', and output ''char'' for ''n''+1 times.
|-
|1B||Toggle blinking text on/off
|-
|1C-1F||Undefined (<tt>uncrunch</tt> just skips these)
|-
|20-FF||Output this character exactly.
|}

== Location ==

These graphics cannot be found or used outside the game executable. They are referenced directly by the code and compiled into the game engine itself.

[[Category:Super ZZT]]
[[Category:Jill of the Jungle]]
[[Category:Kiloblaster]]
[[Category:Xargon]]

Crunched Screen Image

2019-03-06T17:38:44Z

SaxxonPike: Add game categories.

A special format is used internally by [[Super ZZT]] to draw the title screen and ending screen graphics. The format assumes a 80x25 display window.

The same format is also used to store compressed text screens in various other titles by Epic Megagames, including [[Jill of the Jungle]], [[Kiloblaster]] and [[Xargon]] where the hardware configuration screens (and sometimes ending screens) are stored in this format. Some menu programs also use this format to store text-based menu, ordering info and ending screens.

The [[Xargon]] source code refers to this data format as "TheDraw C Crunched Screen Image" in <tt>CFG_WIN.H</tt>. [[Kiloblaster]]'s source code uses the same name in <tt>BEGIN.H</tt>.

== Format ==

There is no header information for this format. It is read as a stream of bytes until the Y-position goes off the bottom (row 25). The <tt>uncrunch</tt> algorithm found in the [[Xargon]] and [[Kiloblaster]] source code takes the length of the compressed block as a parameter and stops decompressing once all bytes have been processed.

The <tt>uncrunch</tt> decompression starts with the text attributes set to 0 (black text on black background, not blinking). The text usually appears at the top left corner of the text screen.

{|class="wikitable"
!Value!!Description
|-
|00-0F||Set the foreground color of following output to this value.
|-
|10-17||Set the background color of following output to the lower 4 bits of this value.
|-
|18||Go to the beginning of the following text line.
|-
|19||Read one more byte ''n'', and output a space character ''n''+1 times.
|-
|1A||Read two more bytes ''n'' and ''char'', and output ''char'' for ''n''+1 times.
|-
|1B||Toggle blinking text on/off
|-
|1C-1F||Undefined (<tt>uncrunch</tt> just skips these)
|-
|20-FF||Output this character exactly.
|}

== Location ==

These graphics cannot be found or used outside the game executable. They are referenced directly by the code and compiled into the game engine itself.

[[Category:Super ZZT]]
[[Category:Jill of the Jungle]]
[[Category:Kiloblaster]]
[[Category:Xargon]]

ZZT Format

2019-03-06T17:37:00Z

SaxxonPike: Add ZZT and Super ZZT categories.

{{Playerdata Infobox
| Savegame = Yes
| Where = ?
| Elements = Ammo, gems, keys, scores, many others
| Games =
{{Game|ZZT}}
{{Game|Super ZZT}}
}}

A world file (.ZZT, .SZT) contains information about a game world, status of the player, and all its boards. Saved games (.SAV) are the same format as world files with a different extension and a different setting for the Lock byte.

While there are built-in editors for these games, they do not provide full editing functionality.

== Limits ==

ZZT and Super ZZT have limits imposed either by the game itself or by the data types used to store information about the world's contents.

{|class="wikitable"
!Limitation!!ZZT!!Super ZZT
|-
|Board count (including title screen)||101||33
|-
|Board size (in bytes)||32767||32767
|-
|Board size (in tiles)||60x25||96x80
|-
|Status Elements per board (including Player)||151||129
|-
|Flag strings||10||16
|}

Realistically, the original ZZT can only support boards up to around 20k due to the code itself. ZZT 4.0 by WiL, a hack of the original game executable, can support the full 32k.

== World Format ==

There are two formats for a world file. One is for ZZT and the other is for SuperZZT. The formats are very similar. All 8-bit (byte) values are unsigned. All 16-bit (short) values are signed. Boolean values (such as a player's keys) are represented with 0 for false and 1 for true; any other values may cause inconsistent behavior.

World Name is used by the game to determine which file to load after the player quits and restarts the game. Therefore if a world contains a world name that is actually the filename of another world, after the player quits and restarts the game, the world with the matching filename will be loaded!

There are some unused bytes after the world information that are ignored by the game. While it is safe to put any data whatsoever into this unused space, it is not saved back to disk by the game engine and will be converted to empty padding. [[ZZTAE]] is an editor that uses this space to store extra information such as the author and genre.

=== Common world information ===

The storage of this information is the same between the two formats. After this part of the file, the format will differ slightly.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF FF) and SuperZZT uses -2 (FE FF).
|-
|2||0x002||[[INT16LE]]||NumBoards Number of boards in the world, not including the title screen. Increment by 1 for the real number of stored boards. A value of 0 means only the title screen exists.
|-
|4||0x004||[[INT16LE]]||PlayerAmmo Player's ammunition.
|-
|6||0x006||[[INT16LE]]||PlayerGems Player's gems.
|-
|8||0x008||[[char]][7]||PlayerKeys Player's keys. A nonzero value means the player has the specified key. The keys are in this order: Blue, Green, Cyan, Red, Purple, Yellow, White.
|-
|15||0x00F||[[INT16LE]]||PlayerHealth Player's health.
|-
|17||0x011||[[INT16LE]]||PlayerBoard In a world file, this will be the starting board for the player (the title screen, board 0, is always shown first). In a saved game, this will be the board that the player is currently on.
|-
|}

=== ZZT world header ===

This is the second half of the header specific to a .ZZT file. After this information, storage of the boards starts at byte offset 512 (hex 0x200).

Unused values are preserved. Data not listed here is overwritten with zeroes when saving worlds.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||PlayerTorches Player's torches.
|-
|21||0x015||[[INT16LE]]||TorchCycles Game cycles left for a torch to remain lit.
|-
|23||0x017||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|25||0x019||[[INT16LE]]||(unused)
|-
|27||0x01B||[[INT16LE]]||PlayerScore Player's score.
|-
|29||0x01D||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|30||0x01E||[[char]][20]||WorldName Internal name of the world.
|-
|50||0x032||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|51||0x033||[[char]][20]||Flag0 Name of Flag 0.
|-
|71||0x047||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|72||0x048||[[char]][20]||Flag1 Name of Flag 1.
|-
|92||0x05C||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|93||0x05D||[[char]][20]||Flag2 Name of Flag 2.
|-
|113||0x071||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|114||0x072||[[char]][20]||Flag3 Name of Flag 3.
|-
|134||0x086||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|135||0x087||[[char]][20]||Flag4 Name of Flag 4.
|-
|155||0x09B||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|156||0x09C||[[char]][20]||Flag5 Name of Flag 5.
|-
|176||0x0B0||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|177||0x0B1||[[char]][20]||Flag6 Name of Flag 6.
|-
|197||0x0C5||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|198||0x0C6||[[char]][20]||Flag7 Name of Flag 7.
|-
|218||0x0DA||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|219||0x0DB||[[char]][20]||Flag8 Name of Flag 8.
|-
|239||0x0EF||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|240||0x0F0||[[char]][20]||Flag9 Name of Flag 9.
|-
|260||0x104||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|262||0x106||[[INT16LE]]||TimePassedTicks This contains information about sub-seconds on time limited boards.
|-
|264||0x108||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|265||0x109||[[UINT8]][14]||(unused)
|}

=== Super ZZT world header ===

This is the second half of the header specific to a .SZT file. After this information, storage of the boards starts at byte offset 1024 (hex 0x400).

Unused values are preserved. Data not listed here is overwritten with zeroes when saving worlds.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||(unused)
|-
|21||0x015||[[INT16LE]]||PlayerScore Player's score.
|-
|23||0x017||[[INT16LE]]||(unused)
|-
|25||0x019||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|27||0x01B||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|28||0x01C||[[char]][20]||WorldName Internal name of the world.
|-
|48||0x030||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|49||0x031||[[char]][20]||Flag0 Name of Flag 0.
|-
|69||0x045||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|70||0x046||[[char]][20]||Flag1 Name of Flag 1.
|-
|90||0x05A||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|91||0x05B||[[char]][20]||Flag2 Name of Flag 2.
|-
|111||0x06F||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|112||0x070||[[char]][20]||Flag3 Name of Flag 3.
|-
|132||0x084||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|133||0x085||[[char]][20]||Flag4 Name of Flag 4.
|-
|153||0x099||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|154||0x09A||[[char]][20]||Flag5 Name of Flag 5.
|-
|174||0x0AE||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|175||0x0AF||[[char]][20]||Flag6 Name of Flag 6.
|-
|195||0x0C3||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|196||0x0C4||[[char]][20]||Flag7 Name of Flag 7.
|-
|216||0x0D8||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|217||0x0D9||[[char]][20]||Flag8 Name of Flag 8.
|-
|237||0x0ED||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|238||0x0EE||[[char]][20]||Flag9 Name of Flag 9.
|-
|258||0x102||[[UINT8]]||Flag10Length Length of the name of Flag 10.
|-
|259||0x103||[[char]][20]||Flag10 Name of Flag 10.
|-
|279||0x117||[[UINT8]]||Flag11Length Length of the name of Flag 11.
|-
|280||0x118||[[char]][20]||Flag11 Name of Flag 11.
|-
|300||0x12C||[[UINT8]]||Flag12Length Length of the name of Flag 12.
|-
|301||0x12D||[[char]][20]||Flag12 Name of Flag 12.
|-
|321||0x141||[[UINT8]]||Flag13Length Length of the name of Flag 13.
|-
|322||0x142||[[char]][20]||Flag13 Name of Flag 13.
|-
|342||0x156||[[UINT8]]||Flag14Length Length of the name of Flag 14.
|-
|343||0x157||[[char]][20]||Flag14 Name of Flag 14.
|-
|363||0x16B||[[UINT8]]||Flag15Length Length of the name of Flag 15.
|-
|364||0x16C||[[char]][20]||Flag15 Name of Flag 15.
|-
|384||0x180||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|386||0x182||[[INT16LE]]||TimePassedTicks This contains information about sub-seconds on time limited boards.
|-
|388||0x184||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|389||0x185||[[INT16LE]]||PlayerStones Player's stones of power. If this value is negative, no information is shown in-game about them. If this value is >= 0, it uses a flag to describe this value in the status bar of the game. The flag used is the first one found that is preceded with a Z. "The Lost Forest" contains a flag called "ZSTONES" which shows as "STONES" on the status bar, for example.
|-
|391||0x187||[[UINT8]][11]||(unused)
|}

== Board Format ==

Boards can be stored individually in .BRD files. Since ZZT and Super ZZT use the same extension for boards and there is no world information stored with them, it isn't immediately apparent whether the board is a ZZT or a Super ZZT board. Testing the validity of the board information with both world types should be a good way to determine the type of world a board belongs to.

=== Format layout ===

Boards consist of 4 parts: Board Header, RLE Tiles, Board Properties, and Status Element Properties. Status Elements are elements on the board that the game actively processes - these include the player, enemies, any animating blocks, and Scrolls and Objects which can contain ZZT-OOP code.

=== ZZT board header ===

ZZT boards are 60x25 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes (excluding the two bytes from this value). Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][50]||BoardName Board's name.
|-
|53||0x035||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Super ZZT board header ===

Super ZZT boards are 96x80 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][60]||BoardName Board's name.
|-
|63||0x03F||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Run-length encoded tile data ===

Tile data is represented as sets of 3 bytes. These sets are repeated until the board is completely filled. For ZZT, this will be 60*25=1500 tiles. For SuperZZT, this will be 96*80=7680 tiles. The tiles are unpacked from left to right, top to bottom.

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Count Number of tiles.
|-
|[[UINT8]]||Element Element of the tiles.
|-
|[[UINT8]]||Color Color of the tiles.
|-
|}

A small quirk of this RLE format is when the number of tiles is set to zero. Due to the way the decoder is set up, a Count of 0 means there are actually 256 tiles encoded. The built-in editor does not encode tiles using this value despite being decoded correctly in the game, and it will probably crash some older external editors.

=== ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||IsDark When set to 1, the board is covered in darkness which can only be revealed by using a torch.
|-
|2||0x002||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|3||0x003||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|4||0x004||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|5||0x005||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|6||0x006||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|7||0x007||[[UINT8]]||MessageLength Length of the on-screen message.
|-
|8||0x008||[[char]][58]||Message On-screen message. This is used internally and is not loaded by the game.
|-
|66||0x042||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|67||0x043||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|68||0x044||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|70||0x046||[[UINT8]][16]||(unused)
|-
|86||0x056||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|-
|}

=== Super ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|2||0x002||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|3||0x003||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|4||0x004||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|5||0x005||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|6||0x006||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|7||0x007||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|8||0x008||[[INT16LE]]||CameraX X-coordinate of the viewport. This value is not used when loading worlds.
|-
|10||0x00A||[[INT16LE]]||CameraY Y-coordinate of the viewport. This value is not used when loading worlds.
|-
|12||0x00C||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|14||0x00E||[[UINT8]][14]||(unused)
|-
|28||0x01C||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|}

=== Status Elements ===

This follows directly after board properties. It is repeated for each Status Element. The first element stored is always the player-controlled element. This element may contain strange values for Step, Leader and Follower information - this is because these values are used internally by the game.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||LocationX X-coordinate. Location coordinates are 1-based, unlike any other coordinates in the file.
|-
|1||0x001||[[UINT8]]||LocationY Y-coordinate.
|-
|2||0x002||[[INT16LE]]||StepX X-step value. This pair of values represents a vector that typically points in one of the four cardinal directions. Its use differs for each type of element.
|-
|4||0x004||[[INT16LE]]||StepY Y-step value.
|-
|6||0x006||[[INT16LE]]||Cycle Cycle. This represents the frequency, in ticks, at which the game will process this status element.
|-
|8||0x008||[[UINT8]]||P1 Parameter 1. Its use will differ depending on the type of element.
|-
|9||0x009||[[UINT8]]||P2 Parameter 2. Its use will differ depending on the type of element.
|-
|10||0x00A||[[UINT8]]||P3 Parameter 3. Its use will differ depending on the type of element.
|-
|11||0x00B||[[INT16LE]]||Follower Follower status element. Its value determines if another status element is linked behind this one. Typically used for linking centipedes.
|-
|13||0x00D||[[INT16LE]]||Leader Leader status element. Its value determines if another status element is linked in front of this one. Typically used for linking centipedes.
|-
|15||0x00F||[[UINT8]]||UnderID Element of the tile under this status element.
|-
|16||0x010||[[UINT8]]||UnderColor Color of the tile under this status element.
|-
|17||0x011||[[INT32LE]]||Pointer Stores the location in memory of the code that this status element is using. Status elements typically point to their own code until they #BIND the code of another - in which case this memory location value is replaced with the new one. ZZT does not use this value when loading worlds, and always sets it to 0 when saving worlds.
|-
|21||0x015||[[INT16LE]]||CurrentInstruction The offset in bytes of the code block to execute ZZT-OOP from. Only Objects and Scrolls can execute ZZT-OOP.
|-
|23||0x017||[[INT16LE]]||Length There are two uses for this value: If this value is positive, it represents the number of bytes that are in the code block. If this value is negative, the absolute value of this value represents the Status Element number to copy code from. This saves space by removing redundant code duplication. Since code is shared in this way, all modifications to code will affect any other Status Elements using it.
|-
|}

In ZZT (not Super ZZT), 8 bytes of padding will follow.

If "Length" is positive, the code will be stored here.

== Element Lists ==

This is a list of all valid built-in elements that can be used. Using any elements outside this range produce undefined behavior which is dependent on whatever was residing in memory at the time the game was loaded. Most often, it will crash.

=== Element properties ===

These are all possible internal properties for each element. '''Note:''' The addresses shown are not really significant- you should only consider which ones share the same code to cut down on how many element behaviors to consider.

{|class="wikitable"
!Property!!Description
|-
|Id||Id number of the element
|-
|Hex||Hexidecimal representation of the Id number
|-
|Name||Known name of the element, which may not be present internally
|-
|Character||ASCII character for the default draw code, which may be ignored if special draw code is enabled
|-
|Color||Default color. If the color is 0xFE, then new tiles will be created with the primary color as the background and a white foreground. If the color is >= 0xF0, any primary color is allowed, but in the editor you can't choose the color unless the default color is 0xFF
|-
|Destructible||Element can be destroyed by bullets and by being crushed by puzzle pieces
|-
|Pushable||Element can be pushed. The NS/EW sliders are a special case in the code, so they will not be marked with this flag
|-
|Editor Floor||When using the editor, actors such as enemies can be placed on top of elements marked with this flag. Has no effect during gameplay.
|-
|Floor||Elements with this flag can freely be moved upon by actors
|-
|Shown||ZZT only. Elements marked with this flag will always be shown, even on dark boards
|-
|Special Draw||If this flag is set, the default draw code is bypassed with different draw code
|-
|Draw Code||Offset of the routine that performs the drawing, if Special Draw is set
|-
|Cycle||Default cycle. If this is -1, the element is not generated as an actor. Creatures will have cycles above zero
|-
|Act Code||Offset of the routine that performs standard behavior. For example: creature movement, bomb countdown
|-
|Interact Code||Offset of the routine that handles when a player touches the element. For example: item pickups, entering a passage
|-
|Menu#||Number of the editor menu where this element can be found
|-
|Key||Key press which is mapped to this element in the editor
|-
|Internal Name||Name of the element used in the editor. It is also used by OOP- the parser will remove all symbols and spaces and compare that
|-
|Category||When it comes time to display this element in the editor, if present, the category will be drawn in yellow first.
|-
|Edit P1||Text to show when editing the P1 of an actor that uses this element
|-
|Edit P2||Text to show when editing the P2 of an actor that uses this element
|-
|Edit P3||Text to show when editing the P3 of an actor that uses this element
|-
|Edit Board||Text to show when selecting the target board
|-
|Edit Step||Text to show when selecting the target direction
|-
|Edit Code||Text to show when editing an actor's code (scroll or object OOP)
|-
|Points||When an actor using this element is killed by the player, it's worth this much score
|-
|}

=== ZZT elements ===

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Shown!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3973||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x20||0x07||||||||||||||0x0020||1||0x4481||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||Yes||||0x0020||1||0x3E2F||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||||0x0020||-1||0x0000||0x3289||1||A||Ammo||||||||||||||||0
|-
|6||0x06||Torch||0x9D||0x06||||||||||Yes||||0x0020||-1||0x0000||0x37B6||1||T||Torch||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||||0x0020||-1||0x0000||0x3306||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x3169||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||||0x0020||-1||0x0000||0x33DA||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||||0x0020||1||0x2F9F||0x308B||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||Yes||||0x0020||0||0x0000||0x3372||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||||Yes||0x2A15||2||0x2BFF||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||||Yes||0x1872||6||0x18DA||0x19F3||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||||0x0020||-1||0x0000||0x2034||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||Star||0x53||0x0F||||||||||||Yes||0x1D5D||1||0x1DE9||0x00F5||0||||Star||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||||Yes||0x171C||3||0x176C||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||||Yes||0x17C7||2||0x1817||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||Bullet||0xF8||0x0F||Yes||||||||||||0x0020||1||0x0F65||0x00F5||0||||Bullet||||||||||||||||0
|-
|19||0x13||Water||0xB0||0xF9||||||Yes||||||||0x0020||-1||0x0000||0x3B03||3||W||Water||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||||0x0020||-1||0x0000||0x38D0||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x34E3||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||||0x0020||-1||0x0000||0x3949||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0xB0||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3848||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||||Yes||0x242E||1||0x2445||0x0010||3||L||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||||Yes||0x1CC5||2||0x1C85||0x1C41||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||||Yes||0x122A||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0x99||0x06||Yes||Yes||||||||||0x0020||3||0x054F||0x00F5||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||||0x0020||1||0x0351||0x00F5||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||||Yes||0x2B85||3||0x2AA5||0x2BB7||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||||0x0020||3||0x20AE||0x2295||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||Shark||0x5E||0x07||||||||||||||0x0020||3||0x2321||0x0010||2||Y||Shark||||Intelligence?||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||||Yes||0x11D0||2||0x12A7||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||||Yes||0x3517||4||0x358A||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||||0x0020||2||0x0113||0x00F5||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||||0x0020||2||0x022D||0x00F5||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||||0x0020||2||0x06BF||0x00F5||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||||0x0020||2||0x0EED||0x00F5||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Text (Blue)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|48||0x30||Text (Green)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|49||0x31||Text (Cyan)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|50||0x32||Text (Red)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|51||0x33||Text (Purple)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|52||0x34||Text (Brown)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||Text (Black)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

=== Super ZZT elements ===

Internal properties for each of these elements can be found in the [http://pastebin.com/mdEwu6Y1 Super ZZT Elements Pastebin].

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3FA5||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x02||0x1F||||Yes||||||||0x0020||1||0x4B76||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||||0x0020||1||0x4596||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||0x0020||-1||0x0000||0x37E7||1||A||Ammo||||||||||||||||0
|-
|6||0x06||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||0x0020||-1||0x0000||0x397D||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x36F2||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||0x0020||-1||0x0000||0x3A63||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||0x0020||1||0x3517||0x3603||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||||0x0020||0||0x0000||0x39ED||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||Yes||0x2E32||2||0x3177||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||Yes||0x1DBD||6||0x1E25||0x1F3F||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||0x0020||-1||0x0000||0x2581||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||Yes||0x1C67||3||0x1CB7||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||Yes||0x1D12||2||0x1D62||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|19||0x13||Lava||0x6F||0x4E||||||Yes||||||0x0020||-1||0x0000||0x4155||3||L||Lava||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||0x0020||-1||0x0000||0x3EAF||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x3B5A||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x3F6C||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3E23||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||Yes||0x285B||1||0x2872||0x0010||3||X||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||Yes||0x2216||2||0x21D6||0x2192||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||Yes||0x17C3||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0xEB||0x02||Yes||Yes||||||||0x0020||3||0x09C1||0x014C||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||0x0020||1||0x07C3||0x014C||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||Yes||0x30FD||3||0x2EC2||0x312F||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||0x0020||3||0x25E8||0x27CF||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||Yes||0x1663||2||0x1811||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||Yes||0x3B8E||4||0x3C01||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||0x0020||2||0x016A||0x014C||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||0x0020||2||0x0284||0x014C||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||0x0020||2||0x0B31||0x014C||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||0x0020||2||0x1375||0x014C||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Floor||0xB0||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||F||Floor||Terrains:||||||||||||||0
|-
|48||0x30||Water N||0x1E||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||8||Water N||||||||||||||||0
|-
|49||0x31||Water S||0x1F||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||2||Water S||||||||||||||||0
|-
|50||0x32||Water W||0x11||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||4||Water W||||||||||||||||0
|-
|51||0x33||Water E||0x10||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||6||Water E||||||||||||||||0
|-
|52||0x34||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|54||0x36||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|55||0x37||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|56||0x38||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|57||0x39||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|58||0x3A||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|59||0x3B||Roton||0x94||0x0D||Yes||Yes||||||||0x0020||1||0x03A8||0x014C||4||R||Roton||Uglies:||Intelligence?||Switch Rate?||||||||||2
|-
|60||0x3C||Dragon Pup||0xED||0x04||Yes||Yes||||||Yes||0x05A3||2||0x0563||0x014C||4||D||Dragon Pup||||Intelligence?||Switch Rate?||||||||||1
|-
|61||0x3D||Pairer||0xE5||0x01||Yes||Yes||||||||0x0020||2||0x05E6||0x014C||4||P||Pairer||||Intelligence?||||||||||||2
|-
|62||0x3E||Spider||0x0F||Any (0xFF)||Yes||||||||||0x0020||1||0x06EB||0x014C||4||S||Spider||||Intelligence?||||||||||||3
|-
|63||0x3F||Web||0xC5||Any (0xFF)||||||Yes||Yes||Yes||0x17EA||-1||0x0000||0x0010||5||W||Web||||||||||||||||0
|-
|64||0x40||Stone||0x5A||0x0F||||||||||Yes||0x38A1||1||0x38C3||0x385E||5||Z||Stone||||||||||||||||0
|-
|65||0x41||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|66||0x42||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|67||0x43||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|68||0x44||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|69||0x45||Bullet||0xF8||0x0F||Yes||||||||||0x0020||1||0x13ED||0x014C||0||||Bullet||||||||||||||||0
|-
|70||0x46||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|71||0x47||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|72||0x48||Star||0x53||0x0F||||||||||Yes||0x22AE||1||0x233A||0x014C||0||||Star||||||||||||||||0
|-
|73||0x49||Text (Blue)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|74||0x4A||Text (Green)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|75||0x4B||Text (Cyan)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|76||0x4C||Text (Red)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|77||0x4D||Text (Purple)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|78||0x4E||Text (Brown)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|79||0x4F||Text (Black)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

== Credits ==

This file format was reverse engineered by [[User:SaxxonPike|SaxxonPike]], Kev Vance, WiL and David Hammond. If you find this information helpful in a project you're working on, please give credit where credit is due. (A link back to this wiki would be nice too!)

[[Category:ZZT]]
[[Category:Super ZZT]]

Super ZZT

2019-03-06T17:35:46Z

SaxxonPike: Add Super ZZT category.

{{Stub}}

{{Game Infobox
| Levels = Edit
| Tiles = No
| Sprites = No
| Fullscreen = No
| Sound = No
| Music = No
| Text = No
| Story = No
| Interface = No
}}

== Game info ==

Super ZZT is an object-oriented game scripting engine created by Tim Sweeney. It is based on the same code as [[ZZT]], with a number of notable improvements and changes. There were 3 worlds released with the commercial version of the game: PROVING, FOREST, and MONSTER. The shareware version of Super ZZT came with just MONSTER.

== Debug mode ==

In all versions, the cheat menu can be opened by pressing ? and typing in a code during gameplay. Using the +debug cheat enables the display of how much memory is available on the heap, in bytes. In the upper-left corner, it will show the letter 'm' followed by this value. OOP code on the currently shown board and the game's entire compressed board data consume heap memory.

== Editor ==

While Super ZZT features a world editor, it was considered too buggy for release and was hidden from users. However, the ZZT community was eventually able to locate the command line switch to enable the use of the built-in editor. It can be enabled from the command line using "SUPERZ /E" to start the game, and then opened by pressing "E" at the title screen.

== Versions ==

The latest version of the game is v2.0. The only other known version is v1.1. There are no observable differences between the two versions of the game aside from the opening and closing screens.

{| class="wikitable"
|-
! Version
! File Size (decompressed)
|-
| 1.1
| 53,924 (108,288)
|-
| 2.0
| 54,076 (109,072)
|}

== File formats ==

* [[ZZT Format#Board Format|BRD Format]] - Board format. This is stored exactly the same as in a world, but it's just one board.
* [[HI Format (ZZT)|HGS Format]] - High scores.
* [[SZT Format]] - World format.
* [[Crunched Screen Image]] - Format of the ANSI art on the title screen and the exit screen.

[[Category:Epic Megagames]]
[[Category:ZZT]]
[[Category:Super ZZT]]
[[Category:Game Intro Page]]

Binary Text Format (ZZT)

2019-03-06T17:32:28Z

SaxxonPike: Add initial docs for this format.

This format is used to store text in later versions of [[ZZT]].

== Outside of ZZT.DAT ==

In version 2.0, there is no ZZT.DAT to contain text files. Therefore, all its help and end messages
are stored in plain text. Line endings are 0D 0A.

End messages may also have 0x1A at the end of the file to indicate that it is, in fact, EOF.

== Embedded in ZZT.DAT ==

When ZZT loads text from ZZT.DAT, help and end messages are similar to standard text files with a couple extra rules:

* Carriage return and line feed characters (0D, 0A) are omitted.
* A line consisting of a single '@' character indicates the end of the file.
** This line is not shown to the user.

Each line of text is stored as a byte indicating the length of the line, followed by the line characters.

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Length of the line of text
|-
|[[char]][length]||Line of text
|}

[[Category:ZZT]]

ZZT

2019-03-06T16:40:36Z

SaxxonPike:

{{Game Infobox
| Levels = Edit
| Tiles = No
| Sprites = No
| Fullscreen = No
| Sound = No
| Music = No
| Text = No
| Story = No
| Interface = No
}}

== Game info ==

ZZT is a game creation system created by Tim Sweeney in 1991, the first game developed and published by Potomac Computer Systems (later Epic Megagames, now Epic Games.) There were 4 worlds released with the commercial version of the game: TOWN, CAVES, CITY, and DUNGEONS. The shareware version of ZZT came with just TOWN. In all versions of the game, the built-in world editor is fully functional (however, it will not edit saved games or locked worlds natively.)

Later, [[Super ZZT]] was released based on this engine.

== Debug mode ==

In all versions, the cheat menu can be opened by pressing ? and typing in a code. In versions prior to v3.2, standard cheats will not work until the +debug cheat is used. This also enables the display of how much memory is available on the heap, in bytes. In the upper-right corner, it will show the letter 'm' followed by this value. OOP code on the currently shown board and the game's entire compressed board data consume heap memory.

== Versions ==

The latest version of the game is v3.2. Other versions of the game that can be found are v3.1, v3.0, and v2.0. Aside from improvements in input handling and visual appearance, cheat availability and copyright messages, there are no observable differences between these versions.

{| class="wikitable"
|-
! Version
! File Size (decompressed)
|-
| 2.0
| 89,792 (89,792)
|-
| 3.0
| 47,473 (95,440)
|-
| 3.1
| 47,471 (95,616)
|-
| 3.2
| 47,764 (96,080)
|}

== File formats ==

* [[ZZT Format#Board Format|BRD Format]] - Board format. This is stored exactly the same as in a world, but it's just one board.
* [[CFG Format (ZZT)|CFG Format]] - ZZT.CFG contains the startup configuration and serial number.
* [[DAT Format (ZZT)|DAT Format]] - In 3.0 and later, ZZT.DAT contains help files and end screen messages. This is not present in 2.0; the files are stored in the directory.
* [[HI Format (ZZT)|HI Format]] - High scores.
* [[Binary Text Format (ZZT)|HLP Format]] - In 2.0, these are standard text files. In 3.0 and later, they are encoded differently.
* [[Binary Text Format (ZZT)|MSG Format]] - In 2.0, these are standard text files. In 3.0 and later, they are encoded differently.
* [[ZZT Format|SAV Format]] - Saved games, 100% identical to world files except a byte in the header.
* [[ZZT Format]] - World format.

[[Category:Epic Megagames]]
[[Category:ZZT]]

DAT Format (ZZT)

2019-03-06T01:05:08Z

SaxxonPike: Start the ZZT.DAT page.

Starting with [[ZZT]] version 3.0, a special archive exists that contains all the [[MSG Format (ZZT)|MSG]] and [[HLP Format (ZZT)|HLP]] files.

=== Usage ===

ZZT will search its own directory first when looking for a particular file. If the file can't be found there, it will look inside ZZT.DAT. This allows for game modification without actually modifying any of the original files.

=== Format ===

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||Number of files in the archive
|-
|2||0x002||fileName[24]||Start of the file name list
|-
|1226||0x4CA||[[INT32LE]][24]||Start of the file offset list
|-
|}

There are 24 file names. ZZT will read through them until it encounters a zero-length string. That's how it determines that it has reached the end of the file list.

{|class="wikitable"
!Offset!!Data type!!Description
|-
| +0||[[UINT8]]||Length of the file name
|-
| +1||[[char]][50]||File name, with padding
|-
|}

=== Extracting Files ===

There is nothing to indicate the actual stored length of the files. Therefore, it's important to know how to parse the format of the file that is being requested in order to know when the file actually ends.

[[Category:ZZT]]

HI Format (ZZT)

2019-03-06T00:46:05Z

SaxxonPike: Add count of high scores.

[[ZZT]] and [[Super ZZT]] high scores are stored very similarly, with the only difference being the stored length of the player's name.

{|class="wikitable"
!Game!!Stored Length of Player's Name
|-
|ZZT||50 bytes
|-
|Super ZZT||60 bytes
|}

=== Format ===

This data structure appears a total of 30 times.

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Actual Length of Player's Name
|-
|[[char]][storedLength]||Player's Name including padding
|-
|[[INT16LE]]||Score
|}

Entries with scores less than zero are omitted from the High Score list.

[[Category:ZZT]]
[[Category:Super ZZT]]

Super ZZT

2019-03-06T00:45:16Z

SaxxonPike: Correct some links.

HI Format (ZZT)

2019-03-06T00:43:59Z

SaxxonPike: Add links.

[[ZZT]] and [[Super ZZT]] high scores are stored very similarly, with the only difference being the stored length of the player's name.

{|class="wikitable"
!Game!!Stored Length of Player's Name
|-
|ZZT||50 bytes
|-
|Super ZZT||60 bytes
|}

=== Format ===

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Actual Length of Player's Name
|-
|[[char]][storedLength]||Player's Name including padding
|-
|[[INT16LE]]||Score
|}

Entries with scores less than zero are omitted from the High Score list.

[[Category:ZZT]]
[[Category:Super ZZT]]

HI Format (ZZT)

2019-03-06T00:43:10Z

SaxxonPike: Get high score formats for ZZT and Super ZZT started.

ZZT and Super ZZT high scores are stored very similarly, with the only difference being the stored length of the player's name.

{|class="wikitable"
!Game!!Stored Length of Player's Name
|-
|ZZT||50 bytes
|-
|Super ZZT||60 bytes
|}

=== Format ===

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Actual Length of Player's Name
|-
|[[char]][storedLength]||Player's Name including padding
|-
|[[INT16LE]]||Score
|}

Entries with scores less than zero are omitted from the High Score list.

Jill of the Jungle

2019-03-06T00:07:53Z

SaxxonPike: Point to the page describing the ordering info format

{{Game Infobox
| Levels = Edit
| Tiles = No
| Sprites = No
| Fullscreen = None
| Sound = No
| Music = Edit
| Text = No
| Story = Edit
| Interface = No
}}

[[Jill of the Jungle]] is the first version of the engine which would go on to power [[Xargon]]. It supports CGA, EGA and VGA graphics by way of "colour maps", which dictate the CGA and EGA colours to be used to display each of the possible 256-colours of a given image. This way only a single 256-colour image is supplied, rather than a different image for each display.

Jill is also unique in that it is one of a very small number of games that include a level editor, albeit an undocumented one. See the [[Using the official Jill of the Jungle level editor|tutorial]] for more details.

== Tools ==

{{BeginFileFormatTools|Type=game}}
{{FileFormatTool
| Name = [[Using the official Jill of the Jungle level editor|Built-in editor]]
| Platform = DOS
| grp = N/A
| map = Edit
| gfx = No
| mus = No
| sfx = No
| txt = No
| sav = No
| exe = No
}}
{{FileFormatTool
| Name = [[Camoto]]
| Platform = Linux/Windows
| grp = N/A
| map = Edit
| gfx = Read
| mus = Edit
| sfx = No
| txt = No
| sav = No
| exe = No
}}
{{FileFormatTool
| Name = [http://ftp.funet.fi/pub/msdos/games/editors/jilledit.zip JillEdit] [http://www.stuntsillusion.com/download/jilledit.zip (mirror)]
| Platform = DOS
| grp = N/A
| map = Edit
| gfx = No
| mus = No
| sfx = No
| txt = No
| sav = No
| exe = No
}}
{{EndFileFormatTools}}

{{BeginGameFileList}}
{{GameFile
| Name = *.cfg
| Format = [[CFG Format (Jill of the Jungle)]]
| KnownFormat = Yes
| Desc = Game configuration
}}
{{GameFile
| Name = *.ddt
| Format = [[CMF Format]]
| KnownFormat = Yes
| Desc = Background music
}}
{{GameFile
| Name = jill,dma
| Format = [[DMA Format]]
| KnownFormat = Yes
| Desc = Tile information
}}
{{GameFile
| Name = *.jn[123]
| Format = [[Jill of the Jungle Map Format]]
| KnownFormat = Yes
| Desc = Game levels
}}
{{GameFile
| Name = *.mac
| Format = [[MAC Format (Jill of the Jungle)]]
| KnownFormat = Yes
| Desc = Demo macros
}}
{{GameFile
| Name = *.sha
| Format = [[SHA Format]]
| KnownFormat = Yes
| Desc = Shapes (images/tiles)
}}
{{GameFile
| Name = *.vcl
| Format = [[VCL Format]]
| KnownFormat = Yes
| Desc = Sound and text assets
}}
{{GameFile
| Name = jn[123]save.[0-9]
| Format = [[Jill of the Jungle Map Format]]
| KnownFormat = Yes
| Desc = Saved games - just dumps of the entire level in its current state
}}
{{EndGameFileList}}

== Palette ==
[[Image:Jill of the Jungle palette.png|thumb|right|128px|Jill of the Jungle palette]]
The VGA palette can be found inside the .EXE file. The palette is the same in all episodes and versions.

==== Episode 1: Jill of the Jungle ====
{|class="wikitable"
!Version!!CRC32!!Date!!Size!!Palette Offset
|-
|1.0||7899CC28||1992-06-01||216 804 bytes||0x1ED84
|-
|1.2||9540714E||1992-07-12||204 784 bytes||0x1F884
|-
|1.2(a)||51ADAE83||1992-07-30||206 963 bytes||0x1FD54
|-
|1.2(b)||171E9EC0||1992-08-21||206 712 bytes||0x1FC34
|-
|1.2(c)||C52CA6D9||1993-02-17||206 636 bytes||0x1FC04
|-
|1.2(d)||0E7C596F||1993-12-27||219 216 bytes||0x24A64
|}

==== Episode 2: Jill Goes Underground ====
{|class="wikitable"
!Version!!CRC32!!Date!!Size!!Palette Offset
|-
|1.0||6064EA0A||1992-06-17||65 166* bytes||0x1F0B4†
|-
|1.2(a)||?||1992-07-30||?||?
|-
|1.2(b)||17477A49||1992-08-21||204 158 bytes||0x1F6E4
|-
|1.2(c)||75176ED7||1993-02-17||204 096 bytes||0x1F6B4
|-
|1.2(d)||0FDB489E||1993-12-27||218 338 bytes||0x26A64
|}

==== Episode 3: Jill Saves the Prince ====
{|class="wikitable"
!Version!!CRC32!!Date!!Size!!Palette Offset
|-
|1.0||3B4D8C3B||1992-07-07||201 616 bytes||0x1F1F4
|-
|1.2(a)||B4EA288C||1992-07-30||204 425 bytes||0x1F804
|-
|1.2(b)||D5345AFB||1992-08-21||204 174 bytes||0x1F6E4
|-
|1.2(c)||3FFF0F6C||1993-02-17||204 112 bytes||0x1F6B4
|-
|1.2(d)||E27D4300||1993-12-27||218 370 bytes||0x26A64
|}

*This version has been packed using [[LZEXE|LZEXE91]]. 
†Data taken from version after uncompressing using [[UNLZEXE]].

The palette is in [[VGA Palette|classic VGA format]] (6-bit RGB.) Note that the [[SHA Format]] can override this palette.

== Episode selection screen ==

Some versions of Jill come bundled with an episode loader executable which displays an interactive screen that allows the player to select from three episodes (if present) and ordering info. The executable contains large amounts (About 90%) of raw data used to display the screen itself and the ordering info if selected. The selection screen uses a single image but various areas of it are faded in in sequence when the executable runs.

The ordering info uses the [[Crunched Screen Image]] format.

{|class="wikitable"
!Data!!Location!!Size
|-
|Screen||04E7||64'000 bytes
|-
|Screen palette||FEE7||768 bytes
|-
|Order info||12AF2||23'630 bytes
|}

== Notes ==
* Since the level files are used for a lot of different things, you can e.g. swap <tt>INTRO.JN1</tt> and <tt>1.JN1</tt> and then when you load the first level you'll be playing the intro screen. The demo and help screens can be accessed in the same way.
* You can also press Ctrl+P on the main menu to play the intro level, and Ctrl+E to enter the [[Using the official Jill of the Jungle level editor|level editor]].

== External links ==
* [http://jillofthejungle.110mb.com/home.html Unofficial Jill of the Jungle page] ([http://members.tripod.com/classic_roach/id14.html Older version], and [http://jill-of-the-jungle.tripod.com/jillsite/index.html alternate version])
* [http://ftp.funet.fi/pub/msdos/games/editors/jilledit.zip JillEdit] [http://www.stuntsillusion.com/download/jilledit.zip (mirror)] - a level editor for Jill of the Jungle created by Rory L. Fisher.
* [http://www.vgmaps.com/Atlas/PC/index.htm#JillOfTheJungle vgmaps.com] - all Jill maps as image files
* [http://www.youtube.com/watch?v=_88gJZoLpyc "Funky" remix] by Nick Stubblefield
* [http://www.openjill.org/ OpenJill] - open-source clone of Jill written in Java ([https://github.com/bubulemaster/openjill Github])

[[Category:Epic Megagames]]
[[Category:Sidescroller]]

Super ZZT

2019-03-06T00:04:46Z

SaxxonPike: Point graphics to the correct page.

{{Stub}}

{{Game Infobox
| Levels = Edit
| Tiles = No
| Sprites = No
| Fullscreen = No
| Sound = No
| Music = No
| Text = No
| Story = No
| Interface = No
}}

== Game info ==

Super ZZT is an object-oriented game scripting engine created by Tim Sweeney. It is based on the same code as [[ZZT]], with a number of notable improvements and changes. There were 3 worlds released with the commercial version of the game: PROVING, FOREST, and MONSTER. The shareware version of Super ZZT came with just MONSTER.

== Debug mode ==

In all versions, the cheat menu can be opened by pressing ? and typing in a code during gameplay. Using the +debug cheat enables the display of how much memory is available on the heap, in bytes. In the upper-left corner, it will show the letter 'm' followed by this value. OOP code on the currently shown board and the game's entire compressed board data consume heap memory.

== Editor ==

While Super ZZT features a world editor, it was considered too buggy for release and was hidden from users. However, the ZZT community was eventually able to locate the command line switch to enable the use of the built-in editor. It can be enabled from the command line using "SUPERZ /E" to start the game, and then opened by pressing "E" at the title screen.

== Versions ==

The latest version of the game is v2.0. The only other known version is v1.1. There are no observable differences between the two versions of the game aside from the opening and closing screens.

{| class="wikitable"
|-
! Version
! File Size (decompressed)
|-
| 1.1
| 53,924 (108,288)
|-
| 2.0
| 54,076 (109,072)
|}

== File formats ==

* [[ZZT Format#Board Format|BRD Format]] - Board format. This is stored exactly the same as in a world, but it's just one board.
* [[HGS Format (Super ZZT)|HGS Format]] - High scores.
* [[SZT Format]] - World format.
* [[Crunched Screen Image|Graphics Format]] - Format of the ANSI art on the title screen and the exit screen.

[[Category:Epic Megagames]]
[[Category:ZZT]]
[[Category:Game Intro Page]]

Super ZZT Graphics Format

2019-03-06T00:00:51Z

SaxxonPike: SaxxonPike moved page Super ZZT Graphics Format to Crunched Screen Image: This is the known name for this format elsewhere from Super ZZT

#REDIRECT [[Crunched Screen Image]]

Crunched Screen Image

2019-03-06T00:00:51Z

SaxxonPike: SaxxonPike moved page Super ZZT Graphics Format to Crunched Screen Image: This is the known name for this format elsewhere from Super ZZT

Talk:Jill of the Jungle

2019-03-05T05:10:17Z

SaxxonPike: /* Ordering Info same format as ZZT graphics? */ new section

In my version of Jill of the Jungle, the palettes were found at these locations:

Jill:

VGA to EGA conversion table @ 0x24964.

VGA palette @ 0x24A64.

Jill2:

VGA to EGA conversion table @ 0x1F5B4.

VGA palette @ 0x1F6B4.

Jill3:

VGA to EGA conversion table @ 0x1F704.

VGA palette @ 0x1F804.

Some of them differ from the posted. Does anyone else have a different version? --[[User:SaxxonPike|SaxxonPike]] 16:10, 12 July 2010 (GMT)
:Not sure - is there an easy way to tell which version a given .exe is? If so we should add a column to the table for the version number, so we can list the offsets for all known versions. Maybe also a signature code so it's easy for a program to identify which version a given file is. -- [[User:Malvineous|Malvineous]] 22:49, 12 July 2010 (GMT)

::I've seen different versions of a couple of Epic games, like Jill of the Jungle, Jazz Jackrabbit, Epic Pinball, Silverball and Extreme Pinball, and I couldn't find a version number inside the .exe files or see a version number when running the game. The only way to see which version number a game has, is to read what the included Helpme.doc file says. And even that is not foolproof as I've seen different .exe files with the same Helpme.doc file. Apogee surely did the version numbering a lot better than Epic :). [[User:Calvero|Calvero]] 11:17, 13 July 2010 (GMT)

:::The HELPME.DOC files can be quite misleading, actually. I've found a bunch of copies of the shareware episodes where the HELPME.DOC claims the game is version 2.0 when the game itself identifies itself by another version number (e.g. Solar Winds, version 2.0 in the .DOC and 1.1 in-game). Regarding Jill of the Jungle, there are "officially" (by officially I mean what they identify themselves as in the documents) only two recognized versions, 1.0 and 1.2. But there are also a number of revisions I've found to version 1.2 which I personally call 1.2, 1.2a, 1.2b and 1.2c. I know for a fact all of these revisions except 1.2c also have matching registered versions (I'm not too convinced that 1.2c actually had anything else than a shareware release). I have made a document some time ago to make it easier to identify these versions and it can be found from [http://aoebeta.110mb.com/Private/jill_versions.txt here] (the data is that of the main game EXE). --[[User:Litude|Litude]] 11:24, 15 July 2010 (GMT)

::::Wow, would you mind including that info on the main Jill page? I'm happy to do it but might be better if you do the first edit so it goes against your name in the edit history. Add an extra column for those palette offsets so we can add them in when we find them out for a particular version. My Jill versions match up well with your list, except my Jill 1 v1.0 (216804) is dated 1992-06-01, one day earlier than in your list. Also not sure if you're recording dates/versions of jjfile0.exe (the episode loader) because I'm not sure where that came from as I didn't find it until relatively recently. -- [[User:Malvineous|Malvineous]] 11:38, 15 July 2010 (GMT)

:::::Alright, I'll try adding the info though I don't really mind having someone else adding them (I don't really care that much about getting credited for stuff). Regarding the modify date of version 1.0, you're absolutely right. It seems my finger slipped when putting together that document. JJFILE0.EXE first appeared in version 1.2a and was also present in version 1.2b, but it was removed in 1.2c (which is why I think its shareware only, can't see any other reason for its removal). I don't record the dates of that file as as far as I know there are only two versions of the file, one of which is present in version 1.2a and the other one which is present in 1.2b.--[[User:Litude|Litude]] 12:43, 15 July 2010 (GMT)

::::::The version that is called version 1.1 of Jill 1 on [http://www.classicdosgames.com/game/Jill_of_the_Jungle.html RGB Classic Games] is called version 1.2a here, but when you run the game it says it's the United kingdom version. It gets this version information from the file INTRO.JN1. So at least one version of the game has in-game version information :). Through my own research I found out that only version 1.0 has the references to Commander Keen, Mario, Duke Nukem and Pac-Man in the map level. Can someone confirm this? It's possible to copy MAP.JN1 of version 1.0 to later versions to restore these references. [[User:Calvero|Calvero]] 15:42, 15 July 2010 (GMT)

:::::::That installer is mislabeled, check the documents and it's listed as being version 1.2 (there was no version 1.1 of the game as far as I know). I did check that version but didn't look through it thoroughly enough to notice that it has a modified INTRO.JN1, just concluded it was 1.2a. But that doesn't mean 1.2a was exclusively made for the United Kingdom, as you can find version 1.2a without this United Kingdom mention from [http://cd.textfiles.com/swheaven1/GAMES/JILL.ZIP here]. Regarding actual changes between the versions, I haven't really been looking into this but seeing as MAP.JN1 is identical in 1.2, 1.2a, 1.2b and 1.2c it seems likely. --[[User:Litude|Litude]] 16:01, 15 July 2010 (GMT)

:::::::While I can't confirm it, it has been discussed on the PCKF that the Commander Keen reference only appeared in early versions of Jill and for some reason it was later removed. Which, being a Commander Keen forum, was then immediately followed by many "where I can get the original version" requests. -- [[User:Malvineous|Malvineous]] 14:07, 16 July 2010 (GMT)

== Ordering Info same format as ZZT graphics? ==

It looks like the Ordering Info format described under the Episode Selection Screen might match the graphics format used for Super ZZT:

[[Super_ZZT_Graphics_Format]]

Thoughts?
--[[User:SaxxonPike|SaxxonPike]] ([[User talk:SaxxonPike|talk]]) 05:10, 5 March 2019 (UTC)

CFG Format (ZZT)

2019-03-05T04:32:02Z

SaxxonPike: Add ZZT category.

{{NeedMoreInfo}}

ZZT.CFG is supported in versions 3.0 and 3.2. While the format is somewhat different between the two versions, the overall layout of the file is the same: it's a text file with a series of fields, separated by newlines.

Strangely enough, ZZT 3.1 does not appear to support ZZT.CFG at all.

== 3.0 Format ==

{{TODO|Figure out what on earth is going on with this config file. Most notably with the second, third, and seventh lines.}}

Compared to 3.2, 3.0's config format is quite a bit more complex.

{|class="wikitable"
!Field/Line Number!!Optional!!Name!!Description
|-
|1||No||Input/Display Settings||This is a bitmask that contains some input and display settings. The following values are known (from least to most significant):

# ?
# ?
# Keyboard enabled ({{TODO|Not quite sure about this one}}).
# ?
# Mouse enabled.
# Monochrome display.
# ?
# ?
|-
|2||No||Unknown||
|-
|3||No||Unknown||
|-
|4||No||Show Config Screen||If this value is set to 2, the config screen is shown. If it's set to 3, the config screen will be bypassed. If the mouse is enabled, setting this to 3 doesn't seem to do anything and will cause the config screen to be enabled. ({{TODO|Why are the values 2 and 3? Another bitmask? Need to investigate further.}})
|-
|5||Yes||Startup World File||The world file to load when ZZT is started, sans extension. If this is prepended by an asterisk (i.e. *TOWN), the ZZT editor will be disabled. If this is left blank, the editor will be enabled and TOWN will be used as the default world.
|-
|6||Yes||Registered Flag||If this is left blank or doesn't exist, the game acts like the shareware version. If this field contains any text (by default, the registered 3.2 build sets it to REGISTERED) it will act like the registered version. See [[#Registered vs. Shareware|below]] for more information.
|-
|7||Yes||Unknown||This field does not appear to be significant. In the default configuration this contains the string, "NONE." In a shareware disk that was located recently, this is set to "Serial # 14054-3", prepended with 32 spaces.
|}

If the ZZT.CFG file is missing or any of the required values are missing, the game will create a new ZZT.CFG file. If the optional fields are omitted, they will not be added to the config file. Unlike ZZT 3.2, 3.0 writes to this file after the initial configuration screen is shown.

Take care not to write strings into the required fields. The game engine is expecting those fields to contain integers (or nothing), so if it's fed a string it's very likely to crash on startup.

== 3.2 Format ==

{{TODO|Verify that this section is accurate and that there are no hidden surprises left.}}

ZZT 3.2's config file format is much simpler than 3.0's. It consists of two fields:

{|class="wikitable"
!Field/Line Number!!Optional!!Name!!Description
|-
|1||Yes||Startup World File||The world file to load when ZZT is started, sans extension. If this is prepended by an asterisk (i.e. *TOWN), the ZZT editor will be disabled. If this is left blank, the editor will be enabled and TOWN will be used as the default world.
|-
|2||Yes||Registered Flag||If this is left blank or doesn't exist, the game acts like the shareware version. If this field contains any text (by default, the registered 3.2 build sets it to REGISTERED) it will act like the registered version. See [[#Registered vs. Shareware|below]] for more information.
|}

If the ZZT.CFG file is missing or doesn't contain any information, the file will ''not'' be created by ZZT. The default world file will be set to TOWN, the editor will be enabled, and the registered flag will be disabled.

== Registered vs. Shareware ==

In practice, the "registered" flag doesn't make any significant difference. The help files are static, so setting this flag on the shareware release will still display ordering information in the welcome screen. Similarly, the registered version will still display the "Do not distribute" message.

The only tangible difference is when you exit the game. If the registered flag is set, the outro message will read "Registered version -- Thank you for playing ZZT" regardless of whether or not you're using the shareware version. If it is not set, the freeware registered version will not display a message while the shareware version will display a nag screen.

Aside from these small changes, there are no changes to gameplay or the functionality of the world editor.

[[Category:ZZT]]

Super ZZT

2019-03-04T17:25:19Z

SaxxonPike: Add high score format.

{{Stub}}

{{Game Infobox
| Levels = Edit
| Tiles = No
| Sprites = No
| Fullscreen = No
| Sound = No
| Music = No
| Text = No
| Story = No
| Interface = No
}}

== Game info ==

Super ZZT is an object-oriented game scripting engine created by Tim Sweeney. It is based on the same code as [[ZZT]], with a number of notable improvements and changes. There were 3 worlds released with the commercial version of the game: PROVING, FOREST, and MONSTER. The shareware version of Super ZZT came with just MONSTER.

== Debug mode ==

In all versions, the cheat menu can be opened by pressing ? and typing in a code during gameplay. Using the +debug cheat enables the display of how much memory is available on the heap, in bytes. In the upper-left corner, it will show the letter 'm' followed by this value. OOP code on the currently shown board and the game's entire compressed board data consume heap memory.

== Editor ==

While Super ZZT features a world editor, it was considered too buggy for release and was hidden from users. However, the ZZT community was eventually able to locate the command line switch to enable the use of the built-in editor. It can be enabled from the command line using "SUPERZ /E" to start the game, and then opened by pressing "E" at the title screen.

== Versions ==

The latest version of the game is v2.0. The only other known version is v1.1. There are no observable differences between the two versions of the game aside from the opening and closing screens.

{| class="wikitable"
|-
! Version
! File Size (decompressed)
|-
| 1.1
| 53,924 (108,288)
|-
| 2.0
| 54,076 (109,072)
|}

== File formats ==

* [[ZZT Format#Board Format|BRD Format]] - Board format. This is stored exactly the same as in a world, but it's just one board.
* [[HGS Format (Super ZZT)|HGS Format]] - High scores.
* [[SZT Format]] - World format.
* [[Super ZZT Graphics Format|Graphics Format]] - Format of the ANSI art on the title screen and the exit screen.

[[Category:Epic Megagames]]
[[Category:ZZT]]
[[Category:Game Intro Page]]

ZZT

2019-03-04T16:23:31Z

SaxxonPike: Add more formats to be filled in later.

{{Game Infobox
| Levels = Edit
| Tiles = No
| Sprites = No
| Fullscreen = No
| Sound = No
| Music = No
| Text = No
| Story = No
| Interface = No
}}

== Game info ==

ZZT is a game creation system created by Tim Sweeney in 1991, the first game developed and published by Potomac Computer Systems (later Epic Megagames, now Epic Games.) There were 4 worlds released with the commercial version of the game: TOWN, CAVES, CITY, and DUNGEONS. The shareware version of ZZT came with just TOWN. In all versions of the game, the built-in world editor is fully functional (however, it will not edit saved games or locked worlds natively.)

Later, [[Super ZZT]] was released based on this engine.

== Debug mode ==

In all versions, the cheat menu can be opened by pressing ? and typing in a code. In versions prior to v3.2, standard cheats will not work until the +debug cheat is used. This also enables the display of how much memory is available on the heap, in bytes. In the upper-right corner, it will show the letter 'm' followed by this value. OOP code on the currently shown board and the game's entire compressed board data consume heap memory.

== Versions ==

The latest version of the game is v3.2. Other versions of the game that can be found are v3.1, v3.0, and v2.0. Aside from improvements in input handling and visual appearance, cheat availability and copyright messages, there are no observable differences between these versions.

{| class="wikitable"
|-
! Version
! File Size (decompressed)
|-
| 2.0
| 89,792 (89,792)
|-
| 3.0
| 47,473 (95,440)
|-
| 3.1
| 47,471 (95,616)
|-
| 3.2
| 47,764 (96,080)
|}

== File formats ==

* [[ZZT Format#Board Format|BRD Format]] - Board format. This is stored exactly the same as in a world, but it's just one board.
* [[CFG Format (ZZT)|CFG Format]] - ZZT.CFG contains the startup configuration and serial number.
* [[DAT Format (ZZT)|DAT Format]] - In 3.0 and later, ZZT.DAT contains help files and end screen messages. This is not present in 2.0; the files are stored in the directory.
* [[HI Format (ZZT)|HI Format]] - High scores.
* [[HLP Format (ZZT)|HLP Format]] - Help file format.
* [[MSG Format (ZZT)|MSG Format]] - Stores end game messages.
* [[ZZT Format|SAV Format]] - Saved games, 100% identical to world files except a byte in the header.
* [[ZZT Format]] - World format.

[[Category:Epic Megagames]]
[[Category:ZZT]]

User:SaxxonPike

2016-07-27T16:27:03Z

SaxxonPike: Use actual game links.

Super ZZT

2016-07-27T16:16:10Z

SaxxonPike: Add information about the heap in Super ZZT.

{{Stub}}

{{Game Infobox
| Levels = Edit
| Tiles = No
| Sprites = No
| Fullscreen = No
| Sound = No
| Music = No
| Text = No
| Story = No
| Interface = No
}}

== Game info ==

Super ZZT is an object-oriented game scripting engine created by Tim Sweeney. It is based on the same code as [[ZZT]], with a number of notable improvements and changes. There were 3 worlds released with the commercial version of the game: PROVING, FOREST, and MONSTER. The shareware version of Super ZZT came with just MONSTER.

== Debug mode ==

In all versions, the cheat menu can be opened by pressing ? and typing in a code during gameplay. Using the +debug cheat enables the display of how much memory is available on the heap, in bytes. In the upper-left corner, it will show the letter 'm' followed by this value. OOP code on the currently shown board and the game's entire compressed board data consume heap memory.

== Editor ==

While Super ZZT features a world editor, it was considered too buggy for release and was hidden from users. However, the ZZT community was eventually able to locate the command line switch to enable the use of the built-in editor. It can be enabled from the command line using "SUPERZ /E" to start the game, and then opened by pressing "E" at the title screen.

== Versions ==

The latest version of the game is v2.0. The only other known version is v1.1. There are no observable differences between the two versions of the game aside from the opening and closing screens.

{| class="wikitable"
|-
! Version
! File Size (decompressed)
|-
| 1.1
| 53,924 (108,288)
|-
| 2.0
| 54,076 (109,072)
|}

== File formats ==

* [[ZZT Format#Board Format|BRD Format]] - Board format. This is stored exactly the same as in a world, but it's just one board.
* [[SZT Format]] - World format.
* [[Super ZZT Graphics Format|Graphics Format]] - Format of the ANSI art on the title screen and the exit screen.

[[Category:Epic Megagames]]
[[Category:ZZT]]
[[Category:Game Intro Page]]

ZZT

2016-07-27T16:14:58Z

SaxxonPike: /* Game info */ Info about Super ZZT.

{{Game Infobox
| Levels = Edit
| Tiles = No
| Sprites = No
| Fullscreen = No
| Sound = No
| Music = No
| Text = No
| Story = No
| Interface = No
}}

== Game info ==

ZZT is a game creation system created by Tim Sweeney in 1991, the first game developed and published by Potomac Computer Systems (later Epic Megagames, now Epic Games.) There were 4 worlds released with the commercial version of the game: TOWN, CAVES, CITY, and DUNGEONS. The shareware version of ZZT came with just TOWN. In all versions of the game, the built-in world editor is fully functional (however, it will not edit saved games or locked worlds natively.)

Later, [[Super ZZT]] was released based on this engine.

== Debug mode ==

In all versions, the cheat menu can be opened by pressing ? and typing in a code. In versions prior to v3.2, standard cheats will not work until the +debug cheat is used. This also enables the display of how much memory is available on the heap, in bytes. In the upper-right corner, it will show the letter 'm' followed by this value. OOP code on the currently shown board and the game's entire compressed board data consume heap memory.

== Versions ==

The latest version of the game is v3.2. Other versions of the game that can be found are v3.1, v3.0, and v2.0. Aside from improvements in input handling and visual appearance, cheat availability and copyright messages, there are no observable differences between these versions.

{| class="wikitable"
|-
! Version
! File Size (decompressed)
|-
| 2.0
| 89,792 (89,792)
|-
| 3.0
| 47,473 (95,440)
|-
| 3.1
| 47,471 (95,616)
|-
| 3.2
| 47,764 (96,080)
|}

== File formats ==

* [[ZZT Format#Board Format|BRD Format]] - Board format. This is stored exactly the same as in a world, but it's just one board.
* [[HI Format (ZZT)|HI Format]] - High scores.
* [[ZZT Format|SAV Format]] - Saved games, 100% identical to world files except a byte in the header.
* [[ZZT Format]] - World format.

[[Category:Epic Megagames]]
[[Category:ZZT]]

ZZT

2016-07-27T16:13:41Z

SaxxonPike: /* Debug mode */ Info about the heap.

{{Game Infobox
| Levels = Edit
| Tiles = No
| Sprites = No
| Fullscreen = No
| Sound = No
| Music = No
| Text = No
| Story = No
| Interface = No
}}

== Game info ==

ZZT is a game creation system created by Tim Sweeney in 1991, the first game developed and published by Potomac Computer Systems (later Epic Megagames, now Epic Games.) There were 4 worlds released with the commercial version of the game: TOWN, CAVES, CITY, and DUNGEONS. The shareware version of ZZT came with just TOWN. In all versions of the game, the built-in world editor is fully functional (however, it will not edit saved games or locked worlds natively.)

== Debug mode ==

In all versions, the cheat menu can be opened by pressing ? and typing in a code. In versions prior to v3.2, standard cheats will not work until the +debug cheat is used. This also enables the display of how much memory is available on the heap, in bytes. In the upper-right corner, it will show the letter 'm' followed by this value. OOP code on the currently shown board and the game's entire compressed board data consume heap memory.

== Versions ==

The latest version of the game is v3.2. Other versions of the game that can be found are v3.1, v3.0, and v2.0. Aside from improvements in input handling and visual appearance, cheat availability and copyright messages, there are no observable differences between these versions.

{| class="wikitable"
|-
! Version
! File Size (decompressed)
|-
| 2.0
| 89,792 (89,792)
|-
| 3.0
| 47,473 (95,440)
|-
| 3.1
| 47,471 (95,616)
|-
| 3.2
| 47,764 (96,080)
|}

== File formats ==

* [[ZZT Format#Board Format|BRD Format]] - Board format. This is stored exactly the same as in a world, but it's just one board.
* [[HI Format (ZZT)|HI Format]] - High scores.
* [[ZZT Format|SAV Format]] - Saved games, 100% identical to world files except a byte in the header.
* [[ZZT Format]] - World format.

[[Category:Epic Megagames]]
[[Category:ZZT]]

ZZT

2016-07-27T16:10:30Z

SaxxonPike: Debug information

{{Game Infobox
| Levels = Edit
| Tiles = No
| Sprites = No
| Fullscreen = No
| Sound = No
| Music = No
| Text = No
| Story = No
| Interface = No
}}

== Game info ==

ZZT is a game creation system created by Tim Sweeney in 1991, the first game developed and published by Potomac Computer Systems (later Epic Megagames, now Epic Games.) There were 4 worlds released with the commercial version of the game: TOWN, CAVES, CITY, and DUNGEONS. The shareware version of ZZT came with just TOWN. In all versions of the game, the built-in world editor is fully functional (however, it will not edit saved games or locked worlds natively.)

== Debug mode ==

In all versions, the cheat menu can be opened by pressing ? and typing in a code. In versions prior to v3.2, standard cheats will not work until the +debug cheat is used. This also enables the display of how much memory is available for OOP programs, in bytes. In the upper-right corner, it will show the letter 'm' followed by this value.

== Versions ==

The latest version of the game is v3.2. Other versions of the game that can be found are v3.1, v3.0, and v2.0. Aside from improvements in input handling and visual appearance, cheat availability and copyright messages, there are no observable differences between these versions.

{| class="wikitable"
|-
! Version
! File Size (decompressed)
|-
| 2.0
| 89,792 (89,792)
|-
| 3.0
| 47,473 (95,440)
|-
| 3.1
| 47,471 (95,616)
|-
| 3.2
| 47,764 (96,080)
|}

== File formats ==

* [[ZZT Format#Board Format|BRD Format]] - Board format. This is stored exactly the same as in a world, but it's just one board.
* [[HI Format (ZZT)|HI Format]] - High scores.
* [[ZZT Format|SAV Format]] - Saved games, 100% identical to world files except a byte in the header.
* [[ZZT Format]] - World format.

[[Category:Epic Megagames]]
[[Category:ZZT]]

ZZT Format

2016-07-27T15:55:16Z

SaxxonPike: /* ZZT world header */ Clean up unused values.

ZZT Format

2016-07-27T15:53:35Z

SaxxonPike: /* Super ZZT world header */ Clean up unused values.

{{Playerdata Infobox
| Savegame = Yes
| Where = ?
| Elements = Ammo, gems, keys, scores, many others
| Games =
{{Game|ZZT}}
{{Game|Super ZZT}}
}}

A world file (.ZZT, .SZT) contains information about a game world, status of the player, and all its boards. Saved games (.SAV) are the same format as world files with a different extension and a different setting for the Lock byte.

While there are built-in editors for these games, they do not provide full editing functionality.

== Limits ==

ZZT and Super ZZT have limits imposed either by the game itself or by the data types used to store information about the world's contents.

{|class="wikitable"
!Limitation!!ZZT!!Super ZZT
|-
|Board count (including title screen)||101||33
|-
|Board size (in bytes)||32767||32767
|-
|Board size (in tiles)||60x25||96x80
|-
|Status Elements per board (including Player)||151||129
|-
|Flag strings||10||16
|}

Realistically, the original ZZT can only support boards up to around 20k due to the code itself. ZZT 4.0 by WiL, a hack of the original game executable, can support the full 32k.

== World Format ==

There are two formats for a world file. One is for ZZT and the other is for SuperZZT. The formats are very similar. All 8-bit (byte) values are unsigned. All 16-bit (short) values are signed. Boolean values (such as a player's keys) are represented with 0 for false and 1 for true; any other values may cause inconsistent behavior.

World Name is used by the game to determine which file to load after the player quits and restarts the game. Therefore if a world contains a world name that is actually the filename of another world, after the player quits and restarts the game, the world with the matching filename will be loaded!

There are some unused bytes after the world information that are ignored by the game. While it is safe to put any data whatsoever into this unused space, it is not saved back to disk by the game engine and will be converted to empty padding. [[ZZTAE]] is an editor that uses this space to store extra information such as the author and genre.

=== Common world information ===

The storage of this information is the same between the two formats. After this part of the file, the format will differ slightly.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF FF) and SuperZZT uses -2 (FE FF).
|-
|2||0x002||[[INT16LE]]||NumBoards Number of boards in the world, not including the title screen. Increment by 1 for the real number of stored boards. A value of 0 means only the title screen exists.
|-
|4||0x004||[[INT16LE]]||PlayerAmmo Player's ammunition.
|-
|6||0x006||[[INT16LE]]||PlayerGems Player's gems.
|-
|8||0x008||[[char]][7]||PlayerKeys Player's keys. A nonzero value means the player has the specified key. The keys are in this order: Blue, Green, Cyan, Red, Purple, Yellow, White.
|-
|15||0x00F||[[INT16LE]]||PlayerHealth Player's health.
|-
|17||0x011||[[INT16LE]]||PlayerBoard In a world file, this will be the starting board for the player (the title screen, board 0, is always shown first). In a saved game, this will be the board that the player is currently on.
|-
|}

=== ZZT world header ===

This is the second half of the header specific to a .ZZT file. After this information, storage of the boards starts at byte offset 512 (hex 0x200).

Only bytes through 279 (hex 0x117) are copied into memory. The rest of the bytes before board data are discarded upon saving.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||PlayerTorches Player's torches.
|-
|21||0x015||[[INT16LE]]||TorchCycles Game cycles left for a torch to remain lit.
|-
|23||0x017||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|25||0x019||[[INT16LE]]||(unused) This value is preserved but not used by the game engine.
|-
|27||0x01B||[[INT16LE]]||PlayerScore Player's score.
|-
|29||0x01D||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|30||0x01E||[[char]][20]||WorldName Internal name of the world.
|-
|50||0x032||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|51||0x033||[[char]][20]||Flag0 Name of Flag 0.
|-
|71||0x047||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|72||0x048||[[char]][20]||Flag1 Name of Flag 1.
|-
|92||0x05C||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|93||0x05D||[[char]][20]||Flag2 Name of Flag 2.
|-
|113||0x071||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|114||0x072||[[char]][20]||Flag3 Name of Flag 3.
|-
|134||0x086||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|135||0x087||[[char]][20]||Flag4 Name of Flag 4.
|-
|155||0x09B||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|156||0x09C||[[char]][20]||Flag5 Name of Flag 5.
|-
|176||0x0B0||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|177||0x0B1||[[char]][20]||Flag6 Name of Flag 6.
|-
|197||0x0C5||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|198||0x0C6||[[char]][20]||Flag7 Name of Flag 7.
|-
|218||0x0DA||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|219||0x0DB||[[char]][20]||Flag8 Name of Flag 8.
|-
|239||0x0EF||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|240||0x0F0||[[char]][20]||Flag9 Name of Flag 9.
|-
|260||0x104||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|262||0x106||[[INT16LE]]||TimePassedTicks This contains information about sub-seconds on time limited boards.
|-
|264||0x108||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|}

=== Super ZZT world header ===

This is the second half of the header specific to a .SZT file. After this information, storage of the boards starts at byte offset 1024 (hex 0x400).

Unused values are preserved. Data not listed here is overwritten with zeroes when saving worlds.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||(unused)
|-
|21||0x015||[[INT16LE]]||PlayerScore Player's score.
|-
|23||0x017||[[INT16LE]]||(unused)
|-
|25||0x019||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|27||0x01B||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|28||0x01C||[[char]][20]||WorldName Internal name of the world.
|-
|48||0x030||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|49||0x031||[[char]][20]||Flag0 Name of Flag 0.
|-
|69||0x045||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|70||0x046||[[char]][20]||Flag1 Name of Flag 1.
|-
|90||0x05A||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|91||0x05B||[[char]][20]||Flag2 Name of Flag 2.
|-
|111||0x06F||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|112||0x070||[[char]][20]||Flag3 Name of Flag 3.
|-
|132||0x084||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|133||0x085||[[char]][20]||Flag4 Name of Flag 4.
|-
|153||0x099||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|154||0x09A||[[char]][20]||Flag5 Name of Flag 5.
|-
|174||0x0AE||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|175||0x0AF||[[char]][20]||Flag6 Name of Flag 6.
|-
|195||0x0C3||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|196||0x0C4||[[char]][20]||Flag7 Name of Flag 7.
|-
|216||0x0D8||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|217||0x0D9||[[char]][20]||Flag8 Name of Flag 8.
|-
|237||0x0ED||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|238||0x0EE||[[char]][20]||Flag9 Name of Flag 9.
|-
|258||0x102||[[UINT8]]||Flag10Length Length of the name of Flag 10.
|-
|259||0x103||[[char]][20]||Flag10 Name of Flag 10.
|-
|279||0x117||[[UINT8]]||Flag11Length Length of the name of Flag 11.
|-
|280||0x118||[[char]][20]||Flag11 Name of Flag 11.
|-
|300||0x12C||[[UINT8]]||Flag12Length Length of the name of Flag 12.
|-
|301||0x12D||[[char]][20]||Flag12 Name of Flag 12.
|-
|321||0x141||[[UINT8]]||Flag13Length Length of the name of Flag 13.
|-
|322||0x142||[[char]][20]||Flag13 Name of Flag 13.
|-
|342||0x156||[[UINT8]]||Flag14Length Length of the name of Flag 14.
|-
|343||0x157||[[char]][20]||Flag14 Name of Flag 14.
|-
|363||0x16B||[[UINT8]]||Flag15Length Length of the name of Flag 15.
|-
|364||0x16C||[[char]][20]||Flag15 Name of Flag 15.
|-
|384||0x180||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|386||0x182||[[INT16LE]]||TimePassedTicks This contains information about sub-seconds on time limited boards.
|-
|388||0x184||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|389||0x185||[[INT16LE]]||PlayerStones Player's stones of power. If this value is negative, no information is shown in-game about them. If this value is >= 0, it uses a flag to describe this value in the status bar of the game. The flag used is the first one found that is preceded with a Z. "The Lost Forest" contains a flag called "ZSTONES" which shows as "STONES" on the status bar, for example.
|-
|391||0x187||[[UINT8]][11]||(unused)
|}

== Board Format ==

Boards can be stored individually in .BRD files. Since ZZT and Super ZZT use the same extension for boards and there is no world information stored with them, it isn't immediately apparent whether the board is a ZZT or a Super ZZT board. Testing the validity of the board information with both world types should be a good way to determine the type of world a board belongs to.

=== Format layout ===

Boards consist of 4 parts: Board Header, RLE Tiles, Board Properties, and Status Element Properties. Status Elements are elements on the board that the game actively processes - these include the player, enemies, any animating blocks, and Scrolls and Objects which can contain ZZT-OOP code.

=== ZZT board header ===

ZZT boards are 60x25 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes (excluding the two bytes from this value). Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][50]||BoardName Board's name.
|-
|53||0x035||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Super ZZT board header ===

Super ZZT boards are 96x80 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][60]||BoardName Board's name.
|-
|63||0x03F||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Run-length encoded tile data ===

Tile data is represented as sets of 3 bytes. These sets are repeated until the board is completely filled. For ZZT, this will be 60*25=1500 tiles. For SuperZZT, this will be 96*80=7680 tiles. The tiles are unpacked from left to right, top to bottom.

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Count Number of tiles.
|-
|[[UINT8]]||Element Element of the tiles.
|-
|[[UINT8]]||Color Color of the tiles.
|-
|}

A small quirk of this RLE format is when the number of tiles is set to zero. Due to the way the decoder is set up, a Count of 0 means there are actually 256 tiles encoded. The built-in editor does not encode tiles using this value despite being decoded correctly in the game, and it will probably crash some older external editors.

=== ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||IsDark When set to 1, the board is covered in darkness which can only be revealed by using a torch.
|-
|2||0x002||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|3||0x003||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|4||0x004||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|5||0x005||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|6||0x006||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|7||0x007||[[UINT8]]||MessageLength Length of the on-screen message.
|-
|8||0x008||[[char]][58]||Message On-screen message. This is used internally and is not loaded by the game.
|-
|66||0x042||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|67||0x043||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|68||0x044||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|70||0x046||[[UINT8]][16]||(unused)
|-
|86||0x056||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|-
|}

=== Super ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|2||0x002||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|3||0x003||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|4||0x004||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|5||0x005||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|6||0x006||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|7||0x007||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|8||0x008||[[INT16LE]]||CameraX X-coordinate of the viewport. This value is not used when loading worlds.
|-
|10||0x00A||[[INT16LE]]||CameraY Y-coordinate of the viewport. This value is not used when loading worlds.
|-
|12||0x00C||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|14||0x00E||[[UINT8]][14]||(unused)
|-
|28||0x01C||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|}

=== Status Elements ===

This follows directly after board properties. It is repeated for each Status Element. The first element stored is always the player-controlled element. This element may contain strange values for Step, Leader and Follower information - this is because these values are used internally by the game.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||LocationX X-coordinate. Location coordinates are 1-based, unlike any other coordinates in the file.
|-
|1||0x001||[[UINT8]]||LocationY Y-coordinate.
|-
|2||0x002||[[INT16LE]]||StepX X-step value. This pair of values represents a vector that typically points in one of the four cardinal directions. Its use differs for each type of element.
|-
|4||0x004||[[INT16LE]]||StepY Y-step value.
|-
|6||0x006||[[INT16LE]]||Cycle Cycle. This represents the frequency, in ticks, at which the game will process this status element.
|-
|8||0x008||[[UINT8]]||P1 Parameter 1. Its use will differ depending on the type of element.
|-
|9||0x009||[[UINT8]]||P2 Parameter 2. Its use will differ depending on the type of element.
|-
|10||0x00A||[[UINT8]]||P3 Parameter 3. Its use will differ depending on the type of element.
|-
|11||0x00B||[[INT16LE]]||Follower Follower status element. Its value determines if another status element is linked behind this one. Typically used for linking centipedes.
|-
|13||0x00D||[[INT16LE]]||Leader Leader status element. Its value determines if another status element is linked in front of this one. Typically used for linking centipedes.
|-
|15||0x00F||[[UINT8]]||UnderID Element of the tile under this status element.
|-
|16||0x010||[[UINT8]]||UnderColor Color of the tile under this status element.
|-
|17||0x011||[[INT32LE]]||Pointer Stores the location in memory of the code that this status element is using. Status elements typically point to their own code until they #BIND the code of another - in which case this memory location value is replaced with the new one. ZZT does not use this value when loading worlds, and always sets it to 0 when saving worlds.
|-
|21||0x015||[[INT16LE]]||CurrentInstruction The offset in bytes of the code block to execute ZZT-OOP from. Only Objects and Scrolls can execute ZZT-OOP.
|-
|23||0x017||[[INT16LE]]||Length There are two uses for this value: If this value is positive, it represents the number of bytes that are in the code block. If this value is negative, the absolute value of this value represents the Status Element number to copy code from. This saves space by removing redundant code duplication. Since code is shared in this way, all modifications to code will affect any other Status Elements using it.
|-
|}

In ZZT (not Super ZZT), 8 bytes of padding will follow.

If "Length" is positive, the code will be stored here.

== Element Lists ==

This is a list of all valid built-in elements that can be used. Using any elements outside this range produce undefined behavior which is dependent on whatever was residing in memory at the time the game was loaded. Most often, it will crash.

=== Element properties ===

These are all possible internal properties for each element. '''Note:''' The addresses shown are not really significant- you should only consider which ones share the same code to cut down on how many element behaviors to consider.

{|class="wikitable"
!Property!!Description
|-
|Id||Id number of the element
|-
|Hex||Hexidecimal representation of the Id number
|-
|Name||Known name of the element, which may not be present internally
|-
|Character||ASCII character for the default draw code, which may be ignored if special draw code is enabled
|-
|Color||Default color. If the color is 0xFE, then new tiles will be created with the primary color as the background and a white foreground. If the color is >= 0xF0, any primary color is allowed, but in the editor you can't choose the color unless the default color is 0xFF
|-
|Destructible||Element can be destroyed by bullets and by being crushed by puzzle pieces
|-
|Pushable||Element can be pushed. The NS/EW sliders are a special case in the code, so they will not be marked with this flag
|-
|Editor Floor||When using the editor, actors such as enemies can be placed on top of elements marked with this flag. Has no effect during gameplay.
|-
|Floor||Elements with this flag can freely be moved upon by actors
|-
|Shown||ZZT only. Elements marked with this flag will always be shown, even on dark boards
|-
|Special Draw||If this flag is set, the default draw code is bypassed with different draw code
|-
|Draw Code||Offset of the routine that performs the drawing, if Special Draw is set
|-
|Cycle||Default cycle. If this is -1, the element is not generated as an actor. Creatures will have cycles above zero
|-
|Act Code||Offset of the routine that performs standard behavior. For example: creature movement, bomb countdown
|-
|Interact Code||Offset of the routine that handles when a player touches the element. For example: item pickups, entering a passage
|-
|Menu#||Number of the editor menu where this element can be found
|-
|Key||Key press which is mapped to this element in the editor
|-
|Internal Name||Name of the element used in the editor. It is also used by OOP- the parser will remove all symbols and spaces and compare that
|-
|Category||When it comes time to display this element in the editor, if present, the category will be drawn in yellow first.
|-
|Edit P1||Text to show when editing the P1 of an actor that uses this element
|-
|Edit P2||Text to show when editing the P2 of an actor that uses this element
|-
|Edit P3||Text to show when editing the P3 of an actor that uses this element
|-
|Edit Board||Text to show when selecting the target board
|-
|Edit Step||Text to show when selecting the target direction
|-
|Edit Code||Text to show when editing an actor's code (scroll or object OOP)
|-
|Points||When an actor using this element is killed by the player, it's worth this much score
|-
|}

=== ZZT elements ===

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Shown!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3973||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x20||0x07||||||||||||||0x0020||1||0x4481||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||Yes||||0x0020||1||0x3E2F||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||||0x0020||-1||0x0000||0x3289||1||A||Ammo||||||||||||||||0
|-
|6||0x06||Torch||0x9D||0x06||||||||||Yes||||0x0020||-1||0x0000||0x37B6||1||T||Torch||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||||0x0020||-1||0x0000||0x3306||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x3169||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||||0x0020||-1||0x0000||0x33DA||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||||0x0020||1||0x2F9F||0x308B||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||Yes||||0x0020||0||0x0000||0x3372||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||||Yes||0x2A15||2||0x2BFF||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||||Yes||0x1872||6||0x18DA||0x19F3||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||||0x0020||-1||0x0000||0x2034||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||Star||0x53||0x0F||||||||||||Yes||0x1D5D||1||0x1DE9||0x00F5||0||||Star||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||||Yes||0x171C||3||0x176C||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||||Yes||0x17C7||2||0x1817||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||Bullet||0xF8||0x0F||Yes||||||||||||0x0020||1||0x0F65||0x00F5||0||||Bullet||||||||||||||||0
|-
|19||0x13||Water||0xB0||0xF9||||||Yes||||||||0x0020||-1||0x0000||0x3B03||3||W||Water||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||||0x0020||-1||0x0000||0x38D0||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x34E3||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||||0x0020||-1||0x0000||0x3949||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0xB0||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3848||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||||Yes||0x242E||1||0x2445||0x0010||3||L||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||||Yes||0x1CC5||2||0x1C85||0x1C41||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||||Yes||0x122A||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0x99||0x06||Yes||Yes||||||||||0x0020||3||0x054F||0x00F5||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||||0x0020||1||0x0351||0x00F5||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||||Yes||0x2B85||3||0x2AA5||0x2BB7||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||||0x0020||3||0x20AE||0x2295||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||Shark||0x5E||0x07||||||||||||||0x0020||3||0x2321||0x0010||2||Y||Shark||||Intelligence?||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||||Yes||0x11D0||2||0x12A7||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||||Yes||0x3517||4||0x358A||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||||0x0020||2||0x0113||0x00F5||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||||0x0020||2||0x022D||0x00F5||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||||0x0020||2||0x06BF||0x00F5||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||||0x0020||2||0x0EED||0x00F5||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Text (Blue)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|48||0x30||Text (Green)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|49||0x31||Text (Cyan)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|50||0x32||Text (Red)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|51||0x33||Text (Purple)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|52||0x34||Text (Brown)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||Text (Black)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

=== Super ZZT elements ===

Internal properties for each of these elements can be found in the [http://pastebin.com/mdEwu6Y1 Super ZZT Elements Pastebin].

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3FA5||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x02||0x1F||||Yes||||||||0x0020||1||0x4B76||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||||0x0020||1||0x4596||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||0x0020||-1||0x0000||0x37E7||1||A||Ammo||||||||||||||||0
|-
|6||0x06||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||0x0020||-1||0x0000||0x397D||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x36F2||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||0x0020||-1||0x0000||0x3A63||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||0x0020||1||0x3517||0x3603||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||||0x0020||0||0x0000||0x39ED||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||Yes||0x2E32||2||0x3177||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||Yes||0x1DBD||6||0x1E25||0x1F3F||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||0x0020||-1||0x0000||0x2581||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||Yes||0x1C67||3||0x1CB7||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||Yes||0x1D12||2||0x1D62||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|19||0x13||Lava||0x6F||0x4E||||||Yes||||||0x0020||-1||0x0000||0x4155||3||L||Lava||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||0x0020||-1||0x0000||0x3EAF||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x3B5A||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x3F6C||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3E23||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||Yes||0x285B||1||0x2872||0x0010||3||X||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||Yes||0x2216||2||0x21D6||0x2192||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||Yes||0x17C3||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0xEB||0x02||Yes||Yes||||||||0x0020||3||0x09C1||0x014C||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||0x0020||1||0x07C3||0x014C||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||Yes||0x30FD||3||0x2EC2||0x312F||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||0x0020||3||0x25E8||0x27CF||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||Yes||0x1663||2||0x1811||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||Yes||0x3B8E||4||0x3C01||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||0x0020||2||0x016A||0x014C||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||0x0020||2||0x0284||0x014C||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||0x0020||2||0x0B31||0x014C||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||0x0020||2||0x1375||0x014C||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Floor||0xB0||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||F||Floor||Terrains:||||||||||||||0
|-
|48||0x30||Water N||0x1E||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||8||Water N||||||||||||||||0
|-
|49||0x31||Water S||0x1F||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||2||Water S||||||||||||||||0
|-
|50||0x32||Water W||0x11||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||4||Water W||||||||||||||||0
|-
|51||0x33||Water E||0x10||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||6||Water E||||||||||||||||0
|-
|52||0x34||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|54||0x36||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|55||0x37||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|56||0x38||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|57||0x39||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|58||0x3A||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|59||0x3B||Roton||0x94||0x0D||Yes||Yes||||||||0x0020||1||0x03A8||0x014C||4||R||Roton||Uglies:||Intelligence?||Switch Rate?||||||||||2
|-
|60||0x3C||Dragon Pup||0xED||0x04||Yes||Yes||||||Yes||0x05A3||2||0x0563||0x014C||4||D||Dragon Pup||||Intelligence?||Switch Rate?||||||||||1
|-
|61||0x3D||Pairer||0xE5||0x01||Yes||Yes||||||||0x0020||2||0x05E6||0x014C||4||P||Pairer||||Intelligence?||||||||||||2
|-
|62||0x3E||Spider||0x0F||Any (0xFF)||Yes||||||||||0x0020||1||0x06EB||0x014C||4||S||Spider||||Intelligence?||||||||||||3
|-
|63||0x3F||Web||0xC5||Any (0xFF)||||||Yes||Yes||Yes||0x17EA||-1||0x0000||0x0010||5||W||Web||||||||||||||||0
|-
|64||0x40||Stone||0x5A||0x0F||||||||||Yes||0x38A1||1||0x38C3||0x385E||5||Z||Stone||||||||||||||||0
|-
|65||0x41||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|66||0x42||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|67||0x43||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|68||0x44||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|69||0x45||Bullet||0xF8||0x0F||Yes||||||||||0x0020||1||0x13ED||0x014C||0||||Bullet||||||||||||||||0
|-
|70||0x46||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|71||0x47||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|72||0x48||Star||0x53||0x0F||||||||||Yes||0x22AE||1||0x233A||0x014C||0||||Star||||||||||||||||0
|-
|73||0x49||Text (Blue)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|74||0x4A||Text (Green)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|75||0x4B||Text (Cyan)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|76||0x4C||Text (Red)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|77||0x4D||Text (Purple)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|78||0x4E||Text (Brown)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|79||0x4F||Text (Black)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

== Credits ==

This file format was reverse engineered by [[User:SaxxonPike|SaxxonPike]], Kev Vance, WiL and David Hammond. If you find this information helpful in a project you're working on, please give credit where credit is due. (A link back to this wiki would be nice too!)

ZZT Format

2016-07-27T15:49:29Z

SaxxonPike: /* ZZT world header */ Clarification on unused values.

{{Playerdata Infobox
| Savegame = Yes
| Where = ?
| Elements = Ammo, gems, keys, scores, many others
| Games =
{{Game|ZZT}}
{{Game|Super ZZT}}
}}

A world file (.ZZT, .SZT) contains information about a game world, status of the player, and all its boards. Saved games (.SAV) are the same format as world files with a different extension and a different setting for the Lock byte.

While there are built-in editors for these games, they do not provide full editing functionality.

== Limits ==

ZZT and Super ZZT have limits imposed either by the game itself or by the data types used to store information about the world's contents.

{|class="wikitable"
!Limitation!!ZZT!!Super ZZT
|-
|Board count (including title screen)||101||33
|-
|Board size (in bytes)||32767||32767
|-
|Board size (in tiles)||60x25||96x80
|-
|Status Elements per board (including Player)||151||129
|-
|Flag strings||10||16
|}

Realistically, the original ZZT can only support boards up to around 20k due to the code itself. ZZT 4.0 by WiL, a hack of the original game executable, can support the full 32k.

== World Format ==

There are two formats for a world file. One is for ZZT and the other is for SuperZZT. The formats are very similar. All 8-bit (byte) values are unsigned. All 16-bit (short) values are signed. Boolean values (such as a player's keys) are represented with 0 for false and 1 for true; any other values may cause inconsistent behavior.

World Name is used by the game to determine which file to load after the player quits and restarts the game. Therefore if a world contains a world name that is actually the filename of another world, after the player quits and restarts the game, the world with the matching filename will be loaded!

There are some unused bytes after the world information that are ignored by the game. While it is safe to put any data whatsoever into this unused space, it is not saved back to disk by the game engine and will be converted to empty padding. [[ZZTAE]] is an editor that uses this space to store extra information such as the author and genre.

=== Common world information ===

The storage of this information is the same between the two formats. After this part of the file, the format will differ slightly.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF FF) and SuperZZT uses -2 (FE FF).
|-
|2||0x002||[[INT16LE]]||NumBoards Number of boards in the world, not including the title screen. Increment by 1 for the real number of stored boards. A value of 0 means only the title screen exists.
|-
|4||0x004||[[INT16LE]]||PlayerAmmo Player's ammunition.
|-
|6||0x006||[[INT16LE]]||PlayerGems Player's gems.
|-
|8||0x008||[[char]][7]||PlayerKeys Player's keys. A nonzero value means the player has the specified key. The keys are in this order: Blue, Green, Cyan, Red, Purple, Yellow, White.
|-
|15||0x00F||[[INT16LE]]||PlayerHealth Player's health.
|-
|17||0x011||[[INT16LE]]||PlayerBoard In a world file, this will be the starting board for the player (the title screen, board 0, is always shown first). In a saved game, this will be the board that the player is currently on.
|-
|}

=== ZZT world header ===

This is the second half of the header specific to a .ZZT file. After this information, storage of the boards starts at byte offset 512 (hex 0x200).

Only bytes through 279 (hex 0x117) are copied into memory. The rest of the bytes before board data are discarded upon saving.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||PlayerTorches Player's torches.
|-
|21||0x015||[[INT16LE]]||TorchCycles Game cycles left for a torch to remain lit.
|-
|23||0x017||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|25||0x019||[[INT16LE]]||(unused) This value is preserved but not used by the game engine.
|-
|27||0x01B||[[INT16LE]]||PlayerScore Player's score.
|-
|29||0x01D||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|30||0x01E||[[char]][20]||WorldName Internal name of the world.
|-
|50||0x032||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|51||0x033||[[char]][20]||Flag0 Name of Flag 0.
|-
|71||0x047||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|72||0x048||[[char]][20]||Flag1 Name of Flag 1.
|-
|92||0x05C||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|93||0x05D||[[char]][20]||Flag2 Name of Flag 2.
|-
|113||0x071||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|114||0x072||[[char]][20]||Flag3 Name of Flag 3.
|-
|134||0x086||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|135||0x087||[[char]][20]||Flag4 Name of Flag 4.
|-
|155||0x09B||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|156||0x09C||[[char]][20]||Flag5 Name of Flag 5.
|-
|176||0x0B0||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|177||0x0B1||[[char]][20]||Flag6 Name of Flag 6.
|-
|197||0x0C5||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|198||0x0C6||[[char]][20]||Flag7 Name of Flag 7.
|-
|218||0x0DA||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|219||0x0DB||[[char]][20]||Flag8 Name of Flag 8.
|-
|239||0x0EF||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|240||0x0F0||[[char]][20]||Flag9 Name of Flag 9.
|-
|260||0x104||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|262||0x106||[[INT16LE]]||TimePassedTicks This contains information about sub-seconds on time limited boards.
|-
|264||0x108||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|}

=== Super ZZT world header ===

This is the second half of the header specific to a .SZT file. After this information, storage of the boards starts at byte offset 1024 (hex 0x400).

Only bytes through 402 (hex 0x192) are copied into memory. The rest of the bytes before board data are discarded upon saving.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||(unused) Always 0.
|-
|21||0x015||[[INT16LE]]||PlayerScore Player's score.
|-
|23||0x017||[[INT16LE]]||(unused) Always 0.
|-
|25||0x019||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|27||0x01B||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|28||0x01C||[[char]][20]||WorldName Internal name of the world.
|-
|48||0x030||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|49||0x031||[[char]][20]||Flag0 Name of Flag 0.
|-
|69||0x045||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|70||0x046||[[char]][20]||Flag1 Name of Flag 1.
|-
|90||0x05A||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|91||0x05B||[[char]][20]||Flag2 Name of Flag 2.
|-
|111||0x06F||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|112||0x070||[[char]][20]||Flag3 Name of Flag 3.
|-
|132||0x084||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|133||0x085||[[char]][20]||Flag4 Name of Flag 4.
|-
|153||0x099||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|154||0x09A||[[char]][20]||Flag5 Name of Flag 5.
|-
|174||0x0AE||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|175||0x0AF||[[char]][20]||Flag6 Name of Flag 6.
|-
|195||0x0C3||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|196||0x0C4||[[char]][20]||Flag7 Name of Flag 7.
|-
|216||0x0D8||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|217||0x0D9||[[char]][20]||Flag8 Name of Flag 8.
|-
|237||0x0ED||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|238||0x0EE||[[char]][20]||Flag9 Name of Flag 9.
|-
|258||0x102||[[UINT8]]||Flag10Length Length of the name of Flag 10.
|-
|259||0x103||[[char]][20]||Flag10 Name of Flag 10.
|-
|279||0x117||[[UINT8]]||Flag11Length Length of the name of Flag 11.
|-
|280||0x118||[[char]][20]||Flag11 Name of Flag 11.
|-
|300||0x12C||[[UINT8]]||Flag12Length Length of the name of Flag 12.
|-
|301||0x12D||[[char]][20]||Flag12 Name of Flag 12.
|-
|321||0x141||[[UINT8]]||Flag13Length Length of the name of Flag 13.
|-
|322||0x142||[[char]][20]||Flag13 Name of Flag 13.
|-
|342||0x156||[[UINT8]]||Flag14Length Length of the name of Flag 14.
|-
|343||0x157||[[char]][20]||Flag14 Name of Flag 14.
|-
|363||0x16B||[[UINT8]]||Flag15Length Length of the name of Flag 15.
|-
|364||0x16C||[[char]][20]||Flag15 Name of Flag 15.
|-
|384||0x180||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|386||0x182||[[INT16LE]]||TimePassedTicks This contains information about sub-seconds on time limited boards.
|-
|388||0x184||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|389||0x185||[[INT16LE]]||PlayerStones Player's stones of power. If this value is negative, no information is shown in-game about them. If this value is >= 0, it uses a flag to describe this value in the status bar of the game. The flag used is the first one found that is preceded with a Z. "The Lost Forest" contains a flag called "ZSTONES" which shows as "STONES" on the status bar, for example.
|}

== Board Format ==

Boards can be stored individually in .BRD files. Since ZZT and Super ZZT use the same extension for boards and there is no world information stored with them, it isn't immediately apparent whether the board is a ZZT or a Super ZZT board. Testing the validity of the board information with both world types should be a good way to determine the type of world a board belongs to.

=== Format layout ===

Boards consist of 4 parts: Board Header, RLE Tiles, Board Properties, and Status Element Properties. Status Elements are elements on the board that the game actively processes - these include the player, enemies, any animating blocks, and Scrolls and Objects which can contain ZZT-OOP code.

=== ZZT board header ===

ZZT boards are 60x25 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes (excluding the two bytes from this value). Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][50]||BoardName Board's name.
|-
|53||0x035||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Super ZZT board header ===

Super ZZT boards are 96x80 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][60]||BoardName Board's name.
|-
|63||0x03F||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Run-length encoded tile data ===

Tile data is represented as sets of 3 bytes. These sets are repeated until the board is completely filled. For ZZT, this will be 60*25=1500 tiles. For SuperZZT, this will be 96*80=7680 tiles. The tiles are unpacked from left to right, top to bottom.

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Count Number of tiles.
|-
|[[UINT8]]||Element Element of the tiles.
|-
|[[UINT8]]||Color Color of the tiles.
|-
|}

A small quirk of this RLE format is when the number of tiles is set to zero. Due to the way the decoder is set up, a Count of 0 means there are actually 256 tiles encoded. The built-in editor does not encode tiles using this value despite being decoded correctly in the game, and it will probably crash some older external editors.

=== ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||IsDark When set to 1, the board is covered in darkness which can only be revealed by using a torch.
|-
|2||0x002||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|3||0x003||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|4||0x004||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|5||0x005||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|6||0x006||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|7||0x007||[[UINT8]]||MessageLength Length of the on-screen message.
|-
|8||0x008||[[char]][58]||Message On-screen message. This is used internally and is not loaded by the game.
|-
|66||0x042||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|67||0x043||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|68||0x044||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|70||0x046||[[UINT8]][16]||(unused)
|-
|86||0x056||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|-
|}

=== Super ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|2||0x002||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|3||0x003||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|4||0x004||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|5||0x005||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|6||0x006||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|7||0x007||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|8||0x008||[[INT16LE]]||CameraX X-coordinate of the viewport. This value is not used when loading worlds.
|-
|10||0x00A||[[INT16LE]]||CameraY Y-coordinate of the viewport. This value is not used when loading worlds.
|-
|12||0x00C||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|14||0x00E||[[UINT8]][14]||(unused)
|-
|28||0x01C||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|}

=== Status Elements ===

This follows directly after board properties. It is repeated for each Status Element. The first element stored is always the player-controlled element. This element may contain strange values for Step, Leader and Follower information - this is because these values are used internally by the game.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||LocationX X-coordinate. Location coordinates are 1-based, unlike any other coordinates in the file.
|-
|1||0x001||[[UINT8]]||LocationY Y-coordinate.
|-
|2||0x002||[[INT16LE]]||StepX X-step value. This pair of values represents a vector that typically points in one of the four cardinal directions. Its use differs for each type of element.
|-
|4||0x004||[[INT16LE]]||StepY Y-step value.
|-
|6||0x006||[[INT16LE]]||Cycle Cycle. This represents the frequency, in ticks, at which the game will process this status element.
|-
|8||0x008||[[UINT8]]||P1 Parameter 1. Its use will differ depending on the type of element.
|-
|9||0x009||[[UINT8]]||P2 Parameter 2. Its use will differ depending on the type of element.
|-
|10||0x00A||[[UINT8]]||P3 Parameter 3. Its use will differ depending on the type of element.
|-
|11||0x00B||[[INT16LE]]||Follower Follower status element. Its value determines if another status element is linked behind this one. Typically used for linking centipedes.
|-
|13||0x00D||[[INT16LE]]||Leader Leader status element. Its value determines if another status element is linked in front of this one. Typically used for linking centipedes.
|-
|15||0x00F||[[UINT8]]||UnderID Element of the tile under this status element.
|-
|16||0x010||[[UINT8]]||UnderColor Color of the tile under this status element.
|-
|17||0x011||[[INT32LE]]||Pointer Stores the location in memory of the code that this status element is using. Status elements typically point to their own code until they #BIND the code of another - in which case this memory location value is replaced with the new one. ZZT does not use this value when loading worlds, and always sets it to 0 when saving worlds.
|-
|21||0x015||[[INT16LE]]||CurrentInstruction The offset in bytes of the code block to execute ZZT-OOP from. Only Objects and Scrolls can execute ZZT-OOP.
|-
|23||0x017||[[INT16LE]]||Length There are two uses for this value: If this value is positive, it represents the number of bytes that are in the code block. If this value is negative, the absolute value of this value represents the Status Element number to copy code from. This saves space by removing redundant code duplication. Since code is shared in this way, all modifications to code will affect any other Status Elements using it.
|-
|}

In ZZT (not Super ZZT), 8 bytes of padding will follow.

If "Length" is positive, the code will be stored here.

== Element Lists ==

This is a list of all valid built-in elements that can be used. Using any elements outside this range produce undefined behavior which is dependent on whatever was residing in memory at the time the game was loaded. Most often, it will crash.

=== Element properties ===

These are all possible internal properties for each element. '''Note:''' The addresses shown are not really significant- you should only consider which ones share the same code to cut down on how many element behaviors to consider.

{|class="wikitable"
!Property!!Description
|-
|Id||Id number of the element
|-
|Hex||Hexidecimal representation of the Id number
|-
|Name||Known name of the element, which may not be present internally
|-
|Character||ASCII character for the default draw code, which may be ignored if special draw code is enabled
|-
|Color||Default color. If the color is 0xFE, then new tiles will be created with the primary color as the background and a white foreground. If the color is >= 0xF0, any primary color is allowed, but in the editor you can't choose the color unless the default color is 0xFF
|-
|Destructible||Element can be destroyed by bullets and by being crushed by puzzle pieces
|-
|Pushable||Element can be pushed. The NS/EW sliders are a special case in the code, so they will not be marked with this flag
|-
|Editor Floor||When using the editor, actors such as enemies can be placed on top of elements marked with this flag. Has no effect during gameplay.
|-
|Floor||Elements with this flag can freely be moved upon by actors
|-
|Shown||ZZT only. Elements marked with this flag will always be shown, even on dark boards
|-
|Special Draw||If this flag is set, the default draw code is bypassed with different draw code
|-
|Draw Code||Offset of the routine that performs the drawing, if Special Draw is set
|-
|Cycle||Default cycle. If this is -1, the element is not generated as an actor. Creatures will have cycles above zero
|-
|Act Code||Offset of the routine that performs standard behavior. For example: creature movement, bomb countdown
|-
|Interact Code||Offset of the routine that handles when a player touches the element. For example: item pickups, entering a passage
|-
|Menu#||Number of the editor menu where this element can be found
|-
|Key||Key press which is mapped to this element in the editor
|-
|Internal Name||Name of the element used in the editor. It is also used by OOP- the parser will remove all symbols and spaces and compare that
|-
|Category||When it comes time to display this element in the editor, if present, the category will be drawn in yellow first.
|-
|Edit P1||Text to show when editing the P1 of an actor that uses this element
|-
|Edit P2||Text to show when editing the P2 of an actor that uses this element
|-
|Edit P3||Text to show when editing the P3 of an actor that uses this element
|-
|Edit Board||Text to show when selecting the target board
|-
|Edit Step||Text to show when selecting the target direction
|-
|Edit Code||Text to show when editing an actor's code (scroll or object OOP)
|-
|Points||When an actor using this element is killed by the player, it's worth this much score
|-
|}

=== ZZT elements ===

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Shown!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3973||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x20||0x07||||||||||||||0x0020||1||0x4481||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||Yes||||0x0020||1||0x3E2F||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||||0x0020||-1||0x0000||0x3289||1||A||Ammo||||||||||||||||0
|-
|6||0x06||Torch||0x9D||0x06||||||||||Yes||||0x0020||-1||0x0000||0x37B6||1||T||Torch||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||||0x0020||-1||0x0000||0x3306||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x3169||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||||0x0020||-1||0x0000||0x33DA||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||||0x0020||1||0x2F9F||0x308B||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||Yes||||0x0020||0||0x0000||0x3372||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||||Yes||0x2A15||2||0x2BFF||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||||Yes||0x1872||6||0x18DA||0x19F3||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||||0x0020||-1||0x0000||0x2034||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||Star||0x53||0x0F||||||||||||Yes||0x1D5D||1||0x1DE9||0x00F5||0||||Star||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||||Yes||0x171C||3||0x176C||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||||Yes||0x17C7||2||0x1817||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||Bullet||0xF8||0x0F||Yes||||||||||||0x0020||1||0x0F65||0x00F5||0||||Bullet||||||||||||||||0
|-
|19||0x13||Water||0xB0||0xF9||||||Yes||||||||0x0020||-1||0x0000||0x3B03||3||W||Water||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||||0x0020||-1||0x0000||0x38D0||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x34E3||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||||0x0020||-1||0x0000||0x3949||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0xB0||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3848||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||||Yes||0x242E||1||0x2445||0x0010||3||L||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||||Yes||0x1CC5||2||0x1C85||0x1C41||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||||Yes||0x122A||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0x99||0x06||Yes||Yes||||||||||0x0020||3||0x054F||0x00F5||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||||0x0020||1||0x0351||0x00F5||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||||Yes||0x2B85||3||0x2AA5||0x2BB7||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||||0x0020||3||0x20AE||0x2295||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||Shark||0x5E||0x07||||||||||||||0x0020||3||0x2321||0x0010||2||Y||Shark||||Intelligence?||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||||Yes||0x11D0||2||0x12A7||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||||Yes||0x3517||4||0x358A||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||||0x0020||2||0x0113||0x00F5||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||||0x0020||2||0x022D||0x00F5||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||||0x0020||2||0x06BF||0x00F5||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||||0x0020||2||0x0EED||0x00F5||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Text (Blue)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|48||0x30||Text (Green)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|49||0x31||Text (Cyan)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|50||0x32||Text (Red)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|51||0x33||Text (Purple)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|52||0x34||Text (Brown)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||Text (Black)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

=== Super ZZT elements ===

Internal properties for each of these elements can be found in the [http://pastebin.com/mdEwu6Y1 Super ZZT Elements Pastebin].

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3FA5||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x02||0x1F||||Yes||||||||0x0020||1||0x4B76||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||||0x0020||1||0x4596||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||0x0020||-1||0x0000||0x37E7||1||A||Ammo||||||||||||||||0
|-
|6||0x06||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||0x0020||-1||0x0000||0x397D||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x36F2||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||0x0020||-1||0x0000||0x3A63||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||0x0020||1||0x3517||0x3603||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||||0x0020||0||0x0000||0x39ED||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||Yes||0x2E32||2||0x3177||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||Yes||0x1DBD||6||0x1E25||0x1F3F||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||0x0020||-1||0x0000||0x2581||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||Yes||0x1C67||3||0x1CB7||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||Yes||0x1D12||2||0x1D62||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|19||0x13||Lava||0x6F||0x4E||||||Yes||||||0x0020||-1||0x0000||0x4155||3||L||Lava||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||0x0020||-1||0x0000||0x3EAF||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x3B5A||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x3F6C||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3E23||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||Yes||0x285B||1||0x2872||0x0010||3||X||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||Yes||0x2216||2||0x21D6||0x2192||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||Yes||0x17C3||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0xEB||0x02||Yes||Yes||||||||0x0020||3||0x09C1||0x014C||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||0x0020||1||0x07C3||0x014C||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||Yes||0x30FD||3||0x2EC2||0x312F||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||0x0020||3||0x25E8||0x27CF||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||Yes||0x1663||2||0x1811||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||Yes||0x3B8E||4||0x3C01||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||0x0020||2||0x016A||0x014C||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||0x0020||2||0x0284||0x014C||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||0x0020||2||0x0B31||0x014C||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||0x0020||2||0x1375||0x014C||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Floor||0xB0||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||F||Floor||Terrains:||||||||||||||0
|-
|48||0x30||Water N||0x1E||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||8||Water N||||||||||||||||0
|-
|49||0x31||Water S||0x1F||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||2||Water S||||||||||||||||0
|-
|50||0x32||Water W||0x11||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||4||Water W||||||||||||||||0
|-
|51||0x33||Water E||0x10||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||6||Water E||||||||||||||||0
|-
|52||0x34||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|54||0x36||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|55||0x37||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|56||0x38||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|57||0x39||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|58||0x3A||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|59||0x3B||Roton||0x94||0x0D||Yes||Yes||||||||0x0020||1||0x03A8||0x014C||4||R||Roton||Uglies:||Intelligence?||Switch Rate?||||||||||2
|-
|60||0x3C||Dragon Pup||0xED||0x04||Yes||Yes||||||Yes||0x05A3||2||0x0563||0x014C||4||D||Dragon Pup||||Intelligence?||Switch Rate?||||||||||1
|-
|61||0x3D||Pairer||0xE5||0x01||Yes||Yes||||||||0x0020||2||0x05E6||0x014C||4||P||Pairer||||Intelligence?||||||||||||2
|-
|62||0x3E||Spider||0x0F||Any (0xFF)||Yes||||||||||0x0020||1||0x06EB||0x014C||4||S||Spider||||Intelligence?||||||||||||3
|-
|63||0x3F||Web||0xC5||Any (0xFF)||||||Yes||Yes||Yes||0x17EA||-1||0x0000||0x0010||5||W||Web||||||||||||||||0
|-
|64||0x40||Stone||0x5A||0x0F||||||||||Yes||0x38A1||1||0x38C3||0x385E||5||Z||Stone||||||||||||||||0
|-
|65||0x41||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|66||0x42||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|67||0x43||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|68||0x44||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|69||0x45||Bullet||0xF8||0x0F||Yes||||||||||0x0020||1||0x13ED||0x014C||0||||Bullet||||||||||||||||0
|-
|70||0x46||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|71||0x47||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|72||0x48||Star||0x53||0x0F||||||||||Yes||0x22AE||1||0x233A||0x014C||0||||Star||||||||||||||||0
|-
|73||0x49||Text (Blue)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|74||0x4A||Text (Green)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|75||0x4B||Text (Cyan)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|76||0x4C||Text (Red)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|77||0x4D||Text (Purple)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|78||0x4E||Text (Brown)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|79||0x4F||Text (Black)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

== Credits ==

This file format was reverse engineered by [[User:SaxxonPike|SaxxonPike]], Kev Vance, WiL and David Hammond. If you find this information helpful in a project you're working on, please give credit where credit is due. (A link back to this wiki would be nice too!)

ZZT Format

2016-07-27T15:47:17Z

SaxxonPike: /* ZZT world header */ Add header preservation information.

{{Playerdata Infobox
| Savegame = Yes
| Where = ?
| Elements = Ammo, gems, keys, scores, many others
| Games =
{{Game|ZZT}}
{{Game|Super ZZT}}
}}

A world file (.ZZT, .SZT) contains information about a game world, status of the player, and all its boards. Saved games (.SAV) are the same format as world files with a different extension and a different setting for the Lock byte.

While there are built-in editors for these games, they do not provide full editing functionality.

== Limits ==

ZZT and Super ZZT have limits imposed either by the game itself or by the data types used to store information about the world's contents.

{|class="wikitable"
!Limitation!!ZZT!!Super ZZT
|-
|Board count (including title screen)||101||33
|-
|Board size (in bytes)||32767||32767
|-
|Board size (in tiles)||60x25||96x80
|-
|Status Elements per board (including Player)||151||129
|-
|Flag strings||10||16
|}

Realistically, the original ZZT can only support boards up to around 20k due to the code itself. ZZT 4.0 by WiL, a hack of the original game executable, can support the full 32k.

== World Format ==

There are two formats for a world file. One is for ZZT and the other is for SuperZZT. The formats are very similar. All 8-bit (byte) values are unsigned. All 16-bit (short) values are signed. Boolean values (such as a player's keys) are represented with 0 for false and 1 for true; any other values may cause inconsistent behavior.

World Name is used by the game to determine which file to load after the player quits and restarts the game. Therefore if a world contains a world name that is actually the filename of another world, after the player quits and restarts the game, the world with the matching filename will be loaded!

There are some unused bytes after the world information that are ignored by the game. While it is safe to put any data whatsoever into this unused space, it is not saved back to disk by the game engine and will be converted to empty padding. [[ZZTAE]] is an editor that uses this space to store extra information such as the author and genre.

=== Common world information ===

The storage of this information is the same between the two formats. After this part of the file, the format will differ slightly.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF FF) and SuperZZT uses -2 (FE FF).
|-
|2||0x002||[[INT16LE]]||NumBoards Number of boards in the world, not including the title screen. Increment by 1 for the real number of stored boards. A value of 0 means only the title screen exists.
|-
|4||0x004||[[INT16LE]]||PlayerAmmo Player's ammunition.
|-
|6||0x006||[[INT16LE]]||PlayerGems Player's gems.
|-
|8||0x008||[[char]][7]||PlayerKeys Player's keys. A nonzero value means the player has the specified key. The keys are in this order: Blue, Green, Cyan, Red, Purple, Yellow, White.
|-
|15||0x00F||[[INT16LE]]||PlayerHealth Player's health.
|-
|17||0x011||[[INT16LE]]||PlayerBoard In a world file, this will be the starting board for the player (the title screen, board 0, is always shown first). In a saved game, this will be the board that the player is currently on.
|-
|}

=== ZZT world header ===

This is the second half of the header specific to a .ZZT file. After this information, storage of the boards starts at byte offset 512 (hex 0x200).

Only bytes through 279 (hex 0x117) are copied into memory. The rest of the bytes before board data are discarded upon saving.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||PlayerTorches Player's torches.
|-
|21||0x015||[[INT16LE]]||TorchCycles Game cycles left for a torch to remain lit.
|-
|23||0x017||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|25||0x019||[[INT16LE]]||(unused) Always 0.
|-
|27||0x01B||[[INT16LE]]||PlayerScore Player's score.
|-
|29||0x01D||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|30||0x01E||[[char]][20]||WorldName Internal name of the world.
|-
|50||0x032||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|51||0x033||[[char]][20]||Flag0 Name of Flag 0.
|-
|71||0x047||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|72||0x048||[[char]][20]||Flag1 Name of Flag 1.
|-
|92||0x05C||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|93||0x05D||[[char]][20]||Flag2 Name of Flag 2.
|-
|113||0x071||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|114||0x072||[[char]][20]||Flag3 Name of Flag 3.
|-
|134||0x086||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|135||0x087||[[char]][20]||Flag4 Name of Flag 4.
|-
|155||0x09B||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|156||0x09C||[[char]][20]||Flag5 Name of Flag 5.
|-
|176||0x0B0||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|177||0x0B1||[[char]][20]||Flag6 Name of Flag 6.
|-
|197||0x0C5||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|198||0x0C6||[[char]][20]||Flag7 Name of Flag 7.
|-
|218||0x0DA||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|219||0x0DB||[[char]][20]||Flag8 Name of Flag 8.
|-
|239||0x0EF||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|240||0x0F0||[[char]][20]||Flag9 Name of Flag 9.
|-
|260||0x104||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|262||0x106||[[INT16LE]]||TimePassedTicks This contains information about sub-seconds on time limited boards.
|-
|264||0x108||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|}

=== Super ZZT world header ===

This is the second half of the header specific to a .SZT file. After this information, storage of the boards starts at byte offset 1024 (hex 0x400).

Only bytes through 402 (hex 0x192) are copied into memory. The rest of the bytes before board data are discarded upon saving.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||(unused) Always 0.
|-
|21||0x015||[[INT16LE]]||PlayerScore Player's score.
|-
|23||0x017||[[INT16LE]]||(unused) Always 0.
|-
|25||0x019||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|27||0x01B||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|28||0x01C||[[char]][20]||WorldName Internal name of the world.
|-
|48||0x030||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|49||0x031||[[char]][20]||Flag0 Name of Flag 0.
|-
|69||0x045||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|70||0x046||[[char]][20]||Flag1 Name of Flag 1.
|-
|90||0x05A||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|91||0x05B||[[char]][20]||Flag2 Name of Flag 2.
|-
|111||0x06F||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|112||0x070||[[char]][20]||Flag3 Name of Flag 3.
|-
|132||0x084||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|133||0x085||[[char]][20]||Flag4 Name of Flag 4.
|-
|153||0x099||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|154||0x09A||[[char]][20]||Flag5 Name of Flag 5.
|-
|174||0x0AE||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|175||0x0AF||[[char]][20]||Flag6 Name of Flag 6.
|-
|195||0x0C3||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|196||0x0C4||[[char]][20]||Flag7 Name of Flag 7.
|-
|216||0x0D8||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|217||0x0D9||[[char]][20]||Flag8 Name of Flag 8.
|-
|237||0x0ED||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|238||0x0EE||[[char]][20]||Flag9 Name of Flag 9.
|-
|258||0x102||[[UINT8]]||Flag10Length Length of the name of Flag 10.
|-
|259||0x103||[[char]][20]||Flag10 Name of Flag 10.
|-
|279||0x117||[[UINT8]]||Flag11Length Length of the name of Flag 11.
|-
|280||0x118||[[char]][20]||Flag11 Name of Flag 11.
|-
|300||0x12C||[[UINT8]]||Flag12Length Length of the name of Flag 12.
|-
|301||0x12D||[[char]][20]||Flag12 Name of Flag 12.
|-
|321||0x141||[[UINT8]]||Flag13Length Length of the name of Flag 13.
|-
|322||0x142||[[char]][20]||Flag13 Name of Flag 13.
|-
|342||0x156||[[UINT8]]||Flag14Length Length of the name of Flag 14.
|-
|343||0x157||[[char]][20]||Flag14 Name of Flag 14.
|-
|363||0x16B||[[UINT8]]||Flag15Length Length of the name of Flag 15.
|-
|364||0x16C||[[char]][20]||Flag15 Name of Flag 15.
|-
|384||0x180||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|386||0x182||[[INT16LE]]||TimePassedTicks This contains information about sub-seconds on time limited boards.
|-
|388||0x184||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|389||0x185||[[INT16LE]]||PlayerStones Player's stones of power. If this value is negative, no information is shown in-game about them. If this value is >= 0, it uses a flag to describe this value in the status bar of the game. The flag used is the first one found that is preceded with a Z. "The Lost Forest" contains a flag called "ZSTONES" which shows as "STONES" on the status bar, for example.
|}

== Board Format ==

Boards can be stored individually in .BRD files. Since ZZT and Super ZZT use the same extension for boards and there is no world information stored with them, it isn't immediately apparent whether the board is a ZZT or a Super ZZT board. Testing the validity of the board information with both world types should be a good way to determine the type of world a board belongs to.

=== Format layout ===

Boards consist of 4 parts: Board Header, RLE Tiles, Board Properties, and Status Element Properties. Status Elements are elements on the board that the game actively processes - these include the player, enemies, any animating blocks, and Scrolls and Objects which can contain ZZT-OOP code.

=== ZZT board header ===

ZZT boards are 60x25 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes (excluding the two bytes from this value). Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][50]||BoardName Board's name.
|-
|53||0x035||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Super ZZT board header ===

Super ZZT boards are 96x80 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][60]||BoardName Board's name.
|-
|63||0x03F||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Run-length encoded tile data ===

Tile data is represented as sets of 3 bytes. These sets are repeated until the board is completely filled. For ZZT, this will be 60*25=1500 tiles. For SuperZZT, this will be 96*80=7680 tiles. The tiles are unpacked from left to right, top to bottom.

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Count Number of tiles.
|-
|[[UINT8]]||Element Element of the tiles.
|-
|[[UINT8]]||Color Color of the tiles.
|-
|}

A small quirk of this RLE format is when the number of tiles is set to zero. Due to the way the decoder is set up, a Count of 0 means there are actually 256 tiles encoded. The built-in editor does not encode tiles using this value despite being decoded correctly in the game, and it will probably crash some older external editors.

=== ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||IsDark When set to 1, the board is covered in darkness which can only be revealed by using a torch.
|-
|2||0x002||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|3||0x003||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|4||0x004||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|5||0x005||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|6||0x006||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|7||0x007||[[UINT8]]||MessageLength Length of the on-screen message.
|-
|8||0x008||[[char]][58]||Message On-screen message. This is used internally and is not loaded by the game.
|-
|66||0x042||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|67||0x043||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|68||0x044||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|70||0x046||[[UINT8]][16]||(unused)
|-
|86||0x056||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|-
|}

=== Super ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|2||0x002||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|3||0x003||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|4||0x004||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|5||0x005||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|6||0x006||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|7||0x007||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|8||0x008||[[INT16LE]]||CameraX X-coordinate of the viewport. This value is not used when loading worlds.
|-
|10||0x00A||[[INT16LE]]||CameraY Y-coordinate of the viewport. This value is not used when loading worlds.
|-
|12||0x00C||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|14||0x00E||[[UINT8]][14]||(unused)
|-
|28||0x01C||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|}

=== Status Elements ===

This follows directly after board properties. It is repeated for each Status Element. The first element stored is always the player-controlled element. This element may contain strange values for Step, Leader and Follower information - this is because these values are used internally by the game.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||LocationX X-coordinate. Location coordinates are 1-based, unlike any other coordinates in the file.
|-
|1||0x001||[[UINT8]]||LocationY Y-coordinate.
|-
|2||0x002||[[INT16LE]]||StepX X-step value. This pair of values represents a vector that typically points in one of the four cardinal directions. Its use differs for each type of element.
|-
|4||0x004||[[INT16LE]]||StepY Y-step value.
|-
|6||0x006||[[INT16LE]]||Cycle Cycle. This represents the frequency, in ticks, at which the game will process this status element.
|-
|8||0x008||[[UINT8]]||P1 Parameter 1. Its use will differ depending on the type of element.
|-
|9||0x009||[[UINT8]]||P2 Parameter 2. Its use will differ depending on the type of element.
|-
|10||0x00A||[[UINT8]]||P3 Parameter 3. Its use will differ depending on the type of element.
|-
|11||0x00B||[[INT16LE]]||Follower Follower status element. Its value determines if another status element is linked behind this one. Typically used for linking centipedes.
|-
|13||0x00D||[[INT16LE]]||Leader Leader status element. Its value determines if another status element is linked in front of this one. Typically used for linking centipedes.
|-
|15||0x00F||[[UINT8]]||UnderID Element of the tile under this status element.
|-
|16||0x010||[[UINT8]]||UnderColor Color of the tile under this status element.
|-
|17||0x011||[[INT32LE]]||Pointer Stores the location in memory of the code that this status element is using. Status elements typically point to their own code until they #BIND the code of another - in which case this memory location value is replaced with the new one. ZZT does not use this value when loading worlds, and always sets it to 0 when saving worlds.
|-
|21||0x015||[[INT16LE]]||CurrentInstruction The offset in bytes of the code block to execute ZZT-OOP from. Only Objects and Scrolls can execute ZZT-OOP.
|-
|23||0x017||[[INT16LE]]||Length There are two uses for this value: If this value is positive, it represents the number of bytes that are in the code block. If this value is negative, the absolute value of this value represents the Status Element number to copy code from. This saves space by removing redundant code duplication. Since code is shared in this way, all modifications to code will affect any other Status Elements using it.
|-
|}

In ZZT (not Super ZZT), 8 bytes of padding will follow.

If "Length" is positive, the code will be stored here.

== Element Lists ==

This is a list of all valid built-in elements that can be used. Using any elements outside this range produce undefined behavior which is dependent on whatever was residing in memory at the time the game was loaded. Most often, it will crash.

=== Element properties ===

These are all possible internal properties for each element. '''Note:''' The addresses shown are not really significant- you should only consider which ones share the same code to cut down on how many element behaviors to consider.

{|class="wikitable"
!Property!!Description
|-
|Id||Id number of the element
|-
|Hex||Hexidecimal representation of the Id number
|-
|Name||Known name of the element, which may not be present internally
|-
|Character||ASCII character for the default draw code, which may be ignored if special draw code is enabled
|-
|Color||Default color. If the color is 0xFE, then new tiles will be created with the primary color as the background and a white foreground. If the color is >= 0xF0, any primary color is allowed, but in the editor you can't choose the color unless the default color is 0xFF
|-
|Destructible||Element can be destroyed by bullets and by being crushed by puzzle pieces
|-
|Pushable||Element can be pushed. The NS/EW sliders are a special case in the code, so they will not be marked with this flag
|-
|Editor Floor||When using the editor, actors such as enemies can be placed on top of elements marked with this flag. Has no effect during gameplay.
|-
|Floor||Elements with this flag can freely be moved upon by actors
|-
|Shown||ZZT only. Elements marked with this flag will always be shown, even on dark boards
|-
|Special Draw||If this flag is set, the default draw code is bypassed with different draw code
|-
|Draw Code||Offset of the routine that performs the drawing, if Special Draw is set
|-
|Cycle||Default cycle. If this is -1, the element is not generated as an actor. Creatures will have cycles above zero
|-
|Act Code||Offset of the routine that performs standard behavior. For example: creature movement, bomb countdown
|-
|Interact Code||Offset of the routine that handles when a player touches the element. For example: item pickups, entering a passage
|-
|Menu#||Number of the editor menu where this element can be found
|-
|Key||Key press which is mapped to this element in the editor
|-
|Internal Name||Name of the element used in the editor. It is also used by OOP- the parser will remove all symbols and spaces and compare that
|-
|Category||When it comes time to display this element in the editor, if present, the category will be drawn in yellow first.
|-
|Edit P1||Text to show when editing the P1 of an actor that uses this element
|-
|Edit P2||Text to show when editing the P2 of an actor that uses this element
|-
|Edit P3||Text to show when editing the P3 of an actor that uses this element
|-
|Edit Board||Text to show when selecting the target board
|-
|Edit Step||Text to show when selecting the target direction
|-
|Edit Code||Text to show when editing an actor's code (scroll or object OOP)
|-
|Points||When an actor using this element is killed by the player, it's worth this much score
|-
|}

=== ZZT elements ===

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Shown!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3973||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x20||0x07||||||||||||||0x0020||1||0x4481||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||Yes||||0x0020||1||0x3E2F||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||||0x0020||-1||0x0000||0x3289||1||A||Ammo||||||||||||||||0
|-
|6||0x06||Torch||0x9D||0x06||||||||||Yes||||0x0020||-1||0x0000||0x37B6||1||T||Torch||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||||0x0020||-1||0x0000||0x3306||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x3169||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||||0x0020||-1||0x0000||0x33DA||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||||0x0020||1||0x2F9F||0x308B||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||Yes||||0x0020||0||0x0000||0x3372||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||||Yes||0x2A15||2||0x2BFF||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||||Yes||0x1872||6||0x18DA||0x19F3||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||||0x0020||-1||0x0000||0x2034||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||Star||0x53||0x0F||||||||||||Yes||0x1D5D||1||0x1DE9||0x00F5||0||||Star||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||||Yes||0x171C||3||0x176C||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||||Yes||0x17C7||2||0x1817||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||Bullet||0xF8||0x0F||Yes||||||||||||0x0020||1||0x0F65||0x00F5||0||||Bullet||||||||||||||||0
|-
|19||0x13||Water||0xB0||0xF9||||||Yes||||||||0x0020||-1||0x0000||0x3B03||3||W||Water||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||||0x0020||-1||0x0000||0x38D0||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x34E3||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||||0x0020||-1||0x0000||0x3949||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0xB0||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3848||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||||Yes||0x242E||1||0x2445||0x0010||3||L||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||||Yes||0x1CC5||2||0x1C85||0x1C41||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||||Yes||0x122A||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0x99||0x06||Yes||Yes||||||||||0x0020||3||0x054F||0x00F5||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||||0x0020||1||0x0351||0x00F5||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||||Yes||0x2B85||3||0x2AA5||0x2BB7||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||||0x0020||3||0x20AE||0x2295||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||Shark||0x5E||0x07||||||||||||||0x0020||3||0x2321||0x0010||2||Y||Shark||||Intelligence?||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||||Yes||0x11D0||2||0x12A7||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||||Yes||0x3517||4||0x358A||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||||0x0020||2||0x0113||0x00F5||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||||0x0020||2||0x022D||0x00F5||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||||0x0020||2||0x06BF||0x00F5||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||||0x0020||2||0x0EED||0x00F5||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Text (Blue)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|48||0x30||Text (Green)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|49||0x31||Text (Cyan)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|50||0x32||Text (Red)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|51||0x33||Text (Purple)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|52||0x34||Text (Brown)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||Text (Black)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

=== Super ZZT elements ===

Internal properties for each of these elements can be found in the [http://pastebin.com/mdEwu6Y1 Super ZZT Elements Pastebin].

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3FA5||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x02||0x1F||||Yes||||||||0x0020||1||0x4B76||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||||0x0020||1||0x4596||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||0x0020||-1||0x0000||0x37E7||1||A||Ammo||||||||||||||||0
|-
|6||0x06||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||0x0020||-1||0x0000||0x397D||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x36F2||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||0x0020||-1||0x0000||0x3A63||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||0x0020||1||0x3517||0x3603||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||||0x0020||0||0x0000||0x39ED||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||Yes||0x2E32||2||0x3177||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||Yes||0x1DBD||6||0x1E25||0x1F3F||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||0x0020||-1||0x0000||0x2581||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||Yes||0x1C67||3||0x1CB7||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||Yes||0x1D12||2||0x1D62||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|19||0x13||Lava||0x6F||0x4E||||||Yes||||||0x0020||-1||0x0000||0x4155||3||L||Lava||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||0x0020||-1||0x0000||0x3EAF||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x3B5A||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x3F6C||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3E23||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||Yes||0x285B||1||0x2872||0x0010||3||X||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||Yes||0x2216||2||0x21D6||0x2192||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||Yes||0x17C3||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0xEB||0x02||Yes||Yes||||||||0x0020||3||0x09C1||0x014C||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||0x0020||1||0x07C3||0x014C||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||Yes||0x30FD||3||0x2EC2||0x312F||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||0x0020||3||0x25E8||0x27CF||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||Yes||0x1663||2||0x1811||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||Yes||0x3B8E||4||0x3C01||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||0x0020||2||0x016A||0x014C||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||0x0020||2||0x0284||0x014C||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||0x0020||2||0x0B31||0x014C||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||0x0020||2||0x1375||0x014C||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Floor||0xB0||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||F||Floor||Terrains:||||||||||||||0
|-
|48||0x30||Water N||0x1E||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||8||Water N||||||||||||||||0
|-
|49||0x31||Water S||0x1F||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||2||Water S||||||||||||||||0
|-
|50||0x32||Water W||0x11||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||4||Water W||||||||||||||||0
|-
|51||0x33||Water E||0x10||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||6||Water E||||||||||||||||0
|-
|52||0x34||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|54||0x36||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|55||0x37||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|56||0x38||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|57||0x39||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|58||0x3A||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|59||0x3B||Roton||0x94||0x0D||Yes||Yes||||||||0x0020||1||0x03A8||0x014C||4||R||Roton||Uglies:||Intelligence?||Switch Rate?||||||||||2
|-
|60||0x3C||Dragon Pup||0xED||0x04||Yes||Yes||||||Yes||0x05A3||2||0x0563||0x014C||4||D||Dragon Pup||||Intelligence?||Switch Rate?||||||||||1
|-
|61||0x3D||Pairer||0xE5||0x01||Yes||Yes||||||||0x0020||2||0x05E6||0x014C||4||P||Pairer||||Intelligence?||||||||||||2
|-
|62||0x3E||Spider||0x0F||Any (0xFF)||Yes||||||||||0x0020||1||0x06EB||0x014C||4||S||Spider||||Intelligence?||||||||||||3
|-
|63||0x3F||Web||0xC5||Any (0xFF)||||||Yes||Yes||Yes||0x17EA||-1||0x0000||0x0010||5||W||Web||||||||||||||||0
|-
|64||0x40||Stone||0x5A||0x0F||||||||||Yes||0x38A1||1||0x38C3||0x385E||5||Z||Stone||||||||||||||||0
|-
|65||0x41||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|66||0x42||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|67||0x43||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|68||0x44||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|69||0x45||Bullet||0xF8||0x0F||Yes||||||||||0x0020||1||0x13ED||0x014C||0||||Bullet||||||||||||||||0
|-
|70||0x46||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|71||0x47||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|72||0x48||Star||0x53||0x0F||||||||||Yes||0x22AE||1||0x233A||0x014C||0||||Star||||||||||||||||0
|-
|73||0x49||Text (Blue)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|74||0x4A||Text (Green)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|75||0x4B||Text (Cyan)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|76||0x4C||Text (Red)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|77||0x4D||Text (Purple)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|78||0x4E||Text (Brown)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|79||0x4F||Text (Black)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

== Credits ==

This file format was reverse engineered by [[User:SaxxonPike|SaxxonPike]], Kev Vance, WiL and David Hammond. If you find this information helpful in a project you're working on, please give credit where credit is due. (A link back to this wiki would be nice too!)

ZZT Format

2016-07-27T15:44:31Z

SaxxonPike: /* Super ZZT world header */ Add more information about preserved bytes.

{{Playerdata Infobox
| Savegame = Yes
| Where = ?
| Elements = Ammo, gems, keys, scores, many others
| Games =
{{Game|ZZT}}
{{Game|Super ZZT}}
}}

A world file (.ZZT, .SZT) contains information about a game world, status of the player, and all its boards. Saved games (.SAV) are the same format as world files with a different extension and a different setting for the Lock byte.

While there are built-in editors for these games, they do not provide full editing functionality.

== Limits ==

ZZT and Super ZZT have limits imposed either by the game itself or by the data types used to store information about the world's contents.

{|class="wikitable"
!Limitation!!ZZT!!Super ZZT
|-
|Board count (including title screen)||101||33
|-
|Board size (in bytes)||32767||32767
|-
|Board size (in tiles)||60x25||96x80
|-
|Status Elements per board (including Player)||151||129
|-
|Flag strings||10||16
|}

Realistically, the original ZZT can only support boards up to around 20k due to the code itself. ZZT 4.0 by WiL, a hack of the original game executable, can support the full 32k.

== World Format ==

There are two formats for a world file. One is for ZZT and the other is for SuperZZT. The formats are very similar. All 8-bit (byte) values are unsigned. All 16-bit (short) values are signed. Boolean values (such as a player's keys) are represented with 0 for false and 1 for true; any other values may cause inconsistent behavior.

World Name is used by the game to determine which file to load after the player quits and restarts the game. Therefore if a world contains a world name that is actually the filename of another world, after the player quits and restarts the game, the world with the matching filename will be loaded!

There are some unused bytes after the world information that are ignored by the game. While it is safe to put any data whatsoever into this unused space, it is not saved back to disk by the game engine and will be converted to empty padding. [[ZZTAE]] is an editor that uses this space to store extra information such as the author and genre.

=== Common world information ===

The storage of this information is the same between the two formats. After this part of the file, the format will differ slightly.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF FF) and SuperZZT uses -2 (FE FF).
|-
|2||0x002||[[INT16LE]]||NumBoards Number of boards in the world, not including the title screen. Increment by 1 for the real number of stored boards. A value of 0 means only the title screen exists.
|-
|4||0x004||[[INT16LE]]||PlayerAmmo Player's ammunition.
|-
|6||0x006||[[INT16LE]]||PlayerGems Player's gems.
|-
|8||0x008||[[char]][7]||PlayerKeys Player's keys. A nonzero value means the player has the specified key. The keys are in this order: Blue, Green, Cyan, Red, Purple, Yellow, White.
|-
|15||0x00F||[[INT16LE]]||PlayerHealth Player's health.
|-
|17||0x011||[[INT16LE]]||PlayerBoard In a world file, this will be the starting board for the player (the title screen, board 0, is always shown first). In a saved game, this will be the board that the player is currently on.
|-
|}

=== ZZT world header ===

This is the second half of the header specific to a .ZZT file. After this information, storage of the boards starts at byte offset 512 (hex 0x200).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||PlayerTorches Player's torches.
|-
|21||0x015||[[INT16LE]]||TorchCycles Game cycles left for a torch to remain lit.
|-
|23||0x017||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|25||0x019||[[INT16LE]]||(unused) Always 0.
|-
|27||0x01B||[[INT16LE]]||PlayerScore Player's score.
|-
|29||0x01D||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|30||0x01E||[[char]][20]||WorldName Internal name of the world.
|-
|50||0x032||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|51||0x033||[[char]][20]||Flag0 Name of Flag 0.
|-
|71||0x047||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|72||0x048||[[char]][20]||Flag1 Name of Flag 1.
|-
|92||0x05C||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|93||0x05D||[[char]][20]||Flag2 Name of Flag 2.
|-
|113||0x071||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|114||0x072||[[char]][20]||Flag3 Name of Flag 3.
|-
|134||0x086||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|135||0x087||[[char]][20]||Flag4 Name of Flag 4.
|-
|155||0x09B||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|156||0x09C||[[char]][20]||Flag5 Name of Flag 5.
|-
|176||0x0B0||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|177||0x0B1||[[char]][20]||Flag6 Name of Flag 6.
|-
|197||0x0C5||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|198||0x0C6||[[char]][20]||Flag7 Name of Flag 7.
|-
|218||0x0DA||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|219||0x0DB||[[char]][20]||Flag8 Name of Flag 8.
|-
|239||0x0EF||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|240||0x0F0||[[char]][20]||Flag9 Name of Flag 9.
|-
|260||0x104||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|262||0x106||[[INT16LE]]||TimePassedTicks This contains information about sub-seconds on time limited boards.
|-
|264||0x108||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|}

=== Super ZZT world header ===

This is the second half of the header specific to a .SZT file. After this information, storage of the boards starts at byte offset 1024 (hex 0x400).

Only bytes through 402 (hex 0x192) are copied into memory. The rest of the bytes before board data are discarded upon saving.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||(unused) Always 0.
|-
|21||0x015||[[INT16LE]]||PlayerScore Player's score.
|-
|23||0x017||[[INT16LE]]||(unused) Always 0.
|-
|25||0x019||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|27||0x01B||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|28||0x01C||[[char]][20]||WorldName Internal name of the world.
|-
|48||0x030||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|49||0x031||[[char]][20]||Flag0 Name of Flag 0.
|-
|69||0x045||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|70||0x046||[[char]][20]||Flag1 Name of Flag 1.
|-
|90||0x05A||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|91||0x05B||[[char]][20]||Flag2 Name of Flag 2.
|-
|111||0x06F||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|112||0x070||[[char]][20]||Flag3 Name of Flag 3.
|-
|132||0x084||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|133||0x085||[[char]][20]||Flag4 Name of Flag 4.
|-
|153||0x099||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|154||0x09A||[[char]][20]||Flag5 Name of Flag 5.
|-
|174||0x0AE||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|175||0x0AF||[[char]][20]||Flag6 Name of Flag 6.
|-
|195||0x0C3||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|196||0x0C4||[[char]][20]||Flag7 Name of Flag 7.
|-
|216||0x0D8||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|217||0x0D9||[[char]][20]||Flag8 Name of Flag 8.
|-
|237||0x0ED||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|238||0x0EE||[[char]][20]||Flag9 Name of Flag 9.
|-
|258||0x102||[[UINT8]]||Flag10Length Length of the name of Flag 10.
|-
|259||0x103||[[char]][20]||Flag10 Name of Flag 10.
|-
|279||0x117||[[UINT8]]||Flag11Length Length of the name of Flag 11.
|-
|280||0x118||[[char]][20]||Flag11 Name of Flag 11.
|-
|300||0x12C||[[UINT8]]||Flag12Length Length of the name of Flag 12.
|-
|301||0x12D||[[char]][20]||Flag12 Name of Flag 12.
|-
|321||0x141||[[UINT8]]||Flag13Length Length of the name of Flag 13.
|-
|322||0x142||[[char]][20]||Flag13 Name of Flag 13.
|-
|342||0x156||[[UINT8]]||Flag14Length Length of the name of Flag 14.
|-
|343||0x157||[[char]][20]||Flag14 Name of Flag 14.
|-
|363||0x16B||[[UINT8]]||Flag15Length Length of the name of Flag 15.
|-
|364||0x16C||[[char]][20]||Flag15 Name of Flag 15.
|-
|384||0x180||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|386||0x182||[[INT16LE]]||TimePassedTicks This contains information about sub-seconds on time limited boards.
|-
|388||0x184||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|389||0x185||[[INT16LE]]||PlayerStones Player's stones of power. If this value is negative, no information is shown in-game about them. If this value is >= 0, it uses a flag to describe this value in the status bar of the game. The flag used is the first one found that is preceded with a Z. "The Lost Forest" contains a flag called "ZSTONES" which shows as "STONES" on the status bar, for example.
|}

== Board Format ==

Boards can be stored individually in .BRD files. Since ZZT and Super ZZT use the same extension for boards and there is no world information stored with them, it isn't immediately apparent whether the board is a ZZT or a Super ZZT board. Testing the validity of the board information with both world types should be a good way to determine the type of world a board belongs to.

=== Format layout ===

Boards consist of 4 parts: Board Header, RLE Tiles, Board Properties, and Status Element Properties. Status Elements are elements on the board that the game actively processes - these include the player, enemies, any animating blocks, and Scrolls and Objects which can contain ZZT-OOP code.

=== ZZT board header ===

ZZT boards are 60x25 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes (excluding the two bytes from this value). Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][50]||BoardName Board's name.
|-
|53||0x035||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Super ZZT board header ===

Super ZZT boards are 96x80 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][60]||BoardName Board's name.
|-
|63||0x03F||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Run-length encoded tile data ===

Tile data is represented as sets of 3 bytes. These sets are repeated until the board is completely filled. For ZZT, this will be 60*25=1500 tiles. For SuperZZT, this will be 96*80=7680 tiles. The tiles are unpacked from left to right, top to bottom.

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Count Number of tiles.
|-
|[[UINT8]]||Element Element of the tiles.
|-
|[[UINT8]]||Color Color of the tiles.
|-
|}

A small quirk of this RLE format is when the number of tiles is set to zero. Due to the way the decoder is set up, a Count of 0 means there are actually 256 tiles encoded. The built-in editor does not encode tiles using this value despite being decoded correctly in the game, and it will probably crash some older external editors.

=== ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||IsDark When set to 1, the board is covered in darkness which can only be revealed by using a torch.
|-
|2||0x002||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|3||0x003||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|4||0x004||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|5||0x005||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|6||0x006||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|7||0x007||[[UINT8]]||MessageLength Length of the on-screen message.
|-
|8||0x008||[[char]][58]||Message On-screen message. This is used internally and is not loaded by the game.
|-
|66||0x042||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|67||0x043||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|68||0x044||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|70||0x046||[[UINT8]][16]||(unused)
|-
|86||0x056||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|-
|}

=== Super ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|2||0x002||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|3||0x003||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|4||0x004||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|5||0x005||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|6||0x006||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|7||0x007||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|8||0x008||[[INT16LE]]||CameraX X-coordinate of the viewport. This value is not used when loading worlds.
|-
|10||0x00A||[[INT16LE]]||CameraY Y-coordinate of the viewport. This value is not used when loading worlds.
|-
|12||0x00C||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|14||0x00E||[[UINT8]][14]||(unused)
|-
|28||0x01C||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|}

=== Status Elements ===

This follows directly after board properties. It is repeated for each Status Element. The first element stored is always the player-controlled element. This element may contain strange values for Step, Leader and Follower information - this is because these values are used internally by the game.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||LocationX X-coordinate. Location coordinates are 1-based, unlike any other coordinates in the file.
|-
|1||0x001||[[UINT8]]||LocationY Y-coordinate.
|-
|2||0x002||[[INT16LE]]||StepX X-step value. This pair of values represents a vector that typically points in one of the four cardinal directions. Its use differs for each type of element.
|-
|4||0x004||[[INT16LE]]||StepY Y-step value.
|-
|6||0x006||[[INT16LE]]||Cycle Cycle. This represents the frequency, in ticks, at which the game will process this status element.
|-
|8||0x008||[[UINT8]]||P1 Parameter 1. Its use will differ depending on the type of element.
|-
|9||0x009||[[UINT8]]||P2 Parameter 2. Its use will differ depending on the type of element.
|-
|10||0x00A||[[UINT8]]||P3 Parameter 3. Its use will differ depending on the type of element.
|-
|11||0x00B||[[INT16LE]]||Follower Follower status element. Its value determines if another status element is linked behind this one. Typically used for linking centipedes.
|-
|13||0x00D||[[INT16LE]]||Leader Leader status element. Its value determines if another status element is linked in front of this one. Typically used for linking centipedes.
|-
|15||0x00F||[[UINT8]]||UnderID Element of the tile under this status element.
|-
|16||0x010||[[UINT8]]||UnderColor Color of the tile under this status element.
|-
|17||0x011||[[INT32LE]]||Pointer Stores the location in memory of the code that this status element is using. Status elements typically point to their own code until they #BIND the code of another - in which case this memory location value is replaced with the new one. ZZT does not use this value when loading worlds, and always sets it to 0 when saving worlds.
|-
|21||0x015||[[INT16LE]]||CurrentInstruction The offset in bytes of the code block to execute ZZT-OOP from. Only Objects and Scrolls can execute ZZT-OOP.
|-
|23||0x017||[[INT16LE]]||Length There are two uses for this value: If this value is positive, it represents the number of bytes that are in the code block. If this value is negative, the absolute value of this value represents the Status Element number to copy code from. This saves space by removing redundant code duplication. Since code is shared in this way, all modifications to code will affect any other Status Elements using it.
|-
|}

In ZZT (not Super ZZT), 8 bytes of padding will follow.

If "Length" is positive, the code will be stored here.

== Element Lists ==

This is a list of all valid built-in elements that can be used. Using any elements outside this range produce undefined behavior which is dependent on whatever was residing in memory at the time the game was loaded. Most often, it will crash.

=== Element properties ===

These are all possible internal properties for each element. '''Note:''' The addresses shown are not really significant- you should only consider which ones share the same code to cut down on how many element behaviors to consider.

{|class="wikitable"
!Property!!Description
|-
|Id||Id number of the element
|-
|Hex||Hexidecimal representation of the Id number
|-
|Name||Known name of the element, which may not be present internally
|-
|Character||ASCII character for the default draw code, which may be ignored if special draw code is enabled
|-
|Color||Default color. If the color is 0xFE, then new tiles will be created with the primary color as the background and a white foreground. If the color is >= 0xF0, any primary color is allowed, but in the editor you can't choose the color unless the default color is 0xFF
|-
|Destructible||Element can be destroyed by bullets and by being crushed by puzzle pieces
|-
|Pushable||Element can be pushed. The NS/EW sliders are a special case in the code, so they will not be marked with this flag
|-
|Editor Floor||When using the editor, actors such as enemies can be placed on top of elements marked with this flag. Has no effect during gameplay.
|-
|Floor||Elements with this flag can freely be moved upon by actors
|-
|Shown||ZZT only. Elements marked with this flag will always be shown, even on dark boards
|-
|Special Draw||If this flag is set, the default draw code is bypassed with different draw code
|-
|Draw Code||Offset of the routine that performs the drawing, if Special Draw is set
|-
|Cycle||Default cycle. If this is -1, the element is not generated as an actor. Creatures will have cycles above zero
|-
|Act Code||Offset of the routine that performs standard behavior. For example: creature movement, bomb countdown
|-
|Interact Code||Offset of the routine that handles when a player touches the element. For example: item pickups, entering a passage
|-
|Menu#||Number of the editor menu where this element can be found
|-
|Key||Key press which is mapped to this element in the editor
|-
|Internal Name||Name of the element used in the editor. It is also used by OOP- the parser will remove all symbols and spaces and compare that
|-
|Category||When it comes time to display this element in the editor, if present, the category will be drawn in yellow first.
|-
|Edit P1||Text to show when editing the P1 of an actor that uses this element
|-
|Edit P2||Text to show when editing the P2 of an actor that uses this element
|-
|Edit P3||Text to show when editing the P3 of an actor that uses this element
|-
|Edit Board||Text to show when selecting the target board
|-
|Edit Step||Text to show when selecting the target direction
|-
|Edit Code||Text to show when editing an actor's code (scroll or object OOP)
|-
|Points||When an actor using this element is killed by the player, it's worth this much score
|-
|}

=== ZZT elements ===

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Shown!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3973||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x20||0x07||||||||||||||0x0020||1||0x4481||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||Yes||||0x0020||1||0x3E2F||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||||0x0020||-1||0x0000||0x3289||1||A||Ammo||||||||||||||||0
|-
|6||0x06||Torch||0x9D||0x06||||||||||Yes||||0x0020||-1||0x0000||0x37B6||1||T||Torch||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||||0x0020||-1||0x0000||0x3306||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x3169||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||||0x0020||-1||0x0000||0x33DA||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||||0x0020||1||0x2F9F||0x308B||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||Yes||||0x0020||0||0x0000||0x3372||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||||Yes||0x2A15||2||0x2BFF||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||||Yes||0x1872||6||0x18DA||0x19F3||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||||0x0020||-1||0x0000||0x2034||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||Star||0x53||0x0F||||||||||||Yes||0x1D5D||1||0x1DE9||0x00F5||0||||Star||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||||Yes||0x171C||3||0x176C||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||||Yes||0x17C7||2||0x1817||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||Bullet||0xF8||0x0F||Yes||||||||||||0x0020||1||0x0F65||0x00F5||0||||Bullet||||||||||||||||0
|-
|19||0x13||Water||0xB0||0xF9||||||Yes||||||||0x0020||-1||0x0000||0x3B03||3||W||Water||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||||0x0020||-1||0x0000||0x38D0||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x34E3||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||||0x0020||-1||0x0000||0x3949||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0xB0||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3848||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||||Yes||0x242E||1||0x2445||0x0010||3||L||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||||Yes||0x1CC5||2||0x1C85||0x1C41||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||||Yes||0x122A||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0x99||0x06||Yes||Yes||||||||||0x0020||3||0x054F||0x00F5||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||||0x0020||1||0x0351||0x00F5||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||||Yes||0x2B85||3||0x2AA5||0x2BB7||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||||0x0020||3||0x20AE||0x2295||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||Shark||0x5E||0x07||||||||||||||0x0020||3||0x2321||0x0010||2||Y||Shark||||Intelligence?||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||||Yes||0x11D0||2||0x12A7||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||||Yes||0x3517||4||0x358A||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||||0x0020||2||0x0113||0x00F5||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||||0x0020||2||0x022D||0x00F5||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||||0x0020||2||0x06BF||0x00F5||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||||0x0020||2||0x0EED||0x00F5||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Text (Blue)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|48||0x30||Text (Green)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|49||0x31||Text (Cyan)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|50||0x32||Text (Red)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|51||0x33||Text (Purple)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|52||0x34||Text (Brown)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||Text (Black)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

=== Super ZZT elements ===

Internal properties for each of these elements can be found in the [http://pastebin.com/mdEwu6Y1 Super ZZT Elements Pastebin].

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3FA5||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x02||0x1F||||Yes||||||||0x0020||1||0x4B76||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||||0x0020||1||0x4596||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||0x0020||-1||0x0000||0x37E7||1||A||Ammo||||||||||||||||0
|-
|6||0x06||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||0x0020||-1||0x0000||0x397D||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x36F2||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||0x0020||-1||0x0000||0x3A63||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||0x0020||1||0x3517||0x3603||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||||0x0020||0||0x0000||0x39ED||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||Yes||0x2E32||2||0x3177||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||Yes||0x1DBD||6||0x1E25||0x1F3F||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||0x0020||-1||0x0000||0x2581||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||Yes||0x1C67||3||0x1CB7||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||Yes||0x1D12||2||0x1D62||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|19||0x13||Lava||0x6F||0x4E||||||Yes||||||0x0020||-1||0x0000||0x4155||3||L||Lava||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||0x0020||-1||0x0000||0x3EAF||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x3B5A||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x3F6C||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3E23||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||Yes||0x285B||1||0x2872||0x0010||3||X||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||Yes||0x2216||2||0x21D6||0x2192||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||Yes||0x17C3||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0xEB||0x02||Yes||Yes||||||||0x0020||3||0x09C1||0x014C||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||0x0020||1||0x07C3||0x014C||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||Yes||0x30FD||3||0x2EC2||0x312F||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||0x0020||3||0x25E8||0x27CF||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||Yes||0x1663||2||0x1811||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||Yes||0x3B8E||4||0x3C01||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||0x0020||2||0x016A||0x014C||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||0x0020||2||0x0284||0x014C||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||0x0020||2||0x0B31||0x014C||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||0x0020||2||0x1375||0x014C||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Floor||0xB0||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||F||Floor||Terrains:||||||||||||||0
|-
|48||0x30||Water N||0x1E||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||8||Water N||||||||||||||||0
|-
|49||0x31||Water S||0x1F||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||2||Water S||||||||||||||||0
|-
|50||0x32||Water W||0x11||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||4||Water W||||||||||||||||0
|-
|51||0x33||Water E||0x10||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||6||Water E||||||||||||||||0
|-
|52||0x34||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|54||0x36||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|55||0x37||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|56||0x38||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|57||0x39||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|58||0x3A||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|59||0x3B||Roton||0x94||0x0D||Yes||Yes||||||||0x0020||1||0x03A8||0x014C||4||R||Roton||Uglies:||Intelligence?||Switch Rate?||||||||||2
|-
|60||0x3C||Dragon Pup||0xED||0x04||Yes||Yes||||||Yes||0x05A3||2||0x0563||0x014C||4||D||Dragon Pup||||Intelligence?||Switch Rate?||||||||||1
|-
|61||0x3D||Pairer||0xE5||0x01||Yes||Yes||||||||0x0020||2||0x05E6||0x014C||4||P||Pairer||||Intelligence?||||||||||||2
|-
|62||0x3E||Spider||0x0F||Any (0xFF)||Yes||||||||||0x0020||1||0x06EB||0x014C||4||S||Spider||||Intelligence?||||||||||||3
|-
|63||0x3F||Web||0xC5||Any (0xFF)||||||Yes||Yes||Yes||0x17EA||-1||0x0000||0x0010||5||W||Web||||||||||||||||0
|-
|64||0x40||Stone||0x5A||0x0F||||||||||Yes||0x38A1||1||0x38C3||0x385E||5||Z||Stone||||||||||||||||0
|-
|65||0x41||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|66||0x42||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|67||0x43||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|68||0x44||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|69||0x45||Bullet||0xF8||0x0F||Yes||||||||||0x0020||1||0x13ED||0x014C||0||||Bullet||||||||||||||||0
|-
|70||0x46||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|71||0x47||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|72||0x48||Star||0x53||0x0F||||||||||Yes||0x22AE||1||0x233A||0x014C||0||||Star||||||||||||||||0
|-
|73||0x49||Text (Blue)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|74||0x4A||Text (Green)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|75||0x4B||Text (Cyan)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|76||0x4C||Text (Red)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|77||0x4D||Text (Purple)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|78||0x4E||Text (Brown)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|79||0x4F||Text (Black)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

== Credits ==

This file format was reverse engineered by [[User:SaxxonPike|SaxxonPike]], Kev Vance, WiL and David Hammond. If you find this information helpful in a project you're working on, please give credit where credit is due. (A link back to this wiki would be nice too!)

ZZT Format

2016-07-27T15:37:09Z

SaxxonPike: /* Super ZZT world header */ Discovery about 0x182

{{Playerdata Infobox
| Savegame = Yes
| Where = ?
| Elements = Ammo, gems, keys, scores, many others
| Games =
{{Game|ZZT}}
{{Game|Super ZZT}}
}}

A world file (.ZZT, .SZT) contains information about a game world, status of the player, and all its boards. Saved games (.SAV) are the same format as world files with a different extension and a different setting for the Lock byte.

While there are built-in editors for these games, they do not provide full editing functionality.

== Limits ==

ZZT and Super ZZT have limits imposed either by the game itself or by the data types used to store information about the world's contents.

{|class="wikitable"
!Limitation!!ZZT!!Super ZZT
|-
|Board count (including title screen)||101||33
|-
|Board size (in bytes)||32767||32767
|-
|Board size (in tiles)||60x25||96x80
|-
|Status Elements per board (including Player)||151||129
|-
|Flag strings||10||16
|}

Realistically, the original ZZT can only support boards up to around 20k due to the code itself. ZZT 4.0 by WiL, a hack of the original game executable, can support the full 32k.

== World Format ==

There are two formats for a world file. One is for ZZT and the other is for SuperZZT. The formats are very similar. All 8-bit (byte) values are unsigned. All 16-bit (short) values are signed. Boolean values (such as a player's keys) are represented with 0 for false and 1 for true; any other values may cause inconsistent behavior.

World Name is used by the game to determine which file to load after the player quits and restarts the game. Therefore if a world contains a world name that is actually the filename of another world, after the player quits and restarts the game, the world with the matching filename will be loaded!

There are some unused bytes after the world information that are ignored by the game. While it is safe to put any data whatsoever into this unused space, it is not saved back to disk by the game engine and will be converted to empty padding. [[ZZTAE]] is an editor that uses this space to store extra information such as the author and genre.

=== Common world information ===

The storage of this information is the same between the two formats. After this part of the file, the format will differ slightly.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF FF) and SuperZZT uses -2 (FE FF).
|-
|2||0x002||[[INT16LE]]||NumBoards Number of boards in the world, not including the title screen. Increment by 1 for the real number of stored boards. A value of 0 means only the title screen exists.
|-
|4||0x004||[[INT16LE]]||PlayerAmmo Player's ammunition.
|-
|6||0x006||[[INT16LE]]||PlayerGems Player's gems.
|-
|8||0x008||[[char]][7]||PlayerKeys Player's keys. A nonzero value means the player has the specified key. The keys are in this order: Blue, Green, Cyan, Red, Purple, Yellow, White.
|-
|15||0x00F||[[INT16LE]]||PlayerHealth Player's health.
|-
|17||0x011||[[INT16LE]]||PlayerBoard In a world file, this will be the starting board for the player (the title screen, board 0, is always shown first). In a saved game, this will be the board that the player is currently on.
|-
|}

=== ZZT world header ===

This is the second half of the header specific to a .ZZT file. After this information, storage of the boards starts at byte offset 512 (hex 0x200).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||PlayerTorches Player's torches.
|-
|21||0x015||[[INT16LE]]||TorchCycles Game cycles left for a torch to remain lit.
|-
|23||0x017||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|25||0x019||[[INT16LE]]||(unused) Always 0.
|-
|27||0x01B||[[INT16LE]]||PlayerScore Player's score.
|-
|29||0x01D||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|30||0x01E||[[char]][20]||WorldName Internal name of the world.
|-
|50||0x032||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|51||0x033||[[char]][20]||Flag0 Name of Flag 0.
|-
|71||0x047||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|72||0x048||[[char]][20]||Flag1 Name of Flag 1.
|-
|92||0x05C||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|93||0x05D||[[char]][20]||Flag2 Name of Flag 2.
|-
|113||0x071||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|114||0x072||[[char]][20]||Flag3 Name of Flag 3.
|-
|134||0x086||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|135||0x087||[[char]][20]||Flag4 Name of Flag 4.
|-
|155||0x09B||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|156||0x09C||[[char]][20]||Flag5 Name of Flag 5.
|-
|176||0x0B0||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|177||0x0B1||[[char]][20]||Flag6 Name of Flag 6.
|-
|197||0x0C5||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|198||0x0C6||[[char]][20]||Flag7 Name of Flag 7.
|-
|218||0x0DA||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|219||0x0DB||[[char]][20]||Flag8 Name of Flag 8.
|-
|239||0x0EF||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|240||0x0F0||[[char]][20]||Flag9 Name of Flag 9.
|-
|260||0x104||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|262||0x106||[[INT16LE]]||TimePassedTicks This contains information about sub-seconds on time limited boards.
|-
|264||0x108||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|}

=== Super ZZT world header ===

This is the second half of the header specific to a .SZT file. After this information, storage of the boards starts at byte offset 1024 (hex 0x400).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||(unused) Always 0.
|-
|21||0x015||[[INT16LE]]||PlayerScore Player's score.
|-
|23||0x017||[[INT16LE]]||(unused) Always 0.
|-
|25||0x019||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|27||0x01B||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|28||0x01C||[[char]][20]||WorldName Internal name of the world.
|-
|48||0x030||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|49||0x031||[[char]][20]||Flag0 Name of Flag 0.
|-
|69||0x045||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|70||0x046||[[char]][20]||Flag1 Name of Flag 1.
|-
|90||0x05A||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|91||0x05B||[[char]][20]||Flag2 Name of Flag 2.
|-
|111||0x06F||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|112||0x070||[[char]][20]||Flag3 Name of Flag 3.
|-
|132||0x084||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|133||0x085||[[char]][20]||Flag4 Name of Flag 4.
|-
|153||0x099||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|154||0x09A||[[char]][20]||Flag5 Name of Flag 5.
|-
|174||0x0AE||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|175||0x0AF||[[char]][20]||Flag6 Name of Flag 6.
|-
|195||0x0C3||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|196||0x0C4||[[char]][20]||Flag7 Name of Flag 7.
|-
|216||0x0D8||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|217||0x0D9||[[char]][20]||Flag8 Name of Flag 8.
|-
|237||0x0ED||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|238||0x0EE||[[char]][20]||Flag9 Name of Flag 9.
|-
|258||0x102||[[UINT8]]||Flag10Length Length of the name of Flag 10.
|-
|259||0x103||[[char]][20]||Flag10 Name of Flag 10.
|-
|279||0x117||[[UINT8]]||Flag11Length Length of the name of Flag 11.
|-
|280||0x118||[[char]][20]||Flag11 Name of Flag 11.
|-
|300||0x12C||[[UINT8]]||Flag12Length Length of the name of Flag 12.
|-
|301||0x12D||[[char]][20]||Flag12 Name of Flag 12.
|-
|321||0x141||[[UINT8]]||Flag13Length Length of the name of Flag 13.
|-
|322||0x142||[[char]][20]||Flag13 Name of Flag 13.
|-
|342||0x156||[[UINT8]]||Flag14Length Length of the name of Flag 14.
|-
|343||0x157||[[char]][20]||Flag14 Name of Flag 14.
|-
|363||0x16B||[[UINT8]]||Flag15Length Length of the name of Flag 15.
|-
|364||0x16C||[[char]][20]||Flag15 Name of Flag 15.
|-
|384||0x180||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|386||0x182||[[INT16LE]]||TimePassedTicks This contains information about sub-seconds on time limited boards.
|-
|388||0x184||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|389||0x185||[[INT16LE]]||PlayerStones Player's stones of power. If this value is negative, no information is shown in-game about them. If this value is >= 0, it uses a flag to describe this value in the status bar of the game. The flag used is the first one found that is preceded with a Z. "The Lost Forest" contains a flag called "ZSTONES" which shows as "STONES" on the status bar, for example.
|}

== Board Format ==

Boards can be stored individually in .BRD files. Since ZZT and Super ZZT use the same extension for boards and there is no world information stored with them, it isn't immediately apparent whether the board is a ZZT or a Super ZZT board. Testing the validity of the board information with both world types should be a good way to determine the type of world a board belongs to.

=== Format layout ===

Boards consist of 4 parts: Board Header, RLE Tiles, Board Properties, and Status Element Properties. Status Elements are elements on the board that the game actively processes - these include the player, enemies, any animating blocks, and Scrolls and Objects which can contain ZZT-OOP code.

=== ZZT board header ===

ZZT boards are 60x25 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes (excluding the two bytes from this value). Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][50]||BoardName Board's name.
|-
|53||0x035||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Super ZZT board header ===

Super ZZT boards are 96x80 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][60]||BoardName Board's name.
|-
|63||0x03F||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Run-length encoded tile data ===

Tile data is represented as sets of 3 bytes. These sets are repeated until the board is completely filled. For ZZT, this will be 60*25=1500 tiles. For SuperZZT, this will be 96*80=7680 tiles. The tiles are unpacked from left to right, top to bottom.

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Count Number of tiles.
|-
|[[UINT8]]||Element Element of the tiles.
|-
|[[UINT8]]||Color Color of the tiles.
|-
|}

A small quirk of this RLE format is when the number of tiles is set to zero. Due to the way the decoder is set up, a Count of 0 means there are actually 256 tiles encoded. The built-in editor does not encode tiles using this value despite being decoded correctly in the game, and it will probably crash some older external editors.

=== ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||IsDark When set to 1, the board is covered in darkness which can only be revealed by using a torch.
|-
|2||0x002||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|3||0x003||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|4||0x004||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|5||0x005||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|6||0x006||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|7||0x007||[[UINT8]]||MessageLength Length of the on-screen message.
|-
|8||0x008||[[char]][58]||Message On-screen message. This is used internally and is not loaded by the game.
|-
|66||0x042||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|67||0x043||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|68||0x044||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|70||0x046||[[UINT8]][16]||(unused)
|-
|86||0x056||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|-
|}

=== Super ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|2||0x002||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|3||0x003||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|4||0x004||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|5||0x005||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|6||0x006||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|7||0x007||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|8||0x008||[[INT16LE]]||CameraX X-coordinate of the viewport. This value is not used when loading worlds.
|-
|10||0x00A||[[INT16LE]]||CameraY Y-coordinate of the viewport. This value is not used when loading worlds.
|-
|12||0x00C||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|14||0x00E||[[UINT8]][14]||(unused)
|-
|28||0x01C||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|}

=== Status Elements ===

This follows directly after board properties. It is repeated for each Status Element. The first element stored is always the player-controlled element. This element may contain strange values for Step, Leader and Follower information - this is because these values are used internally by the game.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||LocationX X-coordinate. Location coordinates are 1-based, unlike any other coordinates in the file.
|-
|1||0x001||[[UINT8]]||LocationY Y-coordinate.
|-
|2||0x002||[[INT16LE]]||StepX X-step value. This pair of values represents a vector that typically points in one of the four cardinal directions. Its use differs for each type of element.
|-
|4||0x004||[[INT16LE]]||StepY Y-step value.
|-
|6||0x006||[[INT16LE]]||Cycle Cycle. This represents the frequency, in ticks, at which the game will process this status element.
|-
|8||0x008||[[UINT8]]||P1 Parameter 1. Its use will differ depending on the type of element.
|-
|9||0x009||[[UINT8]]||P2 Parameter 2. Its use will differ depending on the type of element.
|-
|10||0x00A||[[UINT8]]||P3 Parameter 3. Its use will differ depending on the type of element.
|-
|11||0x00B||[[INT16LE]]||Follower Follower status element. Its value determines if another status element is linked behind this one. Typically used for linking centipedes.
|-
|13||0x00D||[[INT16LE]]||Leader Leader status element. Its value determines if another status element is linked in front of this one. Typically used for linking centipedes.
|-
|15||0x00F||[[UINT8]]||UnderID Element of the tile under this status element.
|-
|16||0x010||[[UINT8]]||UnderColor Color of the tile under this status element.
|-
|17||0x011||[[INT32LE]]||Pointer Stores the location in memory of the code that this status element is using. Status elements typically point to their own code until they #BIND the code of another - in which case this memory location value is replaced with the new one. ZZT does not use this value when loading worlds, and always sets it to 0 when saving worlds.
|-
|21||0x015||[[INT16LE]]||CurrentInstruction The offset in bytes of the code block to execute ZZT-OOP from. Only Objects and Scrolls can execute ZZT-OOP.
|-
|23||0x017||[[INT16LE]]||Length There are two uses for this value: If this value is positive, it represents the number of bytes that are in the code block. If this value is negative, the absolute value of this value represents the Status Element number to copy code from. This saves space by removing redundant code duplication. Since code is shared in this way, all modifications to code will affect any other Status Elements using it.
|-
|}

In ZZT (not Super ZZT), 8 bytes of padding will follow.

If "Length" is positive, the code will be stored here.

== Element Lists ==

This is a list of all valid built-in elements that can be used. Using any elements outside this range produce undefined behavior which is dependent on whatever was residing in memory at the time the game was loaded. Most often, it will crash.

=== Element properties ===

These are all possible internal properties for each element. '''Note:''' The addresses shown are not really significant- you should only consider which ones share the same code to cut down on how many element behaviors to consider.

{|class="wikitable"
!Property!!Description
|-
|Id||Id number of the element
|-
|Hex||Hexidecimal representation of the Id number
|-
|Name||Known name of the element, which may not be present internally
|-
|Character||ASCII character for the default draw code, which may be ignored if special draw code is enabled
|-
|Color||Default color. If the color is 0xFE, then new tiles will be created with the primary color as the background and a white foreground. If the color is >= 0xF0, any primary color is allowed, but in the editor you can't choose the color unless the default color is 0xFF
|-
|Destructible||Element can be destroyed by bullets and by being crushed by puzzle pieces
|-
|Pushable||Element can be pushed. The NS/EW sliders are a special case in the code, so they will not be marked with this flag
|-
|Editor Floor||When using the editor, actors such as enemies can be placed on top of elements marked with this flag. Has no effect during gameplay.
|-
|Floor||Elements with this flag can freely be moved upon by actors
|-
|Shown||ZZT only. Elements marked with this flag will always be shown, even on dark boards
|-
|Special Draw||If this flag is set, the default draw code is bypassed with different draw code
|-
|Draw Code||Offset of the routine that performs the drawing, if Special Draw is set
|-
|Cycle||Default cycle. If this is -1, the element is not generated as an actor. Creatures will have cycles above zero
|-
|Act Code||Offset of the routine that performs standard behavior. For example: creature movement, bomb countdown
|-
|Interact Code||Offset of the routine that handles when a player touches the element. For example: item pickups, entering a passage
|-
|Menu#||Number of the editor menu where this element can be found
|-
|Key||Key press which is mapped to this element in the editor
|-
|Internal Name||Name of the element used in the editor. It is also used by OOP- the parser will remove all symbols and spaces and compare that
|-
|Category||When it comes time to display this element in the editor, if present, the category will be drawn in yellow first.
|-
|Edit P1||Text to show when editing the P1 of an actor that uses this element
|-
|Edit P2||Text to show when editing the P2 of an actor that uses this element
|-
|Edit P3||Text to show when editing the P3 of an actor that uses this element
|-
|Edit Board||Text to show when selecting the target board
|-
|Edit Step||Text to show when selecting the target direction
|-
|Edit Code||Text to show when editing an actor's code (scroll or object OOP)
|-
|Points||When an actor using this element is killed by the player, it's worth this much score
|-
|}

=== ZZT elements ===

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Shown!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3973||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x20||0x07||||||||||||||0x0020||1||0x4481||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||Yes||||0x0020||1||0x3E2F||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||||0x0020||-1||0x0000||0x3289||1||A||Ammo||||||||||||||||0
|-
|6||0x06||Torch||0x9D||0x06||||||||||Yes||||0x0020||-1||0x0000||0x37B6||1||T||Torch||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||||0x0020||-1||0x0000||0x3306||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x3169||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||||0x0020||-1||0x0000||0x33DA||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||||0x0020||1||0x2F9F||0x308B||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||Yes||||0x0020||0||0x0000||0x3372||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||||Yes||0x2A15||2||0x2BFF||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||||Yes||0x1872||6||0x18DA||0x19F3||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||||0x0020||-1||0x0000||0x2034||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||Star||0x53||0x0F||||||||||||Yes||0x1D5D||1||0x1DE9||0x00F5||0||||Star||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||||Yes||0x171C||3||0x176C||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||||Yes||0x17C7||2||0x1817||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||Bullet||0xF8||0x0F||Yes||||||||||||0x0020||1||0x0F65||0x00F5||0||||Bullet||||||||||||||||0
|-
|19||0x13||Water||0xB0||0xF9||||||Yes||||||||0x0020||-1||0x0000||0x3B03||3||W||Water||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||||0x0020||-1||0x0000||0x38D0||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x34E3||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||||0x0020||-1||0x0000||0x3949||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0xB0||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3848||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||||Yes||0x242E||1||0x2445||0x0010||3||L||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||||Yes||0x1CC5||2||0x1C85||0x1C41||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||||Yes||0x122A||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0x99||0x06||Yes||Yes||||||||||0x0020||3||0x054F||0x00F5||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||||0x0020||1||0x0351||0x00F5||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||||Yes||0x2B85||3||0x2AA5||0x2BB7||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||||0x0020||3||0x20AE||0x2295||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||Shark||0x5E||0x07||||||||||||||0x0020||3||0x2321||0x0010||2||Y||Shark||||Intelligence?||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||||Yes||0x11D0||2||0x12A7||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||||Yes||0x3517||4||0x358A||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||||0x0020||2||0x0113||0x00F5||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||||0x0020||2||0x022D||0x00F5||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||||0x0020||2||0x06BF||0x00F5||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||||0x0020||2||0x0EED||0x00F5||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Text (Blue)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|48||0x30||Text (Green)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|49||0x31||Text (Cyan)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|50||0x32||Text (Red)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|51||0x33||Text (Purple)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|52||0x34||Text (Brown)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||Text (Black)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

=== Super ZZT elements ===

Internal properties for each of these elements can be found in the [http://pastebin.com/mdEwu6Y1 Super ZZT Elements Pastebin].

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3FA5||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x02||0x1F||||Yes||||||||0x0020||1||0x4B76||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||||0x0020||1||0x4596||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||0x0020||-1||0x0000||0x37E7||1||A||Ammo||||||||||||||||0
|-
|6||0x06||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||0x0020||-1||0x0000||0x397D||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x36F2||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||0x0020||-1||0x0000||0x3A63||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||0x0020||1||0x3517||0x3603||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||||0x0020||0||0x0000||0x39ED||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||Yes||0x2E32||2||0x3177||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||Yes||0x1DBD||6||0x1E25||0x1F3F||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||0x0020||-1||0x0000||0x2581||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||Yes||0x1C67||3||0x1CB7||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||Yes||0x1D12||2||0x1D62||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|19||0x13||Lava||0x6F||0x4E||||||Yes||||||0x0020||-1||0x0000||0x4155||3||L||Lava||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||0x0020||-1||0x0000||0x3EAF||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x3B5A||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x3F6C||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3E23||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||Yes||0x285B||1||0x2872||0x0010||3||X||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||Yes||0x2216||2||0x21D6||0x2192||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||Yes||0x17C3||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0xEB||0x02||Yes||Yes||||||||0x0020||3||0x09C1||0x014C||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||0x0020||1||0x07C3||0x014C||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||Yes||0x30FD||3||0x2EC2||0x312F||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||0x0020||3||0x25E8||0x27CF||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||Yes||0x1663||2||0x1811||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||Yes||0x3B8E||4||0x3C01||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||0x0020||2||0x016A||0x014C||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||0x0020||2||0x0284||0x014C||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||0x0020||2||0x0B31||0x014C||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||0x0020||2||0x1375||0x014C||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Floor||0xB0||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||F||Floor||Terrains:||||||||||||||0
|-
|48||0x30||Water N||0x1E||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||8||Water N||||||||||||||||0
|-
|49||0x31||Water S||0x1F||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||2||Water S||||||||||||||||0
|-
|50||0x32||Water W||0x11||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||4||Water W||||||||||||||||0
|-
|51||0x33||Water E||0x10||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||6||Water E||||||||||||||||0
|-
|52||0x34||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|54||0x36||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|55||0x37||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|56||0x38||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|57||0x39||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|58||0x3A||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|59||0x3B||Roton||0x94||0x0D||Yes||Yes||||||||0x0020||1||0x03A8||0x014C||4||R||Roton||Uglies:||Intelligence?||Switch Rate?||||||||||2
|-
|60||0x3C||Dragon Pup||0xED||0x04||Yes||Yes||||||Yes||0x05A3||2||0x0563||0x014C||4||D||Dragon Pup||||Intelligence?||Switch Rate?||||||||||1
|-
|61||0x3D||Pairer||0xE5||0x01||Yes||Yes||||||||0x0020||2||0x05E6||0x014C||4||P||Pairer||||Intelligence?||||||||||||2
|-
|62||0x3E||Spider||0x0F||Any (0xFF)||Yes||||||||||0x0020||1||0x06EB||0x014C||4||S||Spider||||Intelligence?||||||||||||3
|-
|63||0x3F||Web||0xC5||Any (0xFF)||||||Yes||Yes||Yes||0x17EA||-1||0x0000||0x0010||5||W||Web||||||||||||||||0
|-
|64||0x40||Stone||0x5A||0x0F||||||||||Yes||0x38A1||1||0x38C3||0x385E||5||Z||Stone||||||||||||||||0
|-
|65||0x41||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|66||0x42||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|67||0x43||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|68||0x44||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|69||0x45||Bullet||0xF8||0x0F||Yes||||||||||0x0020||1||0x13ED||0x014C||0||||Bullet||||||||||||||||0
|-
|70||0x46||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|71||0x47||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|72||0x48||Star||0x53||0x0F||||||||||Yes||0x22AE||1||0x233A||0x014C||0||||Star||||||||||||||||0
|-
|73||0x49||Text (Blue)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|74||0x4A||Text (Green)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|75||0x4B||Text (Cyan)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|76||0x4C||Text (Red)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|77||0x4D||Text (Purple)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|78||0x4E||Text (Brown)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|79||0x4F||Text (Black)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

== Credits ==

This file format was reverse engineered by [[User:SaxxonPike|SaxxonPike]], Kev Vance, WiL and David Hammond. If you find this information helpful in a project you're working on, please give credit where credit is due. (A link back to this wiki would be nice too!)

ZZT Format

2016-07-27T15:36:24Z

SaxxonPike: /* ZZT world header */ Discovery about 0x106

{{Playerdata Infobox
| Savegame = Yes
| Where = ?
| Elements = Ammo, gems, keys, scores, many others
| Games =
{{Game|ZZT}}
{{Game|Super ZZT}}
}}

A world file (.ZZT, .SZT) contains information about a game world, status of the player, and all its boards. Saved games (.SAV) are the same format as world files with a different extension and a different setting for the Lock byte.

While there are built-in editors for these games, they do not provide full editing functionality.

== Limits ==

ZZT and Super ZZT have limits imposed either by the game itself or by the data types used to store information about the world's contents.

{|class="wikitable"
!Limitation!!ZZT!!Super ZZT
|-
|Board count (including title screen)||101||33
|-
|Board size (in bytes)||32767||32767
|-
|Board size (in tiles)||60x25||96x80
|-
|Status Elements per board (including Player)||151||129
|-
|Flag strings||10||16
|}

Realistically, the original ZZT can only support boards up to around 20k due to the code itself. ZZT 4.0 by WiL, a hack of the original game executable, can support the full 32k.

== World Format ==

There are two formats for a world file. One is for ZZT and the other is for SuperZZT. The formats are very similar. All 8-bit (byte) values are unsigned. All 16-bit (short) values are signed. Boolean values (such as a player's keys) are represented with 0 for false and 1 for true; any other values may cause inconsistent behavior.

World Name is used by the game to determine which file to load after the player quits and restarts the game. Therefore if a world contains a world name that is actually the filename of another world, after the player quits and restarts the game, the world with the matching filename will be loaded!

There are some unused bytes after the world information that are ignored by the game. While it is safe to put any data whatsoever into this unused space, it is not saved back to disk by the game engine and will be converted to empty padding. [[ZZTAE]] is an editor that uses this space to store extra information such as the author and genre.

=== Common world information ===

The storage of this information is the same between the two formats. After this part of the file, the format will differ slightly.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF FF) and SuperZZT uses -2 (FE FF).
|-
|2||0x002||[[INT16LE]]||NumBoards Number of boards in the world, not including the title screen. Increment by 1 for the real number of stored boards. A value of 0 means only the title screen exists.
|-
|4||0x004||[[INT16LE]]||PlayerAmmo Player's ammunition.
|-
|6||0x006||[[INT16LE]]||PlayerGems Player's gems.
|-
|8||0x008||[[char]][7]||PlayerKeys Player's keys. A nonzero value means the player has the specified key. The keys are in this order: Blue, Green, Cyan, Red, Purple, Yellow, White.
|-
|15||0x00F||[[INT16LE]]||PlayerHealth Player's health.
|-
|17||0x011||[[INT16LE]]||PlayerBoard In a world file, this will be the starting board for the player (the title screen, board 0, is always shown first). In a saved game, this will be the board that the player is currently on.
|-
|}

=== ZZT world header ===

This is the second half of the header specific to a .ZZT file. After this information, storage of the boards starts at byte offset 512 (hex 0x200).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||PlayerTorches Player's torches.
|-
|21||0x015||[[INT16LE]]||TorchCycles Game cycles left for a torch to remain lit.
|-
|23||0x017||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|25||0x019||[[INT16LE]]||(unused) Always 0.
|-
|27||0x01B||[[INT16LE]]||PlayerScore Player's score.
|-
|29||0x01D||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|30||0x01E||[[char]][20]||WorldName Internal name of the world.
|-
|50||0x032||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|51||0x033||[[char]][20]||Flag0 Name of Flag 0.
|-
|71||0x047||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|72||0x048||[[char]][20]||Flag1 Name of Flag 1.
|-
|92||0x05C||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|93||0x05D||[[char]][20]||Flag2 Name of Flag 2.
|-
|113||0x071||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|114||0x072||[[char]][20]||Flag3 Name of Flag 3.
|-
|134||0x086||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|135||0x087||[[char]][20]||Flag4 Name of Flag 4.
|-
|155||0x09B||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|156||0x09C||[[char]][20]||Flag5 Name of Flag 5.
|-
|176||0x0B0||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|177||0x0B1||[[char]][20]||Flag6 Name of Flag 6.
|-
|197||0x0C5||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|198||0x0C6||[[char]][20]||Flag7 Name of Flag 7.
|-
|218||0x0DA||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|219||0x0DB||[[char]][20]||Flag8 Name of Flag 8.
|-
|239||0x0EF||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|240||0x0F0||[[char]][20]||Flag9 Name of Flag 9.
|-
|260||0x104||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|262||0x106||[[INT16LE]]||TimePassedTicks This contains information about sub-seconds on time limited boards.
|-
|264||0x108||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|}

=== Super ZZT world header ===

This is the second half of the header specific to a .SZT file. After this information, storage of the boards starts at byte offset 1024 (hex 0x400).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||(unused) Always 0.
|-
|21||0x015||[[INT16LE]]||PlayerScore Player's score.
|-
|23||0x017||[[INT16LE]]||(unused) Always 0.
|-
|25||0x019||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|27||0x01B||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|28||0x01C||[[char]][20]||WorldName Internal name of the world.
|-
|48||0x030||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|49||0x031||[[char]][20]||Flag0 Name of Flag 0.
|-
|69||0x045||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|70||0x046||[[char]][20]||Flag1 Name of Flag 1.
|-
|90||0x05A||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|91||0x05B||[[char]][20]||Flag2 Name of Flag 2.
|-
|111||0x06F||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|112||0x070||[[char]][20]||Flag3 Name of Flag 3.
|-
|132||0x084||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|133||0x085||[[char]][20]||Flag4 Name of Flag 4.
|-
|153||0x099||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|154||0x09A||[[char]][20]||Flag5 Name of Flag 5.
|-
|174||0x0AE||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|175||0x0AF||[[char]][20]||Flag6 Name of Flag 6.
|-
|195||0x0C3||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|196||0x0C4||[[char]][20]||Flag7 Name of Flag 7.
|-
|216||0x0D8||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|217||0x0D9||[[char]][20]||Flag8 Name of Flag 8.
|-
|237||0x0ED||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|238||0x0EE||[[char]][20]||Flag9 Name of Flag 9.
|-
|258||0x102||[[UINT8]]||Flag10Length Length of the name of Flag 10.
|-
|259||0x103||[[char]][20]||Flag10 Name of Flag 10.
|-
|279||0x117||[[UINT8]]||Flag11Length Length of the name of Flag 11.
|-
|280||0x118||[[char]][20]||Flag11 Name of Flag 11.
|-
|300||0x12C||[[UINT8]]||Flag12Length Length of the name of Flag 12.
|-
|301||0x12D||[[char]][20]||Flag12 Name of Flag 12.
|-
|321||0x141||[[UINT8]]||Flag13Length Length of the name of Flag 13.
|-
|322||0x142||[[char]][20]||Flag13 Name of Flag 13.
|-
|342||0x156||[[UINT8]]||Flag14Length Length of the name of Flag 14.
|-
|343||0x157||[[char]][20]||Flag14 Name of Flag 14.
|-
|363||0x16B||[[UINT8]]||Flag15Length Length of the name of Flag 15.
|-
|364||0x16C||[[char]][20]||Flag15 Name of Flag 15.
|-
|384||0x180||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|386||0x182||[[INT16LE]]||PlayerData This stores a runtime memory location that points to the status element currently being used by the player. Its value is not used when loading worlds, and is always set to 0 when saving worlds.
|-
|388||0x184||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|389||0x185||[[INT16LE]]||PlayerStones Player's stones of power. If this value is negative, no information is shown in-game about them. If this value is >= 0, it uses a flag to describe this value in the status bar of the game. The flag used is the first one found that is preceded with a Z. "The Lost Forest" contains a flag called "ZSTONES" which shows as "STONES" on the status bar, for example.
|}

== Board Format ==

Boards can be stored individually in .BRD files. Since ZZT and Super ZZT use the same extension for boards and there is no world information stored with them, it isn't immediately apparent whether the board is a ZZT or a Super ZZT board. Testing the validity of the board information with both world types should be a good way to determine the type of world a board belongs to.

=== Format layout ===

Boards consist of 4 parts: Board Header, RLE Tiles, Board Properties, and Status Element Properties. Status Elements are elements on the board that the game actively processes - these include the player, enemies, any animating blocks, and Scrolls and Objects which can contain ZZT-OOP code.

=== ZZT board header ===

ZZT boards are 60x25 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes (excluding the two bytes from this value). Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][50]||BoardName Board's name.
|-
|53||0x035||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Super ZZT board header ===

Super ZZT boards are 96x80 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][60]||BoardName Board's name.
|-
|63||0x03F||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Run-length encoded tile data ===

Tile data is represented as sets of 3 bytes. These sets are repeated until the board is completely filled. For ZZT, this will be 60*25=1500 tiles. For SuperZZT, this will be 96*80=7680 tiles. The tiles are unpacked from left to right, top to bottom.

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Count Number of tiles.
|-
|[[UINT8]]||Element Element of the tiles.
|-
|[[UINT8]]||Color Color of the tiles.
|-
|}

A small quirk of this RLE format is when the number of tiles is set to zero. Due to the way the decoder is set up, a Count of 0 means there are actually 256 tiles encoded. The built-in editor does not encode tiles using this value despite being decoded correctly in the game, and it will probably crash some older external editors.

=== ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||IsDark When set to 1, the board is covered in darkness which can only be revealed by using a torch.
|-
|2||0x002||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|3||0x003||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|4||0x004||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|5||0x005||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|6||0x006||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|7||0x007||[[UINT8]]||MessageLength Length of the on-screen message.
|-
|8||0x008||[[char]][58]||Message On-screen message. This is used internally and is not loaded by the game.
|-
|66||0x042||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|67||0x043||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|68||0x044||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|70||0x046||[[UINT8]][16]||(unused)
|-
|86||0x056||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|-
|}

=== Super ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|2||0x002||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|3||0x003||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|4||0x004||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|5||0x005||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|6||0x006||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|7||0x007||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|8||0x008||[[INT16LE]]||CameraX X-coordinate of the viewport. This value is not used when loading worlds.
|-
|10||0x00A||[[INT16LE]]||CameraY Y-coordinate of the viewport. This value is not used when loading worlds.
|-
|12||0x00C||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|14||0x00E||[[UINT8]][14]||(unused)
|-
|28||0x01C||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|}

=== Status Elements ===

This follows directly after board properties. It is repeated for each Status Element. The first element stored is always the player-controlled element. This element may contain strange values for Step, Leader and Follower information - this is because these values are used internally by the game.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||LocationX X-coordinate. Location coordinates are 1-based, unlike any other coordinates in the file.
|-
|1||0x001||[[UINT8]]||LocationY Y-coordinate.
|-
|2||0x002||[[INT16LE]]||StepX X-step value. This pair of values represents a vector that typically points in one of the four cardinal directions. Its use differs for each type of element.
|-
|4||0x004||[[INT16LE]]||StepY Y-step value.
|-
|6||0x006||[[INT16LE]]||Cycle Cycle. This represents the frequency, in ticks, at which the game will process this status element.
|-
|8||0x008||[[UINT8]]||P1 Parameter 1. Its use will differ depending on the type of element.
|-
|9||0x009||[[UINT8]]||P2 Parameter 2. Its use will differ depending on the type of element.
|-
|10||0x00A||[[UINT8]]||P3 Parameter 3. Its use will differ depending on the type of element.
|-
|11||0x00B||[[INT16LE]]||Follower Follower status element. Its value determines if another status element is linked behind this one. Typically used for linking centipedes.
|-
|13||0x00D||[[INT16LE]]||Leader Leader status element. Its value determines if another status element is linked in front of this one. Typically used for linking centipedes.
|-
|15||0x00F||[[UINT8]]||UnderID Element of the tile under this status element.
|-
|16||0x010||[[UINT8]]||UnderColor Color of the tile under this status element.
|-
|17||0x011||[[INT32LE]]||Pointer Stores the location in memory of the code that this status element is using. Status elements typically point to their own code until they #BIND the code of another - in which case this memory location value is replaced with the new one. ZZT does not use this value when loading worlds, and always sets it to 0 when saving worlds.
|-
|21||0x015||[[INT16LE]]||CurrentInstruction The offset in bytes of the code block to execute ZZT-OOP from. Only Objects and Scrolls can execute ZZT-OOP.
|-
|23||0x017||[[INT16LE]]||Length There are two uses for this value: If this value is positive, it represents the number of bytes that are in the code block. If this value is negative, the absolute value of this value represents the Status Element number to copy code from. This saves space by removing redundant code duplication. Since code is shared in this way, all modifications to code will affect any other Status Elements using it.
|-
|}

In ZZT (not Super ZZT), 8 bytes of padding will follow.

If "Length" is positive, the code will be stored here.

== Element Lists ==

This is a list of all valid built-in elements that can be used. Using any elements outside this range produce undefined behavior which is dependent on whatever was residing in memory at the time the game was loaded. Most often, it will crash.

=== Element properties ===

These are all possible internal properties for each element. '''Note:''' The addresses shown are not really significant- you should only consider which ones share the same code to cut down on how many element behaviors to consider.

{|class="wikitable"
!Property!!Description
|-
|Id||Id number of the element
|-
|Hex||Hexidecimal representation of the Id number
|-
|Name||Known name of the element, which may not be present internally
|-
|Character||ASCII character for the default draw code, which may be ignored if special draw code is enabled
|-
|Color||Default color. If the color is 0xFE, then new tiles will be created with the primary color as the background and a white foreground. If the color is >= 0xF0, any primary color is allowed, but in the editor you can't choose the color unless the default color is 0xFF
|-
|Destructible||Element can be destroyed by bullets and by being crushed by puzzle pieces
|-
|Pushable||Element can be pushed. The NS/EW sliders are a special case in the code, so they will not be marked with this flag
|-
|Editor Floor||When using the editor, actors such as enemies can be placed on top of elements marked with this flag. Has no effect during gameplay.
|-
|Floor||Elements with this flag can freely be moved upon by actors
|-
|Shown||ZZT only. Elements marked with this flag will always be shown, even on dark boards
|-
|Special Draw||If this flag is set, the default draw code is bypassed with different draw code
|-
|Draw Code||Offset of the routine that performs the drawing, if Special Draw is set
|-
|Cycle||Default cycle. If this is -1, the element is not generated as an actor. Creatures will have cycles above zero
|-
|Act Code||Offset of the routine that performs standard behavior. For example: creature movement, bomb countdown
|-
|Interact Code||Offset of the routine that handles when a player touches the element. For example: item pickups, entering a passage
|-
|Menu#||Number of the editor menu where this element can be found
|-
|Key||Key press which is mapped to this element in the editor
|-
|Internal Name||Name of the element used in the editor. It is also used by OOP- the parser will remove all symbols and spaces and compare that
|-
|Category||When it comes time to display this element in the editor, if present, the category will be drawn in yellow first.
|-
|Edit P1||Text to show when editing the P1 of an actor that uses this element
|-
|Edit P2||Text to show when editing the P2 of an actor that uses this element
|-
|Edit P3||Text to show when editing the P3 of an actor that uses this element
|-
|Edit Board||Text to show when selecting the target board
|-
|Edit Step||Text to show when selecting the target direction
|-
|Edit Code||Text to show when editing an actor's code (scroll or object OOP)
|-
|Points||When an actor using this element is killed by the player, it's worth this much score
|-
|}

=== ZZT elements ===

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Shown!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3973||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x20||0x07||||||||||||||0x0020||1||0x4481||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||Yes||||0x0020||1||0x3E2F||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||||0x0020||-1||0x0000||0x3289||1||A||Ammo||||||||||||||||0
|-
|6||0x06||Torch||0x9D||0x06||||||||||Yes||||0x0020||-1||0x0000||0x37B6||1||T||Torch||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||||0x0020||-1||0x0000||0x3306||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x3169||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||||0x0020||-1||0x0000||0x33DA||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||||0x0020||1||0x2F9F||0x308B||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||Yes||||0x0020||0||0x0000||0x3372||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||||Yes||0x2A15||2||0x2BFF||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||||Yes||0x1872||6||0x18DA||0x19F3||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||||0x0020||-1||0x0000||0x2034||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||Star||0x53||0x0F||||||||||||Yes||0x1D5D||1||0x1DE9||0x00F5||0||||Star||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||||Yes||0x171C||3||0x176C||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||||Yes||0x17C7||2||0x1817||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||Bullet||0xF8||0x0F||Yes||||||||||||0x0020||1||0x0F65||0x00F5||0||||Bullet||||||||||||||||0
|-
|19||0x13||Water||0xB0||0xF9||||||Yes||||||||0x0020||-1||0x0000||0x3B03||3||W||Water||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||||0x0020||-1||0x0000||0x38D0||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x34E3||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||||0x0020||-1||0x0000||0x3949||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0xB0||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3848||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||||Yes||0x242E||1||0x2445||0x0010||3||L||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||||Yes||0x1CC5||2||0x1C85||0x1C41||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||||Yes||0x122A||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0x99||0x06||Yes||Yes||||||||||0x0020||3||0x054F||0x00F5||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||||0x0020||1||0x0351||0x00F5||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||||Yes||0x2B85||3||0x2AA5||0x2BB7||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||||0x0020||3||0x20AE||0x2295||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||Shark||0x5E||0x07||||||||||||||0x0020||3||0x2321||0x0010||2||Y||Shark||||Intelligence?||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||||Yes||0x11D0||2||0x12A7||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||||Yes||0x3517||4||0x358A||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||||0x0020||2||0x0113||0x00F5||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||||0x0020||2||0x022D||0x00F5||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||||0x0020||2||0x06BF||0x00F5||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||||0x0020||2||0x0EED||0x00F5||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Text (Blue)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|48||0x30||Text (Green)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|49||0x31||Text (Cyan)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|50||0x32||Text (Red)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|51||0x33||Text (Purple)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|52||0x34||Text (Brown)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||Text (Black)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

=== Super ZZT elements ===

Internal properties for each of these elements can be found in the [http://pastebin.com/mdEwu6Y1 Super ZZT Elements Pastebin].

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3FA5||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x02||0x1F||||Yes||||||||0x0020||1||0x4B76||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||||0x0020||1||0x4596||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||0x0020||-1||0x0000||0x37E7||1||A||Ammo||||||||||||||||0
|-
|6||0x06||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||0x0020||-1||0x0000||0x397D||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x36F2||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||0x0020||-1||0x0000||0x3A63||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||0x0020||1||0x3517||0x3603||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||||0x0020||0||0x0000||0x39ED||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||Yes||0x2E32||2||0x3177||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||Yes||0x1DBD||6||0x1E25||0x1F3F||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||0x0020||-1||0x0000||0x2581||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||Yes||0x1C67||3||0x1CB7||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||Yes||0x1D12||2||0x1D62||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|19||0x13||Lava||0x6F||0x4E||||||Yes||||||0x0020||-1||0x0000||0x4155||3||L||Lava||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||0x0020||-1||0x0000||0x3EAF||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x3B5A||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x3F6C||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3E23||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||Yes||0x285B||1||0x2872||0x0010||3||X||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||Yes||0x2216||2||0x21D6||0x2192||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||Yes||0x17C3||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0xEB||0x02||Yes||Yes||||||||0x0020||3||0x09C1||0x014C||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||0x0020||1||0x07C3||0x014C||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||Yes||0x30FD||3||0x2EC2||0x312F||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||0x0020||3||0x25E8||0x27CF||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||Yes||0x1663||2||0x1811||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||Yes||0x3B8E||4||0x3C01||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||0x0020||2||0x016A||0x014C||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||0x0020||2||0x0284||0x014C||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||0x0020||2||0x0B31||0x014C||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||0x0020||2||0x1375||0x014C||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Floor||0xB0||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||F||Floor||Terrains:||||||||||||||0
|-
|48||0x30||Water N||0x1E||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||8||Water N||||||||||||||||0
|-
|49||0x31||Water S||0x1F||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||2||Water S||||||||||||||||0
|-
|50||0x32||Water W||0x11||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||4||Water W||||||||||||||||0
|-
|51||0x33||Water E||0x10||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||6||Water E||||||||||||||||0
|-
|52||0x34||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|54||0x36||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|55||0x37||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|56||0x38||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|57||0x39||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|58||0x3A||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|59||0x3B||Roton||0x94||0x0D||Yes||Yes||||||||0x0020||1||0x03A8||0x014C||4||R||Roton||Uglies:||Intelligence?||Switch Rate?||||||||||2
|-
|60||0x3C||Dragon Pup||0xED||0x04||Yes||Yes||||||Yes||0x05A3||2||0x0563||0x014C||4||D||Dragon Pup||||Intelligence?||Switch Rate?||||||||||1
|-
|61||0x3D||Pairer||0xE5||0x01||Yes||Yes||||||||0x0020||2||0x05E6||0x014C||4||P||Pairer||||Intelligence?||||||||||||2
|-
|62||0x3E||Spider||0x0F||Any (0xFF)||Yes||||||||||0x0020||1||0x06EB||0x014C||4||S||Spider||||Intelligence?||||||||||||3
|-
|63||0x3F||Web||0xC5||Any (0xFF)||||||Yes||Yes||Yes||0x17EA||-1||0x0000||0x0010||5||W||Web||||||||||||||||0
|-
|64||0x40||Stone||0x5A||0x0F||||||||||Yes||0x38A1||1||0x38C3||0x385E||5||Z||Stone||||||||||||||||0
|-
|65||0x41||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|66||0x42||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|67||0x43||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|68||0x44||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|69||0x45||Bullet||0xF8||0x0F||Yes||||||||||0x0020||1||0x13ED||0x014C||0||||Bullet||||||||||||||||0
|-
|70||0x46||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|71||0x47||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|72||0x48||Star||0x53||0x0F||||||||||Yes||0x22AE||1||0x233A||0x014C||0||||Star||||||||||||||||0
|-
|73||0x49||Text (Blue)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|74||0x4A||Text (Green)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|75||0x4B||Text (Cyan)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|76||0x4C||Text (Red)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|77||0x4D||Text (Purple)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|78||0x4E||Text (Brown)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|79||0x4F||Text (Black)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

== Credits ==

This file format was reverse engineered by [[User:SaxxonPike|SaxxonPike]], Kev Vance, WiL and David Hammond. If you find this information helpful in a project you're working on, please give credit where credit is due. (A link back to this wiki would be nice too!)

Super ZZT

2016-07-26T17:29:26Z

SaxxonPike: /* Game info */ More info about Super ZZT's origins

{{Stub}}

{{Game Infobox
| Levels = Edit
| Tiles = No
| Sprites = No
| Fullscreen = No
| Sound = No
| Music = No
| Text = No
| Story = No
| Interface = No
}}

== Game info ==

Super ZZT is an object-oriented game scripting engine created by Tim Sweeney. It is based on the same code as [[ZZT]], with a number of notable improvements and changes. There were 3 worlds released with the commercial version of the game: PROVING, FOREST, and MONSTER. The shareware version of Super ZZT came with just MONSTER.

== Editor ==

While Super ZZT features a world editor, it was considered too buggy for release and was hidden from users. However, the ZZT community was eventually able to locate the command line switch to enable the use of the built-in editor. It can be enabled from the command line using "SUPERZ /E" to start the game, and then opened by pressing "E" at the title screen.

== Versions ==

The latest version of the game is v2.0. The only other known version is v1.1. There are no observable differences between the two versions of the game aside from the opening and closing screens.

{| class="wikitable"
|-
! Version
! File Size (decompressed)
|-
| 1.1
| 53,924 (108,288)
|-
| 2.0
| 54,076 (109,072)
|}

== File formats ==

* [[ZZT Format#Board Format|BRD Format]] - Board format. This is stored exactly the same as in a world, but it's just one board.
* [[SZT Format]] - World format.
* [[Super ZZT Graphics Format|Graphics Format]] - Format of the ANSI art on the title screen and the exit screen.

[[Category:Epic Megagames]]
[[Category:ZZT]]
[[Category:Game Intro Page]]

Crunched Screen Image

2016-07-26T17:27:32Z

SaxxonPike: Add link.

A special format is used internally by [[Super ZZT]] to draw the title screen and ending screen graphics. The format assumes a 80x25 display window.

== Format ==

There is no header information for this format. It is read as a stream of bytes until the Y-position goes off the bottom (row 25).

{|class="wikitable"
!Value!!Description
|-
|00-0F||Set the foreground color of following output to this value.
|-
|10-17||Set the background color of following output to the lower 4 bits of this value.
|-
|18||Go to the beginning of the following text line.
|-
|19||Read one more byte ''n'', and output a space character ''n''+1 times.
|-
|1A||Read two more bytes ''n'' and ''char'', and output ''char'' for ''n''+1 times.
|-
|1B-1F||Undefined?
|-
|20-FF||Output this character exactly.
|}

== Location ==

These graphics cannot be found or used outside the game executable. They are referenced directly by the code and compiled into the game engine itself.

Crunched Screen Image

2016-07-26T17:26:34Z

SaxxonPike: Created page with "A special format is used internally by Super ZZT to draw the title screen and ending screen graphics. The format assumes a 80x25 display window. == Format == There is no hea..."

A special format is used internally by Super ZZT to draw the title screen and ending screen graphics. The format assumes a 80x25 display window.

== Format ==

There is no header information for this format. It is read as a stream of bytes until the Y-position goes off the bottom (row 25).

{|class="wikitable"
!Value!!Description
|-
|00-0F||Set the foreground color of following output to this value.
|-
|10-17||Set the background color of following output to the lower 4 bits of this value.
|-
|18||Go to the beginning of the following text line.
|-
|19||Read one more byte ''n'', and output a space character ''n''+1 times.
|-
|1A||Read two more bytes ''n'' and ''char'', and output ''char'' for ''n''+1 times.
|-
|1B-1F||Undefined?
|-
|20-FF||Output this character exactly.
|}

== Location ==

These graphics cannot be found or used outside the game executable. They are referenced directly by the code and compiled into the game engine itself.

Super ZZT

2016-07-26T17:13:45Z

SaxxonPike:

{{Stub}}

{{Game Infobox
| Levels = Edit
| Tiles = No
| Sprites = No
| Fullscreen = No
| Sound = No
| Music = No
| Text = No
| Story = No
| Interface = No
}}

== Game info ==

Super ZZT is an object-oriented game scripting engine created by Tim Sweeney. There were 3 worlds released with the commercial version of the game: PROVING, FOREST, and MONSTER. The shareware version of Super ZZT came with just MONSTER.

== Editor ==

While Super ZZT features a world editor, it was considered too buggy for release and was hidden from users. However, the ZZT community was eventually able to locate the command line switch to enable the use of the built-in editor. It can be enabled from the command line using "SUPERZ /E" to start the game, and then opened by pressing "E" at the title screen.

== Versions ==

The latest version of the game is v2.0. The only other known version is v1.1. There are no observable differences between the two versions of the game aside from the opening and closing screens.

{| class="wikitable"
|-
! Version
! File Size (decompressed)
|-
| 1.1
| 53,924 (108,288)
|-
| 2.0
| 54,076 (109,072)
|}

== File formats ==

* [[ZZT Format#Board Format|BRD Format]] - Board format. This is stored exactly the same as in a world, but it's just one board.
* [[SZT Format]] - World format.
* [[Super ZZT Graphics Format|Graphics Format]] - Format of the ANSI art on the title screen and the exit screen.

[[Category:Epic Megagames]]
[[Category:ZZT]]
[[Category:Game Intro Page]]

ZZT Format

2016-07-18T18:05:09Z

SaxxonPike: /* ZZT board header */ Clarify board length bytes.

{{Playerdata Infobox
| Savegame = Yes
| Where = ?
| Elements = Ammo, gems, keys, scores, many others
| Games =
{{Game|ZZT}}
{{Game|Super ZZT}}
}}

A world file (.ZZT, .SZT) contains information about a game world, status of the player, and all its boards. Saved games (.SAV) are the same format as world files with a different extension and a different setting for the Lock byte.

While there are built-in editors for these games, they do not provide full editing functionality.

== Limits ==

ZZT and Super ZZT have limits imposed either by the game itself or by the data types used to store information about the world's contents.

{|class="wikitable"
!Limitation!!ZZT!!Super ZZT
|-
|Board count (including title screen)||101||33
|-
|Board size (in bytes)||32767||32767
|-
|Board size (in tiles)||60x25||96x80
|-
|Status Elements per board (including Player)||151||129
|-
|Flag strings||10||16
|}

Realistically, the original ZZT can only support boards up to around 20k due to the code itself. ZZT 4.0 by WiL, a hack of the original game executable, can support the full 32k.

== World Format ==

There are two formats for a world file. One is for ZZT and the other is for SuperZZT. The formats are very similar. All 8-bit (byte) values are unsigned. All 16-bit (short) values are signed. Boolean values (such as a player's keys) are represented with 0 for false and 1 for true; any other values may cause inconsistent behavior.

World Name is used by the game to determine which file to load after the player quits and restarts the game. Therefore if a world contains a world name that is actually the filename of another world, after the player quits and restarts the game, the world with the matching filename will be loaded!

There are some unused bytes after the world information that are ignored by the game. While it is safe to put any data whatsoever into this unused space, it is not saved back to disk by the game engine and will be converted to empty padding. [[ZZTAE]] is an editor that uses this space to store extra information such as the author and genre.

=== Common world information ===

The storage of this information is the same between the two formats. After this part of the file, the format will differ slightly.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF FF) and SuperZZT uses -2 (FE FF).
|-
|2||0x002||[[INT16LE]]||NumBoards Number of boards in the world, not including the title screen. Increment by 1 for the real number of stored boards. A value of 0 means only the title screen exists.
|-
|4||0x004||[[INT16LE]]||PlayerAmmo Player's ammunition.
|-
|6||0x006||[[INT16LE]]||PlayerGems Player's gems.
|-
|8||0x008||[[char]][7]||PlayerKeys Player's keys. A nonzero value means the player has the specified key. The keys are in this order: Blue, Green, Cyan, Red, Purple, Yellow, White.
|-
|15||0x00F||[[INT16LE]]||PlayerHealth Player's health.
|-
|17||0x011||[[INT16LE]]||PlayerBoard In a world file, this will be the starting board for the player (the title screen, board 0, is always shown first). In a saved game, this will be the board that the player is currently on.
|-
|}

=== ZZT world header ===

This is the second half of the header specific to a .ZZT file. After this information, storage of the boards starts at byte offset 512 (hex 0x200).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||PlayerTorches Player's torches.
|-
|21||0x015||[[INT16LE]]||TorchCycles Game cycles left for a torch to remain lit.
|-
|23||0x017||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|25||0x019||[[INT16LE]]||(unused) Always 0.
|-
|27||0x01B||[[INT16LE]]||PlayerScore Player's score.
|-
|29||0x01D||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|30||0x01E||[[char]][20]||WorldName Internal name of the world.
|-
|50||0x032||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|51||0x033||[[char]][20]||Flag0 Name of Flag 0.
|-
|71||0x047||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|72||0x048||[[char]][20]||Flag1 Name of Flag 1.
|-
|92||0x05C||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|93||0x05D||[[char]][20]||Flag2 Name of Flag 2.
|-
|113||0x071||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|114||0x072||[[char]][20]||Flag3 Name of Flag 3.
|-
|134||0x086||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|135||0x087||[[char]][20]||Flag4 Name of Flag 4.
|-
|155||0x09B||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|156||0x09C||[[char]][20]||Flag5 Name of Flag 5.
|-
|176||0x0B0||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|177||0x0B1||[[char]][20]||Flag6 Name of Flag 6.
|-
|197||0x0C5||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|198||0x0C6||[[char]][20]||Flag7 Name of Flag 7.
|-
|218||0x0DA||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|219||0x0DB||[[char]][20]||Flag8 Name of Flag 8.
|-
|239||0x0EF||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|240||0x0F0||[[char]][20]||Flag9 Name of Flag 9.
|-
|260||0x104||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|262||0x106||[[INT16LE]]||PlayerData This stores a runtime memory location that points to the status element currently being used by the player. Its value is not used when loading worlds, and is always set to 0 when saving worlds.
|-
|264||0x108||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|}

=== Super ZZT world header ===

This is the second half of the header specific to a .SZT file. After this information, storage of the boards starts at byte offset 1024 (hex 0x400).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||(unused) Always 0.
|-
|21||0x015||[[INT16LE]]||PlayerScore Player's score.
|-
|23||0x017||[[INT16LE]]||(unused) Always 0.
|-
|25||0x019||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|27||0x01B||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|28||0x01C||[[char]][20]||WorldName Internal name of the world.
|-
|48||0x030||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|49||0x031||[[char]][20]||Flag0 Name of Flag 0.
|-
|69||0x045||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|70||0x046||[[char]][20]||Flag1 Name of Flag 1.
|-
|90||0x05A||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|91||0x05B||[[char]][20]||Flag2 Name of Flag 2.
|-
|111||0x06F||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|112||0x070||[[char]][20]||Flag3 Name of Flag 3.
|-
|132||0x084||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|133||0x085||[[char]][20]||Flag4 Name of Flag 4.
|-
|153||0x099||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|154||0x09A||[[char]][20]||Flag5 Name of Flag 5.
|-
|174||0x0AE||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|175||0x0AF||[[char]][20]||Flag6 Name of Flag 6.
|-
|195||0x0C3||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|196||0x0C4||[[char]][20]||Flag7 Name of Flag 7.
|-
|216||0x0D8||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|217||0x0D9||[[char]][20]||Flag8 Name of Flag 8.
|-
|237||0x0ED||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|238||0x0EE||[[char]][20]||Flag9 Name of Flag 9.
|-
|258||0x102||[[UINT8]]||Flag10Length Length of the name of Flag 10.
|-
|259||0x103||[[char]][20]||Flag10 Name of Flag 10.
|-
|279||0x117||[[UINT8]]||Flag11Length Length of the name of Flag 11.
|-
|280||0x118||[[char]][20]||Flag11 Name of Flag 11.
|-
|300||0x12C||[[UINT8]]||Flag12Length Length of the name of Flag 12.
|-
|301||0x12D||[[char]][20]||Flag12 Name of Flag 12.
|-
|321||0x141||[[UINT8]]||Flag13Length Length of the name of Flag 13.
|-
|322||0x142||[[char]][20]||Flag13 Name of Flag 13.
|-
|342||0x156||[[UINT8]]||Flag14Length Length of the name of Flag 14.
|-
|343||0x157||[[char]][20]||Flag14 Name of Flag 14.
|-
|363||0x16B||[[UINT8]]||Flag15Length Length of the name of Flag 15.
|-
|364||0x16C||[[char]][20]||Flag15 Name of Flag 15.
|-
|384||0x180||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|386||0x182||[[INT16LE]]||PlayerData This stores a runtime memory location that points to the status element currently being used by the player. Its value is not used when loading worlds, and is always set to 0 when saving worlds.
|-
|388||0x184||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|389||0x185||[[INT16LE]]||PlayerStones Player's stones of power. If this value is negative, no information is shown in-game about them. If this value is >= 0, it uses a flag to describe this value in the status bar of the game. The flag used is the first one found that is preceded with a Z. "The Lost Forest" contains a flag called "ZSTONES" which shows as "STONES" on the status bar, for example.
|}

== Board Format ==

Boards can be stored individually in .BRD files. Since ZZT and Super ZZT use the same extension for boards and there is no world information stored with them, it isn't immediately apparent whether the board is a ZZT or a Super ZZT board. Testing the validity of the board information with both world types should be a good way to determine the type of world a board belongs to.

=== Format layout ===

Boards consist of 4 parts: Board Header, RLE Tiles, Board Properties, and Status Element Properties. Status Elements are elements on the board that the game actively processes - these include the player, enemies, any animating blocks, and Scrolls and Objects which can contain ZZT-OOP code.

=== ZZT board header ===

ZZT boards are 60x25 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes (excluding the two bytes from this value). Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][50]||BoardName Board's name.
|-
|53||0x035||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Super ZZT board header ===

Super ZZT boards are 96x80 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][60]||BoardName Board's name.
|-
|63||0x03F||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Run-length encoded tile data ===

Tile data is represented as sets of 3 bytes. These sets are repeated until the board is completely filled. For ZZT, this will be 60*25=1500 tiles. For SuperZZT, this will be 96*80=7680 tiles. The tiles are unpacked from left to right, top to bottom.

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Count Number of tiles.
|-
|[[UINT8]]||Element Element of the tiles.
|-
|[[UINT8]]||Color Color of the tiles.
|-
|}

A small quirk of this RLE format is when the number of tiles is set to zero. Due to the way the decoder is set up, a Count of 0 means there are actually 256 tiles encoded. The built-in editor does not encode tiles using this value despite being decoded correctly in the game, and it will probably crash some older external editors.

=== ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||IsDark When set to 1, the board is covered in darkness which can only be revealed by using a torch.
|-
|2||0x002||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|3||0x003||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|4||0x004||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|5||0x005||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|6||0x006||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|7||0x007||[[UINT8]]||MessageLength Length of the on-screen message.
|-
|8||0x008||[[char]][58]||Message On-screen message. This is used internally and is not loaded by the game.
|-
|66||0x042||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|67||0x043||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|68||0x044||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|70||0x046||[[UINT8]][16]||(unused)
|-
|86||0x056||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|-
|}

=== Super ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|2||0x002||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|3||0x003||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|4||0x004||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|5||0x005||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|6||0x006||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|7||0x007||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|8||0x008||[[INT16LE]]||CameraX X-coordinate of the viewport. This value is not used when loading worlds.
|-
|10||0x00A||[[INT16LE]]||CameraY Y-coordinate of the viewport. This value is not used when loading worlds.
|-
|12||0x00C||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|14||0x00E||[[UINT8]][14]||(unused)
|-
|28||0x01C||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|}

=== Status Elements ===

This follows directly after board properties. It is repeated for each Status Element. The first element stored is always the player-controlled element. This element may contain strange values for Step, Leader and Follower information - this is because these values are used internally by the game.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||LocationX X-coordinate. Location coordinates are 1-based, unlike any other coordinates in the file.
|-
|1||0x001||[[UINT8]]||LocationY Y-coordinate.
|-
|2||0x002||[[INT16LE]]||StepX X-step value. This pair of values represents a vector that typically points in one of the four cardinal directions. Its use differs for each type of element.
|-
|4||0x004||[[INT16LE]]||StepY Y-step value.
|-
|6||0x006||[[INT16LE]]||Cycle Cycle. This represents the frequency, in ticks, at which the game will process this status element.
|-
|8||0x008||[[UINT8]]||P1 Parameter 1. Its use will differ depending on the type of element.
|-
|9||0x009||[[UINT8]]||P2 Parameter 2. Its use will differ depending on the type of element.
|-
|10||0x00A||[[UINT8]]||P3 Parameter 3. Its use will differ depending on the type of element.
|-
|11||0x00B||[[INT16LE]]||Follower Follower status element. Its value determines if another status element is linked behind this one. Typically used for linking centipedes.
|-
|13||0x00D||[[INT16LE]]||Leader Leader status element. Its value determines if another status element is linked in front of this one. Typically used for linking centipedes.
|-
|15||0x00F||[[UINT8]]||UnderID Element of the tile under this status element.
|-
|16||0x010||[[UINT8]]||UnderColor Color of the tile under this status element.
|-
|17||0x011||[[INT32LE]]||Pointer Stores the location in memory of the code that this status element is using. Status elements typically point to their own code until they #BIND the code of another - in which case this memory location value is replaced with the new one. ZZT does not use this value when loading worlds, and always sets it to 0 when saving worlds.
|-
|21||0x015||[[INT16LE]]||CurrentInstruction The offset in bytes of the code block to execute ZZT-OOP from. Only Objects and Scrolls can execute ZZT-OOP.
|-
|23||0x017||[[INT16LE]]||Length There are two uses for this value: If this value is positive, it represents the number of bytes that are in the code block. If this value is negative, the absolute value of this value represents the Status Element number to copy code from. This saves space by removing redundant code duplication. Since code is shared in this way, all modifications to code will affect any other Status Elements using it.
|-
|}

In ZZT (not Super ZZT), 8 bytes of padding will follow.

If "Length" is positive, the code will be stored here.

== Element Lists ==

This is a list of all valid built-in elements that can be used. Using any elements outside this range produce undefined behavior which is dependent on whatever was residing in memory at the time the game was loaded. Most often, it will crash.

=== Element properties ===

These are all possible internal properties for each element. '''Note:''' The addresses shown are not really significant- you should only consider which ones share the same code to cut down on how many element behaviors to consider.

{|class="wikitable"
!Property!!Description
|-
|Id||Id number of the element
|-
|Hex||Hexidecimal representation of the Id number
|-
|Name||Known name of the element, which may not be present internally
|-
|Character||ASCII character for the default draw code, which may be ignored if special draw code is enabled
|-
|Color||Default color. If the color is 0xFE, then new tiles will be created with the primary color as the background and a white foreground. If the color is >= 0xF0, any primary color is allowed, but in the editor you can't choose the color unless the default color is 0xFF
|-
|Destructible||Element can be destroyed by bullets and by being crushed by puzzle pieces
|-
|Pushable||Element can be pushed. The NS/EW sliders are a special case in the code, so they will not be marked with this flag
|-
|Editor Floor||When using the editor, actors such as enemies can be placed on top of elements marked with this flag. Has no effect during gameplay.
|-
|Floor||Elements with this flag can freely be moved upon by actors
|-
|Shown||ZZT only. Elements marked with this flag will always be shown, even on dark boards
|-
|Special Draw||If this flag is set, the default draw code is bypassed with different draw code
|-
|Draw Code||Offset of the routine that performs the drawing, if Special Draw is set
|-
|Cycle||Default cycle. If this is -1, the element is not generated as an actor. Creatures will have cycles above zero
|-
|Act Code||Offset of the routine that performs standard behavior. For example: creature movement, bomb countdown
|-
|Interact Code||Offset of the routine that handles when a player touches the element. For example: item pickups, entering a passage
|-
|Menu#||Number of the editor menu where this element can be found
|-
|Key||Key press which is mapped to this element in the editor
|-
|Internal Name||Name of the element used in the editor. It is also used by OOP- the parser will remove all symbols and spaces and compare that
|-
|Category||When it comes time to display this element in the editor, if present, the category will be drawn in yellow first.
|-
|Edit P1||Text to show when editing the P1 of an actor that uses this element
|-
|Edit P2||Text to show when editing the P2 of an actor that uses this element
|-
|Edit P3||Text to show when editing the P3 of an actor that uses this element
|-
|Edit Board||Text to show when selecting the target board
|-
|Edit Step||Text to show when selecting the target direction
|-
|Edit Code||Text to show when editing an actor's code (scroll or object OOP)
|-
|Points||When an actor using this element is killed by the player, it's worth this much score
|-
|}

=== ZZT elements ===

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Shown!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3973||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x20||0x07||||||||||||||0x0020||1||0x4481||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||Yes||||0x0020||1||0x3E2F||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||||0x0020||-1||0x0000||0x3289||1||A||Ammo||||||||||||||||0
|-
|6||0x06||Torch||0x9D||0x06||||||||||Yes||||0x0020||-1||0x0000||0x37B6||1||T||Torch||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||||0x0020||-1||0x0000||0x3306||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x3169||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||||0x0020||-1||0x0000||0x33DA||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||||0x0020||1||0x2F9F||0x308B||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||Yes||||0x0020||0||0x0000||0x3372||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||||Yes||0x2A15||2||0x2BFF||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||||Yes||0x1872||6||0x18DA||0x19F3||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||||0x0020||-1||0x0000||0x2034||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||Star||0x53||0x0F||||||||||||Yes||0x1D5D||1||0x1DE9||0x00F5||0||||Star||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||||Yes||0x171C||3||0x176C||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||||Yes||0x17C7||2||0x1817||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||Bullet||0xF8||0x0F||Yes||||||||||||0x0020||1||0x0F65||0x00F5||0||||Bullet||||||||||||||||0
|-
|19||0x13||Water||0xB0||0xF9||||||Yes||||||||0x0020||-1||0x0000||0x3B03||3||W||Water||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||||0x0020||-1||0x0000||0x38D0||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x34E3||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||||0x0020||-1||0x0000||0x3949||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0xB0||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3848||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||||Yes||0x242E||1||0x2445||0x0010||3||L||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||||Yes||0x1CC5||2||0x1C85||0x1C41||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||||Yes||0x122A||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0x99||0x06||Yes||Yes||||||||||0x0020||3||0x054F||0x00F5||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||||0x0020||1||0x0351||0x00F5||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||||Yes||0x2B85||3||0x2AA5||0x2BB7||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||||0x0020||3||0x20AE||0x2295||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||Shark||0x5E||0x07||||||||||||||0x0020||3||0x2321||0x0010||2||Y||Shark||||Intelligence?||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||||Yes||0x11D0||2||0x12A7||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||||Yes||0x3517||4||0x358A||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||||0x0020||2||0x0113||0x00F5||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||||0x0020||2||0x022D||0x00F5||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||||0x0020||2||0x06BF||0x00F5||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||||0x0020||2||0x0EED||0x00F5||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Text (Blue)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|48||0x30||Text (Green)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|49||0x31||Text (Cyan)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|50||0x32||Text (Red)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|51||0x33||Text (Purple)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|52||0x34||Text (Brown)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||Text (Black)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

=== Super ZZT elements ===

Internal properties for each of these elements can be found in the [http://pastebin.com/mdEwu6Y1 Super ZZT Elements Pastebin].

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3FA5||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x02||0x1F||||Yes||||||||0x0020||1||0x4B76||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||||0x0020||1||0x4596||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||0x0020||-1||0x0000||0x37E7||1||A||Ammo||||||||||||||||0
|-
|6||0x06||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||0x0020||-1||0x0000||0x397D||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x36F2||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||0x0020||-1||0x0000||0x3A63||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||0x0020||1||0x3517||0x3603||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||||0x0020||0||0x0000||0x39ED||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||Yes||0x2E32||2||0x3177||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||Yes||0x1DBD||6||0x1E25||0x1F3F||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||0x0020||-1||0x0000||0x2581||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||Yes||0x1C67||3||0x1CB7||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||Yes||0x1D12||2||0x1D62||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|19||0x13||Lava||0x6F||0x4E||||||Yes||||||0x0020||-1||0x0000||0x4155||3||L||Lava||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||0x0020||-1||0x0000||0x3EAF||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x3B5A||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x3F6C||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3E23||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||Yes||0x285B||1||0x2872||0x0010||3||X||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||Yes||0x2216||2||0x21D6||0x2192||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||Yes||0x17C3||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0xEB||0x02||Yes||Yes||||||||0x0020||3||0x09C1||0x014C||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||0x0020||1||0x07C3||0x014C||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||Yes||0x30FD||3||0x2EC2||0x312F||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||0x0020||3||0x25E8||0x27CF||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||Yes||0x1663||2||0x1811||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||Yes||0x3B8E||4||0x3C01||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||0x0020||2||0x016A||0x014C||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||0x0020||2||0x0284||0x014C||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||0x0020||2||0x0B31||0x014C||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||0x0020||2||0x1375||0x014C||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Floor||0xB0||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||F||Floor||Terrains:||||||||||||||0
|-
|48||0x30||Water N||0x1E||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||8||Water N||||||||||||||||0
|-
|49||0x31||Water S||0x1F||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||2||Water S||||||||||||||||0
|-
|50||0x32||Water W||0x11||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||4||Water W||||||||||||||||0
|-
|51||0x33||Water E||0x10||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||6||Water E||||||||||||||||0
|-
|52||0x34||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|54||0x36||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|55||0x37||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|56||0x38||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|57||0x39||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|58||0x3A||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|59||0x3B||Roton||0x94||0x0D||Yes||Yes||||||||0x0020||1||0x03A8||0x014C||4||R||Roton||Uglies:||Intelligence?||Switch Rate?||||||||||2
|-
|60||0x3C||Dragon Pup||0xED||0x04||Yes||Yes||||||Yes||0x05A3||2||0x0563||0x014C||4||D||Dragon Pup||||Intelligence?||Switch Rate?||||||||||1
|-
|61||0x3D||Pairer||0xE5||0x01||Yes||Yes||||||||0x0020||2||0x05E6||0x014C||4||P||Pairer||||Intelligence?||||||||||||2
|-
|62||0x3E||Spider||0x0F||Any (0xFF)||Yes||||||||||0x0020||1||0x06EB||0x014C||4||S||Spider||||Intelligence?||||||||||||3
|-
|63||0x3F||Web||0xC5||Any (0xFF)||||||Yes||Yes||Yes||0x17EA||-1||0x0000||0x0010||5||W||Web||||||||||||||||0
|-
|64||0x40||Stone||0x5A||0x0F||||||||||Yes||0x38A1||1||0x38C3||0x385E||5||Z||Stone||||||||||||||||0
|-
|65||0x41||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|66||0x42||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|67||0x43||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|68||0x44||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|69||0x45||Bullet||0xF8||0x0F||Yes||||||||||0x0020||1||0x13ED||0x014C||0||||Bullet||||||||||||||||0
|-
|70||0x46||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|71||0x47||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|72||0x48||Star||0x53||0x0F||||||||||Yes||0x22AE||1||0x233A||0x014C||0||||Star||||||||||||||||0
|-
|73||0x49||Text (Blue)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|74||0x4A||Text (Green)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|75||0x4B||Text (Cyan)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|76||0x4C||Text (Red)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|77||0x4D||Text (Purple)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|78||0x4E||Text (Brown)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|79||0x4F||Text (Black)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

== Credits ==

This file format was reverse engineered by [[User:SaxxonPike|SaxxonPike]], Kev Vance, WiL and David Hammond. If you find this information helpful in a project you're working on, please give credit where credit is due. (A link back to this wiki would be nice too!)

ZZT Format

2016-02-29T18:48:43Z

SaxxonPike: /* World Format */ Add details about the world info padding.

{{Playerdata Infobox
| Savegame = Yes
| Where = ?
| Elements = Ammo, gems, keys, scores, many others
| Games =
{{Game|ZZT}}
{{Game|Super ZZT}}
}}

A world file (.ZZT, .SZT) contains information about a game world, status of the player, and all its boards. Saved games (.SAV) are the same format as world files with a different extension and a different setting for the Lock byte.

While there are built-in editors for these games, they do not provide full editing functionality.

== Limits ==

ZZT and Super ZZT have limits imposed either by the game itself or by the data types used to store information about the world's contents.

{|class="wikitable"
!Limitation!!ZZT!!Super ZZT
|-
|Board count (including title screen)||101||33
|-
|Board size (in bytes)||32767||32767
|-
|Board size (in tiles)||60x25||96x80
|-
|Status Elements per board (including Player)||151||129
|-
|Flag strings||10||16
|}

Realistically, the original ZZT can only support boards up to around 20k due to the code itself. ZZT 4.0 by WiL, a hack of the original game executable, can support the full 32k.

== World Format ==

There are two formats for a world file. One is for ZZT and the other is for SuperZZT. The formats are very similar. All 8-bit (byte) values are unsigned. All 16-bit (short) values are signed. Boolean values (such as a player's keys) are represented with 0 for false and 1 for true; any other values may cause inconsistent behavior.

World Name is used by the game to determine which file to load after the player quits and restarts the game. Therefore if a world contains a world name that is actually the filename of another world, after the player quits and restarts the game, the world with the matching filename will be loaded!

There are some unused bytes after the world information that are ignored by the game. While it is safe to put any data whatsoever into this unused space, it is not saved back to disk by the game engine and will be converted to empty padding. [[ZZTAE]] is an editor that uses this space to store extra information such as the author and genre.

=== Common world information ===

The storage of this information is the same between the two formats. After this part of the file, the format will differ slightly.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF FF) and SuperZZT uses -2 (FE FF).
|-
|2||0x002||[[INT16LE]]||NumBoards Number of boards in the world, not including the title screen. Increment by 1 for the real number of stored boards. A value of 0 means only the title screen exists.
|-
|4||0x004||[[INT16LE]]||PlayerAmmo Player's ammunition.
|-
|6||0x006||[[INT16LE]]||PlayerGems Player's gems.
|-
|8||0x008||[[char]][7]||PlayerKeys Player's keys. A nonzero value means the player has the specified key. The keys are in this order: Blue, Green, Cyan, Red, Purple, Yellow, White.
|-
|15||0x00F||[[INT16LE]]||PlayerHealth Player's health.
|-
|17||0x011||[[INT16LE]]||PlayerBoard In a world file, this will be the starting board for the player (the title screen, board 0, is always shown first). In a saved game, this will be the board that the player is currently on.
|-
|}

=== ZZT world header ===

This is the second half of the header specific to a .ZZT file. After this information, storage of the boards starts at byte offset 512 (hex 0x200).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||PlayerTorches Player's torches.
|-
|21||0x015||[[INT16LE]]||TorchCycles Game cycles left for a torch to remain lit.
|-
|23||0x017||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|25||0x019||[[INT16LE]]||(unused) Always 0.
|-
|27||0x01B||[[INT16LE]]||PlayerScore Player's score.
|-
|29||0x01D||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|30||0x01E||[[char]][20]||WorldName Internal name of the world.
|-
|50||0x032||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|51||0x033||[[char]][20]||Flag0 Name of Flag 0.
|-
|71||0x047||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|72||0x048||[[char]][20]||Flag1 Name of Flag 1.
|-
|92||0x05C||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|93||0x05D||[[char]][20]||Flag2 Name of Flag 2.
|-
|113||0x071||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|114||0x072||[[char]][20]||Flag3 Name of Flag 3.
|-
|134||0x086||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|135||0x087||[[char]][20]||Flag4 Name of Flag 4.
|-
|155||0x09B||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|156||0x09C||[[char]][20]||Flag5 Name of Flag 5.
|-
|176||0x0B0||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|177||0x0B1||[[char]][20]||Flag6 Name of Flag 6.
|-
|197||0x0C5||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|198||0x0C6||[[char]][20]||Flag7 Name of Flag 7.
|-
|218||0x0DA||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|219||0x0DB||[[char]][20]||Flag8 Name of Flag 8.
|-
|239||0x0EF||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|240||0x0F0||[[char]][20]||Flag9 Name of Flag 9.
|-
|260||0x104||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|262||0x106||[[INT16LE]]||PlayerData This stores a runtime memory location that points to the status element currently being used by the player. Its value is not used when loading worlds, and is always set to 0 when saving worlds.
|-
|264||0x108||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|}

=== Super ZZT world header ===

This is the second half of the header specific to a .SZT file. After this information, storage of the boards starts at byte offset 1024 (hex 0x400).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||(unused) Always 0.
|-
|21||0x015||[[INT16LE]]||PlayerScore Player's score.
|-
|23||0x017||[[INT16LE]]||(unused) Always 0.
|-
|25||0x019||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|27||0x01B||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|28||0x01C||[[char]][20]||WorldName Internal name of the world.
|-
|48||0x030||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|49||0x031||[[char]][20]||Flag0 Name of Flag 0.
|-
|69||0x045||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|70||0x046||[[char]][20]||Flag1 Name of Flag 1.
|-
|90||0x05A||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|91||0x05B||[[char]][20]||Flag2 Name of Flag 2.
|-
|111||0x06F||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|112||0x070||[[char]][20]||Flag3 Name of Flag 3.
|-
|132||0x084||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|133||0x085||[[char]][20]||Flag4 Name of Flag 4.
|-
|153||0x099||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|154||0x09A||[[char]][20]||Flag5 Name of Flag 5.
|-
|174||0x0AE||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|175||0x0AF||[[char]][20]||Flag6 Name of Flag 6.
|-
|195||0x0C3||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|196||0x0C4||[[char]][20]||Flag7 Name of Flag 7.
|-
|216||0x0D8||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|217||0x0D9||[[char]][20]||Flag8 Name of Flag 8.
|-
|237||0x0ED||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|238||0x0EE||[[char]][20]||Flag9 Name of Flag 9.
|-
|258||0x102||[[UINT8]]||Flag10Length Length of the name of Flag 10.
|-
|259||0x103||[[char]][20]||Flag10 Name of Flag 10.
|-
|279||0x117||[[UINT8]]||Flag11Length Length of the name of Flag 11.
|-
|280||0x118||[[char]][20]||Flag11 Name of Flag 11.
|-
|300||0x12C||[[UINT8]]||Flag12Length Length of the name of Flag 12.
|-
|301||0x12D||[[char]][20]||Flag12 Name of Flag 12.
|-
|321||0x141||[[UINT8]]||Flag13Length Length of the name of Flag 13.
|-
|322||0x142||[[char]][20]||Flag13 Name of Flag 13.
|-
|342||0x156||[[UINT8]]||Flag14Length Length of the name of Flag 14.
|-
|343||0x157||[[char]][20]||Flag14 Name of Flag 14.
|-
|363||0x16B||[[UINT8]]||Flag15Length Length of the name of Flag 15.
|-
|364||0x16C||[[char]][20]||Flag15 Name of Flag 15.
|-
|384||0x180||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|386||0x182||[[INT16LE]]||PlayerData This stores a runtime memory location that points to the status element currently being used by the player. Its value is not used when loading worlds, and is always set to 0 when saving worlds.
|-
|388||0x184||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|389||0x185||[[INT16LE]]||PlayerStones Player's stones of power. If this value is negative, no information is shown in-game about them. If this value is >= 0, it uses a flag to describe this value in the status bar of the game. The flag used is the first one found that is preceded with a Z. "The Lost Forest" contains a flag called "ZSTONES" which shows as "STONES" on the status bar, for example.
|}

== Board Format ==

Boards can be stored individually in .BRD files. Since ZZT and Super ZZT use the same extension for boards and there is no world information stored with them, it isn't immediately apparent whether the board is a ZZT or a Super ZZT board. Testing the validity of the board information with both world types should be a good way to determine the type of world a board belongs to.

=== Format layout ===

Boards consist of 4 parts: Board Header, RLE Tiles, Board Properties, and Status Element Properties. Status Elements are elements on the board that the game actively processes - these include the player, enemies, any animating blocks, and Scrolls and Objects which can contain ZZT-OOP code.

=== ZZT board header ===

ZZT boards are 60x25 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][50]||BoardName Board's name.
|-
|53||0x035||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Super ZZT board header ===

Super ZZT boards are 96x80 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][60]||BoardName Board's name.
|-
|63||0x03F||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Run-length encoded tile data ===

Tile data is represented as sets of 3 bytes. These sets are repeated until the board is completely filled. For ZZT, this will be 60*25=1500 tiles. For SuperZZT, this will be 96*80=7680 tiles. The tiles are unpacked from left to right, top to bottom.

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Count Number of tiles.
|-
|[[UINT8]]||Element Element of the tiles.
|-
|[[UINT8]]||Color Color of the tiles.
|-
|}

A small quirk of this RLE format is when the number of tiles is set to zero. Due to the way the decoder is set up, a Count of 0 means there are actually 256 tiles encoded. The built-in editor does not encode tiles using this value despite being decoded correctly in the game, and it will probably crash some older external editors.

=== ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||IsDark When set to 1, the board is covered in darkness which can only be revealed by using a torch.
|-
|2||0x002||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|3||0x003||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|4||0x004||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|5||0x005||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|6||0x006||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|7||0x007||[[UINT8]]||MessageLength Length of the on-screen message.
|-
|8||0x008||[[char]][58]||Message On-screen message. This is used internally and is not loaded by the game.
|-
|66||0x042||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|67||0x043||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|68||0x044||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|70||0x046||[[UINT8]][16]||(unused)
|-
|86||0x056||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|-
|}

=== Super ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|2||0x002||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|3||0x003||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|4||0x004||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|5||0x005||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|6||0x006||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|7||0x007||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|8||0x008||[[INT16LE]]||CameraX X-coordinate of the viewport. This value is not used when loading worlds.
|-
|10||0x00A||[[INT16LE]]||CameraY Y-coordinate of the viewport. This value is not used when loading worlds.
|-
|12||0x00C||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|14||0x00E||[[UINT8]][14]||(unused)
|-
|28||0x01C||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|}

=== Status Elements ===

This follows directly after board properties. It is repeated for each Status Element. The first element stored is always the player-controlled element. This element may contain strange values for Step, Leader and Follower information - this is because these values are used internally by the game.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||LocationX X-coordinate. Location coordinates are 1-based, unlike any other coordinates in the file.
|-
|1||0x001||[[UINT8]]||LocationY Y-coordinate.
|-
|2||0x002||[[INT16LE]]||StepX X-step value. This pair of values represents a vector that typically points in one of the four cardinal directions. Its use differs for each type of element.
|-
|4||0x004||[[INT16LE]]||StepY Y-step value.
|-
|6||0x006||[[INT16LE]]||Cycle Cycle. This represents the frequency, in ticks, at which the game will process this status element.
|-
|8||0x008||[[UINT8]]||P1 Parameter 1. Its use will differ depending on the type of element.
|-
|9||0x009||[[UINT8]]||P2 Parameter 2. Its use will differ depending on the type of element.
|-
|10||0x00A||[[UINT8]]||P3 Parameter 3. Its use will differ depending on the type of element.
|-
|11||0x00B||[[INT16LE]]||Follower Follower status element. Its value determines if another status element is linked behind this one. Typically used for linking centipedes.
|-
|13||0x00D||[[INT16LE]]||Leader Leader status element. Its value determines if another status element is linked in front of this one. Typically used for linking centipedes.
|-
|15||0x00F||[[UINT8]]||UnderID Element of the tile under this status element.
|-
|16||0x010||[[UINT8]]||UnderColor Color of the tile under this status element.
|-
|17||0x011||[[INT32LE]]||Pointer Stores the location in memory of the code that this status element is using. Status elements typically point to their own code until they #BIND the code of another - in which case this memory location value is replaced with the new one. ZZT does not use this value when loading worlds, and always sets it to 0 when saving worlds.
|-
|21||0x015||[[INT16LE]]||CurrentInstruction The offset in bytes of the code block to execute ZZT-OOP from. Only Objects and Scrolls can execute ZZT-OOP.
|-
|23||0x017||[[INT16LE]]||Length There are two uses for this value: If this value is positive, it represents the number of bytes that are in the code block. If this value is negative, the absolute value of this value represents the Status Element number to copy code from. This saves space by removing redundant code duplication. Since code is shared in this way, all modifications to code will affect any other Status Elements using it.
|-
|}

In ZZT (not Super ZZT), 8 bytes of padding will follow.

If "Length" is positive, the code will be stored here.

== Element Lists ==

This is a list of all valid built-in elements that can be used. Using any elements outside this range produce undefined behavior which is dependent on whatever was residing in memory at the time the game was loaded. Most often, it will crash.

=== Element properties ===

These are all possible internal properties for each element. '''Note:''' The addresses shown are not really significant- you should only consider which ones share the same code to cut down on how many element behaviors to consider.

{|class="wikitable"
!Property!!Description
|-
|Id||Id number of the element
|-
|Hex||Hexidecimal representation of the Id number
|-
|Name||Known name of the element, which may not be present internally
|-
|Character||ASCII character for the default draw code, which may be ignored if special draw code is enabled
|-
|Color||Default color. If the color is 0xFE, then new tiles will be created with the primary color as the background and a white foreground. If the color is >= 0xF0, any primary color is allowed, but in the editor you can't choose the color unless the default color is 0xFF
|-
|Destructible||Element can be destroyed by bullets and by being crushed by puzzle pieces
|-
|Pushable||Element can be pushed. The NS/EW sliders are a special case in the code, so they will not be marked with this flag
|-
|Editor Floor||When using the editor, actors such as enemies can be placed on top of elements marked with this flag. Has no effect during gameplay.
|-
|Floor||Elements with this flag can freely be moved upon by actors
|-
|Shown||ZZT only. Elements marked with this flag will always be shown, even on dark boards
|-
|Special Draw||If this flag is set, the default draw code is bypassed with different draw code
|-
|Draw Code||Offset of the routine that performs the drawing, if Special Draw is set
|-
|Cycle||Default cycle. If this is -1, the element is not generated as an actor. Creatures will have cycles above zero
|-
|Act Code||Offset of the routine that performs standard behavior. For example: creature movement, bomb countdown
|-
|Interact Code||Offset of the routine that handles when a player touches the element. For example: item pickups, entering a passage
|-
|Menu#||Number of the editor menu where this element can be found
|-
|Key||Key press which is mapped to this element in the editor
|-
|Internal Name||Name of the element used in the editor. It is also used by OOP- the parser will remove all symbols and spaces and compare that
|-
|Category||When it comes time to display this element in the editor, if present, the category will be drawn in yellow first.
|-
|Edit P1||Text to show when editing the P1 of an actor that uses this element
|-
|Edit P2||Text to show when editing the P2 of an actor that uses this element
|-
|Edit P3||Text to show when editing the P3 of an actor that uses this element
|-
|Edit Board||Text to show when selecting the target board
|-
|Edit Step||Text to show when selecting the target direction
|-
|Edit Code||Text to show when editing an actor's code (scroll or object OOP)
|-
|Points||When an actor using this element is killed by the player, it's worth this much score
|-
|}

=== ZZT elements ===

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Shown!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3973||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x20||0x07||||||||||||||0x0020||1||0x4481||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||Yes||||0x0020||1||0x3E2F||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||||0x0020||-1||0x0000||0x3289||1||A||Ammo||||||||||||||||0
|-
|6||0x06||Torch||0x9D||0x06||||||||||Yes||||0x0020||-1||0x0000||0x37B6||1||T||Torch||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||||0x0020||-1||0x0000||0x3306||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x3169||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||||0x0020||-1||0x0000||0x33DA||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||||0x0020||1||0x2F9F||0x308B||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||Yes||||0x0020||0||0x0000||0x3372||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||||Yes||0x2A15||2||0x2BFF||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||||Yes||0x1872||6||0x18DA||0x19F3||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||||0x0020||-1||0x0000||0x2034||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||Star||0x53||0x0F||||||||||||Yes||0x1D5D||1||0x1DE9||0x00F5||0||||Star||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||||Yes||0x171C||3||0x176C||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||||Yes||0x17C7||2||0x1817||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||Bullet||0xF8||0x0F||Yes||||||||||||0x0020||1||0x0F65||0x00F5||0||||Bullet||||||||||||||||0
|-
|19||0x13||Water||0xB0||0xF9||||||Yes||||||||0x0020||-1||0x0000||0x3B03||3||W||Water||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||||0x0020||-1||0x0000||0x38D0||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x34E3||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||||0x0020||-1||0x0000||0x3949||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0xB0||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3848||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||||Yes||0x242E||1||0x2445||0x0010||3||L||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||||Yes||0x1CC5||2||0x1C85||0x1C41||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||||Yes||0x122A||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0x99||0x06||Yes||Yes||||||||||0x0020||3||0x054F||0x00F5||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||||0x0020||1||0x0351||0x00F5||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||||Yes||0x2B85||3||0x2AA5||0x2BB7||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||||0x0020||3||0x20AE||0x2295||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||Shark||0x5E||0x07||||||||||||||0x0020||3||0x2321||0x0010||2||Y||Shark||||Intelligence?||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||||Yes||0x11D0||2||0x12A7||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||||Yes||0x3517||4||0x358A||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||||0x0020||2||0x0113||0x00F5||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||||0x0020||2||0x022D||0x00F5||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||||0x0020||2||0x06BF||0x00F5||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||||0x0020||2||0x0EED||0x00F5||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Text (Blue)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|48||0x30||Text (Green)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|49||0x31||Text (Cyan)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|50||0x32||Text (Red)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|51||0x33||Text (Purple)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|52||0x34||Text (Brown)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||Text (Black)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

=== Super ZZT elements ===

Internal properties for each of these elements can be found in the [http://pastebin.com/mdEwu6Y1 Super ZZT Elements Pastebin].

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3FA5||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x02||0x1F||||Yes||||||||0x0020||1||0x4B76||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||||0x0020||1||0x4596||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||0x0020||-1||0x0000||0x37E7||1||A||Ammo||||||||||||||||0
|-
|6||0x06||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||0x0020||-1||0x0000||0x397D||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x36F2||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||0x0020||-1||0x0000||0x3A63||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||0x0020||1||0x3517||0x3603||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||||0x0020||0||0x0000||0x39ED||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||Yes||0x2E32||2||0x3177||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||Yes||0x1DBD||6||0x1E25||0x1F3F||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||0x0020||-1||0x0000||0x2581||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||Yes||0x1C67||3||0x1CB7||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||Yes||0x1D12||2||0x1D62||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|19||0x13||Lava||0x6F||0x4E||||||Yes||||||0x0020||-1||0x0000||0x4155||3||L||Lava||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||0x0020||-1||0x0000||0x3EAF||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x3B5A||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x3F6C||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3E23||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||Yes||0x285B||1||0x2872||0x0010||3||X||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||Yes||0x2216||2||0x21D6||0x2192||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||Yes||0x17C3||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0xEB||0x02||Yes||Yes||||||||0x0020||3||0x09C1||0x014C||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||0x0020||1||0x07C3||0x014C||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||Yes||0x30FD||3||0x2EC2||0x312F||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||0x0020||3||0x25E8||0x27CF||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||Yes||0x1663||2||0x1811||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||Yes||0x3B8E||4||0x3C01||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||0x0020||2||0x016A||0x014C||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||0x0020||2||0x0284||0x014C||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||0x0020||2||0x0B31||0x014C||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||0x0020||2||0x1375||0x014C||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Floor||0xB0||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||F||Floor||Terrains:||||||||||||||0
|-
|48||0x30||Water N||0x1E||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||8||Water N||||||||||||||||0
|-
|49||0x31||Water S||0x1F||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||2||Water S||||||||||||||||0
|-
|50||0x32||Water W||0x11||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||4||Water W||||||||||||||||0
|-
|51||0x33||Water E||0x10||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||6||Water E||||||||||||||||0
|-
|52||0x34||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|54||0x36||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|55||0x37||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|56||0x38||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|57||0x39||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|58||0x3A||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|59||0x3B||Roton||0x94||0x0D||Yes||Yes||||||||0x0020||1||0x03A8||0x014C||4||R||Roton||Uglies:||Intelligence?||Switch Rate?||||||||||2
|-
|60||0x3C||Dragon Pup||0xED||0x04||Yes||Yes||||||Yes||0x05A3||2||0x0563||0x014C||4||D||Dragon Pup||||Intelligence?||Switch Rate?||||||||||1
|-
|61||0x3D||Pairer||0xE5||0x01||Yes||Yes||||||||0x0020||2||0x05E6||0x014C||4||P||Pairer||||Intelligence?||||||||||||2
|-
|62||0x3E||Spider||0x0F||Any (0xFF)||Yes||||||||||0x0020||1||0x06EB||0x014C||4||S||Spider||||Intelligence?||||||||||||3
|-
|63||0x3F||Web||0xC5||Any (0xFF)||||||Yes||Yes||Yes||0x17EA||-1||0x0000||0x0010||5||W||Web||||||||||||||||0
|-
|64||0x40||Stone||0x5A||0x0F||||||||||Yes||0x38A1||1||0x38C3||0x385E||5||Z||Stone||||||||||||||||0
|-
|65||0x41||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|66||0x42||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|67||0x43||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|68||0x44||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|69||0x45||Bullet||0xF8||0x0F||Yes||||||||||0x0020||1||0x13ED||0x014C||0||||Bullet||||||||||||||||0
|-
|70||0x46||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|71||0x47||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|72||0x48||Star||0x53||0x0F||||||||||Yes||0x22AE||1||0x233A||0x014C||0||||Star||||||||||||||||0
|-
|73||0x49||Text (Blue)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|74||0x4A||Text (Green)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|75||0x4B||Text (Cyan)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|76||0x4C||Text (Red)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|77||0x4D||Text (Purple)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|78||0x4E||Text (Brown)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|79||0x4F||Text (Black)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

== Credits ==

This file format was reverse engineered by [[User:SaxxonPike|SaxxonPike]], Kev Vance, WiL and David Hammond. If you find this information helpful in a project you're working on, please give credit where credit is due. (A link back to this wiki would be nice too!)

ZZT Format

2015-09-09T02:22:36Z

SaxxonPike: More homogenized credits

== General Information ==

A world file (.ZZT, .SZT) contains information about a game world, status of the player, and all its boards. Saved games (.SAV) are the same format as world files with a different extension and a different setting for the Lock byte.

While there are built-in editors for these games, they do not provide full editing functionality.

== Limits ==

ZZT and Super ZZT have limits imposed either by the game itself or by the data types used to store information about the world's contents.

{|class="wikitable"
!Limitation!!ZZT!!Super ZZT
|-
|Board count (including title screen)||101||33
|-
|Board size (in bytes)||32767||32767
|-
|Board size (in tiles)||60x25||96x80
|-
|Status Elements per board (including Player)||151||129
|-
|Flag strings||10||16
|}

Realistically, the original ZZT can only support boards up to around 20k due to the code itself. ZZT 4.0 by WiL, a hack of the original game executable, can support the full 32k.

== World Format ==

There are two formats for a world file. One is for ZZT and the other is for SuperZZT. The formats are very similar. All 8-bit (byte) values are unsigned. All 16-bit (short) values are signed. Boolean values (such as a player's keys) are represented with 0 for false and 1 for true; any other values may cause inconsistent behavior.

World Name is used by the game to determine which file to load after the player quits and restarts the game. Therefore if a world contains a world name that is actually the filename of another world, after the player quits and restarts the game, the world with the matching filename will be loaded!

=== Common world information ===

The storage of this information is the same between the two formats. After this part of the file, the format will differ slightly.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF FF) and SuperZZT uses -2 (FE FF).
|-
|2||0x002||[[INT16LE]]||NumBoards Number of boards in the world, not including the title screen. Increment by 1 for the real number of stored boards. A value of 0 means only the title screen exists.
|-
|4||0x004||[[INT16LE]]||PlayerAmmo Player's ammunition.
|-
|6||0x006||[[INT16LE]]||PlayerGems Player's gems.
|-
|8||0x008||[[char]][7]||PlayerKeys Player's keys. A nonzero value means the player has the specified key. The keys are in this order: Blue, Green, Cyan, Red, Purple, Yellow, White.
|-
|15||0x00F||[[INT16LE]]||PlayerHealth Player's health.
|-
|17||0x011||[[INT16LE]]||PlayerBoard In a world file, this will be the starting board for the player (the title screen, board 0, is always shown first). In a saved game, this will be the board that the player is currently on.
|-
|}

=== ZZT world header ===

This is the second half of the header specific to a .ZZT file. After this information, storage of the boards starts at byte offset 512 (hex 0x200).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||PlayerTorches Player's torches.
|-
|21||0x015||[[INT16LE]]||TorchCycles Game cycles left for a torch to remain lit.
|-
|23||0x017||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|25||0x019||[[INT16LE]]||(unused) Always 0.
|-
|27||0x01B||[[INT16LE]]||PlayerScore Player's score.
|-
|29||0x01D||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|30||0x01E||[[char]][20]||WorldName Internal name of the world.
|-
|50||0x032||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|51||0x033||[[char]][20]||Flag0 Name of Flag 0.
|-
|71||0x047||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|72||0x048||[[char]][20]||Flag1 Name of Flag 1.
|-
|92||0x05C||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|93||0x05D||[[char]][20]||Flag2 Name of Flag 2.
|-
|113||0x071||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|114||0x072||[[char]][20]||Flag3 Name of Flag 3.
|-
|134||0x086||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|135||0x087||[[char]][20]||Flag4 Name of Flag 4.
|-
|155||0x09B||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|156||0x09C||[[char]][20]||Flag5 Name of Flag 5.
|-
|176||0x0B0||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|177||0x0B1||[[char]][20]||Flag6 Name of Flag 6.
|-
|197||0x0C5||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|198||0x0C6||[[char]][20]||Flag7 Name of Flag 7.
|-
|218||0x0DA||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|219||0x0DB||[[char]][20]||Flag8 Name of Flag 8.
|-
|239||0x0EF||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|240||0x0F0||[[char]][20]||Flag9 Name of Flag 9.
|-
|260||0x104||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|262||0x106||[[INT16LE]]||PlayerData This stores a runtime memory location that points to the status element currently being used by the player. Its value is not used when loading worlds, and is always set to 0 when saving worlds.
|-
|264||0x108||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|}

=== Super ZZT world header ===

This is the second half of the header specific to a .SZT file. After this information, storage of the boards starts at byte offset 1024 (hex 0x400).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||(unused) Always 0.
|-
|21||0x015||[[INT16LE]]||PlayerScore Player's score.
|-
|23||0x017||[[INT16LE]]||(unused) Always 0.
|-
|25||0x019||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|27||0x01B||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|28||0x01C||[[char]][20]||WorldName Internal name of the world.
|-
|48||0x030||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|49||0x031||[[char]][20]||Flag0 Name of Flag 0.
|-
|69||0x045||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|70||0x046||[[char]][20]||Flag1 Name of Flag 1.
|-
|90||0x05A||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|91||0x05B||[[char]][20]||Flag2 Name of Flag 2.
|-
|111||0x06F||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|112||0x070||[[char]][20]||Flag3 Name of Flag 3.
|-
|132||0x084||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|133||0x085||[[char]][20]||Flag4 Name of Flag 4.
|-
|153||0x099||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|154||0x09A||[[char]][20]||Flag5 Name of Flag 5.
|-
|174||0x0AE||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|175||0x0AF||[[char]][20]||Flag6 Name of Flag 6.
|-
|195||0x0C3||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|196||0x0C4||[[char]][20]||Flag7 Name of Flag 7.
|-
|216||0x0D8||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|217||0x0D9||[[char]][20]||Flag8 Name of Flag 8.
|-
|237||0x0ED||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|238||0x0EE||[[char]][20]||Flag9 Name of Flag 9.
|-
|258||0x102||[[UINT8]]||Flag10Length Length of the name of Flag 10.
|-
|259||0x103||[[char]][20]||Flag10 Name of Flag 10.
|-
|279||0x117||[[UINT8]]||Flag11Length Length of the name of Flag 11.
|-
|280||0x118||[[char]][20]||Flag11 Name of Flag 11.
|-
|300||0x12C||[[UINT8]]||Flag12Length Length of the name of Flag 12.
|-
|301||0x12D||[[char]][20]||Flag12 Name of Flag 12.
|-
|321||0x141||[[UINT8]]||Flag13Length Length of the name of Flag 13.
|-
|322||0x142||[[char]][20]||Flag13 Name of Flag 13.
|-
|342||0x156||[[UINT8]]||Flag14Length Length of the name of Flag 14.
|-
|343||0x157||[[char]][20]||Flag14 Name of Flag 14.
|-
|363||0x16B||[[UINT8]]||Flag15Length Length of the name of Flag 15.
|-
|364||0x16C||[[char]][20]||Flag15 Name of Flag 15.
|-
|384||0x180||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|386||0x182||[[INT16LE]]||PlayerData This stores a runtime memory location that points to the status element currently being used by the player. Its value is not used when loading worlds, and is always set to 0 when saving worlds.
|-
|388||0x184||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|389||0x185||[[INT16LE]]||PlayerStones Player's stones of power. If this value is negative, no information is shown in-game about them. If this value is >= 0, it uses a flag to describe this value in the status bar of the game. The flag used is the first one found that is preceded with a Z. "The Lost Forest" contains a flag called "ZSTONES" which shows as "STONES" on the status bar, for example.
|}

== Board Format ==

Boards can be stored individually in .BRD files. Since ZZT and Super ZZT use the same extension for boards and there is no world information stored with them, it isn't immediately apparent whether the board is a ZZT or a Super ZZT board. Testing the validity of the board information with both world types should be a good way to determine the type of world a board belongs to.

=== Format layout ===

Boards consist of 4 parts: Board Header, RLE Tiles, Board Properties, and Status Element Properties. Status Elements are elements on the board that the game actively processes - these include the player, enemies, any animating blocks, and Scrolls and Objects which can contain ZZT-OOP code.

=== ZZT board header ===

ZZT boards are 60x25 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][50]||BoardName Board's name.
|-
|53||0x035||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Super ZZT board header ===

Super ZZT boards are 96x80 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][60]||BoardName Board's name.
|-
|63||0x03F||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Run-length encoded tile data ===

Tile data is represented as sets of 3 bytes. These sets are repeated until the board is completely filled. For ZZT, this will be 60*25=1500 tiles. For SuperZZT, this will be 96*80=7680 tiles. The tiles are unpacked from left to right, top to bottom.

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Count Number of tiles.
|-
|[[UINT8]]||Element Element of the tiles.
|-
|[[UINT8]]||Color Color of the tiles.
|-
|}

A small quirk of this RLE format is when the number of tiles is set to zero. Due to the way the decoder is set up, a Count of 0 means there are actually 256 tiles encoded. The built-in editor does not encode tiles using this value despite being decoded correctly in the game, and it will probably crash some older external editors.

=== ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||IsDark When set to 1, the board is covered in darkness which can only be revealed by using a torch.
|-
|2||0x002||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|3||0x003||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|4||0x004||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|5||0x005||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|6||0x006||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|7||0x007||[[UINT8]]||MessageLength Length of the on-screen message.
|-
|8||0x008||[[char]][58]||Message On-screen message. This is used internally and is not loaded by the game.
|-
|66||0x042||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|67||0x043||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|68||0x044||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|70||0x046||[[UINT8]][16]||(unused)
|-
|86||0x056||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|-
|}

=== Super ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|2||0x002||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|3||0x003||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|4||0x004||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|5||0x005||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|6||0x006||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|7||0x007||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|8||0x008||[[INT16LE]]||CameraX X-coordinate of the viewport. This value is not used when loading worlds.
|-
|10||0x00A||[[INT16LE]]||CameraY Y-coordinate of the viewport. This value is not used when loading worlds.
|-
|12||0x00C||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|14||0x00E||[[UINT8]][14]||(unused)
|-
|28||0x01C||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|}

=== Status Elements ===

This follows directly after board properties. It is repeated for each Status Element. The first element stored is always the player-controlled element. This element may contain strange values for Step, Leader and Follower information - this is because these values are used internally by the game.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||LocationX X-coordinate. Location coordinates are 1-based, unlike any other coordinates in the file.
|-
|1||0x001||[[UINT8]]||LocationY Y-coordinate.
|-
|2||0x002||[[INT16LE]]||StepX X-step value. This pair of values represents a vector that typically points in one of the four cardinal directions. Its use differs for each type of element.
|-
|4||0x004||[[INT16LE]]||StepY Y-step value.
|-
|6||0x006||[[INT16LE]]||Cycle Cycle. This represents the frequency, in ticks, at which the game will process this status element.
|-
|8||0x008||[[UINT8]]||P1 Parameter 1. Its use will differ depending on the type of element.
|-
|9||0x009||[[UINT8]]||P2 Parameter 2. Its use will differ depending on the type of element.
|-
|10||0x00A||[[UINT8]]||P3 Parameter 3. Its use will differ depending on the type of element.
|-
|11||0x00B||[[INT16LE]]||Follower Follower status element. Its value determines if another status element is linked behind this one. Typically used for linking centipedes.
|-
|13||0x00D||[[INT16LE]]||Leader Leader status element. Its value determines if another status element is linked in front of this one. Typically used for linking centipedes.
|-
|15||0x00F||[[UINT8]]||UnderID Element of the tile under this status element.
|-
|16||0x010||[[UINT8]]||UnderColor Color of the tile under this status element.
|-
|17||0x011||[[INT32LE]]||Pointer Stores the location in memory of the code that this status element is using. Status elements typically point to their own code until they #BIND the code of another - in which case this memory location value is replaced with the new one. ZZT does not use this value when loading worlds, and always sets it to 0 when saving worlds.
|-
|21||0x015||[[INT16LE]]||CurrentInstruction The offset in bytes of the code block to execute ZZT-OOP from. Only Objects and Scrolls can execute ZZT-OOP.
|-
|23||0x017||[[INT16LE]]||Length There are two uses for this value: If this value is positive, it represents the number of bytes that are in the code block. If this value is negative, the absolute value of this value represents the Status Element number to copy code from. This saves space by removing redundant code duplication. Since code is shared in this way, all modifications to code will affect any other Status Elements using it.
|-
|}

In ZZT (not Super ZZT), 8 bytes of padding will follow.

If "Length" is positive, the code will be stored here.

== Element Lists ==

This is a list of all valid built-in elements that can be used. Using any elements outside this range produce undefined behavior which is dependent on whatever was residing in memory at the time the game was loaded. Most often, it will crash.

=== Element properties ===

These are all possible internal properties for each element. '''Note:''' The addresses shown are not really significant- you should only consider which ones share the same code to cut down on how many element behaviors to consider.

{|class="wikitable"
!Property!!Description
|-
|Id||Id number of the element
|-
|Hex||Hexidecimal representation of the Id number
|-
|Name||Known name of the element, which may not be present internally
|-
|Character||ASCII character for the default draw code, which may be ignored if special draw code is enabled
|-
|Color||Default color. If the color is 0xFE, then new tiles will be created with the primary color as the background and a white foreground. If the color is >= 0xF0, any primary color is allowed, but in the editor you can't choose the color unless the default color is 0xFF
|-
|Destructible||Element can be destroyed by bullets and by being crushed by puzzle pieces
|-
|Pushable||Element can be pushed. The NS/EW sliders are a special case in the code, so they will not be marked with this flag
|-
|Editor Floor||When using the editor, actors such as enemies can be placed on top of elements marked with this flag. Has no effect during gameplay.
|-
|Floor||Elements with this flag can freely be moved upon by actors
|-
|Shown||ZZT only. Elements marked with this flag will always be shown, even on dark boards
|-
|Special Draw||If this flag is set, the default draw code is bypassed with different draw code
|-
|Draw Code||Offset of the routine that performs the drawing, if Special Draw is set
|-
|Cycle||Default cycle. If this is -1, the element is not generated as an actor. Creatures will have cycles above zero
|-
|Act Code||Offset of the routine that performs standard behavior. For example: creature movement, bomb countdown
|-
|Interact Code||Offset of the routine that handles when a player touches the element. For example: item pickups, entering a passage
|-
|Menu#||Number of the editor menu where this element can be found
|-
|Key||Key press which is mapped to this element in the editor
|-
|Internal Name||Name of the element used in the editor. It is also used by OOP- the parser will remove all symbols and spaces and compare that
|-
|Category||When it comes time to display this element in the editor, if present, the category will be drawn in yellow first.
|-
|Edit P1||Text to show when editing the P1 of an actor that uses this element
|-
|Edit P2||Text to show when editing the P2 of an actor that uses this element
|-
|Edit P3||Text to show when editing the P3 of an actor that uses this element
|-
|Edit Board||Text to show when selecting the target board
|-
|Edit Step||Text to show when selecting the target direction
|-
|Edit Code||Text to show when editing an actor's code (scroll or object OOP)
|-
|Points||When an actor using this element is killed by the player, it's worth this much score
|-
|}

=== ZZT elements ===

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Shown!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3973||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x20||0x07||||||||||||||0x0020||1||0x4481||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||Yes||||0x0020||1||0x3E2F||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||||0x0020||-1||0x0000||0x3289||1||A||Ammo||||||||||||||||0
|-
|6||0x06||Torch||0x9D||0x06||||||||||Yes||||0x0020||-1||0x0000||0x37B6||1||T||Torch||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||||0x0020||-1||0x0000||0x3306||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x3169||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||||0x0020||-1||0x0000||0x33DA||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||||0x0020||1||0x2F9F||0x308B||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||Yes||||0x0020||0||0x0000||0x3372||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||||Yes||0x2A15||2||0x2BFF||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||||Yes||0x1872||6||0x18DA||0x19F3||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||||0x0020||-1||0x0000||0x2034||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||Star||0x53||0x0F||||||||||||Yes||0x1D5D||1||0x1DE9||0x00F5||0||||Star||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||||Yes||0x171C||3||0x176C||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||||Yes||0x17C7||2||0x1817||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||Bullet||0xF8||0x0F||Yes||||||||||||0x0020||1||0x0F65||0x00F5||0||||Bullet||||||||||||||||0
|-
|19||0x13||Water||0xB0||0xF9||||||Yes||||||||0x0020||-1||0x0000||0x3B03||3||W||Water||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||||0x0020||-1||0x0000||0x38D0||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x34E3||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||||0x0020||-1||0x0000||0x3949||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0xB0||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3848||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||||Yes||0x242E||1||0x2445||0x0010||3||L||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||||Yes||0x1CC5||2||0x1C85||0x1C41||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||||Yes||0x122A||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0x99||0x06||Yes||Yes||||||||||0x0020||3||0x054F||0x00F5||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||||0x0020||1||0x0351||0x00F5||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||||Yes||0x2B85||3||0x2AA5||0x2BB7||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||||0x0020||3||0x20AE||0x2295||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||Shark||0x5E||0x07||||||||||||||0x0020||3||0x2321||0x0010||2||Y||Shark||||Intelligence?||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||||Yes||0x11D0||2||0x12A7||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||||Yes||0x3517||4||0x358A||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||||0x0020||2||0x0113||0x00F5||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||||0x0020||2||0x022D||0x00F5||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||||0x0020||2||0x06BF||0x00F5||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||||0x0020||2||0x0EED||0x00F5||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Text (Blue)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|48||0x30||Text (Green)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|49||0x31||Text (Cyan)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|50||0x32||Text (Red)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|51||0x33||Text (Purple)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|52||0x34||Text (Brown)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||Text (Black)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

=== Super ZZT elements ===

Internal properties for each of these elements can be found in the [http://pastebin.com/mdEwu6Y1 Super ZZT Elements Pastebin].

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3FA5||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x02||0x1F||||Yes||||||||0x0020||1||0x4B76||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||||0x0020||1||0x4596||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||0x0020||-1||0x0000||0x37E7||1||A||Ammo||||||||||||||||0
|-
|6||0x06||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||0x0020||-1||0x0000||0x397D||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x36F2||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||0x0020||-1||0x0000||0x3A63||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||0x0020||1||0x3517||0x3603||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||||0x0020||0||0x0000||0x39ED||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||Yes||0x2E32||2||0x3177||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||Yes||0x1DBD||6||0x1E25||0x1F3F||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||0x0020||-1||0x0000||0x2581||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||Yes||0x1C67||3||0x1CB7||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||Yes||0x1D12||2||0x1D62||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|19||0x13||Lava||0x6F||0x4E||||||Yes||||||0x0020||-1||0x0000||0x4155||3||L||Lava||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||0x0020||-1||0x0000||0x3EAF||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x3B5A||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x3F6C||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3E23||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||Yes||0x285B||1||0x2872||0x0010||3||X||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||Yes||0x2216||2||0x21D6||0x2192||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||Yes||0x17C3||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0xEB||0x02||Yes||Yes||||||||0x0020||3||0x09C1||0x014C||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||0x0020||1||0x07C3||0x014C||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||Yes||0x30FD||3||0x2EC2||0x312F||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||0x0020||3||0x25E8||0x27CF||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||Yes||0x1663||2||0x1811||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||Yes||0x3B8E||4||0x3C01||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||0x0020||2||0x016A||0x014C||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||0x0020||2||0x0284||0x014C||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||0x0020||2||0x0B31||0x014C||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||0x0020||2||0x1375||0x014C||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Floor||0xB0||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||F||Floor||Terrains:||||||||||||||0
|-
|48||0x30||Water N||0x1E||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||8||Water N||||||||||||||||0
|-
|49||0x31||Water S||0x1F||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||2||Water S||||||||||||||||0
|-
|50||0x32||Water W||0x11||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||4||Water W||||||||||||||||0
|-
|51||0x33||Water E||0x10||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||6||Water E||||||||||||||||0
|-
|52||0x34||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|54||0x36||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|55||0x37||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|56||0x38||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|57||0x39||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|58||0x3A||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|59||0x3B||Roton||0x94||0x0D||Yes||Yes||||||||0x0020||1||0x03A8||0x014C||4||R||Roton||Uglies:||Intelligence?||Switch Rate?||||||||||2
|-
|60||0x3C||Dragon Pup||0xED||0x04||Yes||Yes||||||Yes||0x05A3||2||0x0563||0x014C||4||D||Dragon Pup||||Intelligence?||Switch Rate?||||||||||1
|-
|61||0x3D||Pairer||0xE5||0x01||Yes||Yes||||||||0x0020||2||0x05E6||0x014C||4||P||Pairer||||Intelligence?||||||||||||2
|-
|62||0x3E||Spider||0x0F||Any (0xFF)||Yes||||||||||0x0020||1||0x06EB||0x014C||4||S||Spider||||Intelligence?||||||||||||3
|-
|63||0x3F||Web||0xC5||Any (0xFF)||||||Yes||Yes||Yes||0x17EA||-1||0x0000||0x0010||5||W||Web||||||||||||||||0
|-
|64||0x40||Stone||0x5A||0x0F||||||||||Yes||0x38A1||1||0x38C3||0x385E||5||Z||Stone||||||||||||||||0
|-
|65||0x41||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|66||0x42||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|67||0x43||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|68||0x44||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|69||0x45||Bullet||0xF8||0x0F||Yes||||||||||0x0020||1||0x13ED||0x014C||0||||Bullet||||||||||||||||0
|-
|70||0x46||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|71||0x47||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|72||0x48||Star||0x53||0x0F||||||||||Yes||0x22AE||1||0x233A||0x014C||0||||Star||||||||||||||||0
|-
|73||0x49||Text (Blue)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|74||0x4A||Text (Green)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|75||0x4B||Text (Cyan)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|76||0x4C||Text (Red)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|77||0x4D||Text (Purple)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|78||0x4E||Text (Brown)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|79||0x4F||Text (Black)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

== Credits ==

This file format was reverse engineered by [[User:SaxxonPike|SaxxonPike]], Kev Vance, WiL and David Hammond. If you find this information helpful in a project you're working on, please give credit where credit is due. (A link back to this wiki would be nice too!)
[[Category:ZZT]]
[[Category:File Formats]]

User:SaxxonPike

2015-09-08T03:56:36Z

SaxxonPike: Add personal contact info.

I'm SaxxonPike. I like to decipher game formats and write programs that modify game files. My ongoing interest in deciphering Bemani game formats has led me to discover a lot of tricks as well as techniques to more quickly discover formats and encryption schemes.

My recent interests that pertain to this Wiki are ZZT, Jill of the Jungle, Kiloblaster, and Xargon.

== Did I miss something? ==

Contact me.

E-mail: [mailto:saxxonpike@gmail.com saxxonpike@gmail.com]

Twitter [https://twitter.com/saxxonfox @SaxxonFox]

ZZT Format

2015-09-08T03:54:35Z

SaxxonPike: Call out for further info.

== Credits ==

A large portion of this information was gathered from documents written by Kev Vance (original ZZT format documentation), David Hammond (Mystical Winds Encyclopedia), and WiL (SuperZZT format documentation). A few errors have been corrected and the information has been tested in an attempt to create the most comprehensive document of both the ZZT and Super ZZT formats. This format document is primarily maintained and tested by [[User:SaxxonPike|SaxxonPike]].

'''If there's anything missing, please let SaxxonPike know, either via e-mail or Twitter.''' You may find these accounts on their [[User:SaxxonPike|user page]].

== General Information ==

A world file (.ZZT, .SZT) contains information about a game world, status of the player, and all its boards. Saved games (.SAV) are the same format as world files with a different extension and a different setting for the Lock byte.

While there are built-in editors for these games, they do not provide full editing functionality.

== Limits ==

ZZT and Super ZZT have limits imposed either by the game itself or by the data types used to store information about the world's contents.

{|class="wikitable"
!Limitation!!ZZT!!Super ZZT
|-
|Board count (including title screen)||101||33
|-
|Board size (in bytes)||32767||32767
|-
|Board size (in tiles)||60x25||96x80
|-
|Status Elements per board (including Player)||151||129
|-
|Flag strings||10||16
|}

Realistically, the original ZZT can only support boards up to around 20k due to the code itself. ZZT 4.0 by WiL, a hack of the original game executable, can support the full 32k.

== World Format ==

There are two formats for a world file. One is for ZZT and the other is for SuperZZT. The formats are very similar. All 8-bit (byte) values are unsigned. All 16-bit (short) values are signed. Boolean values (such as a player's keys) are represented with 0 for false and 1 for true; any other values may cause inconsistent behavior.

World Name is used by the game to determine which file to load after the player quits and restarts the game. Therefore if a world contains a world name that is actually the filename of another world, after the player quits and restarts the game, the world with the matching filename will be loaded!

=== Common world information ===

The storage of this information is the same between the two formats. After this part of the file, the format will differ slightly.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF FF) and SuperZZT uses -2 (FE FF).
|-
|2||0x002||[[INT16LE]]||NumBoards Number of boards in the world, not including the title screen. Increment by 1 for the real number of stored boards. A value of 0 means only the title screen exists.
|-
|4||0x004||[[INT16LE]]||PlayerAmmo Player's ammunition.
|-
|6||0x006||[[INT16LE]]||PlayerGems Player's gems.
|-
|8||0x008||[[char]][7]||PlayerKeys Player's keys. A nonzero value means the player has the specified key. The keys are in this order: Blue, Green, Cyan, Red, Purple, Yellow, White.
|-
|15||0x00F||[[INT16LE]]||PlayerHealth Player's health.
|-
|17||0x011||[[INT16LE]]||PlayerBoard In a world file, this will be the starting board for the player (the title screen, board 0, is always shown first). In a saved game, this will be the board that the player is currently on.
|-
|}

=== ZZT world header ===

This is the second half of the header specific to a .ZZT file. After this information, storage of the boards starts at byte offset 512 (hex 0x200).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||PlayerTorches Player's torches.
|-
|21||0x015||[[INT16LE]]||TorchCycles Game cycles left for a torch to remain lit.
|-
|23||0x017||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|25||0x019||[[INT16LE]]||(unused) Always 0.
|-
|27||0x01B||[[INT16LE]]||PlayerScore Player's score.
|-
|29||0x01D||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|30||0x01E||[[char]][20]||WorldName Internal name of the world.
|-
|50||0x032||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|51||0x033||[[char]][20]||Flag0 Name of Flag 0.
|-
|71||0x047||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|72||0x048||[[char]][20]||Flag1 Name of Flag 1.
|-
|92||0x05C||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|93||0x05D||[[char]][20]||Flag2 Name of Flag 2.
|-
|113||0x071||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|114||0x072||[[char]][20]||Flag3 Name of Flag 3.
|-
|134||0x086||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|135||0x087||[[char]][20]||Flag4 Name of Flag 4.
|-
|155||0x09B||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|156||0x09C||[[char]][20]||Flag5 Name of Flag 5.
|-
|176||0x0B0||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|177||0x0B1||[[char]][20]||Flag6 Name of Flag 6.
|-
|197||0x0C5||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|198||0x0C6||[[char]][20]||Flag7 Name of Flag 7.
|-
|218||0x0DA||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|219||0x0DB||[[char]][20]||Flag8 Name of Flag 8.
|-
|239||0x0EF||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|240||0x0F0||[[char]][20]||Flag9 Name of Flag 9.
|-
|260||0x104||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|262||0x106||[[INT16LE]]||PlayerData This stores a runtime memory location that points to the status element currently being used by the player. Its value is not used when loading worlds, and is always set to 0 when saving worlds.
|-
|264||0x108||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|}

=== Super ZZT world header ===

This is the second half of the header specific to a .SZT file. After this information, storage of the boards starts at byte offset 1024 (hex 0x400).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||(unused) Always 0.
|-
|21||0x015||[[INT16LE]]||PlayerScore Player's score.
|-
|23||0x017||[[INT16LE]]||(unused) Always 0.
|-
|25||0x019||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|27||0x01B||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|28||0x01C||[[char]][20]||WorldName Internal name of the world.
|-
|48||0x030||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|49||0x031||[[char]][20]||Flag0 Name of Flag 0.
|-
|69||0x045||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|70||0x046||[[char]][20]||Flag1 Name of Flag 1.
|-
|90||0x05A||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|91||0x05B||[[char]][20]||Flag2 Name of Flag 2.
|-
|111||0x06F||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|112||0x070||[[char]][20]||Flag3 Name of Flag 3.
|-
|132||0x084||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|133||0x085||[[char]][20]||Flag4 Name of Flag 4.
|-
|153||0x099||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|154||0x09A||[[char]][20]||Flag5 Name of Flag 5.
|-
|174||0x0AE||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|175||0x0AF||[[char]][20]||Flag6 Name of Flag 6.
|-
|195||0x0C3||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|196||0x0C4||[[char]][20]||Flag7 Name of Flag 7.
|-
|216||0x0D8||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|217||0x0D9||[[char]][20]||Flag8 Name of Flag 8.
|-
|237||0x0ED||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|238||0x0EE||[[char]][20]||Flag9 Name of Flag 9.
|-
|258||0x102||[[UINT8]]||Flag10Length Length of the name of Flag 10.
|-
|259||0x103||[[char]][20]||Flag10 Name of Flag 10.
|-
|279||0x117||[[UINT8]]||Flag11Length Length of the name of Flag 11.
|-
|280||0x118||[[char]][20]||Flag11 Name of Flag 11.
|-
|300||0x12C||[[UINT8]]||Flag12Length Length of the name of Flag 12.
|-
|301||0x12D||[[char]][20]||Flag12 Name of Flag 12.
|-
|321||0x141||[[UINT8]]||Flag13Length Length of the name of Flag 13.
|-
|322||0x142||[[char]][20]||Flag13 Name of Flag 13.
|-
|342||0x156||[[UINT8]]||Flag14Length Length of the name of Flag 14.
|-
|343||0x157||[[char]][20]||Flag14 Name of Flag 14.
|-
|363||0x16B||[[UINT8]]||Flag15Length Length of the name of Flag 15.
|-
|364||0x16C||[[char]][20]||Flag15 Name of Flag 15.
|-
|384||0x180||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|386||0x182||[[INT16LE]]||PlayerData This stores a runtime memory location that points to the status element currently being used by the player. Its value is not used when loading worlds, and is always set to 0 when saving worlds.
|-
|388||0x184||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|389||0x185||[[INT16LE]]||PlayerStones Player's stones of power. If this value is negative, no information is shown in-game about them. If this value is >= 0, it uses a flag to describe this value in the status bar of the game. The flag used is the first one found that is preceded with a Z. "The Lost Forest" contains a flag called "ZSTONES" which shows as "STONES" on the status bar, for example.
|}

== Board Format ==

Boards can be stored individually in .BRD files. Since ZZT and Super ZZT use the same extension for boards and there is no world information stored with them, it isn't immediately apparent whether the board is a ZZT or a Super ZZT board. Testing the validity of the board information with both world types should be a good way to determine the type of world a board belongs to.

=== Format layout ===

Boards consist of 4 parts: Board Header, RLE Tiles, Board Properties, and Status Element Properties. Status Elements are elements on the board that the game actively processes - these include the player, enemies, any animating blocks, and Scrolls and Objects which can contain ZZT-OOP code.

=== ZZT board header ===

ZZT boards are 60x25 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][50]||BoardName Board's name.
|-
|53||0x035||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Super ZZT board header ===

Super ZZT boards are 96x80 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][60]||BoardName Board's name.
|-
|63||0x03F||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Run-length encoded tile data ===

Tile data is represented as sets of 3 bytes. These sets are repeated until the board is completely filled. For ZZT, this will be 60*25=1500 tiles. For SuperZZT, this will be 96*80=7680 tiles. The tiles are unpacked from left to right, top to bottom.

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Count Number of tiles.
|-
|[[UINT8]]||Element Element of the tiles.
|-
|[[UINT8]]||Color Color of the tiles.
|-
|}

A small quirk of this RLE format is when the number of tiles is set to zero. Due to the way the decoder is set up, a Count of 0 means there are actually 256 tiles encoded. The built-in editor does not encode tiles using this value despite being decoded correctly in the game, and it will probably crash some older external editors.

=== ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||IsDark When set to 1, the board is covered in darkness which can only be revealed by using a torch.
|-
|2||0x002||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|3||0x003||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|4||0x004||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|5||0x005||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|6||0x006||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|7||0x007||[[UINT8]]||MessageLength Length of the on-screen message.
|-
|8||0x008||[[char]][58]||Message On-screen message. This is used internally and is not loaded by the game.
|-
|66||0x042||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|67||0x043||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|68||0x044||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|70||0x046||[[UINT8]][16]||(unused)
|-
|86||0x056||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|-
|}

=== Super ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|2||0x002||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|3||0x003||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|4||0x004||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|5||0x005||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|6||0x006||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|7||0x007||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|8||0x008||[[INT16LE]]||CameraX X-coordinate of the viewport. This value is not used when loading worlds.
|-
|10||0x00A||[[INT16LE]]||CameraY Y-coordinate of the viewport. This value is not used when loading worlds.
|-
|12||0x00C||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|14||0x00E||[[UINT8]][14]||(unused)
|-
|28||0x01C||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|}

=== Status Elements ===

This follows directly after board properties. It is repeated for each Status Element. The first element stored is always the player-controlled element. This element may contain strange values for Step, Leader and Follower information - this is because these values are used internally by the game.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||LocationX X-coordinate. Location coordinates are 1-based, unlike any other coordinates in the file.
|-
|1||0x001||[[UINT8]]||LocationY Y-coordinate.
|-
|2||0x002||[[INT16LE]]||StepX X-step value. This pair of values represents a vector that typically points in one of the four cardinal directions. Its use differs for each type of element.
|-
|4||0x004||[[INT16LE]]||StepY Y-step value.
|-
|6||0x006||[[INT16LE]]||Cycle Cycle. This represents the frequency, in ticks, at which the game will process this status element.
|-
|8||0x008||[[UINT8]]||P1 Parameter 1. Its use will differ depending on the type of element.
|-
|9||0x009||[[UINT8]]||P2 Parameter 2. Its use will differ depending on the type of element.
|-
|10||0x00A||[[UINT8]]||P3 Parameter 3. Its use will differ depending on the type of element.
|-
|11||0x00B||[[INT16LE]]||Follower Follower status element. Its value determines if another status element is linked behind this one. Typically used for linking centipedes.
|-
|13||0x00D||[[INT16LE]]||Leader Leader status element. Its value determines if another status element is linked in front of this one. Typically used for linking centipedes.
|-
|15||0x00F||[[UINT8]]||UnderID Element of the tile under this status element.
|-
|16||0x010||[[UINT8]]||UnderColor Color of the tile under this status element.
|-
|17||0x011||[[INT32LE]]||Pointer Stores the location in memory of the code that this status element is using. Status elements typically point to their own code until they #BIND the code of another - in which case this memory location value is replaced with the new one. ZZT does not use this value when loading worlds, and always sets it to 0 when saving worlds.
|-
|21||0x015||[[INT16LE]]||CurrentInstruction The offset in bytes of the code block to execute ZZT-OOP from. Only Objects and Scrolls can execute ZZT-OOP.
|-
|23||0x017||[[INT16LE]]||Length There are two uses for this value: If this value is positive, it represents the number of bytes that are in the code block. If this value is negative, the absolute value of this value represents the Status Element number to copy code from. This saves space by removing redundant code duplication. Since code is shared in this way, all modifications to code will affect any other Status Elements using it.
|-
|}

In ZZT (not Super ZZT), 8 bytes of padding will follow.

If "Length" is positive, the code will be stored here.

== Element Lists ==

This is a list of all valid built-in elements that can be used. Using any elements outside this range produce undefined behavior which is dependent on whatever was residing in memory at the time the game was loaded. Most often, it will crash.

=== Element properties ===

These are all possible internal properties for each element. '''Note:''' The addresses shown are not really significant- you should only consider which ones share the same code to cut down on how many element behaviors to consider.

{|class="wikitable"
!Property!!Description
|-
|Id||Id number of the element
|-
|Hex||Hexidecimal representation of the Id number
|-
|Name||Known name of the element, which may not be present internally
|-
|Character||ASCII character for the default draw code, which may be ignored if special draw code is enabled
|-
|Color||Default color. If the color is 0xFE, then new tiles will be created with the primary color as the background and a white foreground. If the color is >= 0xF0, any primary color is allowed, but in the editor you can't choose the color unless the default color is 0xFF
|-
|Destructible||Element can be destroyed by bullets and by being crushed by puzzle pieces
|-
|Pushable||Element can be pushed. The NS/EW sliders are a special case in the code, so they will not be marked with this flag
|-
|Editor Floor||When using the editor, actors such as enemies can be placed on top of elements marked with this flag. Has no effect during gameplay.
|-
|Floor||Elements with this flag can freely be moved upon by actors
|-
|Shown||ZZT only. Elements marked with this flag will always be shown, even on dark boards
|-
|Special Draw||If this flag is set, the default draw code is bypassed with different draw code
|-
|Draw Code||Offset of the routine that performs the drawing, if Special Draw is set
|-
|Cycle||Default cycle. If this is -1, the element is not generated as an actor. Creatures will have cycles above zero
|-
|Act Code||Offset of the routine that performs standard behavior. For example: creature movement, bomb countdown
|-
|Interact Code||Offset of the routine that handles when a player touches the element. For example: item pickups, entering a passage
|-
|Menu#||Number of the editor menu where this element can be found
|-
|Key||Key press which is mapped to this element in the editor
|-
|Internal Name||Name of the element used in the editor. It is also used by OOP- the parser will remove all symbols and spaces and compare that
|-
|Category||When it comes time to display this element in the editor, if present, the category will be drawn in yellow first.
|-
|Edit P1||Text to show when editing the P1 of an actor that uses this element
|-
|Edit P2||Text to show when editing the P2 of an actor that uses this element
|-
|Edit P3||Text to show when editing the P3 of an actor that uses this element
|-
|Edit Board||Text to show when selecting the target board
|-
|Edit Step||Text to show when selecting the target direction
|-
|Edit Code||Text to show when editing an actor's code (scroll or object OOP)
|-
|Points||When an actor using this element is killed by the player, it's worth this much score
|-
|}

=== ZZT elements ===

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Shown!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3973||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x20||0x07||||||||||||||0x0020||1||0x4481||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||Yes||||0x0020||1||0x3E2F||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||||0x0020||-1||0x0000||0x3289||1||A||Ammo||||||||||||||||0
|-
|6||0x06||Torch||0x9D||0x06||||||||||Yes||||0x0020||-1||0x0000||0x37B6||1||T||Torch||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||||0x0020||-1||0x0000||0x3306||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x3169||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||||0x0020||-1||0x0000||0x33DA||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||||0x0020||1||0x2F9F||0x308B||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||Yes||||0x0020||0||0x0000||0x3372||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||||Yes||0x2A15||2||0x2BFF||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||||Yes||0x1872||6||0x18DA||0x19F3||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||||0x0020||-1||0x0000||0x2034||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||Star||0x53||0x0F||||||||||||Yes||0x1D5D||1||0x1DE9||0x00F5||0||||Star||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||||Yes||0x171C||3||0x176C||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||||Yes||0x17C7||2||0x1817||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||Bullet||0xF8||0x0F||Yes||||||||||||0x0020||1||0x0F65||0x00F5||0||||Bullet||||||||||||||||0
|-
|19||0x13||Water||0xB0||0xF9||||||Yes||||||||0x0020||-1||0x0000||0x3B03||3||W||Water||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||||0x0020||-1||0x0000||0x38D0||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x34E3||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||||0x0020||-1||0x0000||0x3949||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0xB0||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3848||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||||Yes||0x242E||1||0x2445||0x0010||3||L||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||||Yes||0x1CC5||2||0x1C85||0x1C41||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||||Yes||0x122A||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0x99||0x06||Yes||Yes||||||||||0x0020||3||0x054F||0x00F5||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||||0x0020||1||0x0351||0x00F5||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||||Yes||0x2B85||3||0x2AA5||0x2BB7||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||||0x0020||3||0x20AE||0x2295||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||Shark||0x5E||0x07||||||||||||||0x0020||3||0x2321||0x0010||2||Y||Shark||||Intelligence?||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||||Yes||0x11D0||2||0x12A7||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||||Yes||0x3517||4||0x358A||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||||0x0020||2||0x0113||0x00F5||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||||0x0020||2||0x022D||0x00F5||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||||0x0020||2||0x06BF||0x00F5||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||||0x0020||2||0x0EED||0x00F5||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Text (Blue)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|48||0x30||Text (Green)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|49||0x31||Text (Cyan)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|50||0x32||Text (Red)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|51||0x33||Text (Purple)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|52||0x34||Text (Brown)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||Text (Black)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

=== Super ZZT elements ===

Internal properties for each of these elements can be found in the [http://pastebin.com/mdEwu6Y1 Super ZZT Elements Pastebin].

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3FA5||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x02||0x1F||||Yes||||||||0x0020||1||0x4B76||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||||0x0020||1||0x4596||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||0x0020||-1||0x0000||0x37E7||1||A||Ammo||||||||||||||||0
|-
|6||0x06||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||0x0020||-1||0x0000||0x397D||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x36F2||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||0x0020||-1||0x0000||0x3A63||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||0x0020||1||0x3517||0x3603||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||||0x0020||0||0x0000||0x39ED||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||Yes||0x2E32||2||0x3177||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||Yes||0x1DBD||6||0x1E25||0x1F3F||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||0x0020||-1||0x0000||0x2581||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||Yes||0x1C67||3||0x1CB7||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||Yes||0x1D12||2||0x1D62||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|19||0x13||Lava||0x6F||0x4E||||||Yes||||||0x0020||-1||0x0000||0x4155||3||L||Lava||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||0x0020||-1||0x0000||0x3EAF||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x3B5A||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x3F6C||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3E23||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||Yes||0x285B||1||0x2872||0x0010||3||X||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||Yes||0x2216||2||0x21D6||0x2192||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||Yes||0x17C3||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0xEB||0x02||Yes||Yes||||||||0x0020||3||0x09C1||0x014C||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||0x0020||1||0x07C3||0x014C||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||Yes||0x30FD||3||0x2EC2||0x312F||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||0x0020||3||0x25E8||0x27CF||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||Yes||0x1663||2||0x1811||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||Yes||0x3B8E||4||0x3C01||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||0x0020||2||0x016A||0x014C||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||0x0020||2||0x0284||0x014C||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||0x0020||2||0x0B31||0x014C||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||0x0020||2||0x1375||0x014C||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Floor||0xB0||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||F||Floor||Terrains:||||||||||||||0
|-
|48||0x30||Water N||0x1E||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||8||Water N||||||||||||||||0
|-
|49||0x31||Water S||0x1F||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||2||Water S||||||||||||||||0
|-
|50||0x32||Water W||0x11||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||4||Water W||||||||||||||||0
|-
|51||0x33||Water E||0x10||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||6||Water E||||||||||||||||0
|-
|52||0x34||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|54||0x36||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|55||0x37||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|56||0x38||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|57||0x39||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|58||0x3A||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|59||0x3B||Roton||0x94||0x0D||Yes||Yes||||||||0x0020||1||0x03A8||0x014C||4||R||Roton||Uglies:||Intelligence?||Switch Rate?||||||||||2
|-
|60||0x3C||Dragon Pup||0xED||0x04||Yes||Yes||||||Yes||0x05A3||2||0x0563||0x014C||4||D||Dragon Pup||||Intelligence?||Switch Rate?||||||||||1
|-
|61||0x3D||Pairer||0xE5||0x01||Yes||Yes||||||||0x0020||2||0x05E6||0x014C||4||P||Pairer||||Intelligence?||||||||||||2
|-
|62||0x3E||Spider||0x0F||Any (0xFF)||Yes||||||||||0x0020||1||0x06EB||0x014C||4||S||Spider||||Intelligence?||||||||||||3
|-
|63||0x3F||Web||0xC5||Any (0xFF)||||||Yes||Yes||Yes||0x17EA||-1||0x0000||0x0010||5||W||Web||||||||||||||||0
|-
|64||0x40||Stone||0x5A||0x0F||||||||||Yes||0x38A1||1||0x38C3||0x385E||5||Z||Stone||||||||||||||||0
|-
|65||0x41||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|66||0x42||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|67||0x43||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|68||0x44||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|69||0x45||Bullet||0xF8||0x0F||Yes||||||||||0x0020||1||0x13ED||0x014C||0||||Bullet||||||||||||||||0
|-
|70||0x46||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|71||0x47||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|72||0x48||Star||0x53||0x0F||||||||||Yes||0x22AE||1||0x233A||0x014C||0||||Star||||||||||||||||0
|-
|73||0x49||Text (Blue)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|74||0x4A||Text (Green)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|75||0x4B||Text (Cyan)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|76||0x4C||Text (Red)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|77||0x4D||Text (Purple)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|78||0x4E||Text (Brown)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|79||0x4F||Text (Black)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

[[Category:ZZT]]
[[Category:File Formats]]

ZZT Format

2015-09-08T03:09:08Z

SaxxonPike: /* Element properties */ Clarification on addresses.

== Credits ==

A large portion of this information was gathered from documents written by Kev Vance (original ZZT format documentation), David Hammond (Mystical Winds Encyclopedia), and WiL (SuperZZT format documentation). A few errors have been corrected and the information has been tested in an attempt to create the most comprehensive document of both the ZZT and Super ZZT formats. This format document is primarily maintained and tested by [[User:SaxxonPike|SaxxonPike]].

== General Information ==

A world file (.ZZT, .SZT) contains information about a game world, status of the player, and all its boards. Saved games (.SAV) are the same format as world files with a different extension and a different setting for the Lock byte.

While there are built-in editors for these games, they do not provide full editing functionality.

== Limits ==

ZZT and Super ZZT have limits imposed either by the game itself or by the data types used to store information about the world's contents.

{|class="wikitable"
!Limitation!!ZZT!!Super ZZT
|-
|Board count (including title screen)||101||33
|-
|Board size (in bytes)||32767||32767
|-
|Board size (in tiles)||60x25||96x80
|-
|Status Elements per board (including Player)||151||129
|-
|Flag strings||10||16
|}

Realistically, the original ZZT can only support boards up to around 20k due to the code itself. ZZT 4.0 by WiL, a hack of the original game executable, can support the full 32k.

== World Format ==

There are two formats for a world file. One is for ZZT and the other is for SuperZZT. The formats are very similar. All 8-bit (byte) values are unsigned. All 16-bit (short) values are signed. Boolean values (such as a player's keys) are represented with 0 for false and 1 for true; any other values may cause inconsistent behavior.

World Name is used by the game to determine which file to load after the player quits and restarts the game. Therefore if a world contains a world name that is actually the filename of another world, after the player quits and restarts the game, the world with the matching filename will be loaded!

=== Common world information ===

The storage of this information is the same between the two formats. After this part of the file, the format will differ slightly.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF FF) and SuperZZT uses -2 (FE FF).
|-
|2||0x002||[[INT16LE]]||NumBoards Number of boards in the world, not including the title screen. Increment by 1 for the real number of stored boards. A value of 0 means only the title screen exists.
|-
|4||0x004||[[INT16LE]]||PlayerAmmo Player's ammunition.
|-
|6||0x006||[[INT16LE]]||PlayerGems Player's gems.
|-
|8||0x008||[[char]][7]||PlayerKeys Player's keys. A nonzero value means the player has the specified key. The keys are in this order: Blue, Green, Cyan, Red, Purple, Yellow, White.
|-
|15||0x00F||[[INT16LE]]||PlayerHealth Player's health.
|-
|17||0x011||[[INT16LE]]||PlayerBoard In a world file, this will be the starting board for the player (the title screen, board 0, is always shown first). In a saved game, this will be the board that the player is currently on.
|-
|}

=== ZZT world header ===

This is the second half of the header specific to a .ZZT file. After this information, storage of the boards starts at byte offset 512 (hex 0x200).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||PlayerTorches Player's torches.
|-
|21||0x015||[[INT16LE]]||TorchCycles Game cycles left for a torch to remain lit.
|-
|23||0x017||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|25||0x019||[[INT16LE]]||(unused) Always 0.
|-
|27||0x01B||[[INT16LE]]||PlayerScore Player's score.
|-
|29||0x01D||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|30||0x01E||[[char]][20]||WorldName Internal name of the world.
|-
|50||0x032||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|51||0x033||[[char]][20]||Flag0 Name of Flag 0.
|-
|71||0x047||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|72||0x048||[[char]][20]||Flag1 Name of Flag 1.
|-
|92||0x05C||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|93||0x05D||[[char]][20]||Flag2 Name of Flag 2.
|-
|113||0x071||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|114||0x072||[[char]][20]||Flag3 Name of Flag 3.
|-
|134||0x086||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|135||0x087||[[char]][20]||Flag4 Name of Flag 4.
|-
|155||0x09B||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|156||0x09C||[[char]][20]||Flag5 Name of Flag 5.
|-
|176||0x0B0||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|177||0x0B1||[[char]][20]||Flag6 Name of Flag 6.
|-
|197||0x0C5||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|198||0x0C6||[[char]][20]||Flag7 Name of Flag 7.
|-
|218||0x0DA||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|219||0x0DB||[[char]][20]||Flag8 Name of Flag 8.
|-
|239||0x0EF||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|240||0x0F0||[[char]][20]||Flag9 Name of Flag 9.
|-
|260||0x104||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|262||0x106||[[INT16LE]]||PlayerData This stores a runtime memory location that points to the status element currently being used by the player. Its value is not used when loading worlds, and is always set to 0 when saving worlds.
|-
|264||0x108||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|}

=== Super ZZT world header ===

This is the second half of the header specific to a .SZT file. After this information, storage of the boards starts at byte offset 1024 (hex 0x400).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||(unused) Always 0.
|-
|21||0x015||[[INT16LE]]||PlayerScore Player's score.
|-
|23||0x017||[[INT16LE]]||(unused) Always 0.
|-
|25||0x019||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|27||0x01B||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|28||0x01C||[[char]][20]||WorldName Internal name of the world.
|-
|48||0x030||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|49||0x031||[[char]][20]||Flag0 Name of Flag 0.
|-
|69||0x045||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|70||0x046||[[char]][20]||Flag1 Name of Flag 1.
|-
|90||0x05A||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|91||0x05B||[[char]][20]||Flag2 Name of Flag 2.
|-
|111||0x06F||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|112||0x070||[[char]][20]||Flag3 Name of Flag 3.
|-
|132||0x084||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|133||0x085||[[char]][20]||Flag4 Name of Flag 4.
|-
|153||0x099||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|154||0x09A||[[char]][20]||Flag5 Name of Flag 5.
|-
|174||0x0AE||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|175||0x0AF||[[char]][20]||Flag6 Name of Flag 6.
|-
|195||0x0C3||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|196||0x0C4||[[char]][20]||Flag7 Name of Flag 7.
|-
|216||0x0D8||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|217||0x0D9||[[char]][20]||Flag8 Name of Flag 8.
|-
|237||0x0ED||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|238||0x0EE||[[char]][20]||Flag9 Name of Flag 9.
|-
|258||0x102||[[UINT8]]||Flag10Length Length of the name of Flag 10.
|-
|259||0x103||[[char]][20]||Flag10 Name of Flag 10.
|-
|279||0x117||[[UINT8]]||Flag11Length Length of the name of Flag 11.
|-
|280||0x118||[[char]][20]||Flag11 Name of Flag 11.
|-
|300||0x12C||[[UINT8]]||Flag12Length Length of the name of Flag 12.
|-
|301||0x12D||[[char]][20]||Flag12 Name of Flag 12.
|-
|321||0x141||[[UINT8]]||Flag13Length Length of the name of Flag 13.
|-
|322||0x142||[[char]][20]||Flag13 Name of Flag 13.
|-
|342||0x156||[[UINT8]]||Flag14Length Length of the name of Flag 14.
|-
|343||0x157||[[char]][20]||Flag14 Name of Flag 14.
|-
|363||0x16B||[[UINT8]]||Flag15Length Length of the name of Flag 15.
|-
|364||0x16C||[[char]][20]||Flag15 Name of Flag 15.
|-
|384||0x180||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|386||0x182||[[INT16LE]]||PlayerData This stores a runtime memory location that points to the status element currently being used by the player. Its value is not used when loading worlds, and is always set to 0 when saving worlds.
|-
|388||0x184||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|389||0x185||[[INT16LE]]||PlayerStones Player's stones of power. If this value is negative, no information is shown in-game about them. If this value is >= 0, it uses a flag to describe this value in the status bar of the game. The flag used is the first one found that is preceded with a Z. "The Lost Forest" contains a flag called "ZSTONES" which shows as "STONES" on the status bar, for example.
|}

== Board Format ==

Boards can be stored individually in .BRD files. Since ZZT and Super ZZT use the same extension for boards and there is no world information stored with them, it isn't immediately apparent whether the board is a ZZT or a Super ZZT board. Testing the validity of the board information with both world types should be a good way to determine the type of world a board belongs to.

=== Format layout ===

Boards consist of 4 parts: Board Header, RLE Tiles, Board Properties, and Status Element Properties. Status Elements are elements on the board that the game actively processes - these include the player, enemies, any animating blocks, and Scrolls and Objects which can contain ZZT-OOP code.

=== ZZT board header ===

ZZT boards are 60x25 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][50]||BoardName Board's name.
|-
|53||0x035||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Super ZZT board header ===

Super ZZT boards are 96x80 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][60]||BoardName Board's name.
|-
|63||0x03F||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Run-length encoded tile data ===

Tile data is represented as sets of 3 bytes. These sets are repeated until the board is completely filled. For ZZT, this will be 60*25=1500 tiles. For SuperZZT, this will be 96*80=7680 tiles. The tiles are unpacked from left to right, top to bottom.

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Count Number of tiles.
|-
|[[UINT8]]||Element Element of the tiles.
|-
|[[UINT8]]||Color Color of the tiles.
|-
|}

A small quirk of this RLE format is when the number of tiles is set to zero. Due to the way the decoder is set up, a Count of 0 means there are actually 256 tiles encoded. The built-in editor does not encode tiles using this value despite being decoded correctly in the game, and it will probably crash some older external editors.

=== ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||IsDark When set to 1, the board is covered in darkness which can only be revealed by using a torch.
|-
|2||0x002||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|3||0x003||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|4||0x004||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|5||0x005||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|6||0x006||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|7||0x007||[[UINT8]]||MessageLength Length of the on-screen message.
|-
|8||0x008||[[char]][58]||Message On-screen message. This is used internally and is not loaded by the game.
|-
|66||0x042||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|67||0x043||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|68||0x044||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|70||0x046||[[UINT8]][16]||(unused)
|-
|86||0x056||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|-
|}

=== Super ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|2||0x002||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|3||0x003||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|4||0x004||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|5||0x005||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|6||0x006||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|7||0x007||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|8||0x008||[[INT16LE]]||CameraX X-coordinate of the viewport. This value is not used when loading worlds.
|-
|10||0x00A||[[INT16LE]]||CameraY Y-coordinate of the viewport. This value is not used when loading worlds.
|-
|12||0x00C||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|14||0x00E||[[UINT8]][14]||(unused)
|-
|28||0x01C||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|}

=== Status Elements ===

This follows directly after board properties. It is repeated for each Status Element. The first element stored is always the player-controlled element. This element may contain strange values for Step, Leader and Follower information - this is because these values are used internally by the game.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||LocationX X-coordinate. Location coordinates are 1-based, unlike any other coordinates in the file.
|-
|1||0x001||[[UINT8]]||LocationY Y-coordinate.
|-
|2||0x002||[[INT16LE]]||StepX X-step value. This pair of values represents a vector that typically points in one of the four cardinal directions. Its use differs for each type of element.
|-
|4||0x004||[[INT16LE]]||StepY Y-step value.
|-
|6||0x006||[[INT16LE]]||Cycle Cycle. This represents the frequency, in ticks, at which the game will process this status element.
|-
|8||0x008||[[UINT8]]||P1 Parameter 1. Its use will differ depending on the type of element.
|-
|9||0x009||[[UINT8]]||P2 Parameter 2. Its use will differ depending on the type of element.
|-
|10||0x00A||[[UINT8]]||P3 Parameter 3. Its use will differ depending on the type of element.
|-
|11||0x00B||[[INT16LE]]||Follower Follower status element. Its value determines if another status element is linked behind this one. Typically used for linking centipedes.
|-
|13||0x00D||[[INT16LE]]||Leader Leader status element. Its value determines if another status element is linked in front of this one. Typically used for linking centipedes.
|-
|15||0x00F||[[UINT8]]||UnderID Element of the tile under this status element.
|-
|16||0x010||[[UINT8]]||UnderColor Color of the tile under this status element.
|-
|17||0x011||[[INT32LE]]||Pointer Stores the location in memory of the code that this status element is using. Status elements typically point to their own code until they #BIND the code of another - in which case this memory location value is replaced with the new one. ZZT does not use this value when loading worlds, and always sets it to 0 when saving worlds.
|-
|21||0x015||[[INT16LE]]||CurrentInstruction The offset in bytes of the code block to execute ZZT-OOP from. Only Objects and Scrolls can execute ZZT-OOP.
|-
|23||0x017||[[INT16LE]]||Length There are two uses for this value: If this value is positive, it represents the number of bytes that are in the code block. If this value is negative, the absolute value of this value represents the Status Element number to copy code from. This saves space by removing redundant code duplication. Since code is shared in this way, all modifications to code will affect any other Status Elements using it.
|-
|}

In ZZT (not Super ZZT), 8 bytes of padding will follow.

If "Length" is positive, the code will be stored here.

== Element Lists ==

This is a list of all valid built-in elements that can be used. Using any elements outside this range produce undefined behavior which is dependent on whatever was residing in memory at the time the game was loaded. Most often, it will crash.

=== Element properties ===

These are all possible internal properties for each element. '''Note:''' The addresses shown are not really significant- you should only consider which ones share the same code to cut down on how many element behaviors to consider.

{|class="wikitable"
!Property!!Description
|-
|Id||Id number of the element
|-
|Hex||Hexidecimal representation of the Id number
|-
|Name||Known name of the element, which may not be present internally
|-
|Character||ASCII character for the default draw code, which may be ignored if special draw code is enabled
|-
|Color||Default color. If the color is 0xFE, then new tiles will be created with the primary color as the background and a white foreground. If the color is >= 0xF0, any primary color is allowed, but in the editor you can't choose the color unless the default color is 0xFF
|-
|Destructible||Element can be destroyed by bullets and by being crushed by puzzle pieces
|-
|Pushable||Element can be pushed. The NS/EW sliders are a special case in the code, so they will not be marked with this flag
|-
|Editor Floor||When using the editor, actors such as enemies can be placed on top of elements marked with this flag. Has no effect during gameplay.
|-
|Floor||Elements with this flag can freely be moved upon by actors
|-
|Shown||ZZT only. Elements marked with this flag will always be shown, even on dark boards
|-
|Special Draw||If this flag is set, the default draw code is bypassed with different draw code
|-
|Draw Code||Offset of the routine that performs the drawing, if Special Draw is set
|-
|Cycle||Default cycle. If this is -1, the element is not generated as an actor. Creatures will have cycles above zero
|-
|Act Code||Offset of the routine that performs standard behavior. For example: creature movement, bomb countdown
|-
|Interact Code||Offset of the routine that handles when a player touches the element. For example: item pickups, entering a passage
|-
|Menu#||Number of the editor menu where this element can be found
|-
|Key||Key press which is mapped to this element in the editor
|-
|Internal Name||Name of the element used in the editor. It is also used by OOP- the parser will remove all symbols and spaces and compare that
|-
|Category||When it comes time to display this element in the editor, if present, the category will be drawn in yellow first.
|-
|Edit P1||Text to show when editing the P1 of an actor that uses this element
|-
|Edit P2||Text to show when editing the P2 of an actor that uses this element
|-
|Edit P3||Text to show when editing the P3 of an actor that uses this element
|-
|Edit Board||Text to show when selecting the target board
|-
|Edit Step||Text to show when selecting the target direction
|-
|Edit Code||Text to show when editing an actor's code (scroll or object OOP)
|-
|Points||When an actor using this element is killed by the player, it's worth this much score
|-
|}

=== ZZT elements ===

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Shown!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3973||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x20||0x07||||||||||||||0x0020||1||0x4481||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||Yes||||0x0020||1||0x3E2F||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||||0x0020||-1||0x0000||0x3289||1||A||Ammo||||||||||||||||0
|-
|6||0x06||Torch||0x9D||0x06||||||||||Yes||||0x0020||-1||0x0000||0x37B6||1||T||Torch||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||||0x0020||-1||0x0000||0x3306||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x3169||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||||0x0020||-1||0x0000||0x33DA||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||||0x0020||1||0x2F9F||0x308B||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||Yes||||0x0020||0||0x0000||0x3372||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||||Yes||0x2A15||2||0x2BFF||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||||Yes||0x1872||6||0x18DA||0x19F3||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||||0x0020||-1||0x0000||0x2034||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||Star||0x53||0x0F||||||||||||Yes||0x1D5D||1||0x1DE9||0x00F5||0||||Star||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||||Yes||0x171C||3||0x176C||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||||Yes||0x17C7||2||0x1817||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||Bullet||0xF8||0x0F||Yes||||||||||||0x0020||1||0x0F65||0x00F5||0||||Bullet||||||||||||||||0
|-
|19||0x13||Water||0xB0||0xF9||||||Yes||||||||0x0020||-1||0x0000||0x3B03||3||W||Water||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||||0x0020||-1||0x0000||0x38D0||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x34E3||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||||0x0020||-1||0x0000||0x3949||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0xB0||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3848||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||||Yes||0x242E||1||0x2445||0x0010||3||L||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||||Yes||0x1CC5||2||0x1C85||0x1C41||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||||Yes||0x122A||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0x99||0x06||Yes||Yes||||||||||0x0020||3||0x054F||0x00F5||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||||0x0020||1||0x0351||0x00F5||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||||Yes||0x2B85||3||0x2AA5||0x2BB7||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||||0x0020||3||0x20AE||0x2295||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||Shark||0x5E||0x07||||||||||||||0x0020||3||0x2321||0x0010||2||Y||Shark||||Intelligence?||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||||Yes||0x11D0||2||0x12A7||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||||Yes||0x3517||4||0x358A||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||||0x0020||2||0x0113||0x00F5||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||||0x0020||2||0x022D||0x00F5||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||||0x0020||2||0x06BF||0x00F5||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||||0x0020||2||0x0EED||0x00F5||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Text (Blue)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|48||0x30||Text (Green)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|49||0x31||Text (Cyan)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|50||0x32||Text (Red)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|51||0x33||Text (Purple)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|52||0x34||Text (Brown)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||Text (Black)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

=== Super ZZT elements ===

Internal properties for each of these elements can be found in the [http://pastebin.com/mdEwu6Y1 Super ZZT Elements Pastebin].

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3FA5||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x02||0x1F||||Yes||||||||0x0020||1||0x4B76||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||||0x0020||1||0x4596||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||0x0020||-1||0x0000||0x37E7||1||A||Ammo||||||||||||||||0
|-
|6||0x06||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||0x0020||-1||0x0000||0x397D||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x36F2||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||0x0020||-1||0x0000||0x3A63||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||0x0020||1||0x3517||0x3603||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||||0x0020||0||0x0000||0x39ED||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||Yes||0x2E32||2||0x3177||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||Yes||0x1DBD||6||0x1E25||0x1F3F||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||0x0020||-1||0x0000||0x2581||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||Yes||0x1C67||3||0x1CB7||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||Yes||0x1D12||2||0x1D62||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|19||0x13||Lava||0x6F||0x4E||||||Yes||||||0x0020||-1||0x0000||0x4155||3||L||Lava||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||0x0020||-1||0x0000||0x3EAF||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x3B5A||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x3F6C||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3E23||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||Yes||0x285B||1||0x2872||0x0010||3||X||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||Yes||0x2216||2||0x21D6||0x2192||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||Yes||0x17C3||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0xEB||0x02||Yes||Yes||||||||0x0020||3||0x09C1||0x014C||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||0x0020||1||0x07C3||0x014C||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||Yes||0x30FD||3||0x2EC2||0x312F||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||0x0020||3||0x25E8||0x27CF||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||Yes||0x1663||2||0x1811||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||Yes||0x3B8E||4||0x3C01||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||0x0020||2||0x016A||0x014C||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||0x0020||2||0x0284||0x014C||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||0x0020||2||0x0B31||0x014C||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||0x0020||2||0x1375||0x014C||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Floor||0xB0||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||F||Floor||Terrains:||||||||||||||0
|-
|48||0x30||Water N||0x1E||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||8||Water N||||||||||||||||0
|-
|49||0x31||Water S||0x1F||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||2||Water S||||||||||||||||0
|-
|50||0x32||Water W||0x11||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||4||Water W||||||||||||||||0
|-
|51||0x33||Water E||0x10||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||6||Water E||||||||||||||||0
|-
|52||0x34||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|54||0x36||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|55||0x37||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|56||0x38||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|57||0x39||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|58||0x3A||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|59||0x3B||Roton||0x94||0x0D||Yes||Yes||||||||0x0020||1||0x03A8||0x014C||4||R||Roton||Uglies:||Intelligence?||Switch Rate?||||||||||2
|-
|60||0x3C||Dragon Pup||0xED||0x04||Yes||Yes||||||Yes||0x05A3||2||0x0563||0x014C||4||D||Dragon Pup||||Intelligence?||Switch Rate?||||||||||1
|-
|61||0x3D||Pairer||0xE5||0x01||Yes||Yes||||||||0x0020||2||0x05E6||0x014C||4||P||Pairer||||Intelligence?||||||||||||2
|-
|62||0x3E||Spider||0x0F||Any (0xFF)||Yes||||||||||0x0020||1||0x06EB||0x014C||4||S||Spider||||Intelligence?||||||||||||3
|-
|63||0x3F||Web||0xC5||Any (0xFF)||||||Yes||Yes||Yes||0x17EA||-1||0x0000||0x0010||5||W||Web||||||||||||||||0
|-
|64||0x40||Stone||0x5A||0x0F||||||||||Yes||0x38A1||1||0x38C3||0x385E||5||Z||Stone||||||||||||||||0
|-
|65||0x41||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|66||0x42||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|67||0x43||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|68||0x44||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|69||0x45||Bullet||0xF8||0x0F||Yes||||||||||0x0020||1||0x13ED||0x014C||0||||Bullet||||||||||||||||0
|-
|70||0x46||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|71||0x47||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|72||0x48||Star||0x53||0x0F||||||||||Yes||0x22AE||1||0x233A||0x014C||0||||Star||||||||||||||||0
|-
|73||0x49||Text (Blue)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|74||0x4A||Text (Green)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|75||0x4B||Text (Cyan)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|76||0x4C||Text (Red)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|77||0x4D||Text (Purple)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|78||0x4E||Text (Brown)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|79||0x4F||Text (Black)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

[[Category:ZZT]]
[[Category:File Formats]]

ZZT Format

2015-09-08T03:03:42Z

SaxxonPike: /* Element Lists */ Table describing the different properties

== Credits ==

A large portion of this information was gathered from documents written by Kev Vance (original ZZT format documentation), David Hammond (Mystical Winds Encyclopedia), and WiL (SuperZZT format documentation). A few errors have been corrected and the information has been tested in an attempt to create the most comprehensive document of both the ZZT and Super ZZT formats. This format document is primarily maintained and tested by [[User:SaxxonPike|SaxxonPike]].

== General Information ==

A world file (.ZZT, .SZT) contains information about a game world, status of the player, and all its boards. Saved games (.SAV) are the same format as world files with a different extension and a different setting for the Lock byte.

While there are built-in editors for these games, they do not provide full editing functionality.

== Limits ==

ZZT and Super ZZT have limits imposed either by the game itself or by the data types used to store information about the world's contents.

{|class="wikitable"
!Limitation!!ZZT!!Super ZZT
|-
|Board count (including title screen)||101||33
|-
|Board size (in bytes)||32767||32767
|-
|Board size (in tiles)||60x25||96x80
|-
|Status Elements per board (including Player)||151||129
|-
|Flag strings||10||16
|}

Realistically, the original ZZT can only support boards up to around 20k due to the code itself. ZZT 4.0 by WiL, a hack of the original game executable, can support the full 32k.

== World Format ==

There are two formats for a world file. One is for ZZT and the other is for SuperZZT. The formats are very similar. All 8-bit (byte) values are unsigned. All 16-bit (short) values are signed. Boolean values (such as a player's keys) are represented with 0 for false and 1 for true; any other values may cause inconsistent behavior.

World Name is used by the game to determine which file to load after the player quits and restarts the game. Therefore if a world contains a world name that is actually the filename of another world, after the player quits and restarts the game, the world with the matching filename will be loaded!

=== Common world information ===

The storage of this information is the same between the two formats. After this part of the file, the format will differ slightly.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF FF) and SuperZZT uses -2 (FE FF).
|-
|2||0x002||[[INT16LE]]||NumBoards Number of boards in the world, not including the title screen. Increment by 1 for the real number of stored boards. A value of 0 means only the title screen exists.
|-
|4||0x004||[[INT16LE]]||PlayerAmmo Player's ammunition.
|-
|6||0x006||[[INT16LE]]||PlayerGems Player's gems.
|-
|8||0x008||[[char]][7]||PlayerKeys Player's keys. A nonzero value means the player has the specified key. The keys are in this order: Blue, Green, Cyan, Red, Purple, Yellow, White.
|-
|15||0x00F||[[INT16LE]]||PlayerHealth Player's health.
|-
|17||0x011||[[INT16LE]]||PlayerBoard In a world file, this will be the starting board for the player (the title screen, board 0, is always shown first). In a saved game, this will be the board that the player is currently on.
|-
|}

=== ZZT world header ===

This is the second half of the header specific to a .ZZT file. After this information, storage of the boards starts at byte offset 512 (hex 0x200).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||PlayerTorches Player's torches.
|-
|21||0x015||[[INT16LE]]||TorchCycles Game cycles left for a torch to remain lit.
|-
|23||0x017||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|25||0x019||[[INT16LE]]||(unused) Always 0.
|-
|27||0x01B||[[INT16LE]]||PlayerScore Player's score.
|-
|29||0x01D||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|30||0x01E||[[char]][20]||WorldName Internal name of the world.
|-
|50||0x032||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|51||0x033||[[char]][20]||Flag0 Name of Flag 0.
|-
|71||0x047||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|72||0x048||[[char]][20]||Flag1 Name of Flag 1.
|-
|92||0x05C||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|93||0x05D||[[char]][20]||Flag2 Name of Flag 2.
|-
|113||0x071||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|114||0x072||[[char]][20]||Flag3 Name of Flag 3.
|-
|134||0x086||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|135||0x087||[[char]][20]||Flag4 Name of Flag 4.
|-
|155||0x09B||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|156||0x09C||[[char]][20]||Flag5 Name of Flag 5.
|-
|176||0x0B0||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|177||0x0B1||[[char]][20]||Flag6 Name of Flag 6.
|-
|197||0x0C5||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|198||0x0C6||[[char]][20]||Flag7 Name of Flag 7.
|-
|218||0x0DA||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|219||0x0DB||[[char]][20]||Flag8 Name of Flag 8.
|-
|239||0x0EF||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|240||0x0F0||[[char]][20]||Flag9 Name of Flag 9.
|-
|260||0x104||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|262||0x106||[[INT16LE]]||PlayerData This stores a runtime memory location that points to the status element currently being used by the player. Its value is not used when loading worlds, and is always set to 0 when saving worlds.
|-
|264||0x108||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|}

=== Super ZZT world header ===

This is the second half of the header specific to a .SZT file. After this information, storage of the boards starts at byte offset 1024 (hex 0x400).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||(unused) Always 0.
|-
|21||0x015||[[INT16LE]]||PlayerScore Player's score.
|-
|23||0x017||[[INT16LE]]||(unused) Always 0.
|-
|25||0x019||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|27||0x01B||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|28||0x01C||[[char]][20]||WorldName Internal name of the world.
|-
|48||0x030||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|49||0x031||[[char]][20]||Flag0 Name of Flag 0.
|-
|69||0x045||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|70||0x046||[[char]][20]||Flag1 Name of Flag 1.
|-
|90||0x05A||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|91||0x05B||[[char]][20]||Flag2 Name of Flag 2.
|-
|111||0x06F||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|112||0x070||[[char]][20]||Flag3 Name of Flag 3.
|-
|132||0x084||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|133||0x085||[[char]][20]||Flag4 Name of Flag 4.
|-
|153||0x099||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|154||0x09A||[[char]][20]||Flag5 Name of Flag 5.
|-
|174||0x0AE||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|175||0x0AF||[[char]][20]||Flag6 Name of Flag 6.
|-
|195||0x0C3||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|196||0x0C4||[[char]][20]||Flag7 Name of Flag 7.
|-
|216||0x0D8||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|217||0x0D9||[[char]][20]||Flag8 Name of Flag 8.
|-
|237||0x0ED||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|238||0x0EE||[[char]][20]||Flag9 Name of Flag 9.
|-
|258||0x102||[[UINT8]]||Flag10Length Length of the name of Flag 10.
|-
|259||0x103||[[char]][20]||Flag10 Name of Flag 10.
|-
|279||0x117||[[UINT8]]||Flag11Length Length of the name of Flag 11.
|-
|280||0x118||[[char]][20]||Flag11 Name of Flag 11.
|-
|300||0x12C||[[UINT8]]||Flag12Length Length of the name of Flag 12.
|-
|301||0x12D||[[char]][20]||Flag12 Name of Flag 12.
|-
|321||0x141||[[UINT8]]||Flag13Length Length of the name of Flag 13.
|-
|322||0x142||[[char]][20]||Flag13 Name of Flag 13.
|-
|342||0x156||[[UINT8]]||Flag14Length Length of the name of Flag 14.
|-
|343||0x157||[[char]][20]||Flag14 Name of Flag 14.
|-
|363||0x16B||[[UINT8]]||Flag15Length Length of the name of Flag 15.
|-
|364||0x16C||[[char]][20]||Flag15 Name of Flag 15.
|-
|384||0x180||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|386||0x182||[[INT16LE]]||PlayerData This stores a runtime memory location that points to the status element currently being used by the player. Its value is not used when loading worlds, and is always set to 0 when saving worlds.
|-
|388||0x184||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|389||0x185||[[INT16LE]]||PlayerStones Player's stones of power. If this value is negative, no information is shown in-game about them. If this value is >= 0, it uses a flag to describe this value in the status bar of the game. The flag used is the first one found that is preceded with a Z. "The Lost Forest" contains a flag called "ZSTONES" which shows as "STONES" on the status bar, for example.
|}

== Board Format ==

Boards can be stored individually in .BRD files. Since ZZT and Super ZZT use the same extension for boards and there is no world information stored with them, it isn't immediately apparent whether the board is a ZZT or a Super ZZT board. Testing the validity of the board information with both world types should be a good way to determine the type of world a board belongs to.

=== Format layout ===

Boards consist of 4 parts: Board Header, RLE Tiles, Board Properties, and Status Element Properties. Status Elements are elements on the board that the game actively processes - these include the player, enemies, any animating blocks, and Scrolls and Objects which can contain ZZT-OOP code.

=== ZZT board header ===

ZZT boards are 60x25 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][50]||BoardName Board's name.
|-
|53||0x035||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Super ZZT board header ===

Super ZZT boards are 96x80 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][60]||BoardName Board's name.
|-
|63||0x03F||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Run-length encoded tile data ===

Tile data is represented as sets of 3 bytes. These sets are repeated until the board is completely filled. For ZZT, this will be 60*25=1500 tiles. For SuperZZT, this will be 96*80=7680 tiles. The tiles are unpacked from left to right, top to bottom.

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Count Number of tiles.
|-
|[[UINT8]]||Element Element of the tiles.
|-
|[[UINT8]]||Color Color of the tiles.
|-
|}

A small quirk of this RLE format is when the number of tiles is set to zero. Due to the way the decoder is set up, a Count of 0 means there are actually 256 tiles encoded. The built-in editor does not encode tiles using this value despite being decoded correctly in the game, and it will probably crash some older external editors.

=== ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||IsDark When set to 1, the board is covered in darkness which can only be revealed by using a torch.
|-
|2||0x002||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|3||0x003||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|4||0x004||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|5||0x005||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|6||0x006||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|7||0x007||[[UINT8]]||MessageLength Length of the on-screen message.
|-
|8||0x008||[[char]][58]||Message On-screen message. This is used internally and is not loaded by the game.
|-
|66||0x042||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|67||0x043||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|68||0x044||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|70||0x046||[[UINT8]][16]||(unused)
|-
|86||0x056||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|-
|}

=== Super ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|2||0x002||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|3||0x003||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|4||0x004||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|5||0x005||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|6||0x006||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|7||0x007||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|8||0x008||[[INT16LE]]||CameraX X-coordinate of the viewport. This value is not used when loading worlds.
|-
|10||0x00A||[[INT16LE]]||CameraY Y-coordinate of the viewport. This value is not used when loading worlds.
|-
|12||0x00C||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|14||0x00E||[[UINT8]][14]||(unused)
|-
|28||0x01C||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|}

=== Status Elements ===

This follows directly after board properties. It is repeated for each Status Element. The first element stored is always the player-controlled element. This element may contain strange values for Step, Leader and Follower information - this is because these values are used internally by the game.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||LocationX X-coordinate. Location coordinates are 1-based, unlike any other coordinates in the file.
|-
|1||0x001||[[UINT8]]||LocationY Y-coordinate.
|-
|2||0x002||[[INT16LE]]||StepX X-step value. This pair of values represents a vector that typically points in one of the four cardinal directions. Its use differs for each type of element.
|-
|4||0x004||[[INT16LE]]||StepY Y-step value.
|-
|6||0x006||[[INT16LE]]||Cycle Cycle. This represents the frequency, in ticks, at which the game will process this status element.
|-
|8||0x008||[[UINT8]]||P1 Parameter 1. Its use will differ depending on the type of element.
|-
|9||0x009||[[UINT8]]||P2 Parameter 2. Its use will differ depending on the type of element.
|-
|10||0x00A||[[UINT8]]||P3 Parameter 3. Its use will differ depending on the type of element.
|-
|11||0x00B||[[INT16LE]]||Follower Follower status element. Its value determines if another status element is linked behind this one. Typically used for linking centipedes.
|-
|13||0x00D||[[INT16LE]]||Leader Leader status element. Its value determines if another status element is linked in front of this one. Typically used for linking centipedes.
|-
|15||0x00F||[[UINT8]]||UnderID Element of the tile under this status element.
|-
|16||0x010||[[UINT8]]||UnderColor Color of the tile under this status element.
|-
|17||0x011||[[INT32LE]]||Pointer Stores the location in memory of the code that this status element is using. Status elements typically point to their own code until they #BIND the code of another - in which case this memory location value is replaced with the new one. ZZT does not use this value when loading worlds, and always sets it to 0 when saving worlds.
|-
|21||0x015||[[INT16LE]]||CurrentInstruction The offset in bytes of the code block to execute ZZT-OOP from. Only Objects and Scrolls can execute ZZT-OOP.
|-
|23||0x017||[[INT16LE]]||Length There are two uses for this value: If this value is positive, it represents the number of bytes that are in the code block. If this value is negative, the absolute value of this value represents the Status Element number to copy code from. This saves space by removing redundant code duplication. Since code is shared in this way, all modifications to code will affect any other Status Elements using it.
|-
|}

In ZZT (not Super ZZT), 8 bytes of padding will follow.

If "Length" is positive, the code will be stored here.

== Element Lists ==

This is a list of all valid built-in elements that can be used. Using any elements outside this range produce undefined behavior which is dependent on whatever was residing in memory at the time the game was loaded. Most often, it will crash.

=== Element properties ===

These are all possible internal properties for each element.

{|class="wikitable"
!Property!!Description
|-
|Id||Id number of the element
|-
|Hex||Hexidecimal representation of the Id number
|-
|Name||Known name of the element, which may not be present internally
|-
|Character||ASCII character for the default draw code, which may be ignored if special draw code is enabled
|-
|Color||Default color. If the color is 0xFE, then new tiles will be created with the primary color as the background and a white foreground. If the color is >= 0xF0, any primary color is allowed, but in the editor you can't choose the color unless the default color is 0xFF
|-
|Destructible||Element can be destroyed by bullets and by being crushed by puzzle pieces
|-
|Pushable||Element can be pushed. The NS/EW sliders are a special case in the code, so they will not be marked with this flag
|-
|Editor Floor||When using the editor, actors such as enemies can be placed on top of elements marked with this flag. Has no effect during gameplay.
|-
|Floor||Elements with this flag can freely be moved upon by actors
|-
|Shown||ZZT only. Elements marked with this flag will always be shown, even on dark boards
|-
|Special Draw||If this flag is set, the default draw code is bypassed with different draw code
|-
|Draw Code||Offset of the routine that performs the drawing, if Special Draw is set
|-
|Cycle||Default cycle. If this is -1, the element is not generated as an actor. Creatures will have cycles above zero
|-
|Act Code||Offset of the routine that performs standard behavior. For example: creature movement, bomb countdown
|-
|Interact Code||Offset of the routine that handles when a player touches the element. For example: item pickups, entering a passage
|-
|Menu#||Number of the editor menu where this element can be found
|-
|Key||Key press which is mapped to this element in the editor
|-
|Internal Name||Name of the element used in the editor. It is also used by OOP- the parser will remove all symbols and spaces and compare that
|-
|Category||When it comes time to display this element in the editor, if present, the category will be drawn in yellow first.
|-
|Edit P1||Text to show when editing the P1 of an actor that uses this element
|-
|Edit P2||Text to show when editing the P2 of an actor that uses this element
|-
|Edit P3||Text to show when editing the P3 of an actor that uses this element
|-
|Edit Board||Text to show when selecting the target board
|-
|Edit Step||Text to show when selecting the target direction
|-
|Edit Code||Text to show when editing an actor's code (scroll or object OOP)
|-
|Points||When an actor using this element is killed by the player, it's worth this much score
|-
|}

=== ZZT elements ===

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Shown!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3973||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x20||0x07||||||||||||||0x0020||1||0x4481||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||Yes||||0x0020||1||0x3E2F||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||||0x0020||-1||0x0000||0x3289||1||A||Ammo||||||||||||||||0
|-
|6||0x06||Torch||0x9D||0x06||||||||||Yes||||0x0020||-1||0x0000||0x37B6||1||T||Torch||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||||0x0020||-1||0x0000||0x3306||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x3169||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||||0x0020||-1||0x0000||0x33DA||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||||0x0020||1||0x2F9F||0x308B||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||Yes||||0x0020||0||0x0000||0x3372||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||||Yes||0x2A15||2||0x2BFF||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||||Yes||0x1872||6||0x18DA||0x19F3||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||||0x0020||-1||0x0000||0x2034||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||Star||0x53||0x0F||||||||||||Yes||0x1D5D||1||0x1DE9||0x00F5||0||||Star||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||||Yes||0x171C||3||0x176C||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||||Yes||0x17C7||2||0x1817||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||Bullet||0xF8||0x0F||Yes||||||||||||0x0020||1||0x0F65||0x00F5||0||||Bullet||||||||||||||||0
|-
|19||0x13||Water||0xB0||0xF9||||||Yes||||||||0x0020||-1||0x0000||0x3B03||3||W||Water||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||||0x0020||-1||0x0000||0x38D0||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x34E3||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||||0x0020||-1||0x0000||0x3949||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0xB0||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3848||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||||Yes||0x242E||1||0x2445||0x0010||3||L||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||||Yes||0x1CC5||2||0x1C85||0x1C41||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||||Yes||0x122A||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0x99||0x06||Yes||Yes||||||||||0x0020||3||0x054F||0x00F5||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||||0x0020||1||0x0351||0x00F5||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||||Yes||0x2B85||3||0x2AA5||0x2BB7||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||||0x0020||3||0x20AE||0x2295||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||Shark||0x5E||0x07||||||||||||||0x0020||3||0x2321||0x0010||2||Y||Shark||||Intelligence?||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||||Yes||0x11D0||2||0x12A7||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||||Yes||0x3517||4||0x358A||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||||0x0020||2||0x0113||0x00F5||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||||0x0020||2||0x022D||0x00F5||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||||0x0020||2||0x06BF||0x00F5||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||||0x0020||2||0x0EED||0x00F5||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Text (Blue)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|48||0x30||Text (Green)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|49||0x31||Text (Cyan)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|50||0x32||Text (Red)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|51||0x33||Text (Purple)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|52||0x34||Text (Brown)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||Text (Black)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

=== Super ZZT elements ===

Internal properties for each of these elements can be found in the [http://pastebin.com/mdEwu6Y1 Super ZZT Elements Pastebin].

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3FA5||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x02||0x1F||||Yes||||||||0x0020||1||0x4B76||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||||0x0020||1||0x4596||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||0x0020||-1||0x0000||0x37E7||1||A||Ammo||||||||||||||||0
|-
|6||0x06||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||0x0020||-1||0x0000||0x397D||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x36F2||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||0x0020||-1||0x0000||0x3A63||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||0x0020||1||0x3517||0x3603||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||||0x0020||0||0x0000||0x39ED||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||Yes||0x2E32||2||0x3177||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||Yes||0x1DBD||6||0x1E25||0x1F3F||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||0x0020||-1||0x0000||0x2581||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||Yes||0x1C67||3||0x1CB7||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||Yes||0x1D12||2||0x1D62||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|19||0x13||Lava||0x6F||0x4E||||||Yes||||||0x0020||-1||0x0000||0x4155||3||L||Lava||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||0x0020||-1||0x0000||0x3EAF||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x3B5A||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x3F6C||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3E23||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||Yes||0x285B||1||0x2872||0x0010||3||X||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||Yes||0x2216||2||0x21D6||0x2192||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||Yes||0x17C3||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0xEB||0x02||Yes||Yes||||||||0x0020||3||0x09C1||0x014C||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||0x0020||1||0x07C3||0x014C||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||Yes||0x30FD||3||0x2EC2||0x312F||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||0x0020||3||0x25E8||0x27CF||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||Yes||0x1663||2||0x1811||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||Yes||0x3B8E||4||0x3C01||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||0x0020||2||0x016A||0x014C||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||0x0020||2||0x0284||0x014C||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||0x0020||2||0x0B31||0x014C||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||0x0020||2||0x1375||0x014C||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Floor||0xB0||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||F||Floor||Terrains:||||||||||||||0
|-
|48||0x30||Water N||0x1E||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||8||Water N||||||||||||||||0
|-
|49||0x31||Water S||0x1F||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||2||Water S||||||||||||||||0
|-
|50||0x32||Water W||0x11||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||4||Water W||||||||||||||||0
|-
|51||0x33||Water E||0x10||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||6||Water E||||||||||||||||0
|-
|52||0x34||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|54||0x36||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|55||0x37||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|56||0x38||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|57||0x39||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|58||0x3A||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|59||0x3B||Roton||0x94||0x0D||Yes||Yes||||||||0x0020||1||0x03A8||0x014C||4||R||Roton||Uglies:||Intelligence?||Switch Rate?||||||||||2
|-
|60||0x3C||Dragon Pup||0xED||0x04||Yes||Yes||||||Yes||0x05A3||2||0x0563||0x014C||4||D||Dragon Pup||||Intelligence?||Switch Rate?||||||||||1
|-
|61||0x3D||Pairer||0xE5||0x01||Yes||Yes||||||||0x0020||2||0x05E6||0x014C||4||P||Pairer||||Intelligence?||||||||||||2
|-
|62||0x3E||Spider||0x0F||Any (0xFF)||Yes||||||||||0x0020||1||0x06EB||0x014C||4||S||Spider||||Intelligence?||||||||||||3
|-
|63||0x3F||Web||0xC5||Any (0xFF)||||||Yes||Yes||Yes||0x17EA||-1||0x0000||0x0010||5||W||Web||||||||||||||||0
|-
|64||0x40||Stone||0x5A||0x0F||||||||||Yes||0x38A1||1||0x38C3||0x385E||5||Z||Stone||||||||||||||||0
|-
|65||0x41||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|66||0x42||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|67||0x43||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|68||0x44||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|69||0x45||Bullet||0xF8||0x0F||Yes||||||||||0x0020||1||0x13ED||0x014C||0||||Bullet||||||||||||||||0
|-
|70||0x46||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|71||0x47||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|72||0x48||Star||0x53||0x0F||||||||||Yes||0x22AE||1||0x233A||0x014C||0||||Star||||||||||||||||0
|-
|73||0x49||Text (Blue)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|74||0x4A||Text (Green)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|75||0x4B||Text (Cyan)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|76||0x4C||Text (Red)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|77||0x4D||Text (Purple)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|78||0x4E||Text (Brown)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|79||0x4F||Text (Black)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

[[Category:ZZT]]
[[Category:File Formats]]

ZZT Format

2015-09-08T02:40:37Z

SaxxonPike: /* Super ZZT elements */ Add properties from binary.

== Credits ==

A large portion of this information was gathered from documents written by Kev Vance (original ZZT format documentation), David Hammond (Mystical Winds Encyclopedia), and WiL (SuperZZT format documentation). A few errors have been corrected and the information has been tested in an attempt to create the most comprehensive document of both the ZZT and Super ZZT formats. This format document is primarily maintained and tested by [[User:SaxxonPike|SaxxonPike]].

== General Information ==

A world file (.ZZT, .SZT) contains information about a game world, status of the player, and all its boards. Saved games (.SAV) are the same format as world files with a different extension and a different setting for the Lock byte.

While there are built-in editors for these games, they do not provide full editing functionality.

== Limits ==

ZZT and Super ZZT have limits imposed either by the game itself or by the data types used to store information about the world's contents.

{|class="wikitable"
!Limitation!!ZZT!!Super ZZT
|-
|Board count (including title screen)||101||33
|-
|Board size (in bytes)||32767||32767
|-
|Board size (in tiles)||60x25||96x80
|-
|Status Elements per board (including Player)||151||129
|-
|Flag strings||10||16
|}

Realistically, the original ZZT can only support boards up to around 20k due to the code itself. ZZT 4.0 by WiL, a hack of the original game executable, can support the full 32k.

== World Format ==

There are two formats for a world file. One is for ZZT and the other is for SuperZZT. The formats are very similar. All 8-bit (byte) values are unsigned. All 16-bit (short) values are signed. Boolean values (such as a player's keys) are represented with 0 for false and 1 for true; any other values may cause inconsistent behavior.

World Name is used by the game to determine which file to load after the player quits and restarts the game. Therefore if a world contains a world name that is actually the filename of another world, after the player quits and restarts the game, the world with the matching filename will be loaded!

=== Common world information ===

The storage of this information is the same between the two formats. After this part of the file, the format will differ slightly.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF FF) and SuperZZT uses -2 (FE FF).
|-
|2||0x002||[[INT16LE]]||NumBoards Number of boards in the world, not including the title screen. Increment by 1 for the real number of stored boards. A value of 0 means only the title screen exists.
|-
|4||0x004||[[INT16LE]]||PlayerAmmo Player's ammunition.
|-
|6||0x006||[[INT16LE]]||PlayerGems Player's gems.
|-
|8||0x008||[[char]][7]||PlayerKeys Player's keys. A nonzero value means the player has the specified key. The keys are in this order: Blue, Green, Cyan, Red, Purple, Yellow, White.
|-
|15||0x00F||[[INT16LE]]||PlayerHealth Player's health.
|-
|17||0x011||[[INT16LE]]||PlayerBoard In a world file, this will be the starting board for the player (the title screen, board 0, is always shown first). In a saved game, this will be the board that the player is currently on.
|-
|}

=== ZZT world header ===

This is the second half of the header specific to a .ZZT file. After this information, storage of the boards starts at byte offset 512 (hex 0x200).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||PlayerTorches Player's torches.
|-
|21||0x015||[[INT16LE]]||TorchCycles Game cycles left for a torch to remain lit.
|-
|23||0x017||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|25||0x019||[[INT16LE]]||(unused) Always 0.
|-
|27||0x01B||[[INT16LE]]||PlayerScore Player's score.
|-
|29||0x01D||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|30||0x01E||[[char]][20]||WorldName Internal name of the world.
|-
|50||0x032||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|51||0x033||[[char]][20]||Flag0 Name of Flag 0.
|-
|71||0x047||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|72||0x048||[[char]][20]||Flag1 Name of Flag 1.
|-
|92||0x05C||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|93||0x05D||[[char]][20]||Flag2 Name of Flag 2.
|-
|113||0x071||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|114||0x072||[[char]][20]||Flag3 Name of Flag 3.
|-
|134||0x086||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|135||0x087||[[char]][20]||Flag4 Name of Flag 4.
|-
|155||0x09B||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|156||0x09C||[[char]][20]||Flag5 Name of Flag 5.
|-
|176||0x0B0||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|177||0x0B1||[[char]][20]||Flag6 Name of Flag 6.
|-
|197||0x0C5||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|198||0x0C6||[[char]][20]||Flag7 Name of Flag 7.
|-
|218||0x0DA||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|219||0x0DB||[[char]][20]||Flag8 Name of Flag 8.
|-
|239||0x0EF||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|240||0x0F0||[[char]][20]||Flag9 Name of Flag 9.
|-
|260||0x104||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|262||0x106||[[INT16LE]]||PlayerData This stores a runtime memory location that points to the status element currently being used by the player. Its value is not used when loading worlds, and is always set to 0 when saving worlds.
|-
|264||0x108||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|}

=== Super ZZT world header ===

This is the second half of the header specific to a .SZT file. After this information, storage of the boards starts at byte offset 1024 (hex 0x400).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||(unused) Always 0.
|-
|21||0x015||[[INT16LE]]||PlayerScore Player's score.
|-
|23||0x017||[[INT16LE]]||(unused) Always 0.
|-
|25||0x019||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|27||0x01B||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|28||0x01C||[[char]][20]||WorldName Internal name of the world.
|-
|48||0x030||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|49||0x031||[[char]][20]||Flag0 Name of Flag 0.
|-
|69||0x045||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|70||0x046||[[char]][20]||Flag1 Name of Flag 1.
|-
|90||0x05A||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|91||0x05B||[[char]][20]||Flag2 Name of Flag 2.
|-
|111||0x06F||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|112||0x070||[[char]][20]||Flag3 Name of Flag 3.
|-
|132||0x084||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|133||0x085||[[char]][20]||Flag4 Name of Flag 4.
|-
|153||0x099||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|154||0x09A||[[char]][20]||Flag5 Name of Flag 5.
|-
|174||0x0AE||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|175||0x0AF||[[char]][20]||Flag6 Name of Flag 6.
|-
|195||0x0C3||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|196||0x0C4||[[char]][20]||Flag7 Name of Flag 7.
|-
|216||0x0D8||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|217||0x0D9||[[char]][20]||Flag8 Name of Flag 8.
|-
|237||0x0ED||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|238||0x0EE||[[char]][20]||Flag9 Name of Flag 9.
|-
|258||0x102||[[UINT8]]||Flag10Length Length of the name of Flag 10.
|-
|259||0x103||[[char]][20]||Flag10 Name of Flag 10.
|-
|279||0x117||[[UINT8]]||Flag11Length Length of the name of Flag 11.
|-
|280||0x118||[[char]][20]||Flag11 Name of Flag 11.
|-
|300||0x12C||[[UINT8]]||Flag12Length Length of the name of Flag 12.
|-
|301||0x12D||[[char]][20]||Flag12 Name of Flag 12.
|-
|321||0x141||[[UINT8]]||Flag13Length Length of the name of Flag 13.
|-
|322||0x142||[[char]][20]||Flag13 Name of Flag 13.
|-
|342||0x156||[[UINT8]]||Flag14Length Length of the name of Flag 14.
|-
|343||0x157||[[char]][20]||Flag14 Name of Flag 14.
|-
|363||0x16B||[[UINT8]]||Flag15Length Length of the name of Flag 15.
|-
|364||0x16C||[[char]][20]||Flag15 Name of Flag 15.
|-
|384||0x180||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|386||0x182||[[INT16LE]]||PlayerData This stores a runtime memory location that points to the status element currently being used by the player. Its value is not used when loading worlds, and is always set to 0 when saving worlds.
|-
|388||0x184||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|389||0x185||[[INT16LE]]||PlayerStones Player's stones of power. If this value is negative, no information is shown in-game about them. If this value is >= 0, it uses a flag to describe this value in the status bar of the game. The flag used is the first one found that is preceded with a Z. "The Lost Forest" contains a flag called "ZSTONES" which shows as "STONES" on the status bar, for example.
|}

== Board Format ==

Boards can be stored individually in .BRD files. Since ZZT and Super ZZT use the same extension for boards and there is no world information stored with them, it isn't immediately apparent whether the board is a ZZT or a Super ZZT board. Testing the validity of the board information with both world types should be a good way to determine the type of world a board belongs to.

=== Format layout ===

Boards consist of 4 parts: Board Header, RLE Tiles, Board Properties, and Status Element Properties. Status Elements are elements on the board that the game actively processes - these include the player, enemies, any animating blocks, and Scrolls and Objects which can contain ZZT-OOP code.

=== ZZT board header ===

ZZT boards are 60x25 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][50]||BoardName Board's name.
|-
|53||0x035||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Super ZZT board header ===

Super ZZT boards are 96x80 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][60]||BoardName Board's name.
|-
|63||0x03F||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Run-length encoded tile data ===

Tile data is represented as sets of 3 bytes. These sets are repeated until the board is completely filled. For ZZT, this will be 60*25=1500 tiles. For SuperZZT, this will be 96*80=7680 tiles. The tiles are unpacked from left to right, top to bottom.

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Count Number of tiles.
|-
|[[UINT8]]||Element Element of the tiles.
|-
|[[UINT8]]||Color Color of the tiles.
|-
|}

A small quirk of this RLE format is when the number of tiles is set to zero. Due to the way the decoder is set up, a Count of 0 means there are actually 256 tiles encoded. The built-in editor does not encode tiles using this value despite being decoded correctly in the game, and it will probably crash some older external editors.

=== ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||IsDark When set to 1, the board is covered in darkness which can only be revealed by using a torch.
|-
|2||0x002||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|3||0x003||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|4||0x004||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|5||0x005||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|6||0x006||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|7||0x007||[[UINT8]]||MessageLength Length of the on-screen message.
|-
|8||0x008||[[char]][58]||Message On-screen message. This is used internally and is not loaded by the game.
|-
|66||0x042||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|67||0x043||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|68||0x044||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|70||0x046||[[UINT8]][16]||(unused)
|-
|86||0x056||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|-
|}

=== Super ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|2||0x002||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|3||0x003||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|4||0x004||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|5||0x005||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|6||0x006||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|7||0x007||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|8||0x008||[[INT16LE]]||CameraX X-coordinate of the viewport. This value is not used when loading worlds.
|-
|10||0x00A||[[INT16LE]]||CameraY Y-coordinate of the viewport. This value is not used when loading worlds.
|-
|12||0x00C||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|14||0x00E||[[UINT8]][14]||(unused)
|-
|28||0x01C||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|}

=== Status Elements ===

This follows directly after board properties. It is repeated for each Status Element. The first element stored is always the player-controlled element. This element may contain strange values for Step, Leader and Follower information - this is because these values are used internally by the game.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||LocationX X-coordinate. Location coordinates are 1-based, unlike any other coordinates in the file.
|-
|1||0x001||[[UINT8]]||LocationY Y-coordinate.
|-
|2||0x002||[[INT16LE]]||StepX X-step value. This pair of values represents a vector that typically points in one of the four cardinal directions. Its use differs for each type of element.
|-
|4||0x004||[[INT16LE]]||StepY Y-step value.
|-
|6||0x006||[[INT16LE]]||Cycle Cycle. This represents the frequency, in ticks, at which the game will process this status element.
|-
|8||0x008||[[UINT8]]||P1 Parameter 1. Its use will differ depending on the type of element.
|-
|9||0x009||[[UINT8]]||P2 Parameter 2. Its use will differ depending on the type of element.
|-
|10||0x00A||[[UINT8]]||P3 Parameter 3. Its use will differ depending on the type of element.
|-
|11||0x00B||[[INT16LE]]||Follower Follower status element. Its value determines if another status element is linked behind this one. Typically used for linking centipedes.
|-
|13||0x00D||[[INT16LE]]||Leader Leader status element. Its value determines if another status element is linked in front of this one. Typically used for linking centipedes.
|-
|15||0x00F||[[UINT8]]||UnderID Element of the tile under this status element.
|-
|16||0x010||[[UINT8]]||UnderColor Color of the tile under this status element.
|-
|17||0x011||[[INT32LE]]||Pointer Stores the location in memory of the code that this status element is using. Status elements typically point to their own code until they #BIND the code of another - in which case this memory location value is replaced with the new one. ZZT does not use this value when loading worlds, and always sets it to 0 when saving worlds.
|-
|21||0x015||[[INT16LE]]||CurrentInstruction The offset in bytes of the code block to execute ZZT-OOP from. Only Objects and Scrolls can execute ZZT-OOP.
|-
|23||0x017||[[INT16LE]]||Length There are two uses for this value: If this value is positive, it represents the number of bytes that are in the code block. If this value is negative, the absolute value of this value represents the Status Element number to copy code from. This saves space by removing redundant code duplication. Since code is shared in this way, all modifications to code will affect any other Status Elements using it.
|-
|}

In ZZT (not Super ZZT), 8 bytes of padding will follow.

If "Length" is positive, the code will be stored here.

== Element Lists ==

This is a list of all valid built-in elements that can be used. Using the undefined values between defined ones will generally not cause a crash; however, these values don't have any notable behavior. They are a simple wall element with no name, and therefore cannot be referenced by ZZT-OOP.

=== ZZT elements ===

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Shown!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3973||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x20||0x07||||||||||||||0x0020||1||0x4481||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||Yes||||0x0020||1||0x3E2F||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||||0x0020||-1||0x0000||0x3289||1||A||Ammo||||||||||||||||0
|-
|6||0x06||Torch||0x9D||0x06||||||||||Yes||||0x0020||-1||0x0000||0x37B6||1||T||Torch||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||||0x0020||-1||0x0000||0x3306||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x3169||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||||0x0020||-1||0x0000||0x33DA||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||||0x0020||1||0x2F9F||0x308B||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||Yes||||0x0020||0||0x0000||0x3372||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||||Yes||0x2A15||2||0x2BFF||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||||Yes||0x1872||6||0x18DA||0x19F3||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||||0x0020||-1||0x0000||0x2034||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||Star||0x53||0x0F||||||||||||Yes||0x1D5D||1||0x1DE9||0x00F5||0||||Star||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||||Yes||0x171C||3||0x176C||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||||Yes||0x17C7||2||0x1817||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||Bullet||0xF8||0x0F||Yes||||||||||||0x0020||1||0x0F65||0x00F5||0||||Bullet||||||||||||||||0
|-
|19||0x13||Water||0xB0||0xF9||||||Yes||||||||0x0020||-1||0x0000||0x3B03||3||W||Water||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||||0x0020||-1||0x0000||0x38D0||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x34E3||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||||0x0020||-1||0x0000||0x3949||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0xB0||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3848||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||||Yes||0x242E||1||0x2445||0x0010||3||L||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||||Yes||0x1CC5||2||0x1C85||0x1C41||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||||Yes||0x122A||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0x99||0x06||Yes||Yes||||||||||0x0020||3||0x054F||0x00F5||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||||0x0020||1||0x0351||0x00F5||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||||Yes||0x2B85||3||0x2AA5||0x2BB7||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||||0x0020||3||0x20AE||0x2295||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||Shark||0x5E||0x07||||||||||||||0x0020||3||0x2321||0x0010||2||Y||Shark||||Intelligence?||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||||Yes||0x11D0||2||0x12A7||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||||Yes||0x3517||4||0x358A||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||||0x0020||2||0x0113||0x00F5||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||||0x0020||2||0x022D||0x00F5||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||||0x0020||2||0x06BF||0x00F5||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||||0x0020||2||0x0EED||0x00F5||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Text (Blue)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|48||0x30||Text (Green)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|49||0x31||Text (Cyan)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|50||0x32||Text (Red)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|51||0x33||Text (Purple)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|52||0x34||Text (Brown)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||Text (Black)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

=== Super ZZT elements ===

Internal properties for each of these elements can be found in the [http://pastebin.com/mdEwu6Y1 Super ZZT Elements Pastebin].

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3FA5||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x02||0x1F||||Yes||||||||0x0020||1||0x4B76||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||||0x0020||1||0x4596||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||0x0020||-1||0x0000||0x37E7||1||A||Ammo||||||||||||||||0
|-
|6||0x06||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||0x0020||-1||0x0000||0x397D||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x36F2||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||0x0020||-1||0x0000||0x3A63||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||0x0020||1||0x3517||0x3603||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||||0x0020||0||0x0000||0x39ED||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||Yes||0x2E32||2||0x3177||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||Yes||0x1DBD||6||0x1E25||0x1F3F||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||0x0020||-1||0x0000||0x2581||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||Yes||0x1C67||3||0x1CB7||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||Yes||0x1D12||2||0x1D62||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|19||0x13||Lava||0x6F||0x4E||||||Yes||||||0x0020||-1||0x0000||0x4155||3||L||Lava||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||0x0020||-1||0x0000||0x3EAF||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||0x0020||-1||0x0000||0x3B5A||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3B5A||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x3F6C||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x3E23||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||Yes||0x285B||1||0x2872||0x0010||3||X||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||Yes||0x2216||2||0x21D6||0x2192||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||Yes||0x17C3||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0xEB||0x02||Yes||Yes||||||||0x0020||3||0x09C1||0x014C||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||0x0020||1||0x07C3||0x014C||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||Yes||0x30FD||3||0x2EC2||0x312F||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||0x0020||3||0x25E8||0x27CF||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||Yes||0x1663||2||0x1811||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||Yes||0x3B8E||4||0x3C01||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||0x0020||2||0x016A||0x014C||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||0x0020||2||0x0284||0x014C||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||0x0020||2||0x0B31||0x014C||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||0x0020||2||0x1375||0x014C||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Floor||0xB0||Any (0xFF)||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||F||Floor||Terrains:||||||||||||||0
|-
|48||0x30||Water N||0x1E||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||8||Water N||||||||||||||||0
|-
|49||0x31||Water S||0x1F||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||2||Water S||||||||||||||||0
|-
|50||0x32||Water W||0x11||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||4||Water W||||||||||||||||0
|-
|51||0x33||Water E||0x10||0x19||||||Yes||Yes||||0x0020||-1||0x0000||0x0010||5||6||Water E||||||||||||||||0
|-
|52||0x34||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|54||0x36||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|55||0x37||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|56||0x38||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|57||0x39||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|58||0x3A||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|59||0x3B||Roton||0x94||0x0D||Yes||Yes||||||||0x0020||1||0x03A8||0x014C||4||R||Roton||Uglies:||Intelligence?||Switch Rate?||||||||||2
|-
|60||0x3C||Dragon Pup||0xED||0x04||Yes||Yes||||||Yes||0x05A3||2||0x0563||0x014C||4||D||Dragon Pup||||Intelligence?||Switch Rate?||||||||||1
|-
|61||0x3D||Pairer||0xE5||0x01||Yes||Yes||||||||0x0020||2||0x05E6||0x014C||4||P||Pairer||||Intelligence?||||||||||||2
|-
|62||0x3E||Spider||0x0F||Any (0xFF)||Yes||||||||||0x0020||1||0x06EB||0x014C||4||S||Spider||||Intelligence?||||||||||||3
|-
|63||0x3F||Web||0xC5||Any (0xFF)||||||Yes||Yes||Yes||0x17EA||-1||0x0000||0x0010||5||W||Web||||||||||||||||0
|-
|64||0x40||Stone||0x5A||0x0F||||||||||Yes||0x38A1||1||0x38C3||0x385E||5||Z||Stone||||||||||||||||0
|-
|65||0x41||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|66||0x42||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|67||0x43||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|68||0x44||||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|69||0x45||Bullet||0xF8||0x0F||Yes||||||||||0x0020||1||0x13ED||0x014C||0||||Bullet||||||||||||||||0
|-
|70||0x46||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|71||0x47||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|72||0x48||Star||0x53||0x0F||||||||||Yes||0x22AE||1||0x233A||0x014C||0||||Star||||||||||||||||0
|-
|73||0x49||Text (Blue)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|74||0x4A||Text (Green)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|75||0x4B||Text (Cyan)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|76||0x4C||Text (Red)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|77||0x4D||Text (Purple)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|78||0x4E||Text (Brown)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|79||0x4F||Text (Black)||0x20||Any (0xFF)||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

[[Category:ZZT]]
[[Category:File Formats]]

ZZT Format

2015-09-08T02:34:21Z

SaxxonPike: /* ZZT elements */ Add raw properties from binary.

== Credits ==

A large portion of this information was gathered from documents written by Kev Vance (original ZZT format documentation), David Hammond (Mystical Winds Encyclopedia), and WiL (SuperZZT format documentation). A few errors have been corrected and the information has been tested in an attempt to create the most comprehensive document of both the ZZT and Super ZZT formats. This format document is primarily maintained and tested by [[User:SaxxonPike|SaxxonPike]].

== General Information ==

A world file (.ZZT, .SZT) contains information about a game world, status of the player, and all its boards. Saved games (.SAV) are the same format as world files with a different extension and a different setting for the Lock byte.

While there are built-in editors for these games, they do not provide full editing functionality.

== Limits ==

ZZT and Super ZZT have limits imposed either by the game itself or by the data types used to store information about the world's contents.

{|class="wikitable"
!Limitation!!ZZT!!Super ZZT
|-
|Board count (including title screen)||101||33
|-
|Board size (in bytes)||32767||32767
|-
|Board size (in tiles)||60x25||96x80
|-
|Status Elements per board (including Player)||151||129
|-
|Flag strings||10||16
|}

Realistically, the original ZZT can only support boards up to around 20k due to the code itself. ZZT 4.0 by WiL, a hack of the original game executable, can support the full 32k.

== World Format ==

There are two formats for a world file. One is for ZZT and the other is for SuperZZT. The formats are very similar. All 8-bit (byte) values are unsigned. All 16-bit (short) values are signed. Boolean values (such as a player's keys) are represented with 0 for false and 1 for true; any other values may cause inconsistent behavior.

World Name is used by the game to determine which file to load after the player quits and restarts the game. Therefore if a world contains a world name that is actually the filename of another world, after the player quits and restarts the game, the world with the matching filename will be loaded!

=== Common world information ===

The storage of this information is the same between the two formats. After this part of the file, the format will differ slightly.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF FF) and SuperZZT uses -2 (FE FF).
|-
|2||0x002||[[INT16LE]]||NumBoards Number of boards in the world, not including the title screen. Increment by 1 for the real number of stored boards. A value of 0 means only the title screen exists.
|-
|4||0x004||[[INT16LE]]||PlayerAmmo Player's ammunition.
|-
|6||0x006||[[INT16LE]]||PlayerGems Player's gems.
|-
|8||0x008||[[char]][7]||PlayerKeys Player's keys. A nonzero value means the player has the specified key. The keys are in this order: Blue, Green, Cyan, Red, Purple, Yellow, White.
|-
|15||0x00F||[[INT16LE]]||PlayerHealth Player's health.
|-
|17||0x011||[[INT16LE]]||PlayerBoard In a world file, this will be the starting board for the player (the title screen, board 0, is always shown first). In a saved game, this will be the board that the player is currently on.
|-
|}

=== ZZT world header ===

This is the second half of the header specific to a .ZZT file. After this information, storage of the boards starts at byte offset 512 (hex 0x200).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||PlayerTorches Player's torches.
|-
|21||0x015||[[INT16LE]]||TorchCycles Game cycles left for a torch to remain lit.
|-
|23||0x017||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|25||0x019||[[INT16LE]]||(unused) Always 0.
|-
|27||0x01B||[[INT16LE]]||PlayerScore Player's score.
|-
|29||0x01D||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|30||0x01E||[[char]][20]||WorldName Internal name of the world.
|-
|50||0x032||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|51||0x033||[[char]][20]||Flag0 Name of Flag 0.
|-
|71||0x047||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|72||0x048||[[char]][20]||Flag1 Name of Flag 1.
|-
|92||0x05C||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|93||0x05D||[[char]][20]||Flag2 Name of Flag 2.
|-
|113||0x071||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|114||0x072||[[char]][20]||Flag3 Name of Flag 3.
|-
|134||0x086||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|135||0x087||[[char]][20]||Flag4 Name of Flag 4.
|-
|155||0x09B||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|156||0x09C||[[char]][20]||Flag5 Name of Flag 5.
|-
|176||0x0B0||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|177||0x0B1||[[char]][20]||Flag6 Name of Flag 6.
|-
|197||0x0C5||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|198||0x0C6||[[char]][20]||Flag7 Name of Flag 7.
|-
|218||0x0DA||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|219||0x0DB||[[char]][20]||Flag8 Name of Flag 8.
|-
|239||0x0EF||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|240||0x0F0||[[char]][20]||Flag9 Name of Flag 9.
|-
|260||0x104||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|262||0x106||[[INT16LE]]||PlayerData This stores a runtime memory location that points to the status element currently being used by the player. Its value is not used when loading worlds, and is always set to 0 when saving worlds.
|-
|264||0x108||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|}

=== Super ZZT world header ===

This is the second half of the header specific to a .SZT file. After this information, storage of the boards starts at byte offset 1024 (hex 0x400).

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|19||0x013||[[INT16LE]]||(unused) Always 0.
|-
|21||0x015||[[INT16LE]]||PlayerScore Player's score.
|-
|23||0x017||[[INT16LE]]||(unused) Always 0.
|-
|25||0x019||[[INT16LE]]||EnergyCycles Game cycles left for an energizer to be effective.
|-
|27||0x01B||[[UINT8]]||WorldNameLength Length of the internal name of the world.
|-
|28||0x01C||[[char]][20]||WorldName Internal name of the world.
|-
|48||0x030||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|49||0x031||[[char]][20]||Flag0 Name of Flag 0.
|-
|69||0x045||[[UINT8]]||Flag1Length Length of the name of Flag 1.
|-
|70||0x046||[[char]][20]||Flag1 Name of Flag 1.
|-
|90||0x05A||[[UINT8]]||Flag2Length Length of the name of Flag 2.
|-
|91||0x05B||[[char]][20]||Flag2 Name of Flag 2.
|-
|111||0x06F||[[UINT8]]||Flag3Length Length of the name of Flag 3.
|-
|112||0x070||[[char]][20]||Flag3 Name of Flag 3.
|-
|132||0x084||[[UINT8]]||Flag4Length Length of the name of Flag 4.
|-
|133||0x085||[[char]][20]||Flag4 Name of Flag 4.
|-
|153||0x099||[[UINT8]]||Flag5Length Length of the name of Flag 5.
|-
|154||0x09A||[[char]][20]||Flag5 Name of Flag 5.
|-
|174||0x0AE||[[UINT8]]||Flag6Length Length of the name of Flag 6.
|-
|175||0x0AF||[[char]][20]||Flag6 Name of Flag 6.
|-
|195||0x0C3||[[UINT8]]||Flag7Length Length of the name of Flag 7.
|-
|196||0x0C4||[[char]][20]||Flag7 Name of Flag 7.
|-
|216||0x0D8||[[UINT8]]||Flag8Length Length of the name of Flag 8.
|-
|217||0x0D9||[[char]][20]||Flag8 Name of Flag 8.
|-
|237||0x0ED||[[UINT8]]||Flag9Length Length of the name of Flag 9.
|-
|238||0x0EE||[[char]][20]||Flag9 Name of Flag 9.
|-
|258||0x102||[[UINT8]]||Flag10Length Length of the name of Flag 10.
|-
|259||0x103||[[char]][20]||Flag10 Name of Flag 10.
|-
|279||0x117||[[UINT8]]||Flag11Length Length of the name of Flag 11.
|-
|280||0x118||[[char]][20]||Flag11 Name of Flag 11.
|-
|300||0x12C||[[UINT8]]||Flag12Length Length of the name of Flag 12.
|-
|301||0x12D||[[char]][20]||Flag12 Name of Flag 12.
|-
|321||0x141||[[UINT8]]||Flag13Length Length of the name of Flag 13.
|-
|322||0x142||[[char]][20]||Flag13 Name of Flag 13.
|-
|342||0x156||[[UINT8]]||Flag14Length Length of the name of Flag 14.
|-
|343||0x157||[[char]][20]||Flag14 Name of Flag 14.
|-
|363||0x16B||[[UINT8]]||Flag15Length Length of the name of Flag 15.
|-
|364||0x16C||[[char]][20]||Flag15 Name of Flag 15.
|-
|384||0x180||[[INT16LE]]||TimePassed Amount of time in seconds that has passed on the current board. Only applicable if the board the player is on has a time limit.
|-
|386||0x182||[[INT16LE]]||PlayerData This stores a runtime memory location that points to the status element currently being used by the player. Its value is not used when loading worlds, and is always set to 0 when saving worlds.
|-
|388||0x184||[[UINT8]]||Locked A nonzero value indicates the world is actually a saved game. Additionally, worlds with a nonzero Locked byte can't be edited using the built-in editor.
|-
|389||0x185||[[INT16LE]]||PlayerStones Player's stones of power. If this value is negative, no information is shown in-game about them. If this value is >= 0, it uses a flag to describe this value in the status bar of the game. The flag used is the first one found that is preceded with a Z. "The Lost Forest" contains a flag called "ZSTONES" which shows as "STONES" on the status bar, for example.
|}

== Board Format ==

Boards can be stored individually in .BRD files. Since ZZT and Super ZZT use the same extension for boards and there is no world information stored with them, it isn't immediately apparent whether the board is a ZZT or a Super ZZT board. Testing the validity of the board information with both world types should be a good way to determine the type of world a board belongs to.

=== Format layout ===

Boards consist of 4 parts: Board Header, RLE Tiles, Board Properties, and Status Element Properties. Status Elements are elements on the board that the game actively processes - these include the player, enemies, any animating blocks, and Scrolls and Objects which can contain ZZT-OOP code.

=== ZZT board header ===

ZZT boards are 60x25 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][50]||BoardName Board's name.
|-
|53||0x035||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Super ZZT board header ===

Super ZZT boards are 96x80 tiles.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[INT16LE]]||BoardSize Size of the board, in bytes. Even if the board was corrupted by the built-in editor (which happens sometimes) this value will be correct; the rest of the boards remain intact and in place.
|-
|2||0x002||[[UINT8]]||BoardNameLength Length of the board's name.
|-
|3||0x003||[[char]][60]||BoardName Board's name.
|-
|63||0x03F||[[#Run-length encoded tile data|ZZT_RLE]]||Tiles Start of the RLE tile data.
|-
|}

=== Run-length encoded tile data ===

Tile data is represented as sets of 3 bytes. These sets are repeated until the board is completely filled. For ZZT, this will be 60*25=1500 tiles. For SuperZZT, this will be 96*80=7680 tiles. The tiles are unpacked from left to right, top to bottom.

{|class="wikitable"
!Data type!!Description
|-
|[[UINT8]]||Count Number of tiles.
|-
|[[UINT8]]||Element Element of the tiles.
|-
|[[UINT8]]||Color Color of the tiles.
|-
|}

A small quirk of this RLE format is when the number of tiles is set to zero. Due to the way the decoder is set up, a Count of 0 means there are actually 256 tiles encoded. The built-in editor does not encode tiles using this value despite being decoded correctly in the game, and it will probably crash some older external editors.

=== ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||IsDark When set to 1, the board is covered in darkness which can only be revealed by using a torch.
|-
|2||0x002||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|3||0x003||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|4||0x004||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|5||0x005||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|6||0x006||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|7||0x007||[[UINT8]]||MessageLength Length of the on-screen message.
|-
|8||0x008||[[char]][58]||Message On-screen message. This is used internally and is not loaded by the game.
|-
|66||0x042||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|67||0x043||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|68||0x044||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|70||0x046||[[UINT8]][16]||(unused)
|-
|86||0x056||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|-
|}

=== Super ZZT board properties ===

This information follows directly after the tile RLE data.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||MaxPlayerShots Maximum number of player-owned projectiles allowed at once.
|-
|1||0x001||[[UINT8]]||ExitNorth Board # that is traveled to when moving off the North side of the board.
|-
|2||0x002||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board.
|-
|3||0x003||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board.
|-
|4||0x004||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board.
|-
|5||0x005||[[UINT8]]||RestartOnZap When set to 1, the player will teleport to the location where they entered the board whenever they are hurt.
|-
|6||0x006||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board.
|-
|7||0x007||[[UINT8]]||PlayerEnterY Y-coordinate of the tile where the player entered the board.
|-
|8||0x008||[[INT16LE]]||CameraX X-coordinate of the viewport. This value is not used when loading worlds.
|-
|10||0x00A||[[INT16LE]]||CameraY Y-coordinate of the viewport. This value is not used when loading worlds.
|-
|12||0x00C||[[INT16LE]]||TimeLimit Time limit of the board, in seconds. The player is hurt when time runs out.
|-
|14||0x00E||[[UINT8]][14]||(unused)
|-
|28||0x01C||[[INT16LE]]||StatElementCount Number of Status Elements on the board, not including the player. Increment by 1 to get the real stored number of status elements.
|}

=== Status Elements ===

This follows directly after board properties. It is repeated for each Status Element. The first element stored is always the player-controlled element. This element may contain strange values for Step, Leader and Follower information - this is because these values are used internally by the game.

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x000||[[UINT8]]||LocationX X-coordinate. Location coordinates are 1-based, unlike any other coordinates in the file.
|-
|1||0x001||[[UINT8]]||LocationY Y-coordinate.
|-
|2||0x002||[[INT16LE]]||StepX X-step value. This pair of values represents a vector that typically points in one of the four cardinal directions. Its use differs for each type of element.
|-
|4||0x004||[[INT16LE]]||StepY Y-step value.
|-
|6||0x006||[[INT16LE]]||Cycle Cycle. This represents the frequency, in ticks, at which the game will process this status element.
|-
|8||0x008||[[UINT8]]||P1 Parameter 1. Its use will differ depending on the type of element.
|-
|9||0x009||[[UINT8]]||P2 Parameter 2. Its use will differ depending on the type of element.
|-
|10||0x00A||[[UINT8]]||P3 Parameter 3. Its use will differ depending on the type of element.
|-
|11||0x00B||[[INT16LE]]||Follower Follower status element. Its value determines if another status element is linked behind this one. Typically used for linking centipedes.
|-
|13||0x00D||[[INT16LE]]||Leader Leader status element. Its value determines if another status element is linked in front of this one. Typically used for linking centipedes.
|-
|15||0x00F||[[UINT8]]||UnderID Element of the tile under this status element.
|-
|16||0x010||[[UINT8]]||UnderColor Color of the tile under this status element.
|-
|17||0x011||[[INT32LE]]||Pointer Stores the location in memory of the code that this status element is using. Status elements typically point to their own code until they #BIND the code of another - in which case this memory location value is replaced with the new one. ZZT does not use this value when loading worlds, and always sets it to 0 when saving worlds.
|-
|21||0x015||[[INT16LE]]||CurrentInstruction The offset in bytes of the code block to execute ZZT-OOP from. Only Objects and Scrolls can execute ZZT-OOP.
|-
|23||0x017||[[INT16LE]]||Length There are two uses for this value: If this value is positive, it represents the number of bytes that are in the code block. If this value is negative, the absolute value of this value represents the Status Element number to copy code from. This saves space by removing redundant code duplication. Since code is shared in this way, all modifications to code will affect any other Status Elements using it.
|-
|}

In ZZT (not Super ZZT), 8 bytes of padding will follow.

If "Length" is positive, the code will be stored here.

== Element Lists ==

This is a list of all valid built-in elements that can be used. Using the undefined values between defined ones will generally not cause a crash; however, these values don't have any notable behavior. They are a simple wall element with no name, and therefore cannot be referenced by ZZT-OOP.

=== ZZT elements ===

{|class="wikitable"
!Id!!Hex!!Name!!Character!!Color!!Destructible!!Pushable!!Editor Floor!!Floor!!Shown!!Special Draw!!Draw Code!!Cycle!!Act Code!!Interact Code!!Menu#!!Key!!Internal Name!!Category!!Edit P1!!Edit P2!!Edit P3!!Edit Board!!Edit Step!!Edit Code!!Points
|-
|0||0x00||Empty||0x20||0x70||||Yes||||Yes||||||0x0020||-1||0x0000||0x0010||0||||Empty||||||||||||||||0
|-
|1||0x01||Board Edge||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3973||0||||||||||||||||||||0
|-
|2||0x02||Messenger||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0039||0x0010||0||||||||||||||||||||0
|-
|3||0x03||Monitor||0x20||0x07||||||||||||||0x0020||1||0x4481||0x0010||0||||Monitor||||||||||||||||0
|-
|4||0x04||Player||0x02||0x1F||Yes||Yes||||||Yes||||0x0020||1||0x3E2F||0x0010||1||Z||Player||Items:||||||||||||||0
|-
|5||0x05||Ammo||0x84||0x03||||Yes||||||||||0x0020||-1||0x0000||0x3289||1||A||Ammo||||||||||||||||0
|-
|6||0x06||Torch||0x9D||0x06||||||||||Yes||||0x0020||-1||0x0000||0x37B6||1||T||Torch||||||||||||||||0
|-
|7||0x07||Gem||0x04||Any (0xFF)||Yes||Yes||||||||||0x0020||-1||0x0000||0x3306||1||G||Gem||||||||||||||||0
|-
|8||0x08||Key||0x0C||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x3169||1||K||Key||||||||||||||||0
|-
|9||0x09||Door||0x0A||Any BG (0xFE)||||||||||||||0x0020||-1||0x0000||0x33DA||1||D||Door||||||||||||||||0
|-
|10||0x0A||Scroll||0xE8||0x0F||||Yes||||||||||0x0020||1||0x2F9F||0x308B||1||S||Scroll||||||||||||||Edit text of scroll||0
|-
|11||0x0B||Passage||0xF0||Any BG (0xFE)||||||||||Yes||||0x0020||0||0x0000||0x3372||1||P||Passage||||||||||Room thru passage?||||||0
|-
|12||0x0C||Duplicator||0xFA||0x0F||||||||||||Yes||0x2A15||2||0x2BFF||0x0010||1||U||Duplicator||||||Duplication rate?;SF||||||Source direction?||||0
|-
|13||0x0D||Bomb||0x0B||Any (0xFF)||||Yes||||||||Yes||0x1872||6||0x18DA||0x19F3||1||B||Bomb||||||||||||||||0
|-
|14||0x0E||Energizer||0x7F||0x05||||||||||||||0x0020||-1||0x0000||0x2034||1||E||Energizer||||||||||||||||0
|-
|15||0x0F||Star||0x53||0x0F||||||||||||Yes||0x1D5D||1||0x1DE9||0x00F5||0||||Star||||||||||||||||0
|-
|16||0x10||Clockwise||0x2F||Any (0xFF)||||||||||||Yes||0x171C||3||0x176C||0x0010||1||1||Clockwise||Conveyors:||||||||||||||0
|-
|17||0x11||Counter||0x5C||Any (0xFF)||||||||||||Yes||0x17C7||2||0x1817||0x0010||1||2||Counter||||||||||||||||0
|-
|18||0x12||Bullet||0xF8||0x0F||Yes||||||||||||0x0020||1||0x0F65||0x00F5||0||||Bullet||||||||||||||||0
|-
|19||0x13||Water||0xB0||0xF9||||||Yes||||||||0x0020||-1||0x0000||0x3B03||3||W||Water||Terrains:||||||||||||||0
|-
|20||0x14||Forest||0xB0||0x20||||||||||||||0x0020||-1||0x0000||0x38D0||3||F||Forest||||||||||||||||0
|-
|21||0x15||Solid||0xDB||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||S||Solid||Walls:||||||||||||||0
|-
|22||0x16||Normal||0xB2||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||N||Normal||||||||||||||||0
|-
|23||0x17||Breakable||0xB1||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||3||B||Breakable||||||||||||||||0
|-
|24||0x18||Boulder||0xFE||Any (0xFF)||||Yes||||||||||0x0020||-1||0x0000||0x34E3||3||O||Boulder||||||||||||||||0
|-
|25||0x19||Slider (NS)||0x12||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||1||Slider (NS)||||||||||||||||0
|-
|26||0x1A||Slider (EW)||0x1D||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x34E3||3||2||Slider (EW)||||||||||||||||0
|-
|27||0x1B||Fake||0xB2||Any (0xFF)||||||Yes||Yes||||||0x0020||-1||0x0000||0x3949||3||A||Fake||||||||||||||||0
|-
|28||0x1C||Invisible||0xB0||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x3848||3||I||Invisible||||||||||||||||0
|-
|29||0x1D||Blink wall||0xCE||Any (0xFF)||||||||||||Yes||0x242E||1||0x2445||0x0010||3||L||Blink wall||||Starting time||Period||||||Wall direction||||0
|-
|30||0x1E||Transporter||0xC5||Any (0xFF)||||||||||||Yes||0x1CC5||2||0x1C85||0x1C41||3||T||Transporter||||||||||||Direction?||||0
|-
|31||0x1F||Line||0xCE||Any (0xFF)||||||||||||Yes||0x122A||-1||0x0000||0x0010||0||||Line||||||||||||||||0
|-
|32||0x20||Ricochet||0x2A||0x0A||||||||||||||0x0020||-1||0x0000||0x0010||3||R||Ricochet||||||||||||||||0
|-
|33||0x21||Blink Ray (Horizontal)||0xCD||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|34||0x22||Bear||0x99||0x06||Yes||Yes||||||||||0x0020||3||0x054F||0x00F5||2||B||Bear||Creatures:||Sensitivity?||||||||||||1
|-
|35||0x23||Ruffian||0x05||0x0D||Yes||Yes||||||||||0x0020||1||0x0351||0x00F5||2||R||Ruffian||||Intelligence?||Resting time?||||||||||2
|-
|36||0x24||Object||0x02||Any (0xFF)||||||||||||Yes||0x2B85||3||0x2AA5||0x2BB7||2||O||Object||||Character?||||||||||Edit Program||0
|-
|37||0x25||Slime||0x2A||Any (0xFF)||||||||||||||0x0020||3||0x20AE||0x2295||2||V||Slime||||||Movement speed?;FS||||||||||0
|-
|38||0x26||Shark||0x5E||0x07||||||||||||||0x0020||3||0x2321||0x0010||2||Y||Shark||||Intelligence?||||||||||||0
|-
|39||0x27||Spinning gun||0x18||Any (0xFF)||||||||||||Yes||0x11D0||2||0x12A7||0x0010||2||G||Spinning gun||||Intelligence?||Firing rate?||Firing type?||||||||0
|-
|40||0x28||Pusher||0x10||Any (0xFF)||||||||||||Yes||0x3517||4||0x358A||0x0010||2||P||Pusher||||||||||||Push direction?||||0
|-
|41||0x29||Lion||0xEA||0x0C||Yes||Yes||||||||||0x0020||2||0x0113||0x00F5||2||L||Lion||Beasts:||Intelligence?||||||||||||1
|-
|42||0x2A||Tiger||0xE3||0x0B||Yes||Yes||||||||||0x0020||2||0x022D||0x00F5||2||T||Tiger||||Intelligence?||Firing rate?||Firing type?||||||||2
|-
|43||0x2B||Blink Ray (Vertical)||0xBA||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|44||0x2C||Head||0xE9||Any (0xFF)||Yes||||||||||||0x0020||2||0x06BF||0x00F5||2||H||Head||Centipedes||Intelligence?||Deviance?||||||||||1
|-
|45||0x2D||Segment||0x4F||Any (0xFF)||Yes||||||||||||0x0020||2||0x0EED||0x00F5||2||S||Segment||||||||||||||||3
|-
|46||0x2E||||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|47||0x2F||Text (Blue)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|48||0x30||Text (Green)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|49||0x31||Text (Cyan)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|50||0x32||Text (Red)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|51||0x33||Text (Purple)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|52||0x34||Text (Brown)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|53||0x35||Text (Black)||0x20||Any (0xFF)||||||||||||||0x0020||-1||0x0000||0x0010||0||||||||||||||||||||0
|-
|}

=== Super ZZT elements ===

Internal properties for each of these elements can be found in the [http://pastebin.com/mdEwu6Y1 Super ZZT Elements Pastebin].

{|class="wikitable"
!Value!!Hex!!Element
|-
|0||0x00||Empty
|-
|1||0x01||Board Edge
|-
|2||0x02||Messenger
|-
|3||0x03||Monitor
|-
|4||0x04||Player
|-
|5||0x05||Ammo
|-
|7||0x07||Gem
|-
|8||0x08||Key
|-
|9||0x09||Door
|-
|10||0x0A||Scroll
|-
|11||0x0B||Passage
|-
|12||0x0C||Duplicator
|-
|13||0x0D||Bomb
|-
|14||0x0E||Energizer
|-
|16||0x10||Conveyor, Clockwise
|-
|17||0x11||Conveyor, Counterclockwise
|-
|19||0x13||Lava
|-
|20||0x14||Forest
|-
|21||0x15||Solid Wall
|-
|22||0x16||Normal Wall
|-
|23||0x17||Breakable Wall
|-
|24||0x18||Boulder
|-
|25||0x19||Slider, North-South
|-
|26||0x1A||Slider, East-West
|-
|27||0x1B||Fake Wall
|-
|28||0x1C||Invisible Wall
|-
|29||0x1D||Blink Wall
|-
|30||0x1E||Transporter
|-
|31||0x1F||Line
|-
|32||0x20||Ricochet
|-
|34||0x22||Bear
|-
|35||0x23||Ruffian
|-
|36||0x24||Object
|-
|37||0x25||Slime
|-
|38||0x26||Shark
|-
|39||0x27||Spinning Gun
|-
|40||0x28||Pusher
|-
|41||0x29||Lion
|-
|42||0x2A||Tiger
|-
|44||0x2C||Centipede Head
|-
|45||0x2D||Centipede Segment
|-
|47||0x2F||Floor
|-
|48||0x30||Water, North
|-
|49||0x31||Water, South
|-
|50||0x32||Water, West
|-
|51||0x33||Water, East
|-
|59||0x3B||Roton
|-
|60||0x3C||Dragon Pup
|-
|61||0x3D||Pairer
|-
|62||0x3E||Spider
|-
|63||0x3F||Web
|-
|64||0x40||Stone of Power
|-
|69||0x45||Bullet
|-
|70||0x46||Blink Ray, Horizontal
|-
|71||0x47||Blink Ray, Vertical
|-
|72||0x48||Star
|-
|73||0x49||Text, Blue
|-
|74||0x4A||Text, Green
|-
|75||0x4B||Text, Cyan
|-
|76||0x4C||Text, Red
|-
|77||0x4D||Text, Purple
|-
|78||0x4E||Text, Brown
|-
|79||0x4F||Text, White
|-
|}

[[Category:ZZT]]
[[Category:File Formats]]

LBX Format

2015-09-08T01:18:22Z

SaxxonPike: Filename info

'''LBX''' is a container format used by [[Master of Orion]], [[Master of Magic]] and [[Master of Orion 2]]. The format may contain multiple files, typically uncompressed. It does not store file names, nor any reliable indication of what the contained files are for (the game is expected to know their purpose internally.) Therefore, while it is not overly difficult to pack or unpack an LBX archive, modding the game requires further knowledge of what each individual .LBX is supposed to contain.

Certain .LBX files in [[Master of Orion 2]] are not actually .LBX archives, but rather renamed video files.

== File format ==

The header of the format is as follows:
{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x00||[[UINT16LE]]||Number of files in archive
|-
|2||0x02||[[BYTE]][4]||Signature (AD FE 00 00)
|-
|6||0x06||[[UINT16LE]]||Information about the contents
|-
|8||0x08||[[UINT32LE]]||Offset to file (repeats for each file stored in the LBX)
|-
|(last offset)||||[[UINT32LE]]||Offset to end of LBX
|}

It is not unusual for there to be some rubbish data in between the header/index and the packaged data.

=== File names ===

Filenames may or may not follow. If they do exist, you will find them at offset 512 (0x200 hex) and they will last until the first file starts:

{|class="wikitable"
!Offset!!Hex!!Data type!!Description
|-
|0||0x00||[[BYTE]][32]||File name
|}

LBX Format

2015-09-08T01:13:24Z

SaxxonPike: File offsets, filled in a little info