Wiki of ZZT - User contributions [en]

ZZT file format

2026-03-19T05:47:45Z

Quantum: Update some descriptions of how different fields behave

== General Info ==

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.

World Name is used by the game both on the title screen to display the game name as well as 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 ZZT and will be converted to empty padding.

=== World Header ===

This header is found at the head of all ZZT files. 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
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF 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.
|-
|}

{|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. For regular worlds, this usually matches the stem of the filename ("TOWN" for TOWN.ZZT); for save files, this is how ZZT knows which world the save came from.
|-
|50||0x032||[[UINT8]]||Flag0Length Length of the name of Flag 0.
|-
|51||0x033||[[char]][20]||Flag0 Name of Flag 0. (An empty string indicates an unused flag slot.)
|-
|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)
|}

After this follows the boards. 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.

=== 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.
|-
|}

=== 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. 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.

=== 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. 0 means no board connects there.
|-
|3||0x003||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board. 0 means no board connects there.
|-
|4||0x004||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board. 0 means no board connects there.
|-
|5||0x005||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board. 0 means no board connects there.
|-
|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 loaded by ZZT but is usually ignored; it will only be displayed if ZZT's in-memory play state from the last game played ''also'' had an on-screen message at the time the user quit that game.
|-
|66||0x042||[[UINT8]]||PlayerEnterX X-coordinate of the tile where the player entered the board. These coordinates only matter when restoring a saved game. When playing a regular world, ZZT ignores the coordinates from the file and uses the player's actual entry coordinates.
|-
|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.
|-
|}
Note that zero is used to indicate that there is no board exit in the given direction. This means it is impossible for a board edge to lead to the [[title screen]], because the title screen always has board index zero.

=== 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, Follower, and Parameter information, especially in older worlds / the commercial+shareware worlds.

{|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, or (0, 0) for no direction. 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. Used for linking centipedes. Editors typically set both indexes to -1, which causes ZZT to link the centipede itself and fill in the correct values.
|-
|13||0x00D||[[INT16LE]]||Leader Leader status element. Its value determines if another status element is linked in front of this one. 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. This is typically 0 (object starts at the top of its program), though objects can be pre-[[End|#ended]] by setting this to -1.
|-
|23||0x017||[[INT16LE]]||Length There are two uses for this value: If Length is positive, it represents the number of bytes that are in the code block. If Length is negative, the absolute value of Length represents the index of the Status Element the current stat is [[Bind|bound]] to, meaning the two stats share the same code block. (Zero simply means the stat's code block is empty; it is impossible to be bound to the stat at index 0.)
|-
|}

After this follows 8 bytes of padding (2 unused pointers). If "Length" is positive, the code is stored after the padding.

=== Element properties ===

These are all possible internal properties for each element. They are initialized on startup and used both in-game and in the editor.

{|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
|-
|}

== Credits ==

The ZZT file format was reverse engineered by SaxxonPike, Kev Vance and David Hammond.

This article is based on content written by SaxxonPike as part of [https://moddingwiki.shikadi.net/wiki/ZZT_Format a corresponding article on the ModdingWiki]. Saxxon has given permission to license their edits to that article under CC BY-SA 4.0.

[[Category:File formats]]

Bind

2026-01-30T09:16:09Z

Quantum: Reorganize a bit, add info on what binding actually is and how to pre-bind properly

{{DISPLAYTITLE:bind}}
'''#bind''' is a [[ZZT-OOP]] command which allows replacing the currently executed [[Object]] code with that of a different Object present on the board.

Binding objects together causes them to share a single copy of the exact same program. This makes #bind useful for saving space when objects need to have the same code. However, this also means that if one of the objects runs a command that alters the code ([[Zap|#zap]] or [[Restore|#restore]]), the other objects will also be affected by that change.

While it is common for objects that use #bind to have it be their only command, that does not need to be the case. Objects can use [[walk|#walk]] before binding to set a different [[flow]] direction, [[cycle|#cycle]] to give themselves a different speed, <code>/i</code> to delay the start of execution, or whatever else suits one's needs.

With external editors it is possible to "pre-bind" an object to another without needing to use this command (even if the other object doesn't have a proper name!). However, care must be taken to make sure the objects are in the correct [[stat order]], or else memory corruption may result. This is because the object that actually contains the code must appear before any bound objects in the stat list; using ZZT's built-in #bind manages this for you, but authors using pre-bound objects must manage the stat order themselves.

== Syntax ==
<code>#bind <object name></code>

== Bugs ==

* In unmodified ZZT, '''#bind''' always causes the memory allocated by previously used code to be freed, without checking if the code is also bound to other Objects. As this does not clear the memory or invalidate the pointer to said code, execution can continue as normal. However, any dynamic memory allocation - such as opening text windows - may cause corruption and instability.

{{ZZT-OOP navbox}}

ZZT file format

2026-01-30T08:40:54Z

Quantum: Clarify meanings of zero when used as board/stat indexes

== General Info ==

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.

World Name is used by the game both on the title screen to display the game name as well as 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 ZZT and will be converted to empty padding.

=== World Header ===

This header is found at the head of all ZZT files. 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
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF 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.
|-
|}

{|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)
|}

After this follows the boards. 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.

=== 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.
|-
|}

=== 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. 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.

=== 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. 0 means no board connects there.
|-
|3||0x003||[[UINT8]]||ExitSouth Board # that is traveled to when moving off the South side of the board. 0 means no board connects there.
|-
|4||0x004||[[UINT8]]||ExitWest Board # that is traveled to when moving off the West side of the board. 0 means no board connects there.
|-
|5||0x005||[[UINT8]]||ExitEast Board # that is traveled to when moving off the East side of the board. 0 means no board connects there.
|-
|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.
|-
|}
Note that zero is used to indicate that there is no board exit in the given direction. This means it is impossible for a board edge to lead to the [[title screen]], because the title screen always has board index zero.

=== 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, Follower, and Parameter information, especially in older worlds / the commercial+shareware worlds.

{|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. 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. 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 Length is positive, it represents the number of bytes that are in the code block. If Length is negative, the absolute value of Length represents the index of the Status Element the current stat is [[Bind|bound]] to, meaning the two stats share the same code block. (Zero simply means the stat's code block is empty; it is impossible to be bound to the stat at index 0.)
|-
|}

After this follows 8 bytes of padding (2 unused pointers). If "Length" is positive, the code is stored after the padding.

=== Element properties ===

These are all possible internal properties for each element. They are initialized on startup and used both in-game and in the editor.

{|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
|-
|}

== Credits ==

The ZZT file format was reverse engineered by SaxxonPike, Kev Vance and David Hammond.

This article is based on content written by SaxxonPike as part of [https://moddingwiki.shikadi.net/wiki/ZZT_Format a corresponding article on the ModdingWiki]. Saxxon has given permission to license their edits to that article under CC BY-SA 4.0.

[[Category:File formats]]

Size limits

2026-01-12T03:25:24Z

Quantum: Redirect to Memory limits

#REDIRECT [[Memory limits]]

Main Page

2025-08-08T08:03:45Z

Quantum: Redo front page, add Museum links

Welcome to the Wiki of ZZT!

ZZT is a text-mode game creation system written in 1991 by Tim Sweeney. This wiki documents various ZZT-related topics, such as its scripting language [[ZZT-OOP]], its built-in [[:Category:Elements|elements]], and technical information such as its [[ZZT file format|file formats]]. Contributions are welcome! See the [[Wiki:Contributing|contributing guide]] for details.

For more community-related stuff, hop on over here:

* [https://museumofzzt.com/ '''The Museum of ZZT'''] is the primary archive of ZZT games. They also host resources for [[Super ZZT]], as well as for community forks/clones of ZZT.
* [https://museumofzzt.com/discord/ '''The Discord of ZZT'''] is the Museum-affiliated community chat.

User:Quantum

2024-02-05T00:55:51Z

Quantum:

I'm Quantum. I administer this wiki, so if you encounter technical issues, let me know.

Hop on the [https://discordapp.com/invite/Nar4Upf Discord of ZZT] and ask for QP.

Module:CharSwatch

2023-06-26T08:01:41Z

Quantum: attempt to fix scroll char

local p = {}

function p.swatch(frame)
local char = tonumber(frame.args[1])
return string.format(
"[[char|#char]] %d %s (0x%02X)",
char, tostring(html_swatch(char)), char
)
end

function html_swatch(i)
local span = mw.html.create("span")
span:css({
["background-color"] = "#555",
["box-shadow"] = "0 0 1px #808080",
color = "#fff",
display = "inline-block",
font = "14px EGA8",
height = "1em",
["line-height"] = "100%",
["min-height"] = "14px",
["min-width"] = "8px",
padding = "2px",
["vertical-align"] = "middle"
})
span:wikitext(char_to_unicode(i))
return span
end

local unicode_table = {
[0] = " ", -- should be null, display as space
[1] = "☺",
[2] = "☻",
[3] = "♥",
[4] = "♦",
[5] = "♣",
[6] = "♠",
[7] = "•",
[8] = "◘",
[9] = "○",
[10] = "◙",
[11] = "♂",
[12] = "♀",
[13] = "♪",
[14] = "♫",
[15] = "☼",
[16] = "►",
[17] = "◄",
[18] = "↕",
[19] = "‼",
[20] = "¶",
[21] = "§",
[22] = "▬",
[23] = "↨",
[24] = "↑",
[25] = "↓",
[26] = "→",
[27] = "←",
[28] = "∟",
[29] = "↔",
[30] = "▲",
[31] = "▼",
[127] = "⌂",
[128] = "Ç",
[129] = "ü",
[130] = "é",
[131] = "â",
[132] = "ä",
[133] = "à",
[134] = "å",
[135] = "ç",
[136] = "ê",
[137] = "ë",
[138] = "è",
[139] = "ï",
[140] = "î",
[141] = "ì",
[142] = "Ä",
[143] = "Å",
[144] = "É",
[145] = "æ",
[146] = "Æ",
[147] = "ô",
[148] = "ö",
[149] = "ò",
[150] = "û",
[151] = "ù",
[152] = "ÿ",
[153] = "Ö",
[154] = "Ü",
[155] = "¢",
[156] = "£",
[157] = "¥",
[158] = "₧",
[159] = "ƒ",
[160] = "á",
[161] = "í",
[162] = "ó",
[163] = "ú",
[164] = "ñ",
[165] = "Ñ",
[166] = "ª",
[167] = "º",
[168] = "¿",
[169] = "⌐",
[170] = "¬",
[171] = "½",
[172] = "¼",
[173] = "¡",
[174] = "«",
[175] = "»",
[176] = "░",
[177] = "▒",
[178] = "▓",
[179] = "│",
[180] = "┤",
[181] = "╡",
[182] = "╢",
[183] = "╖",
[184] = "╕",
[185] = "╣",
[186] = "║",
[187] = "╗",
[188] = "╝",
[189] = "╜",
[190] = "╛",
[191] = "┐",
[192] = "└",
[193] = "┴",
[194] = "┬",
[195] = "├",
[196] = "─",
[197] = "┼",
[198] = "╞",
[199] = "╟",
[200] = "╚",
[201] = "╔",
[202] = "╩",
[203] = "╦",
[204] = "╠",
[205] = "═",
[206] = "╬",
[207] = "╧",
[208] = "╨",
[209] = "╤",
[210] = "╥",
[211] = "╙",
[212] = "╘",
[213] = "╒",
[214] = "╓",
[215] = "╫",
[216] = "╪",
[217] = "┘",
[218] = "┌",
[219] = "█",
[220] = "▄",
[221] = "▌",
[222] = "▐",
[223] = "▀",
[224] = "ɑ",
[225] = "ϐ",
[226] = "ᴦ",
[227] = "π",
[228] = "∑",
[229] = "ơ",
[230] = "µ",
[231] = "ᴛ",
[232] = "Φ",
[233] = "ϴ",
[234] = "Ω",
[235] = "ẟ",
[236] = "∞",
[237] = "∅",
[238] = "∈",
[239] = "∩",
[240] = "≡",
[241] = "±",
[242] = "≥",
[243] = "≤",
[244] = "⌠",
[245] = "⌡",
[246] = "÷",
[247] = "≈",
[248] = "°",
[249] = "∙",
[250] = "·",
[251] = "√",
[252] = "ⁿ",
[253] = "²",
[254] = "■",
[255] = " "
}

function char_to_unicode(i)
if i < 0 or i > 255 then
error("char index out of range: " .. i)
end
if i >= 32 and i <= 126 then
-- Handle regular ASCII characters
return string.char(i)
end
return unicode_table[i]
end

return p

ZZT file format

2021-12-06T00:12:08Z

Quantum: /* Credits */ I messaged Saxxon over Discord and got explicit okay to license their edits to the ModdingWiki article under CC BY-SA 4.0.

== General Info ==

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.

World Name is used by the game both on the title screen to display the game name as well as 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 ZZT and will be converted to empty padding.

=== World Header ===

This header is found at the head of all ZZT files. 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
|-
|0||0x000||[[INT16LE]]||WorldType Used to identify the world's format. ZZT uses -1 (FF 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.
|-
|}

{|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)
|}

After this follows the boards. 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.

=== 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.
|-
|}

=== 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. 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.

=== 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.
|-
|}

=== 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, Follower, and Parameter information, especially in older worlds / the commercial+shareware worlds.

{|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. 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. 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.
|-
|}

After this follows 8 bytes of padding (2 unused pointers). If "Length" is positive, the code is stored after the padding.

=== Element properties ===

These are all possible internal properties for each element. They are initialized on startup and used both in-game and in the editor.

{|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
|-
|}

== Credits ==

The ZZT file format was reverse engineered by SaxxonPike, Kev Vance and David Hammond.

This article is based on content written by SaxxonPike as part of [https://moddingwiki.shikadi.net/wiki/ZZT_Format a corresponding article on the ModdingWiki]. Saxxon has given permission to license their edits to that article under CC BY-SA 4.0.

MediaWiki:Common.css

2021-02-15T07:55:17Z

Quantum: Add WIP styles for byte layout diagram

/* CSS placed here will be applied to all skins */

@font-face {
font-family: "EGA8";
src: url("/w/images/a/ae/Web437_IBM_EGA_8x14.woff") format("woff");
}

.blinking {
animation: 2.5s linear infinite blinking_text;
}
@keyframes blinking_text {
35% {
opacity: 100%;
}
45% {
opacity: 0%;
}
55% {
opacity: 0%;
}
65% {
opacity: 100%;
}
}

/* Navbox CSS */
.navbox {
width: 100%;
border: 1px solid #aaa;
box-sizing: border-box;
margin: 1em 0;
}
.navbox .title th {
background: #B6CEE7;
}
.navbox .group th {
background: #DBE7F3;
padding-left: 1em;
padding-right: 1em;
}
.navbox .group td {
padding-left: 0.5em;
padding-right: 0.5em;
width: 100%;
}
.navbox .group:nth-child(2n+1) td {
background: #f5f5f5;
}

/* Style lists as dot-separated items */
.navbox ul {
margin: 0;
}
.navbox li {
display: inline;
}
.navbox li:nth-child(n+2):before {
content: " · ";
font-weight: bold;
}

/* Experimental: styles for a future byte layout diagram*/
table.byte-layout {
border-collapse: collapse;
}
table.byte-layout th, table.byte-layout td {
padding: 5px;
}
table.byte-layout tr:first-child th {
width: 50px;
}
table.byte-layout tr:nth-child(n+2) td {
border: 1px solid black;
}
table.byte-layout .integer {
background-color: #fcc;
}
table.byte-layout .byte {
background-color: #f3e2d8;
}
table.byte-layout .literal {
background-color: #cedbf5;
}
table.byte-layout .boolean {
background-color: #def2dc;
}
table.byte-layout .pointer {
background-color: #f4dcf2;
}
table.byte-layout .string {
background: linear-gradient(90deg, #b9dce4 0 50px, #dff1f0 50px 100%);
}
table.byte-layout .string-continued {
background-color: #dff1f0;
}
table.byte-layout .padding {
background-color: #c3c3c3;
}
table.byte-layout tr td.skip {
background-color: inherit;
text-align: center;
border: 0px;
}

User:Quantum/Byte layout

2021-02-14T19:18:29Z

Quantum: WIP: Half of a mockup for a byte layout diagram. Not an actual file format.

<table class="byte-layout">
<tr><td></td><th>0</th><th>1</th><th>2</th><th>3</th><th>4</th><th>5</th><th>6</th><th>7</th><th>8</th><th>9</th><th>A</th><th>B</th><th>C</th><th>D</th><th>E</th><th>F</th></tr>
<tr><th>0x0</th><td class="literal" colspan=2>FF FF</td><td class="boolean">save</td><td class="byte"># boards</td><td class="integer" colspan=2>health</td><td class="integer" colspan=2>torches</td><td class="string" colspan=8>Flag 1</td></tr>
<tr><th>0x10</th><td class="string-continued" colspan=12>Flag 1</td><td class="pointer" colspan=4>data pointer</td></tr>
<tr><th>0x20</th><td class="integer" colspan=2>something</td><td class="literal">00</td><td class="integer" colspan=2>another thing</td><td class="padding" colspan=11></td></tr>
<tr><td class="skip" colspan=17>…</td></tr>
<tr><th>0x40</th><td class="padding" colspan=15></td><td class="byte">blue key</td></tr>
</table>

Line

2021-02-14T06:16:19Z

Quantum: Add visual demonstration of the line wall display glitch

{{Element
|zzt-oop name=line
|id={{Byte|31}}
|char={{CharSwatch|206}}
|stats=no
|category=terrain
|effect on movement=wall
|destructible=no
|uses zzt-oop color=yes
}}

The '''line''' element (or more colloquially, "linewall") is one of the built-in wall elements in [[ZZT]]. It cannot be moved and is impervious to all damage. It is functionally identical to the [[solid]] and [[normal]], except with a sophisticated drawing procedure. Lines can be placed in all of the default [[ZZT-OOP]] colors and can be placed in any of the available colors with an external editor.

== Draw Procedure ==

When linewalls are drawn they check if each of the four tiles surrounding them are either another line or a [[edge|board edge]], and then pick the corresponding tile from the following table:

{| class="wikitable sortable"
|+ Line Neighbor Chart
|-
! Character !! E !! W !! S !! N
|-
| {{CharSwatch|249}} || N || N || N || N
|-
| {{CharSwatch|208}} || N || N || N || Y
|-
| {{CharSwatch|210}} || N || N || Y || N
|-
| {{CharSwatch|186}} || N || N || Y || Y
|-
| {{CharSwatch|181}} || N || Y || N || N
|-
| {{CharSwatch|188}} || N || Y || N || Y
|-
| {{CharSwatch|187}} || N || Y || Y || N
|-
| {{CharSwatch|185}} || N || Y || Y || Y
|-
| {{CharSwatch|198}} || Y || N || N || N
|-
| {{CharSwatch|200}} || Y || N || N || Y
|-
| {{CharSwatch|201}} || Y || N || Y || N
|-
| {{CharSwatch|204}} || Y || N || Y || Y
|-
| {{CharSwatch|205}} || Y || Y || N || N
|-
| {{CharSwatch|202}} || Y || Y || N || Y
|-
| {{CharSwatch|203}} || Y || Y || Y || N
|-
| {{CharSwatch|206}} || Y || Y || Y || Y
|}
[[File:Line-display-glitch.png|thumb|96x96px|An object places line walls from left to right, creating a temporary visual glitch.]]
If a portion of a linewall is removed from the board, then the surrounding linewalls will not update their graphics accordingly unless something forces them to redraw. The simplest way to do this is to have an object run the code <code>#change line line</code>. Other events, such as re-entering the board, reloading from a save, having a text window disappear, or having the tile be revealed by a torch can also have the same effect.

[[Category:Elements]]
{{ElementsNavbox}}

File:Line-display-glitch.png

2021-02-14T06:04:15Z

Quantum: Demonstration of the line wall display glitch when they are placed tile-by-tile

== Summary ==
Demonstration of the line wall display glitch when they are placed tile-by-tile

Not

2021-02-14T05:36:37Z

Quantum: Making description a little more precise

{{DISPLAYTITLE:not}}
'''not''' is a condition modifier in [[ZZT-OOP]]. It negates the result of the condition check which follow it within an [[if|#if]] statement. For example, <code>#if not foo give torches 1</code> will add 1 to the [[torches]] counter if no [[flag]] named "foo" is set.

{{ZZT-OOP navbox}}

Module:CharSwatch

2021-02-14T05:32:35Z

Quantum: Fix: make pi lowercase

local p = {}

function p.swatch(frame)
local char = tonumber(frame.args[1])
return string.format(
"[[char|#char]] %d %s (0x%02X)",
char, tostring(html_swatch(char)), char
)
end

function html_swatch(i)
local span = mw.html.create("span")
span:css({
["background-color"] = "#555",
["box-shadow"] = "0 0 1px #808080",
color = "#fff",
display = "inline-block",
font = "14px EGA8",
height = "1em",
["line-height"] = "100%",
["min-height"] = "14px",
["min-width"] = "8px",
padding = "2px",
["vertical-align"] = "middle"
})
span:wikitext(char_to_unicode(i))
return span
end

local unicode_table = {
[0] = " ", -- should be null, display as space
[1] = "☺",
[2] = "☻",
[3] = "♥",
[4] = "♦",
[5] = "♣",
[6] = "♠",
[7] = "•",
[8] = "◘",
[9] = "○",
[10] = "◙",
[11] = "♂",
[12] = "♀",
[13] = "♪",
[14] = "♫",
[15] = "☼",
[16] = "►",
[17] = "◄",
[18] = "↕",
[19] = "‼",
[20] = "¶",
[21] = "§",
[22] = "▬",
[23] = "↨",
[24] = "↑",
[25] = "↓",
[26] = "→",
[27] = "←",
[28] = "∟",
[29] = "↔",
[30] = "▲",
[31] = "▼",
[127] = "⌂",
[128] = "Ç",
[129] = "ü",
[130] = "é",
[131] = "â",
[132] = "ä",
[133] = "à",
[134] = "å",
[135] = "ç",
[136] = "ê",
[137] = "ë",
[138] = "è",
[139] = "ï",
[140] = "î",
[141] = "ì",
[142] = "Ä",
[143] = "Å",
[144] = "É",
[145] = "æ",
[146] = "Æ",
[147] = "ô",
[148] = "ö",
[149] = "ò",
[150] = "û",
[151] = "ù",
[152] = "ÿ",
[153] = "Ö",
[154] = "Ü",
[155] = "¢",
[156] = "£",
[157] = "¥",
[158] = "₧",
[159] = "ƒ",
[160] = "á",
[161] = "í",
[162] = "ó",
[163] = "ú",
[164] = "ñ",
[165] = "Ñ",
[166] = "ª",
[167] = "º",
[168] = "¿",
[169] = "⌐",
[170] = "¬",
[171] = "½",
[172] = "¼",
[173] = "¡",
[174] = "«",
[175] = "»",
[176] = "░",
[177] = "▒",
[178] = "▓",
[179] = "│",
[180] = "┤",
[181] = "╡",
[182] = "╢",
[183] = "╖",
[184] = "╕",
[185] = "╣",
[186] = "║",
[187] = "╗",
[188] = "╝",
[189] = "╜",
[190] = "╛",
[191] = "┐",
[192] = "└",
[193] = "┴",
[194] = "┬",
[195] = "├",
[196] = "─",
[197] = "┼",
[198] = "╞",
[199] = "╟",
[200] = "╚",
[201] = "╔",
[202] = "╩",
[203] = "╦",
[204] = "╠",
[205] = "═",
[206] = "╬",
[207] = "╧",
[208] = "╨",
[209] = "╤",
[210] = "╥",
[211] = "╙",
[212] = "╘",
[213] = "╒",
[214] = "╓",
[215] = "╫",
[216] = "╪",
[217] = "┘",
[218] = "┌",
[219] = "█",
[220] = "▄",
[221] = "▌",
[222] = "▐",
[223] = "▀",
[224] = "ɑ",
[225] = "ϐ",
[226] = "ᴦ",
[227] = "π",
[228] = "∑",
[229] = "ơ",
[230] = "µ",
[231] = "ᴛ",
[232] = "ɸ",
[233] = "ϴ",
[234] = "Ω",
[235] = "ẟ",
[236] = "∞",
[237] = "∅",
[238] = "∈",
[239] = "∩",
[240] = "≡",
[241] = "±",
[242] = "≥",
[243] = "≤",
[244] = "⌠",
[245] = "⌡",
[246] = "÷",
[247] = "≈",
[248] = "°",
[249] = "∙",
[250] = "·",
[251] = "√",
[252] = "ⁿ",
[253] = "²",
[254] = "■",
[255] = " "
}

function char_to_unicode(i)
if i < 0 or i > 255 then
error("char index out of range: " .. i)
end
if i >= 32 and i <= 126 then
-- Handle regular ASCII characters
return string.char(i)
end
return unicode_table[i]
end

return p

Spinning gun

2021-02-14T05:28:33Z

Quantum: Formatting, add link, add an elaboration on character to the infobox

{{Element
|zzt-oop name=spinninggun
|id={{Byte|39}}
|char=animates using the arrow characters {{CharSwatch|24}} through {{CharSwatch|27}}, rotating clockwise
|category=creature
|stats=yes
|cycle=2
|p1=intelligence
|p2=firing rate/type
|effect on movement=wall
|destructible=no
|uses zzt-oop color=yes
}}

The '''spinning gun''' is a built-in creature in ZZT that acts as an indestructible turret. It can configured to shoot either [[bullet|bullets]] or [[star|stars]].

The chance of a spinning gun shooting on a given [[tick]] is <code>P2/9</code>, where <code>P2</code> is <code>Firing Rate - 1</code>.

The direction that the spinning gun shoots is determined semi-randomly depending on the gun's intelligence and the [[player|player's]] position. The chance of the gun firing intelligently on a given tick is <code>P1/9</code>, where <code>P1</code> is <code>Intelligence - 1</code>. If it chooses to fire intelligently, it will fire vertically if the player is within 2 tiles on the x axis and the gun is not blocked vertically. Otherwise, it will shoot horizontally if the player is within two tiles on the y axis. If neither condition is met, it will not make an intelligent shot. If the spinning gun decides to make a non-intelligent shot instead, then it will randomly fire in one of the [[cardinal directions]].

The spinning gun cycles between {{CharSwatch|24}}, {{CharSwatch|26}}, {{CharSwatch|25}}, and {{CharSwatch|27}}, however the direction it fires is completely unrelated to the direction it is visibly pointing.

[[Category:Elements]]
{{ElementsNavbox}}

Walk

2021-02-14T05:22:08Z

Quantum: Formatting, links

{{DISPLAYTITLE:walk}}
'''#walk''' is a [[ZZT-OOP]] command that makes an [[object]] move automatically, independent of conventional [[movement]] commands (<code>[[go|#go]]</code>, <code>[[try|#try]]</code>).

Once <code>#walk</code> is executed, the object will move in the specified direction on every cycle [[tick]]. If a walking object is blocked by an obstacle, it will send a [[thud]] message to itself, unless it's [[lock|locked]].

To stop walking, use <code>#walk [[idle]]</code> or <code>#walk [[idle|i]]</code>.

== Syntax ==
<code>#walk <direction></code>

== Notes ==
* Objects will not push other entities as a result of walking.
* <code>#walk</code> operates independently of other movement commands, so an object can appear to move diagonally by walking along one axis and using <code>#go</code> or <code>#try</code> on the other.
* [[flow]] refers to an object's current walking direction, and can be used in conjunction with [[direction modifiers]] to steer it. For example, <code>#walk cw flow</code> will make an object turn clockwise.
* Internally, ZZT object walking is implemented with two delta variables. Modifying these variables with an enhanced editor beyond the ranges of -1 to +1 will cause the object to skip across terrain.

{{ZZT-OOP navbox}}

Module:Byte layout

2021-02-08T06:21:54Z

Quantum: WIP: Add doc comments, parse unquoted values into numbers

local p = {}

--[[
Parse a string of key-value pairs into a Lua table.
Examples:

parse_string("foo: 123, bar: 456") -- returns {foo=123, bar=456}
parse_string("foo, bar: named value, baz") -- returns {"foo", bar="named value", "baz"}
parse_string("foo: (A:B:C), bar: (1,2,3)") -- returns {foo="A:B:C", bar="1,2,3"}
]]
function p.parse_string(s)
local result = {}

-- Strip leading whitespace
local i = 1
local token = ""
token, i = match_whitespace(s, i)

-- Parse each key-value pair
while i <= #s do
local key = nil
local value = nil

-- optional key, if present
token, i = match_key(s, i)
if token ~= nil then
key = token
end

-- value
token, i = match_unquoted_value(s, i)
if token == nil then
token, i = match_quoted_value(s, i)
end
if token == nil then
error("Parse error: expected a value at position " .. i .. " of: " .. s)
end
value = token

-- Save key:value pair
-- No key means append to end of table
if key == nil then
table.insert(result, value)
else
result[key] = value
end

-- Consume separator between key-value pairs
token, i = match_separator(s, i)
if token == nil and i <= #s then
error("Parse error: expected comma at position " .. i .. " of: " .. s)
end
end

return result
end

-- Attempt to consume a key name, e.g., the "foo" in "foo: bar"
function match_key(s, init)
return match_pattern(s, "^(([%a_][%w_]*)%s*:%s*)", init)
end

-- Attempt to consume an unquoted value, e.g., the "bar" in "foo: bar"
function match_unquoted_value(s, init)
local value, i = match_pattern(s, "^(([^,:()]+)%s*)", init)
local numeric = tonumber(value)
if numeric then
value = numeric
end
return value, i
end

-- Attempt to consume a quoted value, e.g., the ":::" in "dots: (:::)"
function match_quoted_value(s, init)
local quoted, i = match_pattern(s, "^((%b())%s*)", init)
local unquoted = string.sub(quoted, 2, -2)
return unquoted, i
end

-- Attempt to match a comma, e.g., the "," in "foo: 1, bar: 2"
function match_separator(s, init)
return match_pattern(s, "^((,)%s*)", init)
end

-- Attempt to match leading whitespace, e.g., the " " in " foo:bar"
function match_whitespace(s, init)
return match_pattern(s, "^((%s*))", init)
end

--[[
Attempts to "consume" a pattern from a string. Example:

s = "foo bar baz"
offset = 1
word, offset = match_pattern(s, "((foo)%s*)", offset)
-- word = "foo", offset = 5
word, offset = match_pattern(s, "((bar)%s*)", offset)
-- word = "bar", offset = 9
word, offset = match_pattern(s, "((whoops!)%s*)", offset)
-- word = nil, offset = 9
-- (offset doesn't change on failure)

Pattern must have two capture groups: the entire string, and the portion
of interest (the thing that is returned along with the new offset).
]]
function match_pattern(s, pattern, init)
full, content = string.match(s, pattern, init)
if full == nil then
return nil, init
end
return content, init + #full
end

return p

Module:Byte layout

2021-02-08T05:47:17Z

Quantum: WIP: Parser for a simple data-structure DSL, because templates only let you pass in strings

local p = {}

function p.parse_string(s)
local result = {}

-- Strip leading whitespace
local i = 1
local token = ""
token, i = match_whitespace(s, i)

-- Parse each key-value pair
while i <= #s do
local key = nil
local value = nil

-- optional key, if present
token, i = match_key(s, i)
if token ~= nil then
key = token
end

-- value
token, i = match_unquoted_value(s, i)
if token == nil then
token, i = match_quoted_value(s, i)
end
if token == nil then
error("Parse error: expected a value at position " .. i .. " of: " .. s)
end
value = token

-- Save key:value pair
-- No key means append to end of table
if key == nil then
table.insert(result, value)
else
result[key] = value
end

-- Consume separator between key-value pairs
token, i = match_separator(s, i)
if token == nil and i <= #s then
error("Parse error: expected comma at position " .. i .. " of: " .. s)
end
end

return result
end

--[[
Attempts to "consume" a pattern from a string. Example:

s = "foo bar baz"
offset = 1
word, offset = match_pattern(s, "((foo)%s*)", offset)
-- word = "foo", offset = 5
word, offset = match_pattern(s, "((bar)%s*)", offset)
-- word = "bar", offset = 9
word, offset = match_pattern(s, "((whoops!)%s*)", offset)
-- word = nil, offset = 9
-- (offset doesn't change on failure)

Pattern must have two capture groups: the entire string, and the portion
of interest (the thing that is returned along with the new offset).
]]
function match_pattern(s, pattern, init)
full, content = string.match(s, pattern, init)
if full == nil then
return nil, init
end
return content, init + #full
end

-- Attempt to consume a key name, e.g., the "foo" in "foo: bar"
function match_key(s, init)
return match_pattern(s, "^(([%a_][%w_]*)%s*:%s*)", init)
end

-- Attempt to consume an unquoted value, e.g., the "bar" in "foo: bar"
function match_unquoted_value(s, init)
return match_pattern(s, "^(([^,:()]+)%s*)", init)
end

-- Attempt to consume a quoted value, e.g., the ":::" in "dots: (:::)"
function match_quoted_value(s, init)
local quoted, i = match_pattern(s, "^((%b())%s*)", init)
local unquoted = string.sub(quoted, 2, -2)
return unquoted, i
end

-- Attempt to match a comma, e.g., the "," in "foo: 1, bar: 2"
function match_separator(s, init)
return match_pattern(s, "^((,)%s*)", init)
end

-- Attempt to match leading whitespace, e.g., the " " in " foo:bar"
function match_whitespace(s, init)
return match_pattern(s, "^((%s*))", init)
end

return p

MediaWiki:Common.css

2021-02-01T04:58:14Z

Quantum: Add a little space between article content and navbox

Wiki:Requested articles

2021-02-01T03:20:55Z

Quantum: /* Techniques */ Bombs as pushable text

Note that some of these links should probably be the same article: for example, we probably don't need separate articles for NORTH and SOUTH, but we should have redirects to a shared article.

Also, see [[Special:WantedPages]] for an automatically-generated list of linked-to but non-existent pages.

== Categories to add ==
* Colors
* Fake labels (:endgame, :zapped) that are rumored to exist but don't
* Output stuff: Sound? Charsets? Colors?
* World, board, stat
* Special elements/redirects: Player Clone, Dummy, Black Hole
* ZZT itself: versions, Super ZZT
* Cheats
* Locks, especially those integrated with ZZT like the SECRET flag

== ZZT behavior ==
Some of the categorization here is fuzzy (is X a bug or a technique?). You can help by writing the corresponding article, so we can get rid of the offending line on this page. :-)

=== Techniques ===

* [[Kangaroo effect]]
* Using [[Player clone|player clones]] for teleportation
* Using [[Statless player|statless players]] and board [[Edge|edges]] to control teleportation
* [[Colors accessible from ZZT]]
* Detecting [[game speed]]
* Using [[Medusa bug|Medusa bugs]] (transporters, text, etc) to prevent anti-dark cheats
* [[Board illusion]] triggered by crossing to another board and immediately hitting a passage
* Sticking non-[[segment]] entities onto a [[centipede]]
* Using non-unit [[step values]] to, e.g., move diagonally
* [[Stat]] stacking
* Transferring data between worlds by overwriting board edges
* #cycle 0 [[Bomb]]s as pushable text

=== Internals ===

* [[Stat order]]
* [[Tick]]<nowiki/>s modulo 420
* [[32-command limit]]
* [[Pascal string]]<nowiki/>s hold partial previous contents in memory/on disk

=== Bugs and limits ===

*[[Counter]] behavior when [[Give|#giving]] very large numbers (32 bits in size and beyond)
*[[Counter]] display bug: some digits left behind when counter goes from big to small
*[[Label]] behavior with numerals
*[[Restore|#restore]] sometimes doesn't restore all labels
* Black [[Key|keys]] and [[Door|doors]]
* Inaccuracies in frequencies used by [[Play|#play]]
* [[Conveyor]] bugs (ability to delete player, etc)
* 1000-line maximum for all [[text dialog]]<nowiki/>s (including world selector)
* Shooting changes [[step value]] of 150th stat
* Moving while paused via [[mouse movement]]
* Vertical [[blink wall]] can toss the player east on top of a wall/obstruction
* Blank lines in [[text dialog]]<nowiki/>s sometimes appear as hyperlinks
* [[Put|#put]] doesn't work on bottom row
* [[Built-in editor]] and stat deletion bugs, if we ever figure out why that one happens
* Dependencies on CPU speed (e.g., [[sound effects]])
* [[Koopo bug]]
* Can't [[Send|#send]] to a [[label]] on the first line
* [[Passage]]<nowiki/>s have the potential to delete each other if they are adjacent

== ZZT itself ==

=== File formats ===

* [[World]]
* [[Board]]
* [[ZZT.DAT]]
* [[High score files]]
* Help files

=== Tile types ===
* [[Empty]]
* [[Edge]]
* [[Monitor]]
* [[Player]]
* [[Ammo]]
* [[Torch]]
* [[Gem]]
* [[Key]]
* [[Door]]
* [[Scroll]]
* [[Passage]]
* [[Duplicator]]
* [[Bomb]]
* [[Energizer]]
* [[Star]]
* [[Conveyor]]
* [[Bullet]]
* [[Water]]
* [[Forest]]
* [[Solid]]
* [[Normal]]
* [[Breakable]]
* [[Boulder]]
* [[Slider]]
* [[Fake]]
* [[Invisible]]
* [[Blink wall]]
* [[Transporter]]
* [[Line]]
* [[Ricochet]]
* [[Blink wall ray]]
* [[Bear]]
* [[Ruffian]]
* [[Object]]
* [[Slime]]
* [[Shark]]
* [[Spinning gun]]
* [[Pusher]]
* [[Lion]]
* [[Tiger]]
* [[Head]]
* [[Segment]]
* [[Text]]
=== [[ZZT-OOP]] ===
==== Prefixes/statement types ====
* [[Centered text]] ($)
* [[Object name]] (@)
* [[Command]] (#)
* [[Slash move]] (/) (Should this be combined with #[[GO]]?)
* [[Question move]] (?)
* [[Label]] (:)
* [[Comment]]/[[Zapped label]] (')
* [[Hyperlink]] (!)
==== Built-in [[Message]]s ====
* [[Touch]]
* [[Shot]]
* [[Bombed]]
* [[Thud]]
* [[Energize]]
==== Directions ====
* [[North]], [[South]], [[East]], [[West]]
* [[Idle (direction)]]
* [[Seek]]
* [[Flow]]
* [[Rndns]], [[Rndne]], [[Rnd]], [[Rndp]]
* [[Cw]], [[Ccw]], [[Opp]]
==== Built-in [[flag]]s ====
* [[Alligned]]
* [[Any]]
* [[Contact]]
* [[Blocked]]
* [[Energized]]
==== Commands ====
* [[Become]]
* [[Bind]]
* [[Change]]
* [[Char]]
* [[Clear]]
* [[Cycle]]
* [[Die]]
* [[End]]
* [[Endgame]]
* [[Give]]
* [[Go]]
* [[Idle]]
* [[If]]
* [[Lock]]
* [[Play]]
* [[Put]]
* [[Restart]]
* [[Restore]]
* [[Send]]
* [[Shoot]]
* [[Take]]
* [[Throwstar]]
* [[Try]]
* [[Unlock]]
* [[Walk]]
* [[Zap]]

Wiki:Requested articles

2021-01-31T10:01:54Z

Quantum: /* Bugs and limits */ Clarify a couple of items

Note that some of these links should probably be the same article: for example, we probably don't need separate articles for NORTH and SOUTH, but we should have redirects to a shared article.

Also, see [[Special:WantedPages]] for an automatically-generated list of linked-to but non-existent pages.

== Categories to add ==
* Colors
* Fake labels (:endgame, :zapped) that are rumored to exist but don't
* Output stuff: Sound? Charsets? Colors?
* World, board, stat
* Special elements/redirects: Player Clone, Dummy, Black Hole
* ZZT itself: versions, Super ZZT
* Cheats
* Locks, especially those integrated with ZZT like the SECRET flag

== ZZT behavior ==
Some of the categorization here is fuzzy (is X a bug or a technique?). You can help by writing the corresponding article, so we can get rid of the offending line on this page. :-)

=== Techniques ===

* [[Kangaroo effect]]
* Using [[Player clone|player clones]] for teleportation
* Using [[Statless player|statless players]] and board [[Edge|edges]] to control teleportation
* [[Colors accessible from ZZT]]
* Detecting [[game speed]]
* Using [[Medusa bug|Medusa bugs]] (transporters, text, etc) to prevent anti-dark cheats
* [[Board illusion]] triggered by crossing to another board and immediately hitting a passage
* Sticking non-[[segment]] entities onto a [[centipede]]
* Using non-unit [[step values]] to, e.g., move diagonally
* [[Stat]] stacking
* Transferring data between worlds by overwriting board edges

=== Internals ===

* [[Stat order]]
* [[Tick]]<nowiki/>s modulo 420
* [[32-command limit]]
* [[Pascal string]]<nowiki/>s hold partial previous contents in memory/on disk

=== Bugs and limits ===

*[[Counter]] behavior when [[Give|#giving]] very large numbers (32 bits in size and beyond)
*[[Counter]] display bug: some digits left behind when counter goes from big to small
*[[Label]] behavior with numerals
*[[Restore|#restore]] sometimes doesn't restore all labels
* Black [[Key|keys]] and [[Door|doors]]
* Inaccuracies in frequencies used by [[Play|#play]]
* [[Conveyor]] bugs (ability to delete player, etc)
* 1000-line maximum for all [[text dialog]]<nowiki/>s (including world selector)
* Shooting changes [[step value]] of 150th stat
* Moving while paused via [[mouse movement]]
* Vertical [[blink wall]] can toss the player east on top of a wall/obstruction
* Blank lines in [[text dialog]]<nowiki/>s sometimes appear as hyperlinks
* [[Put|#put]] doesn't work on bottom row
* [[Built-in editor]] and stat deletion bugs, if we ever figure out why that one happens
* Dependencies on CPU speed (e.g., [[sound effects]])
* [[Koopo bug]]
* Can't [[Send|#send]] to a [[label]] on the first line
* [[Passage]]<nowiki/>s have the potential to delete each other if they are adjacent

== ZZT itself ==

=== File formats ===

* [[World]]
* [[Board]]
* [[ZZT.DAT]]
* [[High score files]]
* Help files

=== Tile types ===
* [[Empty]]
* [[Edge]]
* [[Monitor]]
* [[Player]]
* [[Ammo]]
* [[Torch]]
* [[Gem]]
* [[Key]]
* [[Door]]
* [[Scroll]]
* [[Passage]]
* [[Duplicator]]
* [[Bomb]]
* [[Energizer]]
* [[Star]]
* [[Conveyor]]
* [[Bullet]]
* [[Water]]
* [[Forest]]
* [[Solid]]
* [[Normal]]
* [[Breakable]]
* [[Boulder]]
* [[Slider]]
* [[Fake]]
* [[Invisible]]
* [[Blink wall]]
* [[Transporter]]
* [[Line]]
* [[Ricochet]]
* [[Blink wall ray]]
* [[Bear]]
* [[Ruffian]]
* [[Object]]
* [[Slime]]
* [[Shark]]
* [[Spinning gun]]
* [[Pusher]]
* [[Lion]]
* [[Tiger]]
* [[Head]]
* [[Segment]]
* [[Text]]
=== [[ZZT-OOP]] ===
==== Prefixes/statement types ====
* [[Centered text]] ($)
* [[Object name]] (@)
* [[Command]] (#)
* [[Slash move]] (/) (Should this be combined with #[[GO]]?)
* [[Question move]] (?)
* [[Label]] (:)
* [[Comment]]/[[Zapped label]] (')
* [[Hyperlink]] (!)
==== Built-in [[Message]]s ====
* [[Touch]]
* [[Shot]]
* [[Bombed]]
* [[Thud]]
* [[Energize]]
==== Directions ====
* [[North]], [[South]], [[East]], [[West]]
* [[Idle (direction)]]
* [[Seek]]
* [[Flow]]
* [[Rndns]], [[Rndne]], [[Rnd]], [[Rndp]]
* [[Cw]], [[Ccw]], [[Opp]]
==== Built-in [[flag]]s ====
* [[Alligned]]
* [[Any]]
* [[Contact]]
* [[Blocked]]
* [[Energized]]
==== Commands ====
* [[Become]]
* [[Bind]]
* [[Change]]
* [[Char]]
* [[Clear]]
* [[Cycle]]
* [[Die]]
* [[End]]
* [[Endgame]]
* [[Give]]
* [[Go]]
* [[Idle]]
* [[If]]
* [[Lock]]
* [[Play]]
* [[Put]]
* [[Restart]]
* [[Restore]]
* [[Send]]
* [[Shoot]]
* [[Take]]
* [[Throwstar]]
* [[Try]]
* [[Unlock]]
* [[Walk]]
* [[Zap]]

World

2021-01-31T01:29:29Z

Quantum: Typo: bad syntax

A ZZT '''world''' is a playable ZZT file. It is composed of one or more [[board]]s, which may be linked together in various ways, as well as the world's starting state: [[counter]] values, [[flag]]s, and so on.

ZZT limits a world to a maximum of 101 boards: 1 [[title screen]] and 100 other boards. To get around this limit, some large ZZT games are composed of multiple world files, to be played and completed in sequence.

== See also ==

* [[ZZT file format]]

World

2021-01-31T01:29:05Z

Quantum: Created page with "A ZZT '''world''' is a playable ZZT file. It is composed of one or more boards, which may be linked together in various ways, as well as the world's starting state: coun..."

A ZZT '''world''' is a playable ZZT file. It is composed of one or more [[board]]s, which may be linked together in various ways, as well as the world's starting state: [[counter]] values, [[flag]s, and so on.

ZZT limits a world to a maximum of 101 boards: 1 [[title screen]] and 100 other boards. To get around this limit, some large ZZT games are composed of multiple world files, to be played and completed in sequence.

== See also ==

* [[ZZT file format]]

Char

2021-01-19T04:02:58Z

Quantum: Add navbox

{{DISPLAYTITLE:char}}
'''#char''' is a [[ZZT-OOP]] command for changing an object's display character. It takes a single parameter, a decimal number from 1 to 255, representing the desired extended ASCII character.

Note that #char does not allow character 0 as a parameter, even though it is a valid extended ASCII character. Running <code>#char 0</code> will silently fail without changing the object's character. This restriction does not typically matter in practice because characters 32 and 255 are usually visually identical to character 0.

{{ZZT-OOP navbox}}

Template:ZZT-OOP navbox

2021-01-19T04:02:11Z

Quantum: Initial ZZT-OOP navbox

{{#invoke:Navbox|navbox|title=[[ZZT-OOP]]
|groupName1=Prefixes
|group1=
* <code>@</code> [[Object name]]
* <code> </code> <code>$</code> [[Message text]]
* <code>#</code> [[Command]]
* <code>/</code> <code>?</code> [[Movement]]
* <code>:</code> [[Label]]
* <code>'</code> [[Comment]]
* <code>!</code> <code>!-</code> [[Hyperlink]]
|groupName2=Messages
|group2=
* [[bombed]]
* [[energize]]
* [[shot]]
* [[thud]]
* [[touch]]
|groupName3=Directions
|group3=
* [[Cardinal directions]]
* [[idle]]
* [[seek]]
* [[flow]]
* [[Direction modifiers]]
* [[Random directions]]
|groupName4=Flags
|group4=
* [[alligned]]
* [[any]]
* [[blocked]]
* [[contact]]
* [[energized]]
* [[not]]
|groupName5=Commands
|group5=
* [[become]]
* [[bind]]
* [[change]]
* [[char]]
* [[clear]]
* [[cycle]]
* [[die]]
* [[end]]
* [[endgame]]
* [[give]]
* [[go]]
* [[idle]]
* [[if]]
* [[lock]]
* [[play]]
* [[put]]
* [[restart]]
* [[restore]]
* [[send]]
* [[shoot]]
* [[take]]
* [[throwstar]]
* [[try]]
* [[unlock]]
* [[walk]]
* [[zap]]
}}<includeonly>[[Category:ZZT-OOP]]</includeonly>

Wiki:Requested articles

2021-01-18T23:15:57Z

Quantum: Add a bunch more items with brief commentary

Note that some of these links should probably be the same article: for example, we probably don't need separate articles for NORTH and SOUTH, but we should have redirects to a shared article.

Also, see [[Special:WantedPages]] for an automatically-generated list of linked-to but non-existent pages.

== Categories to add ==
* Colors
* Fake labels (:endgame, :zapped) that are rumored to exist but don't
* Output stuff: Sound? Charsets? Colors?
* World, board, stat
* Special elements/redirects: Player Clone, Dummy, Black Hole
* ZZT itself: versions, Super ZZT
* Cheats
* Locks, especially those integrated with ZZT like the SECRET flag

== ZZT behavior ==
Some of the categorization here is fuzzy (is X a bug or a technique?). You can help by writing the corresponding article, so we can get rid of the offending line on this page. :-)

=== Techniques ===

* [[Kangaroo effect]]
* Using [[Player clone|player clones]] for teleportation
* Using [[Statless player|statless players]] and board [[Edge|edges]] to control teleportation
* [[Colors accessible from ZZT]]
* Detecting [[game speed]]
* Using [[Medusa bug|Medusa bugs]] (transporters, text, etc) to prevent anti-dark cheats
* [[Board illusion]] triggered by crossing to another board and immediately hitting a passage
* Sticking non-[[segment]] entities onto a [[centipede]]
* Using non-unit [[step values]] to, e.g., move diagonally
* [[Stat]] stacking
* Transferring data between worlds by overwriting board edges

=== Internals ===

* [[Stat order]]
* [[Tick]]<nowiki/>s modulo 420
* [[32-command limit]]
* [[Pascal string]]<nowiki/>s hold partial previous contents in memory/on disk

=== Bugs and limits ===

*[[Counter]] behavior when [[Give|#giving]] very large numbers
*[[Counter]] display bug
*[[Label]] behavior with numerals
*[[Restore|#restore]] sometimes doesn't restore all labels
* Black [[Key|keys]] and [[Door|doors]]
* Inaccuracies in frequencies used by [[Play|#play]]
* [[Conveyor]] bugs (ability to delete player, etc)
* 1000-line maximum for all [[text dialog]]<nowiki/>s (including world selector)
* Shooting changes [[step value]] of 150th stat
* Moving while paused via [[mouse movement]]
* Vertical [[blink wall]] can toss the player east on top of a wall/obstruction
* Blank lines in [[text dialog]]<nowiki/>s sometimes appear as hyperlinks
* [[Put|#put]] doesn't work on bottom row
* [[Built-in editor]] and stat deletion bugs, if we ever figure out why that one happens
* Dependencies on CPU speed (e.g., [[sound effects]])
* [[Koopo bug]]
* Can't [[Send|#send]] to a [[label]] on the first line
* [[Passage]]<nowiki/>s have the potential to delete each other if they are adjacent

== ZZT itself ==

=== File formats ===

* [[World]]
* [[Board]]
* [[ZZT.DAT]]
* [[High score files]]
* Help files

=== Tile types ===
* [[Empty]]
* [[Edge]]
* [[Monitor]]
* [[Player]]
* [[Ammo]]
* [[Torch]]
* [[Gem]]
* [[Key]]
* [[Door]]
* [[Scroll]]
* [[Passage]]
* [[Duplicator]]
* [[Bomb]]
* [[Energizer]]
* [[Star]]
* [[Conveyor]]
* [[Bullet]]
* [[Water]]
* [[Forest]]
* [[Solid]]
* [[Normal]]
* [[Breakable]]
* [[Boulder]]
* [[Slider]]
* [[Fake]]
* [[Invisible]]
* [[Blink wall]]
* [[Transporter]]
* [[Line]]
* [[Ricochet]]
* [[Blink wall ray]]
* [[Bear]]
* [[Ruffian]]
* [[Object]]
* [[Slime]]
* [[Shark]]
* [[Spinning gun]]
* [[Pusher]]
* [[Lion]]
* [[Tiger]]
* [[Head]]
* [[Segment]]
* [[Text]]
=== [[ZZT-OOP]] ===
==== Prefixes/statement types ====
* [[Centered text]] ($)
* [[Object name]] (@)
* [[Command]] (#)
* [[Slash move]] (/) (Should this be combined with #[[GO]]?)
* [[Question move]] (?)
* [[Label]] (:)
* [[Comment]]/[[Zapped label]] (')
* [[Hyperlink]] (!)
==== Built-in [[Message]]s ====
* [[Touch]]
* [[Shot]]
* [[Bombed]]
* [[Thud]]
* [[Energize]]
==== Directions ====
* [[North]], [[South]], [[East]], [[West]]
* [[Idle (direction)]]
* [[Seek]]
* [[Flow]]
* [[Rndns]], [[Rndne]], [[Rnd]], [[Rndp]]
* [[Cw]], [[Ccw]], [[Opp]]
==== Built-in [[flag]]s ====
* [[Alligned]]
* [[Any]]
* [[Contact]]
* [[Blocked]]
* [[Energized]]
==== Commands ====
* [[Become]]
* [[Bind]]
* [[Change]]
* [[Char]]
* [[Clear]]
* [[Cycle]]
* [[Die]]
* [[End]]
* [[Endgame]]
* [[Give]]
* [[Go]]
* [[Idle]]
* [[If]]
* [[Lock]]
* [[Play]]
* [[Put]]
* [[Restart]]
* [[Restore]]
* [[Send]]
* [[Shoot]]
* [[Take]]
* [[Throwstar]]
* [[Try]]
* [[Unlock]]
* [[Walk]]
* [[Zap]]

Wiki:Requested articles

2021-01-18T22:37:16Z

Quantum: Add some items under new "ZZT behavior" section, add link to Special:WantedPages

Wiki:Requested articles

2021-01-18T09:34:19Z

Quantum: /* File formats */

Note that some of these links should probably be the same article: for example, we probably don't need separate articles for NORTH and SOUTH, but we should have redirects to a shared article.

== Categories to add ==
* Colors
* Fake labels (:endgame, :zapped) that are rumored to exist but don't
* Output stuff: Sound? Charsets? Colors?
* World, board, stat
* Special elements/redirects: Player Clone, Dummy, Black Hole
* ZZT itself: versions, Super ZZT
* Cheats
* Locks, especially those integrated with ZZT like the SECRET flag

== ZZT itself ==

=== File formats ===

* [[World]]
* [[Board]]
* [[ZZT.DAT]]
* [[High score files]]
* Help files

=== Tile types ===
* [[Empty]]
* [[Edge]]
* [[Monitor]]
* [[Player]]
* [[Ammo]]
* [[Torch]]
* [[Gem]]
* [[Key]]
* [[Door]]
* [[Scroll]]
* [[Passage]]
* [[Duplicator]]
* [[Bomb]]
* [[Energizer]]
* [[Star]]
* [[Conveyor]]
* [[Bullet]]
* [[Water]]
* [[Forest]]
* [[Solid]]
* [[Normal]]
* [[Breakable]]
* [[Boulder]]
* [[Slider]]
* [[Fake]]
* [[Invisible]]
* [[Blink wall]]
* [[Transporter]]
* [[Line]]
* [[Ricochet]]
* [[Blink wall ray]]
* [[Bear]]
* [[Ruffian]]
* [[Object]]
* [[Slime]]
* [[Shark]]
* [[Spinning gun]]
* [[Pusher]]
* [[Lion]]
* [[Tiger]]
* [[Head]]
* [[Segment]]
* [[Text]]
=== [[ZZT-OOP]] ===
==== Prefixes/statement types ====
* [[Centered text]] ($)
* [[Object name]] (@)
* [[Command]] (#)
* [[Slash move]] (/) (Should this be combined with #[[GO]]?)
* [[Question move]] (?)
* [[Label]] (:)
* [[Comment]]/[[Zapped label]] (')
* [[Hyperlink]] (!)
==== Built-in [[Message]]s ====
* [[Touch]]
* [[Shot]]
* [[Bombed]]
* [[Thud]]
* [[Energize]]
==== Directions ====
* [[North]], [[South]], [[East]], [[West]]
* [[Idle (direction)]]
* [[Seek]]
* [[Flow]]
* [[Rndns]], [[Rndne]], [[Rnd]], [[Rndp]]
* [[Cw]], [[Ccw]], [[Opp]]
==== Built-in [[flag]]s ====
* [[Alligned]]
* [[Any]]
* [[Contact]]
* [[Blocked]]
* [[Energized]]
==== Commands ====
* [[Become]]
* [[Bind]]
* [[Change]]
* [[Char]]
* [[Clear]]
* [[Cycle]]
* [[Die]]
* [[End]]
* [[Endgame]]
* [[Give]]
* [[Go]]
* [[Idle]]
* [[If]]
* [[Lock]]
* [[Play]]
* [[Put]]
* [[Restart]]
* [[Restore]]
* [[Send]]
* [[Shoot]]
* [[Take]]
* [[Throwstar]]
* [[Try]]
* [[Unlock]]
* [[Walk]]
* [[Zap]]

Boulder

2021-01-18T08:34:01Z

Quantum: /* Erasure of fake walls */ Link to other statless pushables

{{Element
|zzt-oop name=boulder
|category=terrain
|id=24 (18h)
|char={{CharSwatch|254}}
|stats=no
|effect on movement=pushable
|destructible=no
|uses zzt-oop color=yes
}}
'''Boulders''' are a [[pushable]] terrain element.

Boulders can be pushed in any direction and are an important element in [[slider]] puzzles. However, they cannot be ''pulled'' by the player, meaning that it is easy for boulders to become stuck in a corner or against a wall. Boulders cannot be destroyed by the player, so a stuck boulder in a game can often lead to a softlock.

Boulders keep their background color when they move, although this is not noticeable unless STK colors are in use. This behavior disappears if the boulder is given stats.

== Erasure of fake walls ==
Boulders leave [[empties]] behind them when they are moved. This can be an issue for games that use [[Fake|fake walls]] as floors, as pushing a boulder across a colorful floor will erase a black trail across the floor. This erasing behavior happens because boulders lack [[stats]] by default, and thus lack a way to track their under tile. Other statless pushables ([[ammo]], [[gems]], [[keys]], and [[sliders]]) also exhibit this erasing behavior, though it is more noticeable with boulders because boulders are more easily manipulated into areas of a board that have fake walls.

This erasing behavior can be eliminated by giving the boulder stats, though the number of boulders that can be treated this way is limited by the board's [[Stat limit|stat limit]].

[[Category:Elements]]
{{ElementsNavbox}}

Ammo

2021-01-18T08:24:40Z

Quantum: Flesh out ammo article a bit

{{Element
|zzt-oop name=ammo
|id={{Byte|5}}
|char={{CharSwatch|132}}
|color={{ColorSwatch|fg=dark cyan|bg=black}}
|category=item
|stats=no
|destructible=no
|effect on movement=pushable
|uses zzt-oop color=no
}}
The '''ammo''' element is ZZT's built-in method for giving the player ammunition.

Picking up an instance of ammo increments the player's [[Ammo (counter)|ammo counter]] by 5 shots. The amount is not configurable, making it a pain for the player to pick up a large quantity of it. For this reason, many modern ZZT worlds do not use ammo for its intended purpose, and instead substitute an [[object]] that [[Give|#gives]] ammo, or initialize the [[world]] with a non-zero ammo counter.

Ammo is useful as a means of programmatically obtaining dark cyan, e.g., by [[Change|#changing]] another item to ammo and back.

{{ElementsNavbox}}

Ammo

2021-01-18T08:03:34Z

Quantum: Stub page: populate templates

Template:Byte

2021-01-18T07:58:10Z

Quantum: Template wrapper for Module:Byte

<noinclude>'''Byte''' is a template for displaying a byte value (unsigned, as in Pascal) in both decimal and hexadecimal. Example:

<nowiki>Tigers have element ID {{Byte|42}}.</nowiki>

Displays as:

<blockquote>Tigers have element ID {{Byte|42}}.</blockquote>

The input can be either hex or decimal: in the case of hex, the "0x" prefix must be present.

Keep in mind that if you're talking about a color or an ASCII character, [[Template:ColorSwatch]] or [[Template:CharSwatch]] might be more appropriate, depending on what you want to do.

</noinclude><includeonly>{{#invoke:Byte|byte|{{{1}}}}}</includeonly>

Module:Byte

2021-01-18T07:50:12Z

Quantum: Module for displaying an unsigned byte value in decimal and hex

local p = {}

function p.byte(frame)
local i = tonumber(frame.args[1])
return string.format("%d (0x%02X)", i, i)
end

return p

Char

2021-01-18T06:28:48Z

Quantum: Remove extra whitespace

Template:ElementsNavbox

2021-01-18T06:19:55Z

Quantum: Moved some items not available in ZZT's default editor into Special category

{{#invoke:Navbox|navbox|title=[[Element|Elements]]
|groupName1=Special
|group1=
* [[Empty]]
* [[Edge]]
* [[Message timer]]
* [[Monitor]]
* [[Star]]
* [[Bullet]]
* [[Blink wall ray]]
|groupName2=Items
|group2=
* [[Player]]
* [[Ammo]]
* [[Torch]]
* [[Gem]]
* [[Key]]
* [[Door]]
* [[Scroll]]
* [[Passage]]
* [[Duplicator]]
* [[Bomb]]
* [[Energizer]]
* [[Conveyor]]
|groupName3=Terrain
|group3=
* [[Water]]
* [[Forest]]
* [[Solid]]
* [[Normal]]
* [[Breakable]]
* [[Boulder]]
* [[Slider]]
* [[Fake]]
* [[Invisible]]
* [[Blink wall]]
* [[Transporter]]
* [[Line]]
* [[Ricochet]]
|groupName4=Creatures
|group4=
* [[Bear]]
* [[Ruffian]]
* [[Object]]
* [[Slime]]
* [[Shark]]
* [[Spinning gun]]
* [[Pusher]]
* [[Lion]]
* [[Tiger]]
* [[Head]]
* [[Segment]]
|groupName5=Text
|group5=
* [[Text]]
}}
<includeonly>[[Category:Elements]]</includeonly>

Lion

2021-01-18T06:15:32Z

Quantum: Add navbox

{{Element
|name=Lion
|zzt-oop name=lion
|category=creature
|id=29h
|color={{ColorSwatch|fg=red|bg=black}}
|char={{CharSwatch|234}}
|stats=yes
|cycle=2
|p1=Intelligence
|score=1
|destructible=yes
|effect on movement=pushable, squishable
|uses zzt-oop color=no
}}
'''Lions''' are a type of built-in enemy in ZZT. They move around semi-randomly, tending to seek out the player (depending on the lion's intelligence). They can only do damage on contact, which destroys the lion as well.

[[Category:Elements]]
{{ElementsNavbox}}

Boulder

2021-01-18T06:15:20Z

Quantum: Add navbox

{{Element
|zzt-oop name=boulder
|category=terrain
|id=24 (18h)
|char={{CharSwatch|254}}
|stats=no
|effect on movement=pushable
|destructible=no
|uses zzt-oop color=yes
}}
'''Boulders''' are a [[pushable]] terrain element.

Boulders can be pushed in any direction and are an important element in [[slider]] puzzles. However, they cannot be ''pulled'' by the player, meaning that it is easy for boulders to become stuck in a corner or against a wall. Boulders cannot be destroyed by the player, so a stuck boulder in a game can often lead to a softlock.

Boulders keep their background color when they move, although this is not noticeable unless STK colors are in use. This behavior disappears if the boulder is given stats.

== Erasure of fake walls ==
Boulders leave [[empties]] behind them when they are moved. This can be an issue for games that use [[Fake|fake walls]] as floors, as pushing a boulder across a colorful floor will erase a black trail across the floor. This erasing behavior happens because boulders lack [[stats]] by default, and thus lack a way to track their under tile. In fact, all statless pushables exhibit this erasing behavior, though it is more noticeable with boulders because boulders are more easily manipulated into areas of a board that have fake walls.

This erasing behavior can be eliminated by giving the boulder stats, though the number of boulders that can be treated this way is limited by the board's [[Stat limit|stat limit]].

[[Category:Elements]]
{{ElementsNavbox}}

Passage

2021-01-18T06:15:08Z

Quantum: Add navbox

{{Element
|id=0x0B
|zzt-oop name=passage
|category=item
|char={{CharSwatch|0xF0}}
|stats=yes
|cycle=0
|p3=index of destination board (title screen is 0)
|destructible=no
|effect on movement=wall; blocks movement of most entities but causes the player to teleport on touch
|uses zzt-oop color=yes, but named color affects background only; foreground is always white
}}
The '''passage''' element allows the player to switch the active board. They are one of the two ways to switch boards, the other being board [[edge|edges]].

By default, traveling via passage does not modify the destination board. However, if the destination contains a second passage with the same color, ZZT will reposition the player on top of that second passage, so that the two passage tiles appear to be two ends of the same passageway: the player steps in one and out the other.

Traveling through a passage will pause the game immediately after switching boards. This allows the player to examine the new board before play begins, so as not to be caught too off guard. However, this can lead to soft-locks if a passage is blocked off: a player can still enter a blocked passageway, but they won't be able to do anything, including returning to the previous board.

==Tile repositioning bug==
Players traveling between identically-colored passages can disturb the surrounding tiles. Specifically, when ZZT repositions the player on top of the destination board's passage, it does so without updating the player [[stat]]'s under type/color. In other words, ZZT relocates not just the player, but also the tile the player was previously standing on, leaving an [[empty]] in its place.

This bug mainly matters for passages adjacent to [[fake]] walls or to other passages, as these tiles can be overwritten when the player is repositioned. The bug can be avoided by making sure that passages are only surrounded by walls and empties, and by making sure that the player is placed on top of an empty tile when the board is created.
[[Category:Elements]]
{{ElementsNavbox}}

Empty

2021-01-18T06:14:56Z

Quantum: Add navbox

{{Element
|name=Empty
|zzt-oop name=empty
|id=0 (00h)
|char={{CharSwatch|0}}
|color={{ColorSwatch|bg=light gray|fg=black}}
|stats=no
|effect on movement=floor
|uses zzt-oop color=no
}}
An '''empty''' behaves like empty space. Empties are the default material for floors in ZZT, and alongside [[Fake|fakes]], are the only two elements that permit free movement of all creatures.

Because they are the default floor material, empties are often produced by behavior within ZZT. For example, the [[Die|#die]] command turns the current object into an empty, and many [[stat]]-less elements (such as [[Key|keys]] and [[Door|doors]]) are replaced with empties when they disappear from the board.

Empties always appear blank on screen and do not show their color. This makes it possible to conceal non-[[STK colors]]: e.g., a game might simulate dark red blood by [[Putting|#putting]] a fake over a dark red empty.

==Black holes==
A '''black hole''' is an empty that has been artificially given a stat.

Black holes affect [[player]] movement by giving the player an extra move when stepped on. A player stepping onto a black hole will cause the black hole's stat to behave like a player stat, usually resulting in the user's movement command being executed again in the same [[cycle]]. The effect is that the player seems to "jump over" the black hole tile.
[[Category:Elements]]
{{ElementsNavbox}}

Text

2021-01-18T06:12:53Z

Quantum: Add navbox

{{Element
|name=Text
|picture=[[File:text-example.png]]
|caption=Text can display any character, but color choices are limited
|zzt-oop name=N/A
|id=Multiple, used to encode background color:
* 0x2F: Blue
* 0x30: Green
* 0x31: Cyan
* 0x32: Red
* 0x33: Purple
* 0x34: Brown
* 0x35: Black
|color=White foreground; element ID determines background
|char=Any (determined by tile's color byte)
|stats=no
|effect on movement=wall
|uses zzt-oop color=N/A
}}
'''Text''' is a terrain type that can have any of the 256 characters. Its intended use is for putting text labels on a board's terrain.

Text is the only element that can display any character without the overhead of using a [[stat]], which makes them useful for ZZT art. However, artistic usage is somewhat hampered by the fact that text can only use a fixed set of color combinations: if you want to write a sentence on the screen in a custom color (e.g., black on light gray), the only way to do it is to use [[object|objects]].

Text is also the only element supported by the built-in editor that has no ZZT-OOP name: e.g., there is no way to change all text tiles to another element type.

==Usage of terrain color byte==
Text is stored differently than any other element. Internally, ZZT repurposes the element's color byte to store character data instead: this allows the full range of characters to be encoded without having to allocate extra space (in the form of [[stats]]) for each tile. Since the color byte is occupied with other data, the actual color info is encoded by having different element IDs for each color. The result is that text is technically not just one element, but several.

Side effects from this roundabout encoding are apparent in a couple of places:

*Overwriting text (using [[Put|#put]] or [[Become|#become]]) will sometimes result in [[STK]]-colored elements. This is because those commands always interpret the color byte as a color: if you #put a gem onto a blue text "Z" (ASCII code 0x5A), you will get a green-on-dark-purple gem (color code 0x5A).
*Unlike most elements, it is impossible to get arbitrary text colors from [[Toolkit|toolkits]] or [[External editor|external editors]]. This is not a matter of ZZT's internal editor being restrictive, but rather a limit imposed by the file format and the in-memory representation.

Text is also the only element supported by the built-in editor that has no ZZT-OOP name: e.g., there is no way to change all text tiles to another element type. This may also be a side effect of text having a unique encoding.

==Unassigned element IDs==
ZZT only officially supports the seven text colors which have assigned element IDs. However, it is possible to get a few additional colors by using IDs beyond the assigned range, as ZZT interprets all element IDs greater than 0x2E as text. The problem is that all these IDs are buggy because they cause ZZT to read past the end of its table of elements. Touching tiles with these IDs will crash ZZT, and many unassigned IDs will crash ZZT immediately, on the first [[tick]].

Some known unassigned IDs and their text colors:

*0x36: {{ColorSwatch|blinking|fg=white|bg=black}}
*0x37: {{ColorSwatch|blinking|fg=white|bg=dark blue}}
*0x38: {{ColorSwatch|blinking|fg=white|bg=dark green}}
*0x39: {{ColorSwatch|blinking|fg=white|bg=dark cyan}}
*0x3A: {{ColorSwatch|blinking|fg=white|bg=dark red}}
*0x3B: {{ColorSwatch|blinking|fg=white|bg=dark purple}}
*0x3C: {{ColorSwatch|blinking|fg=white|bg=dark brown}}
*0x3D: {{ColorSwatch|blinking|fg=white|bg=light gray}}
*0x45: {{ColorSwatch|fg=white|bg=light gray}}

It is impossible to choose the text foreground color because ZZT hard-codes it to be white. This means there are only 16 possible color combinations: the 7 text colors built into ZZT, and the 9 produced by the unassigned IDs above.

{{ElementsNavbox}}
[[Category:Elements]]

Template:ElementsNavbox

2021-01-18T06:11:38Z

Quantum: Create initial elements navbox

{{#invoke:Navbox|navbox|title=[[Element|Elements]]
|groupName1=Special
|group1=
* [[Empty]]
* [[Edge]]
* [[Message timer]]
* [[Monitor]]
|groupName2=Items
|group2=
* [[Player]]
* [[Ammo]]
* [[Torch]]
* [[Gem]]
* [[Key]]
* [[Door]]
* [[Scroll]]
* [[Passage]]
* [[Duplicator]]
* [[Bomb]]
* [[Energizer]]
* [[Star]]
* [[Conveyor]]
* [[Bullet]]
|groupName3=Terrain
|group3=
* [[Water]]
* [[Forest]]
* [[Solid]]
* [[Normal]]
* [[Breakable]]
* [[Boulder]]
* [[Slider]]
* [[Fake]]
* [[Invisible]]
* [[Blink wall]]
* [[Transporter]]
* [[Line]]
* [[Ricochet]]
* [[Blink wall ray]]
|groupName4=Creatures
|group4=
* [[Bear]]
* [[Ruffian]]
* [[Object]]
* [[Slime]]
* [[Shark]]
* [[Spinning gun]]
* [[Pusher]]
* [[Lion]]
* [[Tiger]]
* [[Head]]
* [[Segment]]
|groupName5=Text
|group5=
* [[Text]]
}}
<includeonly>[[Category:Elements]]</includeonly>

MediaWiki:Common.css

2021-01-18T05:56:30Z

Quantum: Tweak navbox colors: via https://meyerweb.com/eric/tools/color-blend/#0055AA:FFFFFF:6:hex

MediaWiki:Common.css

2021-01-18T05:48:29Z

Quantum: CSS bugfix: this makes the following space appear for some reason

MediaWiki:Common.css

2021-01-18T05:43:41Z

Quantum: Revise navbox CSS: use more classes, style lists inline

User:Quantum/Element navbox

2021-01-18T04:09:18Z

Quantum: Add module version

<table class="navbox">
<tr><th colspan=2">[[Elements]]</th></tr>
<tr><th>Special</th><td>[[Empty]] • [[Edge]] • [[Monitor]] • [[Message timer]]</td></tr>
<tr><th>Items</th><td>[[Player]] • [[Ammo]] • [[Torch]] • [[Gem]] • etc...</td></tr>
<tr><th>Terrain</th><td>[[Water]] • [[Forest]] • [[Solid]] • etc...</td></tr>
<tr><th>Creatures</th><td>[[Bear]] • [[Ruffian]] • [[Object]] • etc...</td></tr>
<tr><th>Text</th><td>[[Text]]</td></tr>
</table>

Module version:
{{#invoke:Navbox|navbox|title=[[Elements]]
|groupName1='''Special'''
|group1=
* [[Empty]]
* [[Edge]]
* [[Monitor]]
* [[Message timer]]
|groupName2='''Items'''
|group2=
* [[Player]]
* [[Ammo]]
* [[Torch]]
* [[Gem]]
* etc...
|groupName3='''Terrain'''
|group3=
* [[Water]]
* [[Forest]]
* [[Solid]]
* etc...
|groupName4='''Creatures'''
|group4=
* [[Bear]]
* [[Ruffian]]
* [[Object]]
* etc...
}}

Module:Navbox

2021-01-18T03:47:26Z

Quantum:

local p = {}

function p.navbox(frame)
local title = frame.args.title
if title == nil then
error("Missing title")
end

-- Assign group1, group2, etc to groups
local groups = {}
local i = 1
while frame.args["group" .. i] ~= nil do
local group = {
content = frame.args["group" .. i],
name = frame.args["groupName" .. i] -- can be nil
}
table.insert(groups, group)
i = i + 1
end

return make_box(title, groups)
end

function make_box(title, groups)
local navbox = mw.html.create("table"):addClass("navbox")

-- Create title row
local title_row = navbox:tag("tr"):addClass("title")
title_row:tag("th"):attr("colspan", 2):wikitext(title)

-- Create row for each group
for _, group in ipairs(groups) do
local group_row = navbox:tag("tr"):addClass("group")
local content = "\n" .. group.content .. "\n"
if group.name == nil then
group_row:tag("td"):attr("colspan", "2"):wikitext(content)
else
group_row:tag("th"):wikitext(group.name)
group_row:tag("td"):wikitext(content)
end
end

return navbox
end

return p

Module:Navbox

2021-01-18T03:42:59Z

Quantum: Debugging

local p = {}

function p.navbox(frame)
local title = frame.args.title
if title == nil then
error("Missing title")
end

-- Assign group1, group2, etc to groups
local groups = {}
local i = 1
while frame.args["group" .. i] ~= nil do
local group = {
content = frame.args["group" .. i],
name = frame.args["groupName" .. i] -- can be nil
}
table.insert(groups, group)
i = i + 1
end

return make_box(title, groups)
end

function make_box(title, groups)
local navbox = mw.html.create("table"):addClass("navbox")

-- Create title row
local title_row = navbox:tag("tr"):addClass("title")
title_row:tag("th"):attr("colspan", 2):wikitext(title)

-- Create row for each group
for _, group in ipairs(groups) do
local group_row = navbox:tag("tr"):addClass("group")

if group.name == nil then
group_row:tag("td"):attr("colspan", "2"):tag("div"):wikitext(group.content)
else
group_row:tag("th"):wikitext(group.name)
group_row:tag("td"):tag("div"):wikitext(mw.text.nowiki(group.content))
end
end

return navbox
end

return p

Module:Navbox

2021-01-18T03:36:32Z

Quantum: Add div to see if it helps with MediaWiki list formatting

local p = {}

function p.navbox(frame)
local title = frame.args.title
if title == nil then
error("Missing title")
end

-- Assign group1, group2, etc to groups
local groups = {}
local i = 1
while frame.args["group" .. i] ~= nil do
local group = {
content = frame.args["group" .. i],
name = frame.args["groupName" .. i] -- can be nil
}
table.insert(groups, group)
i = i + 1
end

return make_box(title, groups)
end

function make_box(title, groups)
local navbox = mw.html.create("table"):addClass("navbox")

-- Create title row
local title_row = navbox:tag("tr"):addClass("title")
title_row:tag("th"):attr("colspan", 2):wikitext(title)

-- Create row for each group
for _, group in ipairs(groups) do
local group_row = navbox:tag("tr"):addClass("group")

if group.name == nil then
group_row:tag("td"):attr("colspan", "2"):tag("div"):wikitext(group.content)
else
group_row:tag("th"):wikitext(group.name)
group_row:tag("td"):tag("div"):wikitext(group.content)
end
end

return navbox
end

return p

Module:Navbox

2021-01-18T03:26:20Z

Quantum: Forgot to add class=navbox to table

local p = {}

function p.navbox(frame)
local title = frame.args.title
if title == nil then
error("Missing title")
end

-- Assign group1, group2, etc to groups
local groups = {}
local i = 1
while frame.args["group" .. i] ~= nil do
local group = {
content = frame.args["group" .. i],
name = frame.args["groupName" .. i] -- can be nil
}
table.insert(groups, group)
i = i + 1
end

return make_box(title, groups)
end

function make_box(title, groups)
local navbox = mw.html.create("table"):addClass("navbox")

-- Create title row
local title_row = navbox:tag("tr"):addClass("title")
title_row:tag("th"):attr("colspan", 2):wikitext(title)

-- Create row for each group
for _, group in ipairs(groups) do
local group_row = navbox:tag("tr"):addClass("group")
if group.name == nil then
group_row:tag("td"):attr("colspan", "2"):wikitext(group.content)
else
group_row:tag("th"):wikitext(group.name)
group_row:tag("td"):wikitext(group.content)
end
end

return navbox
end

return p

Module:Navbox

2021-01-18T03:21:57Z

Quantum:

local p = {}

function p.navbox(frame)
local title = frame.args.title
if title == nil then
error("Missing title")
end

-- Assign group1, group2, etc to groups
local groups = {}
local i = 1
while frame.args["group" .. i] ~= nil do
local group = {
content = frame.args["group" .. i],
name = frame.args["groupName" .. i] -- can be nil
}
table.insert(groups, group)
i = i + 1
end

return make_box(title, groups)
end

function make_box(title, groups)
local navbox = mw.html.create("table")

-- Create title row
local title_row = navbox:tag("tr"):addClass("title")
title_row:tag("th"):attr("colspan", 2):wikitext(title)

-- Create row for each group
for _, group in ipairs(groups) do
local group_row = navbox:tag("tr"):addClass("group")
if group.name == nil then
group_row:tag("td"):attr("colspan", "2"):wikitext(group.content)
else
group_row:tag("th"):wikitext(group.name)
group_row:tag("td"):wikitext(group.content)
end
end

return navbox
end

return p