A look inside The Link @ wiki - User contributions [en]

Mohawk archive format

2010-01-26T23:08:13Z

Clone2727: /* RSRC header */ fix the first four bytes of the RSRC header

{{Riven}}
{{Myst}}
==General layout==
Mohawk archives are organized in chunks, and this is the chunk layout:
* IFF chunk
** IFF header
** RSRC header
** Resource dir
*** Type table
*** Name tables (one for each resource type)
*** Resource tables (one for each resource type)
*** Resource name list
*** File table
** Actual data (resource contents)
Note that the chunks may be found in a different order: never trust on them being at fixed locations, and use the offsets to reach them.

Every integer is in big-endian (Motorola) byte order.

==IFF header==
This is always at the beginning of the file.
{| class="structure"
|4 bytes||chunk signature (MHWK), identifies Mohawk archive format
|-
|unsigned long||file size in bytes, '''not''' counting this IFF header (that is, file size - 8)
|}

==RSRC header==
I think this is actually the "Resource Dir header". Note that the Dir can be anywhere in file, but this header always follows the IFF Header.
{| class="structure"
|4 bytes||chunk signature (RSRC)
|-
|unsigned short||version (always 0x100)
|-
|unsigned short||compaction (not used in reading from archives)
|-
|unsigned long||total file size in bytes
|-
|unsigned long||absolute offset of the Resource Dir
|-
|unsigned short||offset in Resource Dir of the File Table
|-
|unsigned short||File Table size in bytes
|}

==Type table==
It lists resource types in the Mohawk file. This table is always at the beginning of the Resource Dir.

Header:
{| class="structure"
|unsigned short||offset in Resource Dir of the Resource Name List (maybe this should go with the RSRC Header)
|-
|unsigned short||number of resource types in this file
|}

Entry (one for each type):
{| class="structure"
|4 bytes||resource type (tWAV, tBMP, NAME etc.)
|-
|unsigned short||offset in Resource Dir of the Resource Table for this type
|-
|unsigned short||offset in Resource Dir of the Name Table for this type
|}

==Name table==
There is one name table for each resource type. Many types don't have resource names; usually only tBMP, tWAV and tMOV do. Each entry holds the name offset in the name list for a resource.

Header:
{| class="structure"
|unsigned short||number of name entries (can be zero)
|}

Entry:
{| class="structure"
|unsigned short||offset of the name string in Name List
|-
|unsigned short||resource index (equal to the resource's index in File Table)
|}

==Resource table==
Again, there is one resource table for each resource type. The resource table holds crucial information about each resource of this type.

Header:
{| class="structure"
|unsigned short||number of resources for this type (number of table entries)
|}

Entry:
{| class="structure"
|unsigned short||resource ID
|-
|unsigned short||index in file table (starting from 1). Also used to find the matching name table entry
|}

==Resource name list==
This is a simple list of null-terminated strings (C strings), where each string is a resource name. Given a resource, you can get the offset to its name by looking in the name table entry for that resource.

==File table==
This table holds other important data about each resource, notably the location and size of the resource content within the whole Mohawk file. I wonder why this information couldn't go directly inside the resource table entry.

Header:
{| class="structure"
|unsigned long||number of file table entries
|}

Entry:
{| class="structure"
|unsigned long||absolute offset of resource data block
|-
|unsigned short||resource data size, bits 15-0
|-
|byte||resource data size, bits 23-16
|-
|byte||resource flags (unknown)
|-
|unsigned short||unknown (usually zero in Riven files)
|}

It should be noted that the resource data size information is incorrect for all [[Riven tMOV resources|tMOV]]s in the Riven archives. One can compensate for this by computing file lengths using the resource offsets.

User:Clone2727

2009-10-01T04:56:21Z

Clone2727: update status

Hi!

== About Me ==
I'm currently working on an engine for [http://www.scummvm.org/ ScummVM] that will run [[Myst engine overview|Myst]], [[Riven engine overview|Riven]], and [[Other Games|other games]] that use the [[Mohawk archive format|Mohawk archives]]. My blog on my progress can be found [http://clone2727.blogspot.com/ here].

While most of [[Riven resources|Riven's resources]] are known, I occasionally add information on them. My main work on the wiki is adding to the non-Riven games. I'll add information mostly as I find out about it.

== Engine Progress ==
=== Myst ===
Myst is now partially playable. The ages are all explorable at least. No puzzles are completable yet, however.

=== Riven ===
It is highly playable right now. Only a few minor bugs remain. Transitions have not been implemented. Background videos are not yet supported. Many external commands are also not implemented yet. Inventory is also supported.

The game is currently playable up until the "Marble Puzzle." This includes completing the Boiler Puzzle and Tay.

=== Other Games ===
Images, palettes, and sounds of other Mohawk games (both old and new file formats) are supported. Images in the old games aren't supported yet.

Old Mohawk archive format

2009-09-10T20:45:45Z

Clone2727: minor cleanup

Some of the very old Mohawk games do not use exactly the [[Mohawk archive format|same format]] as the rest of the Mohawk games. However, it's really the same thing minus the MHWK headers and the resource table/file table merging. In fact, many of the games using the older format were just ported directly into Mohawk files later with only minor changes.

The files are have the extension <tt>.ibm</tt> or <tt>.mac</tt>, being PC and Mac versions, respectively. The biggest difference between these two are endianness, but there are some other minor differences as well. Throughout this, I will use the same wording as the [[Mohawk archive format|regular archive format]] to show where the differences are. The Name Table is always missing here, but it looks like they left room for it, hence the u0 in each type table entry.

= Windows Format (.ibm) =
All values are in Little Endian format. Including the FourCC's! This is important so that it matches up.

== Header ==
{| class="structure"
|unsigned long||absolute offset of the Resource Dir
|-
|unsigned short||size of Resource Dir (analogous to the size of the File table)
|}

The offset of the resource directory seems to be always 6.

== Type Table ==
At the beginning of the Resource Dir is the Type table.

{| class="structure"
|unsigned short||number of resource types in this file
|}

Entry (one for each type):
{| class="structure"
|4 bytes||resource type ([[Other Games#BMAP|BMAP]], [[Other Games#WAV|WAV ]] (with a space), [[Other Games#VRSN|VRSN]] etc.)
|-
|unsigned short||offset in Resource Dir of the Resource Table for this type
|-
|unsigned short||u0
|}

The offset is the offset within the Resource Dir, not the absolute offset. u0 appears to always be 0.

== Resource Table ==
Header:
{| class="structure"
|unsigned short||number of resources for this type (number of table entries)
|}

Entry:
{| class="structure"
|unsigned short||resource ID
|-
|unsigned long||absolute offset of resource data block
|-
|unsigned short||resource data size
|-
|unsigned long||u0
|}

This circumvents having the file table, as it stores the offset and length here. u0 appears to always be 0.

= Macintosh Format (.mac) =
All values are in Big Endian format.

== Header ==
{| class="structure"
|unsigned long||absolute offset of the Resource Dir
|-
|unsigned short||size of Resource Dir (analogous to the size of the File table)
|}

The offset of the resource directory seems to be always 6.

== Type Table ==
At the beginning of the Resource Dir is the Type table.

{| class="structure"
|unsigned short||number of resource types in this file
|}

Entry (one for each type):
{| class="structure"
|4 bytes||resource type ([[Other Games#BMAP|BMAP]], [[Other Games#WAV|WAV ]] (with a space), [[Other Games#VRSN|VRSN]] etc.)
|-
|unsigned long||offset in Resource Dir of the Resource Table for this type
|-
|unsigned long||u0
|}

The offset is the offset within the Resource Dir, not the absolute offset. u0 appears to always be 0.

== Resource Table ==
Header:
{| class="structure"
|unsigned short||number of resources for this type (number of table entries)
|}

Entry:
{| class="structure"
|unsigned short||resource ID
|-
|unsigned long||absolute offset of resource data block
|-
|byte||resource data size, bits 23-16
|-
|unsigned short||resource data size, bits 15-0
|-
|unsigned long||u0
|-
|byte||u1
|}

This circumvents having the file table, as it stores the offset and length here. u0 and u1 appear to always be 0. u1 is probably for alignment.

Other Games

2009-09-10T20:38:26Z

Clone2727: /* ASET */ typo

Myst and Riven aren't the only games to use the [[Mohawk archive format|Mohawk format]]. In fact, many Broderbund based games use it. Here is a (partial) list of games known to use it:

* In the 1st Degree
* James Discovers Math
* James Explores Math
* Logical Journey of the Zoombinis (aka Zoombinis Logical Journey)
* Maggie's Barnyard Adventure
* The Treehouse
* Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)
* Where in the USA is Carmen Sandiego?
* Where in the World is Carmen Sandiego? (Windows/Mac version)

In addition, various Living Books titles use the format or the [[Old Mohawk archive format|"old" Mohawk format]].

= Video =
All the videos of the original games are QuickTime movies. The later Zoombinis release has Bink videos instead.

The audio codec is raw, signed, 16-bit data in Big Endian format. The video codec, however, is not standard. It has the FourCC 'QkBk' and has description "CDToons". Neither QuickTime nor mplayer/ffmpeg can play this codec and its format is unknown. Some videos still use Cinepak (like "The Chief" videos in Carmen Sandiego).

= Game Specific Information =

== James Discovers/Explores Math ==

=== Resources ===
==== tANM ====
Animation?

==== tMFO ====

== Logical Journey of the Zoombinis ==

=== Resources ===
==== \0SND ====
These are [[Mohawk Sounds]]. Note that they begin with a NULL character.

==== CURS ====
Cursor?

==== SCRB ====
==== SCRS ====
==== NODE ====
==== PATH ====
==== SHPL ====

== Maggie's Barnyard Adventure ==

=== Resources ===
==== tCUR ====
Cursor?

== In the 1st Degree ==
=== Resources ===
==== ASET ====
Unknown. Stands for asset (they are found in ASSETLI1.MHK and ASSETLI2.MHK).

==== ANSW ====
Answer?

==== CLIP ====
Video clip?

==== GADG ====
Gadget?

==== MBAR ====
Menu bar?

==== MENU ====
Menu?

==== MITM ====
==== QSET ====
This is a question set. This links questions together into sort of like a dialogue tree.

(Big Endian Order)

{| class="structure"
|unsigned short||count
|-
|unsigned short||values[count]
|}

* ''count'' is the amount of values the follow.
* ''values'' is an array which is probably a list of QUES/ANSW (need to check).

==== QUES ====
This is a question. It appears to hold data for the text as well as the sound clip associated with it.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||sound
|-
|unsigned short||u1
|-
|unsigned short||u2
|-
|unsigned short||u3
|-
|unsigned short||u4
|-
|unsigned short||u5
|-
|unsigned short||u6
|-
|unsigned short||u7
|-
|unsigned short||u8
|-
|unsigned short||u8
|-
|char *||string
|}

* ''u0'' appears to always be 1. Possibly question count?
* ''sound'' is the sound clip associated with this question.
* ''u1'' is unknown. Always 0?
* ''u2'' is unknown. Possibly the answer to this question?
* ''u3'' is unknown. It's usually 2.
* ''u4'' is unknown. It's usually 100.
* ''u5'' is unknown. It's usually 100.
* ''u6'' is unknown. It's usually 100.
* ''u7'' is unknown. Always 0?
* ''u8'' is unknown. Always 0?
* ''u9'' is unknown. Possibly the answer to this question?
* ''string'' is the null-terminated string representing text for this question.

==== TAPE ====
==== THST ====
==== THTR ====
==== WITN ====
Witness?

== Common Resources ==

==== tBMP ====
All tBMP resources contain a [[Mohawk Bitmaps|Mohawk Bitmap]].

==== tWAV ====
This is a [[Mohawk Sounds]] resource. (Found in all but ''Logical Journey of the Zoombinis'')

==== tPAL ====
This is a palette. It is used outside of tBMP resources as a way to share palette information.

(Big Endian Order)

{| class="structure"
|unsigned short||color_start
|-
|unsigned short||color_count
|}

Following that is ''color_count'' RGBA quads. ''color_start'' is the index at which the RGBA quads start.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''The Treehouse''.

==== tCNT ====
Unknown. The data size is always 4 and follows this format:

(Big Endian Order)

{| class="structure"
|unsigned short||resource_id
|-
|unsigned short||u0
|}

''resource_id'' appears to always equal the tCNT that this belongs to.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''James Discovers Math'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''James Explores Math''.

==== tSCR ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== STRL ====
This is a string list.

{| class="structure"
|byte||string_count
|}

Following that is ''string_count'' NULL-terminated strings. This seems reminiscent of Riven's [[Riven_NAME_resources|NAME resources]].

This is found in ''Logical Journey of the Zoombinis'', ''Where in the World is Carmen Sandiego?'', and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== tBMH ====
These appear to also contain a [[Mohawk Bitmaps|Mohawk Bitmap]].

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== tMID ====
This is a [[Mohawk MIDI]] resource.

This is found in ''Logical Journey of the Zoombinis'', ''James Discovers Math'', ''James Explores Math'', ''In the 1st Degree'', and ''The Treehouse''.

==== REGS ====
Unknown.

This is found in ''Logical Journey of the Zoombinis'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== BYTS ====
This appears to be able to hold multiple things. In DATABASE.MHK, it holds database entries (one large null-terminated string), but elsewhere it appears to be something else.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== INTS ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== BBOX ====
Some sort of boxes? It follows this format:

(Big Endian Order)

{| class="structure"
|byte||rect_count
|}

And then, it has ''rect_count'' rects:

{| class="structure"
|unsigned short||left
|-
|unsigned short||top
|-
|unsigned short||right
|-
|unsigned short||bottom
|}

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== ANI ====
Animation? (Note: Ends in a space character)

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== BITL ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SCRP ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SPR# ====
Sprites?
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== VRSN ====
Version?

In Green Eggs and Ham, it contains these two bytes:
<div align="center" style="color:#008; font-family:monospace; margin:1em">00 02</div>

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SHP# ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SYSX ====
This appears to be a list of MIDI Sysex's. There are only two resources in Zoombini (which are found in MIDIMAP.DAT) and are 1 or 0xFFFF. They are identical. In the 1st Degree has several more in MIDIMAP.DAT.

==== BMAP ====
All BMAP resources contain a [[Mohawk Bitmaps|Mohawk Bitmap]].

==== WAV ====
(Note that the FourCC ends with a space)

There are two variants of the format, one in little endian and one in big endian. You can tell the difference just by looking at the header tag.

{| class="structure"
|2 bytes||tag
|-
|unsigned short||sample_rate
|-
|10 bytes||u0
|-
|unsigned long||sample_size
|}

* ''tag'' is '''Wv''' ('''vW''' if little endian).
* ''sample_rate'' is the sample rate, usually 11127.
* ''u0'' has only been observed as all zeroes, but this is likely analogous to the loop part of the [[Mohawk Sounds|Mohawk sound resource]].
* ''sample_size'' is the size of the sample, usually the rest of the resource

Following this is ''sample_size'' bytes of raw, unsigned, 8-bit PCM data.

==== CTBL ====
Unknown, possibly color table?

Myst scripts

2009-09-10T18:12:26Z

Clone2727: commands 196, 197, 298, and 299 are found in the Myst demo, purpose unknown

{{Myst}}
This page describes Myst scripts, command lists used in record types 5, 6, 7, 8, 10, 11, and 12. Scripts always start with an unsigned short representing the command count. Each command has this structure:
{| class="structure"
|unsigned short||opcode
|-
|unsigned short||var
|-
|unsigned short||arg_count
|-
|short||args[arg_count]
|}
When a variable is not given, ''var'' is set to 0. So when the key below says that the variable is ''optional'', that means that it has been found both with and without a variable being passed in. In some cases, the syntax of the arguments depends on whether a variable was passed in. In this case, the variable/arguments header is repeated for each form of the command.

A histogram of command usage in Myst original RLST resources can be found [http://altivec.indivia.net/alitl/myst_rlst_cmd_hist.svg here].

==Commands 0-99==
These are suspected to be general-purpose commands.

===Command 0===
*'''Variable:''' Optional
*'''Arguments:''' None

In some cases it seems to toggle the associated variable between logical "0" and "1" (e.g. see the marker switches on MYST island). However, it's probably more complicated than this: for example, in Mechanical card 6267 it seems to ''increment'' the associated variable.

===Command 1===
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

Could mean "set variable to ''u0''". ''u0'' takes on any number between 0 and 7 (maybe a bit field?)

===Command 2: alternative destination===
*'''Variable:''' Yes
*'''Arguments:''' ''dest''

This command goes to ''dest'' instead of the regular destination if ''var'' is a certain (unknown) value. (Only used for SELEN 1240 and CHANNEL 3359)

===Command 3: change cursor===
*'''Variable:''' Yes
*'''Arguments:''' ''clrc_id''

This is used when picking up pages. Seems to check the associated variable and, depending on its value, set the appropriate cursor and alter the variable itself. ''clrc_id'' is always 800, 801, or 802, which match the cursors of the hand holding the white, red, and blue pages respectively.

===Command 4===
*'''Variable:''' Optional
*'''Arguments:''' None

===Command 6===
*'''Variable:''' Optional
*'''Arguments:''' None

===Command 7===
*'''Variable:''' Optional
*'''Arguments:''' None

===Command 8===
*'''Variable:''' Optional
*'''Arguments:''' None

===Command 9===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is always either ''FFFF'' or omitted.

===Command 12===
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

''Related to [[#Command 13|command 13]]''.

*''u0'' appears to be a nearby card.

This may have similar function to [[#Command 2|command 2]].

===Command 13===
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

''Related to [[#Command 12|command 12]]''.

*''u0'' appears to be a nearby card.

This may have similar function to [[#Command 2|command 2]].

===Command 14===
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

*''u0'' is always 0, 1, or 2.

===Command 15===
*'''Variable:''' Yes
*'''Arguments:''' [''u0'']

*''u0'' is always 0 or omitted.

===Command 16===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' appears to be a nearby card.
*''u1'' is always 0.

===Command 17===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' appears to be a nearby card.
*''u1'' is always 4, 5, or 6.

===Command 18===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is always 4, 5, or 6.

===Command 19: enable hotspots===
*'''Variable:''' No
*'''Arguments:''' ''count'' ''indexes''[''count'']

This seems to enable a list of hotspots, specified by ''indexes''.

===Command 20: disable hotspots===
*'''Variable:''' No
*'''Arguments:''' ''count'' ''indexes''[''count'']

This seems to disable a list of hotspots, specified by ''indexes''. These, unlike [[#Command 19|command 19]], can also be -1, which seems to disable the invoking hotspot.

===Command 21===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2'' ''u3'' ''u4'' ''u5''

There are this command is used 6 times.

*''u0'' is always 0, 74, 76, 117, or 198.
*''u1'' is always 0, 48, 213, or 226.
*''u2'' is always 327, 406, 429, 459, or 544.
*''u3'' is always 257, 332, or 333.
*''u4'' is always 0, 1, 5, 6, or 11.
*''u5'' is always 5 or 25.

===Command 22===
*'''Variable:''' No
*'''Arguments:''' None

===Command 23===
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

The ''u0'' numbers are all 0, 4, or 5. Guess: toggle enable status for a list of hotspots.

===Command 24: play sound, non-blocking===
*'''Variable:''' No
*'''Arguments:''' ''sound_id''

Start sound with ID ''sound_id''. Script execution resumes immediately and the sound plays in the background.

===Command 26===
*'''Variable:''' No
*'''Arguments:''' None

===Command 27: play sound, blocking===
*'''Variable:''' No
*'''Arguments:''' ''sound_id''

Play sound with ID ''sound_id'', blocking script execution until done.

===Command 28===
*'''Variable:''' No
*'''Arguments:''' (<''l t r b''>|''FFFF'')

Often used after command 29. <''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources. Guess: update screen rectangle? See Mechanical card 6009.

===Command 29: copy picture over the hotspot===
*'''Variable:''' No
*'''Arguments:''' ''pict_id'' <''l t r b''> ''u0'' ''u1''

*''pict_id'' appears to be a picture ID.
*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.
*''u0'' appears to be a variable number (it is sometimes 0).
*''u1'' may also be a variable number (it is sometimes 0, 1, or -1).

This command seems to copy picture ''pict_id'' over the hotspot, using <''l'' ''t'' ''r'' ''b''> as the source rect. Additional data is unknown.

===Command 30: start background sounds===
*'''Variable:''' No
*'''Arguments:''' variable

This seems to start a background sound combination. The arg list seems to follow the philosophy of the sounds section in VIEW resources. In most cases there are just 2 args, a positive ''msnd_id'' (background sound ID to play) and ''flags''. However, there is a single exception with 8 args (RLST ID 3225 in Channelwood) which can be correctly interpreted simply as a more complex sounds section.

===Command 31===
*'''Variable:''' Yes (only ever 30)
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is always 0.
*''u1'' looks like a card ID.

===Command 32===
*'''Variable:''' No
*'''Arguments:''' None

===Command 33: draw picture===
*'''Variable:''' No
*'''Arguments:''' ''id'' <''sl st sr sb''> <''dl'' ''dt''>

Draw a picture, given the ID and source rect, at position <''dl'',''dt''>.

===Command 34===
*'''Variable:''' No
*'''Arguments:''' ''card'' ''u1''

Seems to go to card ''card''. ''u1'' is always 0, 1, 4, 5, 6, 9, 10, or 11.

===Command 35===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2''

*''u0'' looks like a card ID.
*''u1'' looks like a card ID.
*''u2'' is always 0, 6, or 10.

===Command 36===
*'''Variable:''' No
*'''Arguments:''' ''u0''

This command is only used twice.

*''u0'' is 900 or 903.

===Command 37===
*'''Variable:''' No
*'''Arguments:''' None

Seems to form pairs with command 38, where it opens the script and command 38 ends it.

===Command 38===
*'''Variable:''' No
*'''Arguments:''' None

Seems to form pairs with command 37, where it closes the script while command 37 opens it.

===Command 39===
*'''Variable:''' No
*'''Arguments:''' ''u0''

''u0'' is 100, 200, 400, 500, 1000, or 1100. Guess: pause execution for ''u0'' milliseconds?

===Command 40: travel to destination age===
*'''Variable:''' No
*'''Arguments:''' ''dst_age_id'' ''src_msnd_id'' ''dst_msnd_id''

*''dst_age_id'' is one of 0 (selen), 1 (stone), 2 (myst), 3 (mechan), 4 (channel) or 6 (dunny).
*''src_msnd_id'' is a sound ID to play in source age.
*''dst_msnd_id'' is a sound ID to play in destination age.

===Command 41===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2'' ''count'' ''u3''[''count'']

*''u0'' looks like a card ID.
*''u1'' looks like a sound ID.
*''u2'' is always 5 or 10.
*''count'' is only ever 6 or 12.
*''u3'' may be divided into groups of sixes.

===Command 42===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''count'' ''u2''[''count'']

*''u0'' looks like a sound ID.
*''u1'' is always 5, 10, 15, or 20.
*''count'' is only ever 6 or 12.
*''u2'' may be divided into groups of sixes.

===Command 43===
*'''Variable:''' No
*'''Arguments:''' None

===Command 44===
*'''Variable:''' No
*'''Arguments:''' None

===Command 46===
*'''Variable:''' No
*'''Arguments:''' None

Often found after commands 29 and 33. Guess: update the whole screen?

==Commands 100-199==
These are suspected to be age-specific, as their syntax changes depending on the age.
===Command 100===
*'''Variable:''' Optional
*'''Arguments:''' [''u0'']

*''u0'' is always 4, 6, or omitted.

===Command 101===
*'''Variable:''' No
*'''Arguments:''' [''u0''|''u1''[6]]

*''u0'' is always 4225 or omitted.
*''u1'' is a series of 6 positive numbers.

===Command 102===
*'''Variable:''' No
*'''Arguments:''' [''u0'' ''u1'' [''u2'']]

*''u0'' looks like a card ID (or 0).
*''u1'' looks like a card ID.
*''u2'' looks like an (optional) bit field. (only 0x64 or 0)

===Command 103===
*'''Variable:''' Yes
*'''Arguments:''' ''bit''

This form of the command most likely negates bit ''bit'' of ''var''.

*''bit'' is a power of 2 (bit mask).

*'''Variable:''' No
*'''Arguments:''' ''u0'' [''u1'']

This form of the command likely makes specified hotspot drawable.

*''u0'' is a number between 13 and 18. It seems to refer to a hotspot index (see stone 2197).
*''u1'' is either 1 or omitted.

===Command 104===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

This command likely makes specified hotspot not drawable.

*''u0'' can be 0, 1, omitted, or 13 to 20. It seems to refer to a hotspot index (see stone 2004 and 2197).

===Command 105===
*'''Variable:''' Optional (set to 9 at one point, but usually not)
*'''Arguments:''' [''u0'']

*''u0'' looks like a sound ID.

===Command 106===
*'''Variable:''' 10
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

===Command 107===
*'''Variable:''' 11
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

===Command 108===
*'''Variable:''' 12
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

===Command 109===
*'''Variable:''' Optional
*'''Arguments:''' [''u0'']

*''u0'' is ''FFFF'', 1, omitted, or 2287 (looks like sound ID).

===Command 110===
*'''Variable:''' No
*'''Arguments:''' 1180 1179 12 203 78 345 167 6 10 203 166 345 306 5 10

This command is only used once.

===Command 111===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

This command likely makes specified hotspot not drawable.

*''u0'' is 14 to 20 or omitted. It seems to refer to a hotspot index (see stone 2004).

===Command 112===
*'''Variable:''' 29
*'''Arguments:''' ''u0'' ''u1'' ''u2''

This command is only used twice.

*''u0'' is 0 or 1800.
*''u1'' is 400 or 2000.
*''u2'' is 1.

===Command 113===
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 0 10

This command is only used once. 5143 is likely sound ID.

===Command 114===
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely sound ID.

===Command 115===
*'''Variable:''' Yes
*'''Arguments:''' ''u0''[3]

*The ''u0'' look like card ID's.

*'''Variable:''' No
*'''Arguments:''' 1139 1140 1140 10 6 204 64 343 279 6 50

This form of the command is only used once.

===Command 116===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is 0, 1, or 6006.

===Command 117===
*'''Variable:''' No
*'''Arguments:''' [''u0''|''u1'' ''u2'']

*''u0'' is 0, 1, 2, 3, or omitted.
*''u1'' and ''u2'' are 5698 and 6698 (only used once).

In Channelwood, card 3012, this command is invoked by the buttons in Achenar's video device and ''u0'' is the button number.

===Command 118===
*'''Variable:''' No
*'''Arguments:''' [4707 5707 6707 7707 4705]

This command is only used 3 times (once with values and twice omitted). Values are likely sound IDs.

===Command 119===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 0, 1, or omitted.

===Command 120===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 0, 1, 2, 3, or omitted.

===Command 121===
*'''Variable:''' Yes
*'''Arguments:''' None

*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is 0 or a card ID.
*''u1'' is a card ID.

===Command 122===
*'''Variable:''' No
*'''Arguments:''' None

===Command 123===
*'''Variable:''' No
*'''Arguments:''' ''u0'' [''u1'']

*''u0'' is 0, 1, or 960.
*''u1'' is 960, 1920, or omitted.

===Command 124===
*'''Variable:''' No
*'''Arguments:''' None

===Command 125===
*'''Variable:''' No
*'''Arguments:''' None

*'''Variable:''' 21
*'''Arguments:''' ''u0''

*''u0'' is 13 or 14.

===Command 126===
*'''Variable:''' No
*'''Arguments:''' None

===Command 127===
*'''Variable:''' no
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is 1, 2, or 3.
*''u1'' is 0 or 1.

===Command 129===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' looks like a sound ID.

===Command 133===
*'''Variable:''' No
*'''Arguments:''' 6500

This command is only used once. Value is a sound ID.

===Command 164===
*'''Variable:''' No
*'''Arguments:''' None

===Command 169===
*'''Variable:''' No
*'''Arguments:''' None

===Command 196===
*'''Variable:''' No
*'''Arguments:''' None

This command is only used in the demo.

===Command 197===
*'''Variable:''' No
*'''Arguments:''' None

This command is only used in the demo.

===Command 198===
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely a sound ID.

===Command 199===
*'''Variable:''' No
*'''Arguments:''' None

==Commands 200-299==
These are only seen in the [[Myst INIT resources|INIT]] scripts.
===Command 200===
*'''Variable:''' Optional
*'''Arguments:''' None
*'''Seen:''' DUNNY, INTRO, MECHAN, SELEN, STONE

*'''Variable:''' No
*'''Arguments:''' ''u0 u1''[3]
*'''Seen:''' MYST

*''u1'' appears to be three sound IDs.

===Command 201===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' CHANNEL, INTRO, SELEN, STONE

*'''Variable:''' No
*'''Arguments:''' ''u0''
*'''Seen:''' MYST
*''u0'' looks like a sound ID.

*'''Variable:''' No
*'''Arguments:''' 0 4 5
*'''Seen:''' MECHAN

===Command 202===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' MECHAN, SELEN, STONE

*'''Variable:''' Yes
*'''Arguments:''' None
*'''Seen:''' CHANNEL

*'''Variable:''' No
*'''Arguments:''' 13
*'''Seen:''' MYST

===Command 203===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' CHANNEL, MECHAN, MYST, SELEN

*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count''] ''u1''
*'''Seen:''' STONE

*''u0'' look like card IDs.
*''u1'' looks like a sound ID.

===Command 204===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' MYST, SELEN, STONE

*'''Variable:''' No
*'''Arguments:''' ''u0''
*'''Seen:''' MECHAN

*''u0'' looks like a sound ID.

===Command 205===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' MYST, SELEN

*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count''] ''u1''
*'''Seen:''' STONE

*''u0'' look like card IDs.
*''u1'' looks like a sound ID.

*'''Variable:''' No
*'''Arguments:''' ''u0''[4]
*'''Seen:''' MECHAN

*''u0'' look like sound IDs.

===Command 206===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' MYST, SELEN, STONE

*'''Variable:''' No
*'''Arguments:''' ''u0''[6]
*'''Seen:''' MECHAN

*''u0'' look like sound IDs.

===Command 207===
*'''Variable:''' No
*'''Arguments:''' STONE

===Command 208===
*'''Variable:''' Yes
*'''Arguments:''' None
*'''Seen:''' MYST

*'''Variable:''' No
*'''Arguments:''' ''u0''[3]
*'''Seen:''' STONE

===Command 209===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 210===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 211===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 212===
*'''Variable:''' No
*'''Arguments:''' None

===Command 213===
*'''Variable:''' No
*'''Arguments:''' None

===Command 214===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 215===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 216===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 217===
*'''Variable:''' No
*'''Arguments:''' None

===Command 218===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 219===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 220===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 221===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 222===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 298===
*'''Variable:''' No
*'''Arguments:''' None

This command is only used in the demo.

===Command 299===
*'''Variable:''' No
*'''Arguments:''' None

This command is only used in the demo.

==Commands 300-399==
These are only seen in the [[Myst EXIT resources|EXIT]] scripts.
===Command 300===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 301===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 302===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 303===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 304===
*'''Variable:''' No
*'''Arguments:''' None

===Command 305===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 306===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 307===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 308===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 309===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 312===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

Mohawk Bitmaps

2009-09-10T18:07:28Z

Clone2727: Minor correction and add values for two more (still unknown) compressions

{{Myst}}
{{Riven}}
All observed Mohawk games use a common bitmap format, besides Myst (which uses [[WDIB]] and [[Myst PICT resources|PICT]] images). Mohawk bitmaps are always stored with a tBMP tag. All values are in big endian order. tBMP resources are divided into three chunks: the header, the palette, and the image. Note that the palette is not always present (such as non-Riven 8bpp images and Riven 24bpp images).

== Bitmap Header ==
{| class="structure"
|unsigned short||bitmap width
|-
|unsigned short||bitmap height
|-
|unsigned short||bytes per row
|-
|unsigned short||compression details
|}

* ''bitmap width'' is the width of the bitmap in pixels.
* ''bitmap height'' is the height of the bitmap in pixels.
* ''bytes per row'' is the pitch of the image (bytes in a scan line).
* For ''compression details'', see the next section.

'''Note''': Both ''bitmap width'' and ''bitmap height'' are only valid for the bottom 10 bits (val & 0x3ff, in C). ''bytes per row'' is also the same, but has to remain even (val & 0x3fe, in C).

=== Compression Details ===
''compression details'' is split up into different sections, depending on their purpose.

==== Bits 0-2 (Bits Per Pixel) ====
The lower three bits represent the images' bit depth. It is chosen from this table.

{| border="1"
|- style="background:silver"
|Value||Bits Per Pixel
|-
|0||1
|-
|1||4
|-
|2||8
|-
|3||16
|-
|4||24
|}

Other values are undefined.

==== Bit 3 (Palette) ====
Bit 3 represents whether or not a palette will occur. However, this is very unreliable, as Riven never has this bit set. If the game is Riven, and the bit depth is 8, you should assume there is a palette.

==== Bits 4-7 (Secondary Compression) ====
Bits 4-7 represent the secondary compression on the image.

{| border="1"
|- style="background:silver"
|Value||Secondary Compression
|-
|0||None
|-
|1||RLE8
|-
|3||Another (still unknown) RLE variant
|}

For none, the image is raw pixels. However, there are ''bytes per row'' bytes per row, so you have to skip remaining bytes at the end of the row. In Riven, there is always no secondary compression. On the contrary, in almost all other games' images, the compression is RLE8.

==== Bits 8-11 (Primary Compression) ====
Bits 8-11 represent the primary compression on the image.

{| border="1"
|- style="background:silver"
|Value||Secondary Compression
|-
|0||None
|-
|1||LZ
|-
|2||Another (still unknown) LZ variant
|-
|4||Riven
|}

For none, there is nothing to do at this stage. See details later for the LZ and Riven compression schemes.

== Palette ==
While bit 3 should represent whether a palette exists or not, all 8bpp Riven images have a palette regardless. The palette starts with a short header:

{| class="structure"
|unsigned short||table_size
|-
|byte||bits_per_color
|-
|byte||color_count
|}

* ''table_size'' is the size of the table, including the four byte header.
* ''bits_per_color'' is the bits that each color is (seems to be always 24)
* ''color_count'' is the amount of colors that the table contains (seems to be always 0xff)

Following the header is ''color_count'' blocks:

{| class="structure"
|byte||blue_component
|-
|byte||green_component
|-
|byte||red_component
|}

== Image ==

The rest of the tBMP resource is made up of the image. To decode the image, you must first use the primary decompression and then the secondary decompression to have the correct output image.

=== Primary Decompression ===

If the image has no primary decompression you can skip this step.

==== LZ Decompression ====

The stream consists of two parts, the header and the compressed data.

===== LZ Header =====

{| class="structure"
|unsigned long||uncompressed_size
|-
|unsigned long||compressed_size
|-
|unsigned short||dictionary_size
|}

* ''uncompressed_size'' is the size of the data after decompressing.
* ''compressed_size'' is the size of the data before decompressing.
* ''dictionary_size'' is the size of the ring buffer to use in the decompressor. However, it is '''''always''''' 0x400, and if it's not 0x400, it should be thrown out.

===== LZ Compression =====
Thanks to Petroff Heroj and Ron Hayter for working out this compression.

Until the end of the resource, each run begins with a byte. Each bit of this byte defines what to do next, starting from the least significant one.
* A 1 means an absolute byte follows. Read a byte from the compressed data and store it directly into the uncompressed buffer.
* A 0 means a length/offset pair follows. Read two bytes ''b1'' and ''b2'' from the compressed data. The most significant 6 bits of ''b1'' represent the length of the run minus 3. The 2 least significant bits of ''b1'' and the whole ''b2'' form together a 10-bit offset into the ring buffer, minus 0x42. At this point copy ''length'' bytes from the ring buffer, starting at ''offset'', to the uncompressed buffer. If ''offset'' is over 0x400 make sure to subtract 0x400 after adding the 0x42, i.e. loop around to the beginning of the ring buffer.
The ring-buffer should be initialized to all zeroes. Remember to store the uncompressed bytes in the ring buffer as well, looping to the beginning after 0x400 bytes.

For example:
<pre>
0xf7 // decoder byte (11110111b)
0x87 // absolute byte
0x73 // absolute byte
0x27 // absolute byte
0x0b // byte 1 of the run data: length = 2 + 3 = 5 (first 6 bits + 3)
0xa9 // byte 2 of the run data: offset = 0x3a9 + 0x42 = 0x3eb
0x27 // absolute byte
0x32 // absolute byte
0x00 // absolute byte
0x4e // absolute byte
</pre>

==== Riven Decompression ====
In compressed tBMP bitmaps, pixels are encoded as a data stream made of variable length commands. Pixels are always decoded in duplets: each command generates at least 2 pixels. The encoding is heavily based on what comes before each command, so even a little decoding bug can cripple the whole image. The commands can appear in any order inside the data stream. The first 4 bytes of the data stream are unknown and can be ignored. Many thanks to Arthur Muller for his precious help in decoding this format.

Like the uncompressed format, sometimes duplets are generated beyond the edge of the image. Use the ''bytes per row'' value to see how many duplets are in each row.

===== Main Commands =====

They are all 1-byte commands, followed by a variable number of arguments.

{| border=1 cellpadding=4 cellspacing=0 style="border:1px #000 solid;border-collapse:collapse;"
|- style="background:#CCC"
! Command !! Action
|-
|style="font-family:monospace"|0x00||End of stream: when reaching it, the decoding is complete. No additional bytes follow. I think some bitmaps don't have this, so just stop when you have decoded enough pixels to fill the image.
|-
|style="font-family:monospace"|0x01 -0x3f||Output ''n'' pixel duplets, where ''n'' is the command value itself. Pixel data comes immediately after the command as 2*''n'' bytes representing direct indices in the 8-bit color table.
|-
|style="font-family:monospace"|0x40-0x7f||Repeat last 2 pixels ''n'' times, where ''n'' = ''command_value'' & 0x3F. No additional bytes follow.
|-
|style="font-family:monospace"|0x80-0xbf||Repeat last 4 pixels ''n'' times, where ''n'' = ''command_value'' & 0x3F. No additional bytes follow.
|-
|style="font-family:monospace"|0xc0-0xff||Begin of a subcommand stream. This is like the main command stream, but contains another set of commands which are somewhat more specific and a bit more complex. This command says that ''command_value'' & 0x3F subcommands will follow. It doesn't generate pixels itself.
|}

===== Subcommands, part 1: arithmetic operations =====
Subcommands are not simply 1-byte values, but are somewhat mixed with their arguments, so the full byte pattern is reported.
{| border=1 cellpadding=4 cellspacing=0 style="border:1px #000 solid;border-collapse:collapse;"
|- style="background:#CCC"
! Command !! Byte pattern !! Action
|-
|style="font-family:monospace"|0x01-0x0f
|style="font-family:monospace"|0000mmmm
|Repeat duplet at relative position -''m'', where ''m'' is given in duplets. So if ''m''=1, repeat the last duplet.
|-
|style="font-family:monospace"|0x10
|style="font-family:monospace"|0x10 p
|Repeat last duplet, but change second pixel to ''p''.
|-
|style="font-family:monospace"|0x11-0x1f
|style="font-family:monospace"|0001mmmm
|Output the first pixel of last duplet, then pixel at relative position -''m''. ''m'' is given in pixels.
|-
|style="font-family:monospace"|0x20-0x2f
|style="font-family:monospace"|0010xxxx
|Repeat last duplet, but add ''x'' to second pixel.
|-
|style="font-family:monospace"|0x30-0x3f
|style="font-family:monospace"|0011xxxx
|Repeat last duplet, but subtract ''x'' to second pixel.
|-
|style="font-family:monospace"|0x40
|style="font-family:monospace"|0x40 p
|Repeat last duplet, but change first pixel to ''p''.
|-
|style="font-family:monospace"|0x41-0x4f
|style="font-family:monospace"|0100mmmm
|Output pixel at relative position -''m'', then second pixel of last duplet.
|-
|style="font-family:monospace"|0x50
|style="font-family:monospace"|0x50 p1 p2
|Output two absolute pixel values, ''p1'' and ''p2''.
|-
|style="font-family:monospace"|0x51-0x57
|style="font-family:monospace"|01010mmm p
|Output pixel at relative position -''m'', then absolute pixel value ''p''.
|-
|style="font-family:monospace"|0x59-0x5f
|style="font-family:monospace"|01011mmm p
|Output absolute pixel value ''p'', then pixel at relative position -''m''.
|-
|style="font-family:monospace"|0x60-0x6f
|style="font-family:monospace"|0110xxxx p
|Output absolute pixel value ''p'', then (second pixel of last duplet) + ''x''.
|-
|style="font-family:monospace"|0x70-0x7f
|style="font-family:monospace"|0111xxxx p
|Output absolute pixel value ''p'', then (second pixel of last duplet) - ''x''.
|-
|style="font-family:monospace"|0x80-0x8f
|style="font-family:monospace"|1000xxxx
|Repeat last duplet adding ''x'' to the first pixel.
|-
|style="font-family:monospace"|0x90-0x9f
|style="font-family:monospace"|1001xxxx p
|Output (first pixel of last duplet) + ''x'', then absolute pixel value ''p''.
|-
|style="font-family:monospace"|0xa0
|style="font-family:monospace"|0xa0 xxxxyyyy
|Repeat last duplet, adding ''x'' to the first pixel and ''y'' to the second.
|-
|style="font-family:monospace"|0xb0
|style="font-family:monospace"|0xb0 xxxxyyyy
|Repeat last duplet, adding ''x'' to the first pixel and subtracting ''y'' from the second.
|-
|style="font-family:monospace"|0xc0-0xcf
|style="font-family:monospace"|1100xxxx
|Repeat last duplet subtracting ''x'' from first pixel.
|-
|style="font-family:monospace"|0xd0-0xdf
|style="font-family:monospace"|1101xxxx p
|Output (first pixel of last duplet) - ''x'', then absolute pixel value ''p''.
|-
|style="font-family:monospace"|0xe0
|style="font-family:monospace"|0xe0 xxxxyyyy
|Repeat last duplet, subtracting ''x'' from first pixel and adding ''y'' to second.
|-
|style="font-family:monospace"|0xf0 and 0xff
|style="font-family:monospace"|0xfx xxxxyyyy
|Repeat last duplet, subtracting ''x'' from first pixel and ''y'' from second.
|}

===== Subcommands, part 2: repeat operations =====

Sometimes these repeat commands will try to copy more than what is available when the command is read. In those cases, the command repeats the available segment of data until the number of duplets needed is copied. Or, equivalently, the command starts copying data that it wrote earlier.

{| border=1 cellpadding=4 cellspacing=0 style="border:1px #000 solid;border-collapse:collapse;"
|- style="background:#CCC"
! Command !! Byte pattern !! Action
|-
|various
|style="font-family:monospace"|1x1xxxmm mmmmmmmm
|
{| border=1 cellspacing=0 style="float:right;border:none;border-collapse:collapse;padding:0px 3px;"
|- style="background:#CCC"
! Command !! n !! r
|-
|style="font-family:monospace"|0xa4 - 0xa7||2||0
|-
|style="font-family:monospace"|0xa8 - 0xab||2||1
|-
|style="font-family:monospace"|0xac - 0xaf||3||0
|-
|style="font-family:monospace"|0xb4 - 0xb7||3||1
|-
|style="font-family:monospace"|0xb8 - 0xbb||4||0
|-
|style="font-family:monospace"|0xbc - 0xbf||4||1
|-
|style="font-family:monospace"|0xe4 - 0xe7||5||0
|-
|style="font-family:monospace"|0xe8 - 0xeb||5||1
|-
|style="font-family:monospace"|0xec - 0xef||6||0
|-
|style="font-family:monospace"|0xf4 - 0xf7||6||1
|-
|style="font-family:monospace"|0xf8 - 0xfb||7||0
|}
Repeat n duplets from relative position -''m'' (given in pixels, not duplets). If ''r'' is 0, another byte follows and the last pixel is set to that value. ''n'' and ''r'' come from the table on the right.
|-
|style="font-family:monospace"|0xfc
|style="font-family:monospace"|0xfc nnnnnrmm mmmmmmmm (p)
|Repeat n+2 duplets from relative position -''m'' (given in pixels, not duplets). If ''r'' is 0, another byte ''p'' follows and the last pixel is set to absolute value ''p''.
|}

=== Secondary Decompression ===
In all Riven images, and some other images, there is no secondary decompression. Instead, the remaining data is just the pixels. For 24bpp images, the pixels are in BGR order. For 8bpp images, there are ''bytes per row'' pixels, so you will have to cut off the remaining bytes at the end of the data (''bytes per row'' - ''bitmap width'').

However, many non-Riven images use the RLE8 compression.

==== RLE8 Compression ====
The RLE8 compression is a rather simple form of RLE. The decoder works by decoding one row at a time, so there will be ''bitmap height'' chunks of data. Each chunk '''''always''''' decodes one row of data.

Per Row:

{| class="structure"
|unsigned short||byte_count
|}

* ''byte_count'' is the amount of bytes that will be used to decode the current row.

The ''byte_count'' should be ignored until later. Until you have completed a row's length of pixels, you must continue decompressing the RLE data.

Each RLE command starts with a byte. The high bit of the data represents whether or not to repeat a pixel or output direct pixels. The bottom 7 bits are the ''run_length'' minus one.

If the high bit is set, read in another byte which represents the pixel to repeat and then output the pixel for the rest of the run. If the high bit is not set, output ''run_length'' absolute pixels from the input stream.

Once you have outputted the correct amount of pixels, you should move ''byte_count'' bytes from the start of the row in the compressed stream.

Other Games

2009-09-10T18:03:05Z

Clone2727: Add notes about old mohawk resource-based games and their resources (though, they usually contain the same as newer Mohawk ones).

Myst and Riven aren't the only games to use the [[Mohawk archive format|Mohawk format]]. In fact, many Broderbund based games use it. Here is a (partial) list of games known to use it:

* In the 1st Degree
* James Discovers Math
* James Explores Math
* Logical Journey of the Zoombinis (aka Zoombinis Logical Journey)
* Maggie's Barnyard Adventure
* The Treehouse
* Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)
* Where in the USA is Carmen Sandiego?
* Where in the World is Carmen Sandiego? (Windows/Mac version)

In addition, various Living Books titles use the format or the [[Old Mohawk archive format|"old" Mohawk format]].

= Video =
All the videos of the original games are QuickTime movies. The later Zoombinis release has Bink videos instead.

The audio codec is raw, signed, 16-bit data in Big Endian format. The video codec, however, is not standard. It has the FourCC 'QkBk' and has description "CDToons". Neither QuickTime nor mplayer/ffmpeg can play this codec and its format is unknown. Some videos still use Cinepak (like "The Chief" videos in Carmen Sandiego).

= Game Specific Information =

== James Discovers/Explores Math ==

=== Resources ===
==== tANM ====
Animation?

==== tMFO ====

== Logical Journey of the Zoombinis ==

=== Resources ===
==== \0SND ====
These are [[Mohawk Sounds]]. Note that they begin with a NULL character.

==== CURS ====
Cursor?

==== SCRB ====
==== SCRS ====
==== NODE ====
==== PATH ====
==== SHPL ====

== Maggie's Barnyard Adventure ==

=== Resources ===
==== tCUR ====
Cursor?

== In the 1st Degree ==
=== Resources ===
==== ASET ====
Unknown. Stands for asset (they are found in ASEETLI1.MHK and ASSETLI2.MHK).

==== ANSW ====
Answer?

==== CLIP ====
Video clip?

==== GADG ====
Gadget?

==== MBAR ====
Menu bar?

==== MENU ====
Menu?

==== MITM ====
==== QSET ====
This is a question set. This links questions together into sort of like a dialogue tree.

(Big Endian Order)

{| class="structure"
|unsigned short||count
|-
|unsigned short||values[count]
|}

* ''count'' is the amount of values the follow.
* ''values'' is an array which is probably a list of QUES/ANSW (need to check).

==== QUES ====
This is a question. It appears to hold data for the text as well as the sound clip associated with it.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||sound
|-
|unsigned short||u1
|-
|unsigned short||u2
|-
|unsigned short||u3
|-
|unsigned short||u4
|-
|unsigned short||u5
|-
|unsigned short||u6
|-
|unsigned short||u7
|-
|unsigned short||u8
|-
|unsigned short||u8
|-
|char *||string
|}

* ''u0'' appears to always be 1. Possibly question count?
* ''sound'' is the sound clip associated with this question.
* ''u1'' is unknown. Always 0?
* ''u2'' is unknown. Possibly the answer to this question?
* ''u3'' is unknown. It's usually 2.
* ''u4'' is unknown. It's usually 100.
* ''u5'' is unknown. It's usually 100.
* ''u6'' is unknown. It's usually 100.
* ''u7'' is unknown. Always 0?
* ''u8'' is unknown. Always 0?
* ''u9'' is unknown. Possibly the answer to this question?
* ''string'' is the null-terminated string representing text for this question.

==== TAPE ====
==== THST ====
==== THTR ====
==== WITN ====
Witness?

== Common Resources ==

==== tBMP ====
All tBMP resources contain a [[Mohawk Bitmaps|Mohawk Bitmap]].

==== tWAV ====
This is a [[Mohawk Sounds]] resource. (Found in all but ''Logical Journey of the Zoombinis'')

==== tPAL ====
This is a palette. It is used outside of tBMP resources as a way to share palette information.

(Big Endian Order)

{| class="structure"
|unsigned short||color_start
|-
|unsigned short||color_count
|}

Following that is ''color_count'' RGBA quads. ''color_start'' is the index at which the RGBA quads start.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''The Treehouse''.

==== tCNT ====
Unknown. The data size is always 4 and follows this format:

(Big Endian Order)

{| class="structure"
|unsigned short||resource_id
|-
|unsigned short||u0
|}

''resource_id'' appears to always equal the tCNT that this belongs to.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''James Discovers Math'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''James Explores Math''.

==== tSCR ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== STRL ====
This is a string list.

{| class="structure"
|byte||string_count
|}

Following that is ''string_count'' NULL-terminated strings. This seems reminiscent of Riven's [[Riven_NAME_resources|NAME resources]].

This is found in ''Logical Journey of the Zoombinis'', ''Where in the World is Carmen Sandiego?'', and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== tBMH ====
These appear to also contain a [[Mohawk Bitmaps|Mohawk Bitmap]].

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== tMID ====
This is a [[Mohawk MIDI]] resource.

This is found in ''Logical Journey of the Zoombinis'', ''James Discovers Math'', ''James Explores Math'', ''In the 1st Degree'', and ''The Treehouse''.

==== REGS ====
Unknown.

This is found in ''Logical Journey of the Zoombinis'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== BYTS ====
This appears to be able to hold multiple things. In DATABASE.MHK, it holds database entries (one large null-terminated string), but elsewhere it appears to be something else.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== INTS ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== BBOX ====
Some sort of boxes? It follows this format:

(Big Endian Order)

{| class="structure"
|byte||rect_count
|}

And then, it has ''rect_count'' rects:

{| class="structure"
|unsigned short||left
|-
|unsigned short||top
|-
|unsigned short||right
|-
|unsigned short||bottom
|}

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== ANI ====
Animation? (Note: Ends in a space character)

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== BITL ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SCRP ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SPR# ====
Sprites?
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== VRSN ====
Version?

In Green Eggs and Ham, it contains these two bytes:
<div align="center" style="color:#008; font-family:monospace; margin:1em">00 02</div>

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SHP# ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SYSX ====
This appears to be a list of MIDI Sysex's. There are only two resources in Zoombini (which are found in MIDIMAP.DAT) and are 1 or 0xFFFF. They are identical. In the 1st Degree has several more in MIDIMAP.DAT.

==== BMAP ====
All BMAP resources contain a [[Mohawk Bitmaps|Mohawk Bitmap]].

==== WAV ====
(Note that the FourCC ends with a space)

There are two variants of the format, one in little endian and one in big endian. You can tell the difference just by looking at the header tag.

{| class="structure"
|2 bytes||tag
|-
|unsigned short||sample_rate
|-
|10 bytes||u0
|-
|unsigned long||sample_size
|}

* ''tag'' is '''Wv''' ('''vW''' if little endian).
* ''sample_rate'' is the sample rate, usually 11127.
* ''u0'' has only been observed as all zeroes, but this is likely analogous to the loop part of the [[Mohawk Sounds|Mohawk sound resource]].
* ''sample_size'' is the size of the sample, usually the rest of the resource

Following this is ''sample_size'' bytes of raw, unsigned, 8-bit PCM data.

==== CTBL ====
Unknown, possibly color table?

Old Mohawk archive format

2009-09-10T17:53:48Z

Clone2727: adding details of the "old" Mohawk archive format, which is clearly the predecessor to the regular ones

Some of the very old Mohawk games do not use exactly the [[Mohawk archive format|same format]] as the rest of the Mohawk games. However, it's really the same thing minus the MHWK headers and the resource table/file table merging. In fact, many of the games using the older format were just ported directly into Mohawk files later with only minor changes.

The files are have the extension <tt>.ibm</tt> or <tt>.mac</tt>, being PC and Mac versions, respectively. The biggest difference between these two are endianness, but there are some other minor differences as well. Throughout this, I will use the same wording as the [[Mohawk archive format|regular archive format]] to show where the differences are. The Name Table is always missing here, but it looks like they left room for it, hence the u0 in each type table entry.

= Windows Format =
All values are in Little Endian format. Including the FourCC's! This is important so that it matches up.

== Header ==
{| class="structure"
|unsigned long||absolute offset of the Resource Dir
|-
|unsigned short||size of Resource Dir (analogous to the size of the File table)
|}

The offset of the resource directory seems to be always 6.

== Type Table ==
At the beginning of the Resource Dir is the Type table.

{| class="structure"
|unsigned short||number of resource types in this file
|}

Entry (one for each type):
{| class="structure"
|4 bytes||resource type (BMAP, WAV (with a space), VRSN etc.)
|-
|unsigned short||offset in Resource Dir of the Resource Table for this type
|-
|unsigned short||u0
|}

The offset is the offset within the Resource Dir, not the absolute offset. u0 appears to always be 0.

== Resource Table ==
Header:
{| class="structure"
|unsigned short||number of resources for this type (number of table entries)
|}

Entry:
{| class="structure"
|unsigned short||resource ID
|-
|unsigned long||absolute offset of resource data block
|-
|unsigned short||resource data size
|-
|unsigned long||u0
|}

This circumvents having the file table, as it stores the offset and length here. u0 appears to always be 0.

= Macintosh Format =
All values are in Big Endian format.

== Header ==
{| class="structure"
|unsigned long||absolute offset of the Resource Dir
|-
|unsigned short||size of Resource Dir (analogous to the size of the File table)
|}

The offset of the resource directory seems to be always 6.

== Type Table ==
At the beginning of the Resource Dir is the Type table.

{| class="structure"
|unsigned short||number of resource types in this file
|}

Entry (one for each type):
{| class="structure"
|4 bytes||resource type (BMAP, WAV (with a space), VRSN etc.)
|-
|unsigned long||offset in Resource Dir of the Resource Table for this type
|-
|unsigned long||u0
|}

The offset is the offset within the Resource Dir, not the absolute offset. u0 appears to always be 0.

== Resource Table ==
Header:
{| class="structure"
|unsigned short||number of resources for this type (number of table entries)
|}

Entry:
{| class="structure"
|unsigned short||resource ID
|-
|unsigned long||absolute offset of resource data block
|-
|byte||resource data size, bits 23-16
|-
|unsigned short||resource data size, bits 15-0
|-
|unsigned long||u0
|-
|byte||u1
|}

This circumvents having the file table, as it stores the offset and length here. u0 and u1 appear to always be 0. u1 is probably for alignment.

Riven variables

2009-08-19T16:02:08Z

Clone2727: /* araw */ remove duplicate entry

{{Riven}}
This page is an attempt to discern the function of every variable in the game.

==a_Data==
====acathstate====
*p_Data var 15
====adoit====
*b_Data var 0, g_Data var 1, j_Data var 5, o_Data var 5, p_Data var 0, r_Data var 1, t_Data var 0
====agehn====
*o_Data var 2, r_Data var 0, t_Data var 7
====aova====
*b_Data var 25, g_Data var 28, j_Data var 12, o_Data var 6, t_Data var 14
====apower====
*b_Data var 45, g_Data var 16, j_Data var 32, t_Data var 31
State of the power provided by the fire-marbles in the huge golden dome. 0=no power, 1=power on. Makes the domes work when set to 1.

====araw====
*b_Data var 24, g_Data var 2, j_Data var 29, r_Data var 4, t_Data var 13

====atemp====
*j_Data var 26
====atrap====
*a_Data var 0
====atrapbook====
*a_Data var 1, o_Data var 3, p_Data var 14, r_Data var 3
====domecheck====
*b_Data var 46, g_Data var 17, j_Data var 35, p_Data var 22, t_Data var 37
Used in dome scope mechanisms. Apparently, *_domecheck() externals set this to let scripts know if the scope button was hit at the right time (0=no, 1=yes).

==b_Data==
====bbacklock====
*b_Data var 21
====bbait====
*b_Data var 39
====bbigbridge====
*b_Data var 6, t_Data var 41
====bbirds====
*b_Data var 36
====bblrarm====
*b_Data var 2
====bblrdoor====
*b_Data var 3
====bblrgrt====
*b_Data var 4
====bblrsw====
*b_Data var 34
====bblrvalve====
*b_Data var 32
====bblrwtr====
*b_Data var 5
Presence of water in the boiler. 0 = empty, 1 = filled.
====bbook====
*b_Data var 44, o_Data var 13
====bbrlever====
*b_Data var 9, t_Data var 40
====bcavedoor====
*b_Data var 16
====bcpipegr====
*b_Data var 26
====bcratergg====
*b_Data var 1
====bdome====
*b_Data var 43
====bdrwr====
*b_Data var 23
====bfans====
*b_Data var 15
====bfmdoor====
*b_Data var 42
====bidvlv====
*b_Data var 30
====blab====
*b_Data var 11
====blabbook====
*b_Data var 28
====blabeye====
*b_Data var 27
====blabfrontdr====
*b_Data var 17
====blabbackdr====
*b_Data var 20
====bfrontlock====
*b_Data var 18
====bheat====
*b_Data var 33
====bmagcar====
*b_Data var 12, g_Data var 7, j_Data var 44
====bpipdr====
*b_Data var 47, j_Data var 43
====bprs====
*b_Data var 37
====bstove====
*b_Data var 29
====btrap====
*b_Data var 35
====bvalve====
*b_Data var 31
Position of the steam valve located at the center of the lake (card 415). 0: steam to the ytram mechanism; 1: steam to the boiler controls; 2: steam to the chipper.

====bvise====
*b_Data var 19
====bytram====
*b_Data var 22
====bytramtime====
*b_Data var 40
====bytrap====
*b_Data var 38
====bytrapped====
*b_Data var 41

==g_Data==
====gbook====
*g_Data var 15, o_Data var 12
====gcathtime====
*g_Data var 26
====gcathstate====
*g_Data var 27
====gdome====
*g_Data var 10
====gemagcar====
*g_Data var 19, j_Data var 39
====gimagecurr====
*g_Data var 13
====gimagemax====
*g_Data var 14
====glkbtns====
*g_Data var 8
====glkbridge====
*g_Data var 9
====glview====
*g_Data var 25
====glviewpos====
*j_Data var 33
====gnmagrot====
*b_Data var 13, g_Data var 4
====gnmagcar====
*b_Data var 14, g_Data var 3
====gpinup====
*g_Data var 11
====gpinpos====
*g_Data var 12
====grview====
*g_Data var 21
====grviewpos====
*g_Data var 22
====gscribe====
*g_Data var 18
====gsubelev====
*g_Data var 0
====gsubdr====
*g_Data var 5
====gwhark====
*g_Data var 6
====gwharktime====
*g_Data var 24

==j_Data==
====jwmagcar====
*g_Data var 20
====jbeetle====
*j_Data var 1
====jbeetlepool====
*j_Data var 23
====jbook====
*j_Data var 31, o_Data var 11
====jbridge1====
*j_Data var 13
Status of the sub dock bridge beneath the village: 0=retracted, 1=extended

====jbridge2====
*j_Data var 14
Status of the sub dock bridge on the path to the village: 0=retracted, 1=extended

====jbridge3====
*j_Data var 15
Status of the sub dock bridge of the gallows: 0=retracted, 1=extended

====jbridge4====
*j_Data var 17
Status of the sub dock bridge of the dock controls: 0=retracted, 1=extended

====jbridge5====
*j_Data var 16
Status of the sub dock bridge of the schoolhouse: 0=retracted, 1=extended

====jccb====
*j_Data var 0
Controls when to play some background bird animations.

====jdome====
*j_Data var 3
====jdrain====
*j_Data var 27
====jgallows====
*j_Data var 9
State of the gallows floor: 0=closed, 1=open.

====jgate====
*j_Data var 2
====jgirl====
*j_Data var 37
====jladder====
*j_Data var 30
====jleftpos====
*j_Data var 47
====jpeek====
*j_Data var 34
====jplaybeetle====
*j_Data var 4
Seems managed by a set of equivalent external commands to control when to play the random beetle movies in the jungle (it is set to 1 in that case).

====jprebel====
*j_Data var 18
====jprisondr====
*j_Data var 11
====jprisonsecdr====
*j_Data var 19
====jrbook====
*j_Data var 22
====jrightpos====
*j_Data var 48
====jsouthpathdr====
*j_Data var 6
====jschooldr====
*j_Data var 42
====jsub====
*j_Data var 10
====jsubdir====
*j_Data var 24
====jsubhatch====
*j_Data var 25
====jsubsw====
*j_Data var 41
====jsunners====
*j_Data var 45, t_Data var 11
====jsunnertime====
*j_Data var 46
====jthronedr====
*j_Data var 7
====jtunneldr====
*j_Data var 21
====jtunnellamps====
*j_Data var 20
====jvillagepeople====
*j_Data var 40
====jwarning====
*j_Data var 8
====jwharkpos====
*j_Data var 49
====jwharkram====
*j_Data var 28
====jwmouth====
*j_Data var 36
State of the whark mouth in the jungle. 0=closed, 1=open.

====jwmagcar====
*j_Data var 38
Presence (1) or absence (0) of the maglev leading to gspit.

====jymagcar====
*j_Data var 50, t_Data var 10

==o_Data==
====oambient====
*o_Data var 1, p_Data var 4
====obutton====
*o_Data var 4
====ocage====
*o_Data var 0, p_Data var 3
====odeskbook====
*o_Data var 7
====omusicplayer====
*o_Data var 8
====ostanddrawer====
*o_Data var 16
====ostove====
*o_Data var 15

==p_Data==
====elevbtn1====
*p_Data var 19
====elevbtn2====
*p_Data var 20
====elevbtn3====
*p_Data var 21
====pbook====
*o_Data var 10, p_Data var 23
====pcage====
*o_Data var 9, p_Data var 2, t_Data var 12
====pcathtime====
*p_Data var 16
====pcathcheck====
*p_Data var 17
====pdome====
*p_Data var 1
====pelevcombo====
*p_Data var 18
====ptemp====
*g_Data var 23

==r_Data==
====rrebel====
*r_Data var 2

Tracks the evolution of events in the rebel age.

====rrebelview====
*r_Data var 5
====rvillagetime====
*r_Data var 6

==t_Data==
====tbars====
*t_Data var 2
====tbeetle====
*t_Data var 28
====tbook====
*o_Data var 14, t_Data var 38
====tbookvalve====
*t_Data var 33
====tcage====
*t_Data var 24
State of the prison at the beginning of the game. 0 = prison closed, 1 = open.

====tcovercombo====
*t_Data var 23
====tdl====
*t_Data var 16
====tdome====
*t_Data var 29
====tdomeelev====
*p_Data var 8, t_Data var 34
====tdomeelevbtn====
*t_Data var 42
====tgatebrhandle====
*t_Data var 36
====tgatebridge====
*t_Data var 17
====tgatestate====
*p_Data var 5, t_Data var 15
====tgridoor====
*p_Data var 12, t_Data var 26
====tgrodoor====
*p_Data var 11, t_Data var 27
====tgrmdoor====
*p_Data var 7, t_Data var 25
====tguard====
*t_Data var 9
====timagedoor====
*t_Data var 1
====tmagcar====
*j_Data var 51, p_Data var 6, t_Data var 3
Presence of the maglev on temple island. 0 = absent, 1 = present.

====tsecdoor====
*p_Data var 9, t_Data var 6
State of the door from the temple tunnel to the temple. 0 = closed, 1 = open.

====tsubbridge====
*p_Data var 13, t_Data var 32
====ttelecover====
*t_Data var 19
State of the star fissure window cover under the telescope. 0 = closed, 1 = open.

====ttelehandle====
*t_Data var 21
Position of the lever controlling telescope direction. 0 = up, 1 = down.

====ttelepin====
*t_Data var 22
State of the telescope safety lever. 0 = locked, 1 = unlocked.

====ttelescope====
*t_Data var 18
Position of the telescope. Seems to range from 1 to 5.

====ttelevalve====
*t_Data var 20
State of the valve feeding steam to the telescope. 0 = off, 1 = on.

====ttemple====
*t_Data var 8
====ttempledoor====
*p_Data var 10, t_Data var 4
State of the huge door from the temple to the maglev. 0 = closed, 1 = open.

====ttunneldoor====
*t_Data var 39
====tviewer====
*t_Data var 5
====twabrvalve====
*t_Data var 35
====twaffle====
*t_Data var 30

==Saved Game Variables==
====all_book====
====auservolume====
The volume set in the options.
====azip====
The state of zip mode. (0=off, 1=on)
====currentcardid====
Current card ID.
====currentstackid====
Current stack ID. See the [[Riven engine overview#Stack ID's in Saved Games|conversion table]].
====doingsetupscreens====
====newpos====
====playerhasbook====
====rivenambients====
====returncardid====
Card ID used to return to after viewing a book on aspit.
====returnstackid====
Stack ID used to return to after viewing a book on aspit. See the [[Riven engine overview#Stack ID's in Saved Games|conversion table]].
====stackvarsinitialized====
====tblue====
====tgreen====
====themarble====
====torange====
====transitionsenabled====
(0=transitions disabled, 1=transitions enabled)
====transitionmode====
Speed of the transitions.
====tred====
====tviolet====
====tyellow====
====waterenabled====
(0=water effects disabled, 1=water effects enabled)

Other Games

2009-08-17T20:52:29Z

Clone2727: /* tPAL */ complete the tPAL specification

Myst and Riven aren't the only games to use the [[Mohawk archive format|Mohawk format]]. In fact, many Broderbund based games use it. Here is a (partial) list of games known to use it:

* Green Eggs and Ham
* In the 1st Degree
* James Discovers Math
* James Explores Math
* Logical Journey of the Zoombinis (aka Zoombinis Logical Journey)
* Maggie's Barnyard Adventure
* The Treehouse
* Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)
* Where in the USA is Carmen Sandiego?
* Where in the World is Carmen Sandiego? (Windows/Mac version)

= Video =
All the videos of the original games are QuickTime movies. The later Zoombinis release has Bink videos instead.

The audio codec is raw, signed, 16-bit data in Big Endian format. The video codec, however, is not standard. It has the FourCC 'QkBk' and has description "CDToons". Neither QuickTime nor mplayer/ffmpeg can play this codec and its format is unknown. Some videos still use Cinepak (like "The Chief" videos in Carmen Sandiego).

= Game Specific Information =

== James Discovers/Explores Math ==

=== Resources ===
==== tANM ====
Animation?

==== tMFO ====

== Logical Journey of the Zoombinis ==

=== Resources ===
==== \0SND ====
These are [[Mohawk Sounds]]. Note that they begin with a NULL character.

==== CURS ====
Cursor?

==== SCRB ====
==== SCRS ====
==== NODE ====
==== PATH ====
==== SHPL ====

== Maggie's Barnyard Adventure ==

=== Resources ===
==== tCUR ====
Cursor?

== In the 1st Degree ==
=== Resources ===
==== ASET ====
Unknown. Stands for asset (they are found in ASEETLI1.MHK and ASSETLI2.MHK).

==== ANSW ====
Answer?

==== CLIP ====
Video clip?

==== GADG ====
Gadget?

==== MBAR ====
Menu bar?

==== MENU ====
Menu?

==== MITM ====
==== QSET ====
This is a question set. This links questions together into sort of like a dialogue tree.

(Big Endian Order)

{| class="structure"
|unsigned short||count
|-
|unsigned short||values[count]
|}

* ''count'' is the amount of values the follow.
* ''values'' is an array which is probably a list of QUES/ANSW (need to check).

==== QUES ====
This is a question. It appears to hold data for the text as well as the sound clip associated with it.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||sound
|-
|unsigned short||u1
|-
|unsigned short||u2
|-
|unsigned short||u3
|-
|unsigned short||u4
|-
|unsigned short||u5
|-
|unsigned short||u6
|-
|unsigned short||u7
|-
|unsigned short||u8
|-
|unsigned short||u8
|-
|char *||string
|}

* ''u0'' appears to always be 1. Possibly question count?
* ''sound'' is the sound clip associated with this question.
* ''u1'' is unknown. Always 0?
* ''u2'' is unknown. Possibly the answer to this question?
* ''u3'' is unknown. It's usually 2.
* ''u4'' is unknown. It's usually 100.
* ''u5'' is unknown. It's usually 100.
* ''u6'' is unknown. It's usually 100.
* ''u7'' is unknown. Always 0?
* ''u8'' is unknown. Always 0?
* ''u9'' is unknown. Possibly the answer to this question?
* ''string'' is the null-terminated string representing text for this question.

==== TAPE ====
==== THST ====
==== THTR ====
==== WITN ====
Witness?

== Common Resources ==

==== tBMP ====
All tBMP resources contain a [[Mohawk Bitmaps|Mohawk Bitmap]].

==== tWAV ====
This is a [[Mohawk Sounds]] resource. (Found in all but ''Logical Journey of the Zoombinis'')

==== tPAL ====
This is a palette. It is used outside of tBMP resources as a way to share palette information.

(Big Endian Order)

{| class="structure"
|unsigned short||color_start
|-
|unsigned short||color_count
|}

Following that is ''color_count'' RGBA quads. ''color_start'' is the index at which the RGBA quads start.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''The Treehouse''.

==== tCNT ====
Unknown. The data size is always 4 and follows this format:

(Big Endian Order)

{| class="structure"
|unsigned short||resource_id
|-
|unsigned short||u0
|}

''resource_id'' appears to always equal the tCNT that this belongs to.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''James Discovers Math'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''James Explores Math''.

==== tSCR ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== STRL ====
This is a string list.

{| class="structure"
|byte||string_count
|}

Following that is ''string_count'' NULL-terminated strings. This seems reminiscent of Riven's [[Riven_NAME_resources|NAME resources]].

This is found in ''Logical Journey of the Zoombinis'', ''Where in the World is Carmen Sandiego?'', and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== tBMH ====
These appear to also contain a [[Mohawk Bitmaps|Mohawk Bitmap]].

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== tMID ====
This is a [[Mohawk MIDI]] resource.

This is found in ''Logical Journey of the Zoombinis'', ''James Discovers Math'', ''James Explores Math'', ''In the 1st Degree'', and ''The Treehouse''.

==== REGS ====
Unknown.

This is found in ''Logical Journey of the Zoombinis'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== BYTS ====
This appears to be able to hold multiple things. In DATABASE.MHK, it holds database entries (one large null-terminated string), but elsewhere it appears to be something else.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== INTS ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== BBOX ====
Some sort of boxes? It follows this format:

(Big Endian Order)

{| class="structure"
|byte||rect_count
|}

And then, it has ''rect_count'' rects:

{| class="structure"
|unsigned short||left
|-
|unsigned short||top
|-
|unsigned short||right
|-
|unsigned short||bottom
|}

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== ANI ====
Animation? (Note: Ends in a space character)

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== BITL ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SCRP ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SPR# ====
Sprites?
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== VRSN ====
Version?

In Green Eggs and Ham, it contains these two bytes:
<div align="center" style="color:#008; font-family:monospace; margin:1em">00 02</div>

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SHP# ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SYSX ====
This appears to be a list of Adlib MIDI commands. There are only two resources in Zoombini (which are found in MIDIMAP.DAT) and are 1 or 0xFFFF. They are identical. In the 1st Degree has several more in MIDIMAP.DAT.

Other Games

2009-08-17T20:50:34Z

Clone2727: /* tBMH */ Mohawk Bitmap here too :P

Myst and Riven aren't the only games to use the [[Mohawk archive format|Mohawk format]]. In fact, many Broderbund based games use it. Here is a (partial) list of games known to use it:

* Green Eggs and Ham
* In the 1st Degree
* James Discovers Math
* James Explores Math
* Logical Journey of the Zoombinis (aka Zoombinis Logical Journey)
* Maggie's Barnyard Adventure
* The Treehouse
* Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)
* Where in the USA is Carmen Sandiego?
* Where in the World is Carmen Sandiego? (Windows/Mac version)

= Video =
All the videos of the original games are QuickTime movies. The later Zoombinis release has Bink videos instead.

The audio codec is raw, signed, 16-bit data in Big Endian format. The video codec, however, is not standard. It has the FourCC 'QkBk' and has description "CDToons". Neither QuickTime nor mplayer/ffmpeg can play this codec and its format is unknown. Some videos still use Cinepak (like "The Chief" videos in Carmen Sandiego).

= Game Specific Information =

== James Discovers/Explores Math ==

=== Resources ===
==== tANM ====
Animation?

==== tMFO ====

== Logical Journey of the Zoombinis ==

=== Resources ===
==== \0SND ====
These are [[Mohawk Sounds]]. Note that they begin with a NULL character.

==== CURS ====
Cursor?

==== SCRB ====
==== SCRS ====
==== NODE ====
==== PATH ====
==== SHPL ====

== Maggie's Barnyard Adventure ==

=== Resources ===
==== tCUR ====
Cursor?

== In the 1st Degree ==
=== Resources ===
==== ASET ====
Unknown. Stands for asset (they are found in ASEETLI1.MHK and ASSETLI2.MHK).

==== ANSW ====
Answer?

==== CLIP ====
Video clip?

==== GADG ====
Gadget?

==== MBAR ====
Menu bar?

==== MENU ====
Menu?

==== MITM ====
==== QSET ====
This is a question set. This links questions together into sort of like a dialogue tree.

(Big Endian Order)

{| class="structure"
|unsigned short||count
|-
|unsigned short||values[count]
|}

* ''count'' is the amount of values the follow.
* ''values'' is an array which is probably a list of QUES/ANSW (need to check).

==== QUES ====
This is a question. It appears to hold data for the text as well as the sound clip associated with it.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||sound
|-
|unsigned short||u1
|-
|unsigned short||u2
|-
|unsigned short||u3
|-
|unsigned short||u4
|-
|unsigned short||u5
|-
|unsigned short||u6
|-
|unsigned short||u7
|-
|unsigned short||u8
|-
|unsigned short||u8
|-
|char *||string
|}

* ''u0'' appears to always be 1. Possibly question count?
* ''sound'' is the sound clip associated with this question.
* ''u1'' is unknown. Always 0?
* ''u2'' is unknown. Possibly the answer to this question?
* ''u3'' is unknown. It's usually 2.
* ''u4'' is unknown. It's usually 100.
* ''u5'' is unknown. It's usually 100.
* ''u6'' is unknown. It's usually 100.
* ''u7'' is unknown. Always 0?
* ''u8'' is unknown. Always 0?
* ''u9'' is unknown. Possibly the answer to this question?
* ''string'' is the null-terminated string representing text for this question.

==== TAPE ====
==== THST ====
==== THTR ====
==== WITN ====
Witness?

== Common Resources ==

==== tBMP ====
All tBMP resources contain a [[Mohawk Bitmaps|Mohawk Bitmap]].

==== tWAV ====
This is a [[Mohawk Sounds]] resource. (Found in all but ''Logical Journey of the Zoombinis'')

==== tPAL ====
This is a palette. Here's what I've worked out so far. It's tied together with tBMP and tBMH.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||color_count
|}

Following that is ''color_count'' RGBA quads.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''The Treehouse''.

==== tCNT ====
Unknown. The data size is always 4 and follows this format:

(Big Endian Order)

{| class="structure"
|unsigned short||resource_id
|-
|unsigned short||u0
|}

''resource_id'' appears to always equal the tCNT that this belongs to.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''James Discovers Math'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''James Explores Math''.

==== tSCR ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== STRL ====
This is a string list.

{| class="structure"
|byte||string_count
|}

Following that is ''string_count'' NULL-terminated strings. This seems reminiscent of Riven's [[Riven_NAME_resources|NAME resources]].

This is found in ''Logical Journey of the Zoombinis'', ''Where in the World is Carmen Sandiego?'', and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== tBMH ====
These appear to also contain a [[Mohawk Bitmaps|Mohawk Bitmap]].

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== tMID ====
This is a [[Mohawk MIDI]] resource.

This is found in ''Logical Journey of the Zoombinis'', ''James Discovers Math'', ''James Explores Math'', ''In the 1st Degree'', and ''The Treehouse''.

==== REGS ====
Unknown.

This is found in ''Logical Journey of the Zoombinis'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== BYTS ====
This appears to be able to hold multiple things. In DATABASE.MHK, it holds database entries (one large null-terminated string), but elsewhere it appears to be something else.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== INTS ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== BBOX ====
Some sort of boxes? It follows this format:

(Big Endian Order)

{| class="structure"
|byte||rect_count
|}

And then, it has ''rect_count'' rects:

{| class="structure"
|unsigned short||left
|-
|unsigned short||top
|-
|unsigned short||right
|-
|unsigned short||bottom
|}

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== ANI ====
Animation? (Note: Ends in a space character)

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== BITL ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SCRP ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SPR# ====
Sprites?
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== VRSN ====
Version?

In Green Eggs and Ham, it contains these two bytes:
<div align="center" style="color:#008; font-family:monospace; margin:1em">00 02</div>

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SHP# ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SYSX ====
This appears to be a list of Adlib MIDI commands. There are only two resources in Zoombini (which are found in MIDIMAP.DAT) and are 1 or 0xFFFF. They are identical. In the 1st Degree has several more in MIDIMAP.DAT.

Other Games

2009-08-17T20:49:28Z

Clone2727: /* tBMP */ tBMP's contain a Mohawk Bitmap

Myst and Riven aren't the only games to use the [[Mohawk archive format|Mohawk format]]. In fact, many Broderbund based games use it. Here is a (partial) list of games known to use it:

* Green Eggs and Ham
* In the 1st Degree
* James Discovers Math
* James Explores Math
* Logical Journey of the Zoombinis (aka Zoombinis Logical Journey)
* Maggie's Barnyard Adventure
* The Treehouse
* Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)
* Where in the USA is Carmen Sandiego?
* Where in the World is Carmen Sandiego? (Windows/Mac version)

= Video =
All the videos of the original games are QuickTime movies. The later Zoombinis release has Bink videos instead.

The audio codec is raw, signed, 16-bit data in Big Endian format. The video codec, however, is not standard. It has the FourCC 'QkBk' and has description "CDToons". Neither QuickTime nor mplayer/ffmpeg can play this codec and its format is unknown. Some videos still use Cinepak (like "The Chief" videos in Carmen Sandiego).

= Game Specific Information =

== James Discovers/Explores Math ==

=== Resources ===
==== tANM ====
Animation?

==== tMFO ====

== Logical Journey of the Zoombinis ==

=== Resources ===
==== \0SND ====
These are [[Mohawk Sounds]]. Note that they begin with a NULL character.

==== CURS ====
Cursor?

==== SCRB ====
==== SCRS ====
==== NODE ====
==== PATH ====
==== SHPL ====

== Maggie's Barnyard Adventure ==

=== Resources ===
==== tCUR ====
Cursor?

== In the 1st Degree ==
=== Resources ===
==== ASET ====
Unknown. Stands for asset (they are found in ASEETLI1.MHK and ASSETLI2.MHK).

==== ANSW ====
Answer?

==== CLIP ====
Video clip?

==== GADG ====
Gadget?

==== MBAR ====
Menu bar?

==== MENU ====
Menu?

==== MITM ====
==== QSET ====
This is a question set. This links questions together into sort of like a dialogue tree.

(Big Endian Order)

{| class="structure"
|unsigned short||count
|-
|unsigned short||values[count]
|}

* ''count'' is the amount of values the follow.
* ''values'' is an array which is probably a list of QUES/ANSW (need to check).

==== QUES ====
This is a question. It appears to hold data for the text as well as the sound clip associated with it.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||sound
|-
|unsigned short||u1
|-
|unsigned short||u2
|-
|unsigned short||u3
|-
|unsigned short||u4
|-
|unsigned short||u5
|-
|unsigned short||u6
|-
|unsigned short||u7
|-
|unsigned short||u8
|-
|unsigned short||u8
|-
|char *||string
|}

* ''u0'' appears to always be 1. Possibly question count?
* ''sound'' is the sound clip associated with this question.
* ''u1'' is unknown. Always 0?
* ''u2'' is unknown. Possibly the answer to this question?
* ''u3'' is unknown. It's usually 2.
* ''u4'' is unknown. It's usually 100.
* ''u5'' is unknown. It's usually 100.
* ''u6'' is unknown. It's usually 100.
* ''u7'' is unknown. Always 0?
* ''u8'' is unknown. Always 0?
* ''u9'' is unknown. Possibly the answer to this question?
* ''string'' is the null-terminated string representing text for this question.

==== TAPE ====
==== THST ====
==== THTR ====
==== WITN ====
Witness?

== Common Resources ==

==== tBMP ====
All tBMP resources contain a [[Mohawk Bitmaps|Mohawk Bitmap]].

==== tWAV ====
This is a [[Mohawk Sounds]] resource. (Found in all but ''Logical Journey of the Zoombinis'')

==== tPAL ====
This is a palette. Here's what I've worked out so far. It's tied together with tBMP and tBMH.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||color_count
|}

Following that is ''color_count'' RGBA quads.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''The Treehouse''.

==== tCNT ====
Unknown. The data size is always 4 and follows this format:

(Big Endian Order)

{| class="structure"
|unsigned short||resource_id
|-
|unsigned short||u0
|}

''resource_id'' appears to always equal the tCNT that this belongs to.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''James Discovers Math'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''James Explores Math''.

==== tSCR ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== STRL ====
This is a string list.

{| class="structure"
|byte||string_count
|}

Following that is ''string_count'' NULL-terminated strings. This seems reminiscent of Riven's [[Riven_NAME_resources|NAME resources]].

This is found in ''Logical Journey of the Zoombinis'', ''Where in the World is Carmen Sandiego?'', and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== tBMH ====
This appears to be identical to the tBMP resources.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== tMID ====
This is a [[Mohawk MIDI]] resource.

This is found in ''Logical Journey of the Zoombinis'', ''James Discovers Math'', ''James Explores Math'', ''In the 1st Degree'', and ''The Treehouse''.

==== REGS ====
Unknown.

This is found in ''Logical Journey of the Zoombinis'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== BYTS ====
This appears to be able to hold multiple things. In DATABASE.MHK, it holds database entries (one large null-terminated string), but elsewhere it appears to be something else.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== INTS ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== BBOX ====
Some sort of boxes? It follows this format:

(Big Endian Order)

{| class="structure"
|byte||rect_count
|}

And then, it has ''rect_count'' rects:

{| class="structure"
|unsigned short||left
|-
|unsigned short||top
|-
|unsigned short||right
|-
|unsigned short||bottom
|}

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== ANI ====
Animation? (Note: Ends in a space character)

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== BITL ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SCRP ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SPR# ====
Sprites?
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== VRSN ====
Version?

In Green Eggs and Ham, it contains these two bytes:
<div align="center" style="color:#008; font-family:monospace; margin:1em">00 02</div>

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SHP# ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SYSX ====
This appears to be a list of Adlib MIDI commands. There are only two resources in Zoombini (which are found in MIDIMAP.DAT) and are 1 or 0xFFFF. They are identical. In the 1st Degree has several more in MIDIMAP.DAT.

Myst WDIB resources

2009-08-17T20:48:13Z

Clone2727: the LZ decompression info has moved to the Mohawk Bitmaps page

{{Myst}}
WDIB resources store compressed images in the original Windows version of Myst, some images in Myst Masterpiece Edition, and cursors.

The data is laid out like this:

{| class="structure"
|-
|unsigned long||uncompressed size
|-
|variable||compressed data
|}

For the compressed data, it uses the same [[Mohawk Bitmaps#LZ Compression|LZ Compression]] as some tBMP's!

Once decoded, a plain uncompressed [http://en.wikipedia.org/wiki/BMP_file_format Windows BMP] is recovered. All in the original Myst are 8bpp. However, some in Myst ME are 24bpp (like the images in Help.dat) but the cursors are still 8bpp.

Mohawk Bitmaps

2009-08-17T20:45:37Z

Clone2727: /* LZ Compression */ add the "thanks" note back

{{Myst}}
{{Riven}}
All observed Mohawk games use a common bitmap format, besides Myst (which uses [[WDIB]] and [[Myst PICT resources|PICT]] images). Mohawk bitmaps are always stored with a tBMP tag. All values are in big endian order. tBMP resources are divided into three chunks: the header, the palette, and the image. Note that the palette is not always present (such as non-Riven 8bpp images and Riven 24bpp images).

== Bitmap Header ==
{| class="structure"
|unsigned short||bitmap width
|-
|unsigned short||bitmap height
|-
|unsigned short||bytes per row
|-
|unsigned short||compression details
|}

* ''bitmap width'' is the width of the bitmap in pixels.
* ''bitmap height'' is the height of the bitmap in pixels.
* ''bytes per row'' is the pitch of the image (bytes in a scan line).
* For ''compression details'', see the next section.

'''Note''': Both ''bitmap width'' and ''bitmap height'' are only valid for the bottom 10 bits (val & 0x3fff, in C). ''bytes per row'' is also the same, but has to remain even (val & 0x3ffe, in C).

=== Compression Details ===
''compression details'' is split up into different sections, depending on their purpose.

==== Bits 0-2 (Bits Per Pixel) ====
The lower three bits represent the images' bit depth. It is chosen from this table.

{| border="1"
|- style="background:silver"
|Value||Bits Per Pixel
|-
|0||1
|-
|1||4
|-
|2||8
|-
|3||16
|-
|4||24
|}

Other values are undefined.

==== Bit 3 (Palette) ====
Bit 3 represents whether or not a palette will occur. However, this is very unreliable, as Riven never has this bit set. If the game is Riven, and the bit depth is 8, you should assume there is a palette.

==== Bits 4-7 (Secondary Compression) ====
Bits 4-7 represent the secondary compression on the image.

{| border="1"
|- style="background:silver"
|Value||Secondary Compression
|-
|0||None
|-
|16||RLE8
|}

For none, the image is raw pixels. However, there are ''bytes per row'' bytes per row, so you have to skip remaining bytes at the end of the row. In Riven, there is always no secondary compression. On the contrary, in almost all other games' images, the compression is RLE8.

==== Bits 8-11 (Primary Compression) ====
Bits 8-11 represent the primary compression on the image.

{| border="1"
|- style="background:silver"
|Value||Secondary Compression
|-
|0||None
|-
|1||LZ
|-
|4||Riven
|}

For none, there is nothing to do at this stage. See details later for the LZ and Riven compression schemes.

== Palette ==
While bit 3 should represent whether a palette exists or not, all 8bpp Riven images have a palette regardless. The palette starts with a short header:

{| class="structure"
|unsigned short||table_size
|-
|byte||bits_per_color
|-
|byte||color_count
|}

* ''table_size'' is the size of the table, including the four byte header.
* ''bits_per_color'' is the bits that each color is (seems to be always 24)
* ''color_count'' is the amount of colors that the table contains (seems to be always 0xff)

Following the header is ''color_count'' blocks:

{| class="structure"
|byte||blue_component
|-
|byte||green_component
|-
|byte||red_component
|}

== Image ==

The rest of the tBMP resource is made up of the image. To decode the image, you must first use the primary decompression and then the secondary decompression to have the correct output image.

=== Primary Decompression ===

If the image has no primary decompression you can skip this step.

==== LZ Decompression ====

The stream consists of two parts, the header and the compressed data.

===== LZ Header =====

{| class="structure"
|unsigned long||uncompressed_size
|-
|unsigned long||compressed_size
|-
|unsigned short||dictionary_size
|}

* ''uncompressed_size'' is the size of the data after decompressing.
* ''compressed_size'' is the size of the data before decompressing.
* ''dictionary_size'' is the size of the ring buffer to use in the decompressor. However, it is '''''always''''' 0x400, and if it's not 0x400, it should be thrown out.

===== LZ Compression =====
Thanks to Petroff Heroj and Ron Hayter for working out this compression.

Until the end of the resource, each run begins with a byte. Each bit of this byte defines what to do next, starting from the least significant one.
* A 1 means an absolute byte follows. Read a byte from the compressed data and store it directly into the uncompressed buffer.
* A 0 means a length/offset pair follows. Read two bytes ''b1'' and ''b2'' from the compressed data. The most significant 6 bits of ''b1'' represent the length of the run minus 3. The 2 least significant bits of ''b1'' and the whole ''b2'' form together a 10-bit offset into the ring buffer, minus 0x42. At this point copy ''length'' bytes from the ring buffer, starting at ''offset'', to the uncompressed buffer. If ''offset'' is over 0x400 make sure to subtract 0x400 after adding the 0x42, i.e. loop around to the beginning of the ring buffer.
The ring-buffer should be initialized to all zeroes. Remember to store the uncompressed bytes in the ring buffer as well, looping to the beginning after 0x400 bytes.

For example:
<pre>
0xf7 // decoder byte (11110111b)
0x87 // absolute byte
0x73 // absolute byte
0x27 // absolute byte
0x0b // byte 1 of the run data: length = 2 + 3 = 5 (first 6 bits + 3)
0xa9 // byte 2 of the run data: offset = 0x3a9 + 0x42 = 0x3eb
0x27 // absolute byte
0x32 // absolute byte
0x00 // absolute byte
0x4e // absolute byte
</pre>

==== Riven Decompression ====
In compressed tBMP bitmaps, pixels are encoded as a data stream made of variable length commands. Pixels are always decoded in duplets: each command generates at least 2 pixels. The encoding is heavily based on what comes before each command, so even a little decoding bug can cripple the whole image. The commands can appear in any order inside the data stream. The first 4 bytes of the data stream are unknown and can be ignored. Many thanks to Arthur Muller for his precious help in decoding this format.

Like the uncompressed format, sometimes duplets are generated beyond the edge of the image. Use the ''bytes per row'' value to see how many duplets are in each row.

===== Main Commands =====

They are all 1-byte commands, followed by a variable number of arguments.

{| border=1 cellpadding=4 cellspacing=0 style="border:1px #000 solid;border-collapse:collapse;"
|- style="background:#CCC"
! Command !! Action
|-
|style="font-family:monospace"|0x00||End of stream: when reaching it, the decoding is complete. No additional bytes follow. I think some bitmaps don't have this, so just stop when you have decoded enough pixels to fill the image.
|-
|style="font-family:monospace"|0x01 -0x3f||Output ''n'' pixel duplets, where ''n'' is the command value itself. Pixel data comes immediately after the command as 2*''n'' bytes representing direct indices in the 8-bit color table.
|-
|style="font-family:monospace"|0x40-0x7f||Repeat last 2 pixels ''n'' times, where ''n'' = ''command_value'' & 0x3F. No additional bytes follow.
|-
|style="font-family:monospace"|0x80-0xbf||Repeat last 4 pixels ''n'' times, where ''n'' = ''command_value'' & 0x3F. No additional bytes follow.
|-
|style="font-family:monospace"|0xc0-0xff||Begin of a subcommand stream. This is like the main command stream, but contains another set of commands which are somewhat more specific and a bit more complex. This command says that ''command_value'' & 0x3F subcommands will follow. It doesn't generate pixels itself.
|}

===== Subcommands, part 1: arithmetic operations =====
Subcommands are not simply 1-byte values, but are somewhat mixed with their arguments, so the full byte pattern is reported.
{| border=1 cellpadding=4 cellspacing=0 style="border:1px #000 solid;border-collapse:collapse;"
|- style="background:#CCC"
! Command !! Byte pattern !! Action
|-
|style="font-family:monospace"|0x01-0x0f
|style="font-family:monospace"|0000mmmm
|Repeat duplet at relative position -''m'', where ''m'' is given in duplets. So if ''m''=1, repeat the last duplet.
|-
|style="font-family:monospace"|0x10
|style="font-family:monospace"|0x10 p
|Repeat last duplet, but change second pixel to ''p''.
|-
|style="font-family:monospace"|0x11-0x1f
|style="font-family:monospace"|0001mmmm
|Output the first pixel of last duplet, then pixel at relative position -''m''. ''m'' is given in pixels.
|-
|style="font-family:monospace"|0x20-0x2f
|style="font-family:monospace"|0010xxxx
|Repeat last duplet, but add ''x'' to second pixel.
|-
|style="font-family:monospace"|0x30-0x3f
|style="font-family:monospace"|0011xxxx
|Repeat last duplet, but subtract ''x'' to second pixel.
|-
|style="font-family:monospace"|0x40
|style="font-family:monospace"|0x40 p
|Repeat last duplet, but change first pixel to ''p''.
|-
|style="font-family:monospace"|0x41-0x4f
|style="font-family:monospace"|0100mmmm
|Output pixel at relative position -''m'', then second pixel of last duplet.
|-
|style="font-family:monospace"|0x50
|style="font-family:monospace"|0x50 p1 p2
|Output two absolute pixel values, ''p1'' and ''p2''.
|-
|style="font-family:monospace"|0x51-0x57
|style="font-family:monospace"|01010mmm p
|Output pixel at relative position -''m'', then absolute pixel value ''p''.
|-
|style="font-family:monospace"|0x59-0x5f
|style="font-family:monospace"|01011mmm p
|Output absolute pixel value ''p'', then pixel at relative position -''m''.
|-
|style="font-family:monospace"|0x60-0x6f
|style="font-family:monospace"|0110xxxx p
|Output absolute pixel value ''p'', then (second pixel of last duplet) + ''x''.
|-
|style="font-family:monospace"|0x70-0x7f
|style="font-family:monospace"|0111xxxx p
|Output absolute pixel value ''p'', then (second pixel of last duplet) - ''x''.
|-
|style="font-family:monospace"|0x80-0x8f
|style="font-family:monospace"|1000xxxx
|Repeat last duplet adding ''x'' to the first pixel.
|-
|style="font-family:monospace"|0x90-0x9f
|style="font-family:monospace"|1001xxxx p
|Output (first pixel of last duplet) + ''x'', then absolute pixel value ''p''.
|-
|style="font-family:monospace"|0xa0
|style="font-family:monospace"|0xa0 xxxxyyyy
|Repeat last duplet, adding ''x'' to the first pixel and ''y'' to the second.
|-
|style="font-family:monospace"|0xb0
|style="font-family:monospace"|0xb0 xxxxyyyy
|Repeat last duplet, adding ''x'' to the first pixel and subtracting ''y'' from the second.
|-
|style="font-family:monospace"|0xc0-0xcf
|style="font-family:monospace"|1100xxxx
|Repeat last duplet subtracting ''x'' from first pixel.
|-
|style="font-family:monospace"|0xd0-0xdf
|style="font-family:monospace"|1101xxxx p
|Output (first pixel of last duplet) - ''x'', then absolute pixel value ''p''.
|-
|style="font-family:monospace"|0xe0
|style="font-family:monospace"|0xe0 xxxxyyyy
|Repeat last duplet, subtracting ''x'' from first pixel and adding ''y'' to second.
|-
|style="font-family:monospace"|0xf0 and 0xff
|style="font-family:monospace"|0xfx xxxxyyyy
|Repeat last duplet, subtracting ''x'' from first pixel and ''y'' from second.
|}

===== Subcommands, part 2: repeat operations =====

Sometimes these repeat commands will try to copy more than what is available when the command is read. In those cases, the command repeats the available segment of data until the number of duplets needed is copied. Or, equivalently, the command starts copying data that it wrote earlier.

{| border=1 cellpadding=4 cellspacing=0 style="border:1px #000 solid;border-collapse:collapse;"
|- style="background:#CCC"
! Command !! Byte pattern !! Action
|-
|various
|style="font-family:monospace"|1x1xxxmm mmmmmmmm
|
{| border=1 cellspacing=0 style="float:right;border:none;border-collapse:collapse;padding:0px 3px;"
|- style="background:#CCC"
! Command !! n !! r
|-
|style="font-family:monospace"|0xa4 - 0xa7||2||0
|-
|style="font-family:monospace"|0xa8 - 0xab||2||1
|-
|style="font-family:monospace"|0xac - 0xaf||3||0
|-
|style="font-family:monospace"|0xb4 - 0xb7||3||1
|-
|style="font-family:monospace"|0xb8 - 0xbb||4||0
|-
|style="font-family:monospace"|0xbc - 0xbf||4||1
|-
|style="font-family:monospace"|0xe4 - 0xe7||5||0
|-
|style="font-family:monospace"|0xe8 - 0xeb||5||1
|-
|style="font-family:monospace"|0xec - 0xef||6||0
|-
|style="font-family:monospace"|0xf4 - 0xf7||6||1
|-
|style="font-family:monospace"|0xf8 - 0xfb||7||0
|}
Repeat n duplets from relative position -''m'' (given in pixels, not duplets). If ''r'' is 0, another byte follows and the last pixel is set to that value. ''n'' and ''r'' come from the table on the right.
|-
|style="font-family:monospace"|0xfc
|style="font-family:monospace"|0xfc nnnnnrmm mmmmmmmm (p)
|Repeat n+2 duplets from relative position -''m'' (given in pixels, not duplets). If ''r'' is 0, another byte ''p'' follows and the last pixel is set to absolute value ''p''.
|}

=== Secondary Decompression ===
In all Riven images, and some other images, there is no secondary decompression. Instead, the remaining data is just the pixels. For 24bpp images, the pixels are in BGR order. For 8bpp images, there are ''bytes per row'' pixels, so you will have to cut off the remaining bytes at the end of the data (''bytes per row'' - ''bitmap width'').

However, many non-Riven images use the RLE8 compression.

==== RLE8 Compression ====
The RLE8 compression is a rather simple form of RLE. The decoder works by decoding one row at a time, so there will be ''bitmap height'' chunks of data. Each chunk '''''always''''' decodes one row of data.

Per Row:

{| class="structure"
|unsigned short||byte_count
|}

* ''byte_count'' is the amount of bytes that will be used to decode the current row.

The ''byte_count'' should be ignored until later. Until you have completed a row's length of pixels, you must continue decompressing the RLE data.

Each RLE command starts with a byte. The high bit of the data represents whether or not to repeat a pixel or output direct pixels. The bottom 7 bits are the ''run_length'' minus one.

If the high bit is set, read in another byte which represents the pixel to repeat and then output the pixel for the rest of the run. If the high bit is not set, output ''run_length'' absolute pixels from the input stream.

Once you have outputted the correct amount of pixels, you should move ''byte_count'' bytes from the start of the row in the compressed stream.

Riven tBMP resources

2009-08-17T20:44:22Z

Clone2727: Most of the Riven tBMP info has been moved to the Mohawk Bitmaps page

{{Riven}}
Riven tBMP resources contain a [[Mohawk Bitmaps|Mohawk Bitmap]]. All images in Riven are 8bpp, except for tBMP 24 in b2_Data.mhk (which is used in the developer's slideshow, accessible from the [[Riven debug shell]]).

Mohawk Bitmaps

2009-08-17T20:41:38Z

Clone2727: It's been a while... but here's the (mostly) complete Mohawk bitmap documentation! All tBMP's should be able to be correctly decoded using this information.

{{Myst}}
{{Riven}}
All observed Mohawk games use a common bitmap format, besides Myst (which uses [[WDIB]] and [[Myst PICT resources|PICT]] images). Mohawk bitmaps are always stored with a tBMP tag. All values are in big endian order. tBMP resources are divided into three chunks: the header, the palette, and the image. Note that the palette is not always present (such as non-Riven 8bpp images and Riven 24bpp images).

== Bitmap Header ==
{| class="structure"
|unsigned short||bitmap width
|-
|unsigned short||bitmap height
|-
|unsigned short||bytes per row
|-
|unsigned short||compression details
|}

* ''bitmap width'' is the width of the bitmap in pixels.
* ''bitmap height'' is the height of the bitmap in pixels.
* ''bytes per row'' is the pitch of the image (bytes in a scan line).
* For ''compression details'', see the next section.

'''Note''': Both ''bitmap width'' and ''bitmap height'' are only valid for the bottom 10 bits (val & 0x3fff, in C). ''bytes per row'' is also the same, but has to remain even (val & 0x3ffe, in C).

=== Compression Details ===
''compression details'' is split up into different sections, depending on their purpose.

==== Bits 0-2 (Bits Per Pixel) ====
The lower three bits represent the images' bit depth. It is chosen from this table.

{| border="1"
|- style="background:silver"
|Value||Bits Per Pixel
|-
|0||1
|-
|1||4
|-
|2||8
|-
|3||16
|-
|4||24
|}

Other values are undefined.

==== Bit 3 (Palette) ====
Bit 3 represents whether or not a palette will occur. However, this is very unreliable, as Riven never has this bit set. If the game is Riven, and the bit depth is 8, you should assume there is a palette.

==== Bits 4-7 (Secondary Compression) ====
Bits 4-7 represent the secondary compression on the image.

{| border="1"
|- style="background:silver"
|Value||Secondary Compression
|-
|0||None
|-
|16||RLE8
|}

For none, the image is raw pixels. However, there are ''bytes per row'' bytes per row, so you have to skip remaining bytes at the end of the row. In Riven, there is always no secondary compression. On the contrary, in almost all other games' images, the compression is RLE8.

==== Bits 8-11 (Primary Compression) ====
Bits 8-11 represent the primary compression on the image.

{| border="1"
|- style="background:silver"
|Value||Secondary Compression
|-
|0||None
|-
|1||LZ
|-
|4||Riven
|}

For none, there is nothing to do at this stage. See details later for the LZ and Riven compression schemes.

== Palette ==
While bit 3 should represent whether a palette exists or not, all 8bpp Riven images have a palette regardless. The palette starts with a short header:

{| class="structure"
|unsigned short||table_size
|-
|byte||bits_per_color
|-
|byte||color_count
|}

* ''table_size'' is the size of the table, including the four byte header.
* ''bits_per_color'' is the bits that each color is (seems to be always 24)
* ''color_count'' is the amount of colors that the table contains (seems to be always 0xff)

Following the header is ''color_count'' blocks:

{| class="structure"
|byte||blue_component
|-
|byte||green_component
|-
|byte||red_component
|}

== Image ==

The rest of the tBMP resource is made up of the image. To decode the image, you must first use the primary decompression and then the secondary decompression to have the correct output image.

=== Primary Decompression ===

If the image has no primary decompression you can skip this step.

==== LZ Decompression ====

The stream consists of two parts, the header and the compressed data.

===== LZ Header =====

{| class="structure"
|unsigned long||uncompressed_size
|-
|unsigned long||compressed_size
|-
|unsigned short||dictionary_size
|}

* ''uncompressed_size'' is the size of the data after decompressing.
* ''compressed_size'' is the size of the data before decompressing.
* ''dictionary_size'' is the size of the ring buffer to use in the decompressor. However, it is '''''always''''' 0x400, and if it's not 0x400, it should be thrown out.

===== LZ Compression =====
Until the end of the resource, each run begins with a byte. Each bit of this byte defines what to do next, starting from the least significant one.
* A 1 means an absolute byte follows. Read a byte from the compressed data and store it directly into the uncompressed buffer.
* A 0 means a length/offset pair follows. Read two bytes ''b1'' and ''b2'' from the compressed data. The most significant 6 bits of ''b1'' represent the length of the run minus 3. The 2 least significant bits of ''b1'' and the whole ''b2'' form together a 10-bit offset into the ring buffer, minus 0x42. At this point copy ''length'' bytes from the ring buffer, starting at ''offset'', to the uncompressed buffer. If ''offset'' is over 0x400 make sure to subtract 0x400 after adding the 0x42, i.e. loop around to the beginning of the ring buffer.
The ring-buffer should be initialized to all zeroes. Remember to store the uncompressed bytes in the ring buffer as well, looping to the beginning after 0x400 bytes.

For example:
<pre>
0xf7 // decoder byte (11110111b)
0x87 // absolute byte
0x73 // absolute byte
0x27 // absolute byte
0x0b // byte 1 of the run data: length = 2 + 3 = 5 (first 6 bits + 3)
0xa9 // byte 2 of the run data: offset = 0x3a9 + 0x42 = 0x3eb
0x27 // absolute byte
0x32 // absolute byte
0x00 // absolute byte
0x4e // absolute byte
</pre>

==== Riven Decompression ====
In compressed tBMP bitmaps, pixels are encoded as a data stream made of variable length commands. Pixels are always decoded in duplets: each command generates at least 2 pixels. The encoding is heavily based on what comes before each command, so even a little decoding bug can cripple the whole image. The commands can appear in any order inside the data stream. The first 4 bytes of the data stream are unknown and can be ignored. Many thanks to Arthur Muller for his precious help in decoding this format.

Like the uncompressed format, sometimes duplets are generated beyond the edge of the image. Use the ''bytes per row'' value to see how many duplets are in each row.

===== Main Commands =====

They are all 1-byte commands, followed by a variable number of arguments.

{| border=1 cellpadding=4 cellspacing=0 style="border:1px #000 solid;border-collapse:collapse;"
|- style="background:#CCC"
! Command !! Action
|-
|style="font-family:monospace"|0x00||End of stream: when reaching it, the decoding is complete. No additional bytes follow. I think some bitmaps don't have this, so just stop when you have decoded enough pixels to fill the image.
|-
|style="font-family:monospace"|0x01 -0x3f||Output ''n'' pixel duplets, where ''n'' is the command value itself. Pixel data comes immediately after the command as 2*''n'' bytes representing direct indices in the 8-bit color table.
|-
|style="font-family:monospace"|0x40-0x7f||Repeat last 2 pixels ''n'' times, where ''n'' = ''command_value'' & 0x3F. No additional bytes follow.
|-
|style="font-family:monospace"|0x80-0xbf||Repeat last 4 pixels ''n'' times, where ''n'' = ''command_value'' & 0x3F. No additional bytes follow.
|-
|style="font-family:monospace"|0xc0-0xff||Begin of a subcommand stream. This is like the main command stream, but contains another set of commands which are somewhat more specific and a bit more complex. This command says that ''command_value'' & 0x3F subcommands will follow. It doesn't generate pixels itself.
|}

===== Subcommands, part 1: arithmetic operations =====
Subcommands are not simply 1-byte values, but are somewhat mixed with their arguments, so the full byte pattern is reported.
{| border=1 cellpadding=4 cellspacing=0 style="border:1px #000 solid;border-collapse:collapse;"
|- style="background:#CCC"
! Command !! Byte pattern !! Action
|-
|style="font-family:monospace"|0x01-0x0f
|style="font-family:monospace"|0000mmmm
|Repeat duplet at relative position -''m'', where ''m'' is given in duplets. So if ''m''=1, repeat the last duplet.
|-
|style="font-family:monospace"|0x10
|style="font-family:monospace"|0x10 p
|Repeat last duplet, but change second pixel to ''p''.
|-
|style="font-family:monospace"|0x11-0x1f
|style="font-family:monospace"|0001mmmm
|Output the first pixel of last duplet, then pixel at relative position -''m''. ''m'' is given in pixels.
|-
|style="font-family:monospace"|0x20-0x2f
|style="font-family:monospace"|0010xxxx
|Repeat last duplet, but add ''x'' to second pixel.
|-
|style="font-family:monospace"|0x30-0x3f
|style="font-family:monospace"|0011xxxx
|Repeat last duplet, but subtract ''x'' to second pixel.
|-
|style="font-family:monospace"|0x40
|style="font-family:monospace"|0x40 p
|Repeat last duplet, but change first pixel to ''p''.
|-
|style="font-family:monospace"|0x41-0x4f
|style="font-family:monospace"|0100mmmm
|Output pixel at relative position -''m'', then second pixel of last duplet.
|-
|style="font-family:monospace"|0x50
|style="font-family:monospace"|0x50 p1 p2
|Output two absolute pixel values, ''p1'' and ''p2''.
|-
|style="font-family:monospace"|0x51-0x57
|style="font-family:monospace"|01010mmm p
|Output pixel at relative position -''m'', then absolute pixel value ''p''.
|-
|style="font-family:monospace"|0x59-0x5f
|style="font-family:monospace"|01011mmm p
|Output absolute pixel value ''p'', then pixel at relative position -''m''.
|-
|style="font-family:monospace"|0x60-0x6f
|style="font-family:monospace"|0110xxxx p
|Output absolute pixel value ''p'', then (second pixel of last duplet) + ''x''.
|-
|style="font-family:monospace"|0x70-0x7f
|style="font-family:monospace"|0111xxxx p
|Output absolute pixel value ''p'', then (second pixel of last duplet) - ''x''.
|-
|style="font-family:monospace"|0x80-0x8f
|style="font-family:monospace"|1000xxxx
|Repeat last duplet adding ''x'' to the first pixel.
|-
|style="font-family:monospace"|0x90-0x9f
|style="font-family:monospace"|1001xxxx p
|Output (first pixel of last duplet) + ''x'', then absolute pixel value ''p''.
|-
|style="font-family:monospace"|0xa0
|style="font-family:monospace"|0xa0 xxxxyyyy
|Repeat last duplet, adding ''x'' to the first pixel and ''y'' to the second.
|-
|style="font-family:monospace"|0xb0
|style="font-family:monospace"|0xb0 xxxxyyyy
|Repeat last duplet, adding ''x'' to the first pixel and subtracting ''y'' from the second.
|-
|style="font-family:monospace"|0xc0-0xcf
|style="font-family:monospace"|1100xxxx
|Repeat last duplet subtracting ''x'' from first pixel.
|-
|style="font-family:monospace"|0xd0-0xdf
|style="font-family:monospace"|1101xxxx p
|Output (first pixel of last duplet) - ''x'', then absolute pixel value ''p''.
|-
|style="font-family:monospace"|0xe0
|style="font-family:monospace"|0xe0 xxxxyyyy
|Repeat last duplet, subtracting ''x'' from first pixel and adding ''y'' to second.
|-
|style="font-family:monospace"|0xf0 and 0xff
|style="font-family:monospace"|0xfx xxxxyyyy
|Repeat last duplet, subtracting ''x'' from first pixel and ''y'' from second.
|}

===== Subcommands, part 2: repeat operations =====

Sometimes these repeat commands will try to copy more than what is available when the command is read. In those cases, the command repeats the available segment of data until the number of duplets needed is copied. Or, equivalently, the command starts copying data that it wrote earlier.

{| border=1 cellpadding=4 cellspacing=0 style="border:1px #000 solid;border-collapse:collapse;"
|- style="background:#CCC"
! Command !! Byte pattern !! Action
|-
|various
|style="font-family:monospace"|1x1xxxmm mmmmmmmm
|
{| border=1 cellspacing=0 style="float:right;border:none;border-collapse:collapse;padding:0px 3px;"
|- style="background:#CCC"
! Command !! n !! r
|-
|style="font-family:monospace"|0xa4 - 0xa7||2||0
|-
|style="font-family:monospace"|0xa8 - 0xab||2||1
|-
|style="font-family:monospace"|0xac - 0xaf||3||0
|-
|style="font-family:monospace"|0xb4 - 0xb7||3||1
|-
|style="font-family:monospace"|0xb8 - 0xbb||4||0
|-
|style="font-family:monospace"|0xbc - 0xbf||4||1
|-
|style="font-family:monospace"|0xe4 - 0xe7||5||0
|-
|style="font-family:monospace"|0xe8 - 0xeb||5||1
|-
|style="font-family:monospace"|0xec - 0xef||6||0
|-
|style="font-family:monospace"|0xf4 - 0xf7||6||1
|-
|style="font-family:monospace"|0xf8 - 0xfb||7||0
|}
Repeat n duplets from relative position -''m'' (given in pixels, not duplets). If ''r'' is 0, another byte follows and the last pixel is set to that value. ''n'' and ''r'' come from the table on the right.
|-
|style="font-family:monospace"|0xfc
|style="font-family:monospace"|0xfc nnnnnrmm mmmmmmmm (p)
|Repeat n+2 duplets from relative position -''m'' (given in pixels, not duplets). If ''r'' is 0, another byte ''p'' follows and the last pixel is set to absolute value ''p''.
|}

=== Secondary Decompression ===
In all Riven images, and some other images, there is no secondary decompression. Instead, the remaining data is just the pixels. For 24bpp images, the pixels are in BGR order. For 8bpp images, there are ''bytes per row'' pixels, so you will have to cut off the remaining bytes at the end of the data (''bytes per row'' - ''bitmap width'').

However, many non-Riven images use the RLE8 compression.

==== RLE8 Compression ====
The RLE8 compression is a rather simple form of RLE. The decoder works by decoding one row at a time, so there will be ''bitmap height'' chunks of data. Each chunk '''''always''''' decodes one row of data.

Per Row:

{| class="structure"
|unsigned short||byte_count
|}

* ''byte_count'' is the amount of bytes that will be used to decode the current row.

The ''byte_count'' should be ignored until later. Until you have completed a row's length of pixels, you must continue decompressing the RLE data.

Each RLE command starts with a byte. The high bit of the data represents whether or not to repeat a pixel or output direct pixels. The bottom 7 bits are the ''run_length'' minus one.

If the high bit is set, read in another byte which represents the pixel to repeat and then output the pixel for the rest of the run. If the high bit is not set, output ''run_length'' absolute pixels from the input stream.

Once you have outputted the correct amount of pixels, you should move ''byte_count'' bytes from the start of the row in the compressed stream.

Riven debug shell

2009-06-07T21:08:04Z

Clone2727: some updates

The original Riven engine features a built-in debug shell with useful capabilities.

It can be activated by typing the string b3hn in the game and then pressing ctrl+tab. A green prompt should appear in the bottom left corner of the game window. This prompt accepts several commands, listed below. After each command the prompt disappears, but it comes out again by just pressing ctrl+tab.

* g <id>: go to card <id>
* gc <id>: go to card, using its RMAP identifier
* gs <stack> [<id>]: go to stack <stack> (e.g. tspit) and to card <id>, if specified
* get <variable>: get the value of a variable
* set <variable> <value>: set the value of a variable
* undo: undoes actions on cur card (autosave must be enabled)
* enable <id>: enable an hotspot
* disable <id>: disable an hotspot
* p: purges all purgeable blocks
* c: compacts entire heap
* pc: purges, then compacts
* mem: returns total free memory
* free: returns physical free memory (excludes virtual)
* debug: toggles a line with useful debug info
* hs: toggle hotspot display
* autosave: toggles autosave-every-card feature
* dump: saves the current card picture to a bmp file
* ipmm: toggles impatient PM mode
* slideshow: show the images from b2_data.mhk with captions
* help: shows the list of commands available

See also the [http://www.mystcommunity.com/board/lofiversion/index.php/t19142.html original source].

Riven VARS resources

2009-06-04T21:03:05Z

Clone2727: fix size of value field

<noinclude>{{Riven}}</noinclude>
The VARS resource is found in Riven saved game files (there is just one). It stores the state of every game variable. The data is just an array of 12-byte records, each representing a variable, with this structure:
{| class="structure"
|unsigned long||u0||
|-
|unsigned long||u1||
|-
|unsigned long||value||class="comment"|Saved variable value
|}

''u0'' starts from 2, and seems to grow when going on with the game; ''u1'' seems to be always 1 or 0. I don't know what these fields mean, they don't seem to be changed by scripts (i.e. they don't tell how many times the variable was written etc).

Fortunately, saved games contain a [[Riven NAME resources|NAME]] resource that labels most variables in the VARS resource. The VARS record index simply matches the NAME one.

The number of records is not constant. If you save different games in different places then new records will appear, usually with ''u1'' = 0 and strange values. However, "known" variables (dome combination, telescope levers state etc) are always at the same record.

Other Games

2009-05-30T18:19:43Z

Clone2727: Where in the USA is Carmen Sandiego also uses Mohawk

Myst and Riven aren't the only games to use the [[Mohawk archive format|Mohawk format]]. In fact, many Broderbund based games use it. Here is a (partial) list of games known to use it:

* Green Eggs and Ham
* In the 1st Degree
* James Discovers Math
* James Explores Math
* Logical Journey of the Zoombinis (aka Zoombinis Logical Journey)
* Maggie's Barnyard Adventure
* The Treehouse
* Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)
* Where in the USA is Carmen Sandiego?
* Where in the World is Carmen Sandiego? (Windows/Mac version)

= Video =
All the videos of the original games are QuickTime movies. The later Zoombinis release has Bink videos instead.

The audio codec is raw, signed, 16-bit data in Big Endian format. The video codec, however, is not standard. It has the FourCC 'QkBk' and has description "CDToons". Neither QuickTime nor mplayer/ffmpeg can play this codec and its format is unknown. Some videos still use Cinepak (like "The Chief" videos in Carmen Sandiego).

= Game Specific Information =

== James Discovers/Explores Math ==

=== Resources ===
==== tANM ====
Animation?

==== tMFO ====

== Logical Journey of the Zoombinis ==

=== Resources ===
==== \0SND ====
These are [[Mohawk Sounds]]. Note that they begin with a NULL character.

==== CURS ====
Cursor?

==== SCRB ====
==== SCRS ====
==== NODE ====
==== PATH ====
==== SHPL ====

== Maggie's Barnyard Adventure ==

=== Resources ===
==== tCUR ====
Cursor?

== In the 1st Degree ==
=== Resources ===
==== ASET ====
Unknown. Stands for asset (they are found in ASEETLI1.MHK and ASSETLI2.MHK).

==== ANSW ====
Answer?

==== CLIP ====
Video clip?

==== GADG ====
Gadget?

==== MBAR ====
Menu bar?

==== MENU ====
Menu?

==== MITM ====
==== QSET ====
This is a question set. This links questions together into sort of like a dialogue tree.

(Big Endian Order)

{| class="structure"
|unsigned short||count
|-
|unsigned short||values[count]
|}

* ''count'' is the amount of values the follow.
* ''values'' is an array which is probably a list of QUES/ANSW (need to check).

==== QUES ====
This is a question. It appears to hold data for the text as well as the sound clip associated with it.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||sound
|-
|unsigned short||u1
|-
|unsigned short||u2
|-
|unsigned short||u3
|-
|unsigned short||u4
|-
|unsigned short||u5
|-
|unsigned short||u6
|-
|unsigned short||u7
|-
|unsigned short||u8
|-
|unsigned short||u8
|-
|char *||string
|}

* ''u0'' appears to always be 1. Possibly question count?
* ''sound'' is the sound clip associated with this question.
* ''u1'' is unknown. Always 0?
* ''u2'' is unknown. Possibly the answer to this question?
* ''u3'' is unknown. It's usually 2.
* ''u4'' is unknown. It's usually 100.
* ''u5'' is unknown. It's usually 100.
* ''u6'' is unknown. It's usually 100.
* ''u7'' is unknown. Always 0?
* ''u8'' is unknown. Always 0?
* ''u9'' is unknown. Possibly the answer to this question?
* ''string'' is the null-terminated string representing text for this question.

==== TAPE ====
==== THST ====
==== THTR ====
==== WITN ====
Witness?

== Common Resources ==

==== tBMP ====
Game bitmaps. However, they are not the same as [[Riven tBMP resources|Riven tBMP's]]! Here's what I figured out so far:

(Big Endian Order)

{| class="structure"
|unsigned long||u0
|-
|unsigned long||u1
|-
|unsigned long||uncompressed_size
|-
|unsigned long||compressed_size
|-
|unsigned short||buffer_size
|}

Following this is ''compressed_size'' bytes. These bytes are LZSS compressed data using a buffer size of ''buffer_size'', perhaps similar to the encoding in [[Myst WDIB resources]]. ''uncompressed_size'' seems to chop off extra bytes left over from decoding. ''u0'' and ''u1'' must have something to do with width/height, though I've not figured it out yet. Perhaps an xor encryption to mask its true purpose. ''buffer_size'' also seems to always be 0x400.

The one thing still unknown is the "key" used for decoding. Myst uses the 0x42 key to add to its offsets. I think each game may use a different key. I am still looking into this.

The palette for the image is stored in a tPAL resource.

This is the same in all non-Riven (and non-Myst) games.

==== tWAV ====
This is a [[Mohawk Sounds]] resource. (Found in all but ''Logical Journey of the Zoombinis'')

==== tPAL ====
This is a palette. Here's what I've worked out so far. It's tied together with tBMP and tBMH.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||color_count
|}

Following that is ''color_count'' RGBA quads.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''The Treehouse''.

==== tCNT ====
Unknown. The data size is always 4 and follows this format:

(Big Endian Order)

{| class="structure"
|unsigned short||resource_id
|-
|unsigned short||u0
|}

''resource_id'' appears to always equal the tCNT that this belongs to.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''James Discovers Math'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''James Explores Math''.

==== tSCR ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== STRL ====
This is a string list.

{| class="structure"
|byte||string_count
|}

Following that is ''string_count'' NULL-terminated strings. This seems reminiscent of Riven's [[Riven_NAME_resources|NAME resources]].

This is found in ''Logical Journey of the Zoombinis'', ''Where in the World is Carmen Sandiego?'', and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== tBMH ====
This appears to be identical to the tBMP resources.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== tMID ====
This is a [[Mohawk MIDI]] resource.

This is found in ''Logical Journey of the Zoombinis'', ''James Discovers Math'', ''James Explores Math'', ''In the 1st Degree'', and ''The Treehouse''.

==== REGS ====
Unknown.

This is found in ''Logical Journey of the Zoombinis'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== BYTS ====
This appears to be able to hold multiple things. In DATABASE.MHK, it holds database entries (one large null-terminated string), but elsewhere it appears to be something else.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== INTS ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== BBOX ====
Some sort of boxes? It follows this format:

(Big Endian Order)

{| class="structure"
|byte||rect_count
|}

And then, it has ''rect_count'' rects:

{| class="structure"
|unsigned short||left
|-
|unsigned short||top
|-
|unsigned short||right
|-
|unsigned short||bottom
|}

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== ANI ====
Animation? (Note: Ends in a space character)

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== BITL ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SCRP ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SPR# ====
Sprites?
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== VRSN ====
Version?

In Green Eggs and Ham, it contains these two bytes:
<div align="center" style="color:#008; font-family:monospace; margin:1em">00 02</div>

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SHP# ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SYSX ====
This appears to be a list of Adlib MIDI commands. There are only two resources in Zoombini (which are found in MIDIMAP.DAT) and are 1 or 0xFFFF. They are identical. In the 1st Degree has several more in MIDIMAP.DAT.

User:Clone2727

2009-04-26T17:38:18Z

Clone2727: update

Hi!

== About Me ==
I'm currently working on an engine for [http://www.scummvm.org/ ScummVM] that will run [[Myst engine overview|Myst]], [[Riven engine overview|Riven]], and [[Other Games|other games]] that use the [[Mohawk archive format|Mohawk archives]]. My blog on my progress can be found [http://clone2727.blogspot.com/ here].

While most of [[Riven resources|Riven's resources]] are known, I occasionally add information on them. My main work on the wiki is adding to the non-Riven games. I'll add information mostly as I find out about it.

== Engine Progress ==
=== Myst ===
Can load images, play sounds, and use cursors. Not much else is usable. Myst ME's images are not yet supported (ScummVM can't handle more than 16bpp images anyway).

=== Riven ===
It is highly playable right now. I have a few bugs (most of which I know the problem, I just need to code a solution). Transitions and zip mode have not been implemented. Video is not completely implemented yet (only the parser and decoders are). Some playback is supported. Most external commands are also not implemented yet.

The game is currently playable up until the "Boiler Puzzle." This includes completing Tay.

=== Other Games ===
Only the ability to play their wave sounds are supported.

Other Games

2009-04-25T13:08:45Z

Clone2727: /* Common Resources */ updates on tBMP/tBMH/tPAL in other games

Myst and Riven aren't the only games to use the [[Mohawk archive format|Mohawk format]]. In fact, many Broderbund based games use it. Here is a (partial) list of games known to use it:

* Green Eggs and Ham
* In the 1st Degree
* James Discovers Math
* James Explores Math
* Logical Journey of the Zoombinis (aka Zoombinis Logical Journey)
* Maggie's Barnyard Adventure
* The Treehouse
* Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)
* Where in the World is Carmen Sandiego? (Windows/Mac version)

= Video =
All the videos of the original games are QuickTime movies. The later Zoombinis release has Bink videos instead.

The audio codec is raw, signed, 16-bit data in Big Endian format. The video codec, however, is not standard. It has the FourCC 'QkBk' and has description "CDToons". Neither QuickTime nor mplayer/ffmpeg can play this codec and its format is unknown. Some videos still use Cinepak (like "The Chief" videos in Carmen Sandiego).

= Game Specific Information =

== James Discovers/Explores Math ==

=== Resources ===
==== tANM ====
Animation?

==== tMFO ====

== Logical Journey of the Zoombinis ==

=== Resources ===
==== \0SND ====
These are [[Mohawk Sounds]]. Note that they begin with a NULL character.

==== CURS ====
Cursor?

==== SCRB ====
==== SCRS ====
==== NODE ====
==== PATH ====
==== SHPL ====

== Maggie's Barnyard Adventure ==

=== Resources ===
==== tCUR ====
Cursor?

== In the 1st Degree ==
=== Resources ===
==== ASET ====
Unknown. Stands for asset (they are found in ASEETLI1.MHK and ASSETLI2.MHK).

==== ANSW ====
Answer?

==== CLIP ====
Video clip?

==== GADG ====
Gadget?

==== MBAR ====
Menu bar?

==== MENU ====
Menu?

==== MITM ====
==== QSET ====
This is a question set. This links questions together into sort of like a dialogue tree.

(Big Endian Order)

{| class="structure"
|unsigned short||count
|-
|unsigned short||values[count]
|}

* ''count'' is the amount of values the follow.
* ''values'' is an array which is probably a list of QUES/ANSW (need to check).

==== QUES ====
This is a question. It appears to hold data for the text as well as the sound clip associated with it.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||sound
|-
|unsigned short||u1
|-
|unsigned short||u2
|-
|unsigned short||u3
|-
|unsigned short||u4
|-
|unsigned short||u5
|-
|unsigned short||u6
|-
|unsigned short||u7
|-
|unsigned short||u8
|-
|unsigned short||u8
|-
|char *||string
|}

* ''u0'' appears to always be 1. Possibly question count?
* ''sound'' is the sound clip associated with this question.
* ''u1'' is unknown. Always 0?
* ''u2'' is unknown. Possibly the answer to this question?
* ''u3'' is unknown. It's usually 2.
* ''u4'' is unknown. It's usually 100.
* ''u5'' is unknown. It's usually 100.
* ''u6'' is unknown. It's usually 100.
* ''u7'' is unknown. Always 0?
* ''u8'' is unknown. Always 0?
* ''u9'' is unknown. Possibly the answer to this question?
* ''string'' is the null-terminated string representing text for this question.

==== TAPE ====
==== THST ====
==== THTR ====
==== WITN ====
Witness?

== Common Resources ==

==== tBMP ====
Game bitmaps. However, they are not the same as [[Riven tBMP resources|Riven tBMP's]]! Here's what I figured out so far:

(Big Endian Order)

{| class="structure"
|unsigned long||u0
|-
|unsigned long||u1
|-
|unsigned long||uncompressed_size
|-
|unsigned long||compressed_size
|-
|unsigned short||buffer_size
|}

Following this is ''compressed_size'' bytes. These bytes are LZSS compressed data using a buffer size of ''buffer_size'', perhaps similar to the encoding in [[Myst WDIB resources]]. ''uncompressed_size'' seems to chop off extra bytes left over from decoding. ''u0'' and ''u1'' must have something to do with width/height, though I've not figured it out yet. Perhaps an xor encryption to mask its true purpose. ''buffer_size'' also seems to always be 0x400.

The one thing still unknown is the "key" used for decoding. Myst uses the 0x42 key to add to its offsets. I think each game may use a different key. I am still looking into this.

The palette for the image is stored in a tPAL resource.

This is the same in all non-Riven (and non-Myst) games.

==== tWAV ====
This is a [[Mohawk Sounds]] resource. (Found in all but ''Logical Journey of the Zoombinis'')

==== tPAL ====
This is a palette. Here's what I've worked out so far. It's tied together with tBMP and tBMH.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||color_count
|}

Following that is ''color_count'' RGBA quads.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''The Treehouse''.

==== tCNT ====
Unknown. The data size is always 4 and follows this format:

(Big Endian Order)

{| class="structure"
|unsigned short||resource_id
|-
|unsigned short||u0
|}

''resource_id'' appears to always equal the tCNT that this belongs to.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''James Discovers Math'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''James Explores Math''.

==== tSCR ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== STRL ====
This is a string list.

{| class="structure"
|byte||string_count
|}

Following that is ''string_count'' NULL-terminated strings. This seems reminiscent of Riven's [[Riven_NAME_resources|NAME resources]].

This is found in ''Logical Journey of the Zoombinis'', ''Where in the World is Carmen Sandiego?'', and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== tBMH ====
This appears to be identical to the tBMP resources.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== tMID ====
This is a [[Mohawk MIDI]] resource.

This is found in ''Logical Journey of the Zoombinis'', ''James Discovers Math'', ''James Explores Math'', ''In the 1st Degree'', and ''The Treehouse''.

==== REGS ====
Unknown.

This is found in ''Logical Journey of the Zoombinis'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== BYTS ====
This appears to be able to hold multiple things. In DATABASE.MHK, it holds database entries (one large null-terminated string), but elsewhere it appears to be something else.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== INTS ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== BBOX ====
Some sort of boxes? It follows this format:

(Big Endian Order)

{| class="structure"
|byte||rect_count
|}

And then, it has ''rect_count'' rects:

{| class="structure"
|unsigned short||left
|-
|unsigned short||top
|-
|unsigned short||right
|-
|unsigned short||bottom
|}

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== ANI ====
Animation? (Note: Ends in a space character)

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== BITL ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SCRP ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SPR# ====
Sprites?
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== VRSN ====
Version?

In Green Eggs and Ham, it contains these two bytes:
<div align="center" style="color:#008; font-family:monospace; margin:1em">00 02</div>

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SHP# ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SYSX ====
This appears to be a list of Adlib MIDI commands. There are only two resources in Zoombini (which are found in MIDIMAP.DAT) and are 1 or 0xFFFF. They are identical. In the 1st Degree has several more in MIDIMAP.DAT.

Riven tMOV resources

2009-04-23T02:14:48Z

Clone2727: update link/cleanup

<noinclude>{{Riven}}</noinclude>
tMOV resources are QuickTime movies. For a complete reference of the format, please see [http://developer.apple.com/documentation/QuickTime/QTFF/index.html here].

== Codecs ==

All Riven movies use the Cinepak video codec and the Apple IMA 4:1 audio codec.

== Notes ==

Note that all offsets in the stco chunk are absolute offsets in the Mohawk archive, not offsets within the video as the format specifies.

Riven tMOV resources

2009-04-22T22:46:27Z

Clone2727: Note about offsets. That just killed about 2 hours of my time figuring out...

<noinclude>{{Riven}}</noinclude>
tMOV resources are QuickTime movies. For a complete reference of the format, please see http://developer.apple.com/documentation/QuickTime/QTFF/QTFFPreface/chapter_1_section_1.html.

== Codecs ==

All Riven movies use the Cinepak video codec and the Apple IMA 4:1 audio codec.

== Notes ==

Note that all offsets in the stco chunk are absolute offsets in the Mohawk archive, not offsets within the video as the format specifies.

Talk:Riven tBMP resources

2009-02-26T11:42:00Z

Clone2727: A concurrence. And cleanup.

Aaron, I'm not entirely clear on your recent additions to the tBMP decode algorithms. Are you aware of specific images that exhibit the behaviors you describe to use a test cases, or a decoder implementation which respects those details?

'''[ [[User:TitoDalCanton|TitoDalCanton]] 21:18, 24 February 2009 (CET) ]''' I think I've seen Aaron's effects in some compressed tBMPs. In particular, I recall being surprised by observing duplets repeating themselves, though I don't remember which tBMPs I was inspecting at the time.

'''[ [[User:Aaron|Aaron]] 06:55, 23 February 2009 (CET) ]''' I mean to go back and check specifically for this, but I'm almost completely certain that this is true. Initially, in my algorithm, I used an unsigned integer to represent the number of pixels to look back from where I started, and decremented it each time I copied a pixel. This crippled all my images, and caused weird segfaults when it rolled over after 0. This was fixed when I used a signed integer type (ie let the command copy into newly-written pixels). This is basically an implementation detail, most people would do it a different way where this doesn't matter, or use a signed integer to begin with. [also, I think that pixel-based lookbacks ignore the extra space off the edge, while duplet-based ones do not, but I'm not certain on that. I'll verify that too, but it's too late now.] I didn't realize this was new information, I just thought it was left out.

'''[ [[User:Aaron|Aaron]] 04:21, 24 February 2009 (CET) ]''' OK, I found specific examples. First of all, pixel lookbacks either never happen close enough to new rows to look back into the last row, or they take into account the extra info not in the final image (the bytes per row thing I mentioned in the article), so I'm glad I tried to confirm it before adding it. As for the others, all of these examples are from my original 5-cd riven set, and they're all from b_Data.MHK. tBMPs 99, 101, and 106 (and others) have a higher bytes per row than image width, and only appear correctly when rendered as if they were (bytes per row) wide, then cropped. tBMP 0 (and almost every other compressed image) has many repeat subcommands that ask for more data than there is available at the time. Specifically, byte 165 of the command stream of tBMP 0 is 0xEC followed by 0x08, meaning n = 6 and m = 8, so it needs 12 pixels copied from 8 pixels ago. These images only render correctly when they are allowed to read into themselves. This also happens with repeat command 0xFC. I hope this clarifies things.

'''[ [[User:TitoDalCanton|TitoDalCanton]] 21:18, 24 February 2009 (CET) ]''' I checked my decoder implementation and I can confirm that your interpretation of row bytes is correct. In fact, I decode to a larger buffer (''rowbytes'' pixels wide) and then crop it to ''width'' pixels to get the final image.

'''[ [[User:BahamutZERO|Jean-Francois Roy]] 23:37, 25 February 2009 (PST) ]''' Thanks everyone for the information. MHKKit also uses a row_bytes * height * bytes_per_pixel for image decoding. If Tito's decoder is "correct", in that it produces correct images, I'll validate MHKKit against it. Perhaps post RGBA checksums for some of those tBMP resources for other people can unit test their decoders. Tito, is the source to maglev that you sent me a while ago still up to date?

'''[ [[User:Clone2727|Clone2727]] 12:42, 26 February 2009 (CET) ]''' My decoder does it the way Tito describes above using rowbytes * height. I also have been doing the "overlapping" with commands reading into themselves that Aaron describes. It has a second pointer which looks back and increments as it gets pixel and the actual image pointer increments as well with each new duplet. The images look fine to me.

Riven debug shell

2009-01-28T23:55:12Z

Clone2727: add note about the slideshow command

The original Riven engine features a built-in debug shell with useful capabilities.

It can be activated by typing the string b3hn in the game and then pressing ctrl+tab. A green prompt should appear in the bottom left corner of the game window. This prompt accepts several commands, listed below. After each command the prompt disappears, but it comes out again by just pressing ctrl+tab.

* g <id>: go to card <id>
* gc <id>: go to card, using its RMAP identifier
* gs <stack> [<id>]: go to stack <stack> (e.g. tspit) and to card <id>, if specified
* get <variable>: get the value of a variable
* set <variable> <value>: set the value of a variable
* undo
* enable <id>: enable an hotspot
* disable <id>: disable an hotspot
* p
* c
* pc
* mem: returns total free memory
* free: returns physical free memory (excludes virtual)
* debug: toggles a line with useful debug info
* hs: toggle hotspot display
* autosave
* dump: saves the current card picture to a bmp file
* ipmm
* slideshow: show the images from b2_data.mhk with captions

See also the [http://www.mystcommunity.com/board/lofiversion/index.php/t19142.html original source].

Other Games

2009-01-23T22:11:25Z

Clone2727: basic outline of the QUES format (missing a lot of fields, however)

Myst and Riven aren't the only games to use the [[Mohawk archive format|Mohawk format]]. In fact, many Broderbund based games use it. Here is a (partial) list of games known to use it:

* Green Eggs and Ham
* In the 1st Degree
* James Discovers Math
* James Explores Math
* Logical Journey of the Zoombinis (aka Zoombinis Logical Journey)
* Maggie's Barnyard Adventure
* The Treehouse
* Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)
* Where in the World is Carmen Sandiego? (Windows/Mac version)

= Video =
All the videos of the original games are QuickTime movies. The later Zoombinis release has Bink videos instead.

The audio codec is raw, signed, 16-bit data in Big Endian format. The video codec, however, is not standard. It has the FourCC 'QkBk' and has description "CDToons". Neither QuickTime nor mplayer/ffmpeg can play this codec and its format is unknown. Some videos still use Cinepak (like "The Chief" videos in Carmen Sandiego).

= Game Specific Information =

== James Discovers/Explores Math ==

=== Resources ===
==== tANM ====
Animation?

==== tMFO ====

== Logical Journey of the Zoombinis ==

=== Resources ===
==== \0SND ====
These are [[Mohawk Sounds]]. Note that they begin with a NULL character.

==== CURS ====
Cursor?

==== SCRB ====
==== SCRS ====
==== NODE ====
==== PATH ====
==== SHPL ====

== Maggie's Barnyard Adventure ==

=== Resources ===
==== tCUR ====
Cursor?

== In the 1st Degree ==
=== Resources ===
==== ASET ====
Unknown. Stands for asset (they are found in ASEETLI1.MHK and ASSETLI2.MHK).

==== ANSW ====
Answer?

==== CLIP ====
Video clip?

==== GADG ====
Gadget?

==== MBAR ====
Menu bar?

==== MENU ====
Menu?

==== MITM ====
==== QSET ====
This is a question set. This links questions together into sort of like a dialogue tree.

(Big Endian Order)

{| class="structure"
|unsigned short||count
|-
|unsigned short||values[count]
|}

* ''count'' is the amount of values the follow.
* ''values'' is an array which is probably a list of QUES/ANSW (need to check).

==== QUES ====
This is a question. It appears to hold data for the text as well as the sound clip associated with it.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||sound
|-
|unsigned short||u1
|-
|unsigned short||u2
|-
|unsigned short||u3
|-
|unsigned short||u4
|-
|unsigned short||u5
|-
|unsigned short||u6
|-
|unsigned short||u7
|-
|unsigned short||u8
|-
|unsigned short||u8
|-
|char *||string
|}

* ''u0'' appears to always be 1. Possibly question count?
* ''sound'' is the sound clip associated with this question.
* ''u1'' is unknown. Always 0?
* ''u2'' is unknown. Possibly the answer to this question?
* ''u3'' is unknown. It's usually 2.
* ''u4'' is unknown. It's usually 100.
* ''u5'' is unknown. It's usually 100.
* ''u6'' is unknown. It's usually 100.
* ''u7'' is unknown. Always 0?
* ''u8'' is unknown. Always 0?
* ''u9'' is unknown. Possibly the answer to this question?
* ''string'' is the null-terminated string representing text for this question.

==== TAPE ====
==== THST ====
==== THTR ====
==== WITN ====
Witness?

== Common Resources ==

==== tBMP ====
Game bitmaps. However, they are not the same as [[Riven tBMP resources|Riven tBMP's]]! Here's what I figured out so far:

(Big Endian Order)

{| class="structure"
|unsigned long||u0
|-
|unsigned long||u1
|-
|unsigned long||u2
|-
|unsigned long||data_size
|-
|unsigned short||buffer_size
|}

Following this is ''data_size'' bytes. u0 and u1 are normally close. u2 and data_size are normally close. Following this seems to be LZSS compressed data using a buffer size of ''buffer_size'', perhaps similar to the encoding in [[Myst WDIB resources]].

This is the same in all non-Riven (and non-Myst) games.

==== tWAV ====
This is a [[Mohawk Sounds]] resource. (Found in all but ''Logical Journey of the Zoombinis'')

==== tPAL ====
This appears to be a palette. Here's what I've worked out so far. I believe this may be tied together with tBMH.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||color_count
|}

Following that is ''color_count'' RGBA quads.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''The Treehouse''.

==== tCNT ====
Unknown. The data size is always 4 and follows this format:

(Big Endian Order)

{| class="structure"
|unsigned short||resource_id
|-
|unsigned short||u0
|}

''resource_id'' appears to always equal the tCNT that this belongs to.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''James Discovers Math'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''James Explores Math''.

==== tSCR ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== STRL ====
This is a string list.

{| class="structure"
|byte||string_count
|}

Following that is ''string_count'' NULL-terminated strings. This seems reminiscent of Riven's [[Riven_NAME_resources|NAME resources]].

This is found in ''Logical Journey of the Zoombinis'', ''Where in the World is Carmen Sandiego?'', and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== tBMH ====
This appears to be identical to the tBMP resources found in these games. I believe this may be tied together with tPAL. I also think this may be sprites. The characters in Carmen Sandiego use different palettes on the same sprites to make the look of the person appear different. For example, the palette could change to change hair color, skin color, and clothing.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== tMID ====
This is a [[Mohawk MIDI]] resource.

This is found in ''Logical Journey of the Zoombinis'', ''James Discovers Math'', ''James Explores Math'', ''In the 1st Degree'', and ''The Treehouse''.

==== REGS ====
Unknown.

This is found in ''Logical Journey of the Zoombinis'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== BYTS ====
This appears to be able to hold multiple things. In DATABASE.MHK, it holds database entries (one large null-terminated string), but elsewhere it appears to be something else.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== INTS ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== BBOX ====
Some sort of boxes? It follows this format:

(Big Endian Order)

{| class="structure"
|byte||rect_count
|}

And then, it has ''rect_count'' rects:

{| class="structure"
|unsigned short||left
|-
|unsigned short||top
|-
|unsigned short||right
|-
|unsigned short||bottom
|}

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== ANI ====
Animation? (Note: Ends in a space character)

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== BITL ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SCRP ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SPR# ====
Sprites?
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== VRSN ====
Version?

In Green Eggs and Ham, it contains these two bytes:
<div align="center" style="color:#008; font-family:monospace; margin:1em">00 02</div>

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SHP# ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SYSX ====
This appears to be a list of Adlib MIDI commands. There are only two resources in Zoombini (which are found in MIDIMAP.DAT) and are 1 or 0xFFFF. They are identical. In the 1st Degree has several more in MIDIMAP.DAT.

Other Games

2009-01-22T23:02:20Z

Clone2727: QSET is a question set

Myst and Riven aren't the only games to use the [[Mohawk archive format|Mohawk format]]. In fact, many Broderbund based games use it. Here is a (partial) list of games known to use it:

* Green Eggs and Ham
* In the 1st Degree
* James Discovers Math
* James Explores Math
* Logical Journey of the Zoombinis (aka Zoombinis Logical Journey)
* Maggie's Barnyard Adventure
* The Treehouse
* Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)
* Where in the World is Carmen Sandiego? (Windows/Mac version)

= Video =
All the videos of the original games are QuickTime movies. The later Zoombinis release has Bink videos instead.

The audio codec is raw, signed, 16-bit data in Big Endian format. The video codec, however, is not standard. It has the FourCC 'QkBk' and has description "CDToons". Neither QuickTime nor mplayer/ffmpeg can play this codec and its format is unknown. Some videos still use Cinepak (like "The Chief" videos in Carmen Sandiego).

= Game Specific Information =

== James Discovers/Explores Math ==

=== Resources ===
==== tANM ====
Animation?

==== tMFO ====

== Logical Journey of the Zoombinis ==

=== Resources ===
==== \0SND ====
These are [[Mohawk Sounds]]. Note that they begin with a NULL character.

==== CURS ====
Cursor?

==== SCRB ====
==== SCRS ====
==== NODE ====
==== PATH ====
==== SHPL ====

== Maggie's Barnyard Adventure ==

=== Resources ===
==== tCUR ====
Cursor?

== In the 1st Degree ==
=== Resources ===
==== ASET ====
Unknown. Stands for asset (they are found in ASEETLI1.MHK and ASSETLI2.MHK).

==== ANSW ====
Answer?

==== CLIP ====
Video clip?

==== GADG ====
Gadget?

==== MBAR ====
Menu bar?

==== MENU ====
Menu?

==== MITM ====
==== QSET ====
This is a question set. This links questions together into sort of like a dialogue tree.

(Big Endian Order)

{| class="structure"
|unsigned short||count
|-
|unsigned short||values[count]
|}

* ''count'' is the amount of values the follow.
* ''values'' is an array which is probably a list of QUES/ANSW (need to check).

==== QUES ====
Question?

==== TAPE ====
==== THST ====
==== THTR ====
==== WITN ====
Witness?

== Common Resources ==

==== tBMP ====
Game bitmaps. However, they are not the same as [[Riven tBMP resources|Riven tBMP's]]! Here's what I figured out so far:

(Big Endian Order)

{| class="structure"
|unsigned long||u0
|-
|unsigned long||u1
|-
|unsigned long||u2
|-
|unsigned long||data_size
|-
|unsigned short||buffer_size
|}

Following this is ''data_size'' bytes. u0 and u1 are normally close. u2 and data_size are normally close. Following this seems to be LZSS compressed data using a buffer size of ''buffer_size'', perhaps similar to the encoding in [[Myst WDIB resources]].

This is the same in all non-Riven (and non-Myst) games.

==== tWAV ====
This is a [[Mohawk Sounds]] resource. (Found in all but ''Logical Journey of the Zoombinis'')

==== tPAL ====
This appears to be a palette. Here's what I've worked out so far. I believe this may be tied together with tBMH.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||color_count
|}

Following that is ''color_count'' RGBA quads.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''The Treehouse''.

==== tCNT ====
Unknown. The data size is always 4 and follows this format:

(Big Endian Order)

{| class="structure"
|unsigned short||resource_id
|-
|unsigned short||u0
|}

''resource_id'' appears to always equal the tCNT that this belongs to.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''James Discovers Math'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''James Explores Math''.

==== tSCR ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== STRL ====
This is a string list.

{| class="structure"
|byte||string_count
|}

Following that is ''string_count'' NULL-terminated strings. This seems reminiscent of Riven's [[Riven_NAME_resources|NAME resources]].

This is found in ''Logical Journey of the Zoombinis'', ''Where in the World is Carmen Sandiego?'', and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== tBMH ====
This appears to be identical to the tBMP resources found in these games. I believe this may be tied together with tPAL. I also think this may be sprites. The characters in Carmen Sandiego use different palettes on the same sprites to make the look of the person appear different. For example, the palette could change to change hair color, skin color, and clothing.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== tMID ====
This is a [[Mohawk MIDI]] resource.

This is found in ''Logical Journey of the Zoombinis'', ''James Discovers Math'', ''James Explores Math'', ''In the 1st Degree'', and ''The Treehouse''.

==== REGS ====
Unknown.

This is found in ''Logical Journey of the Zoombinis'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== BYTS ====
This appears to be able to hold multiple things. In DATABASE.MHK, it holds database entries (one large null-terminated string), but elsewhere it appears to be something else.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== INTS ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== BBOX ====
Some sort of boxes? It follows this format:

(Big Endian Order)

{| class="structure"
|byte||rect_count
|}

And then, it has ''rect_count'' rects:

{| class="structure"
|unsigned short||left
|-
|unsigned short||top
|-
|unsigned short||right
|-
|unsigned short||bottom
|}

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== ANI ====
Animation? (Note: Ends in a space character)

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== BITL ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SCRP ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SPR# ====
Sprites?
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== VRSN ====
Version?

In Green Eggs and Ham, it contains these two bytes:
<div align="center" style="color:#008; font-family:monospace; margin:1em">00 02</div>

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SHP# ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SYSX ====
This appears to be a list of Adlib MIDI commands. There are only two resources in Zoombini (which are found in MIDIMAP.DAT) and are 1 or 0xFFFF. They are identical. In the 1st Degree has several more in MIDIMAP.DAT.

Other Games

2009-01-22T22:08:26Z

Clone2727: more updates for In the 1st Degree

Myst and Riven aren't the only games to use the [[Mohawk archive format|Mohawk format]]. In fact, many Broderbund based games use it. Here is a (partial) list of games known to use it:

* Green Eggs and Ham
* In the 1st Degree
* James Discovers Math
* James Explores Math
* Logical Journey of the Zoombinis (aka Zoombinis Logical Journey)
* Maggie's Barnyard Adventure
* The Treehouse
* Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)
* Where in the World is Carmen Sandiego? (Windows/Mac version)

= Video =
All the videos of the original games are QuickTime movies. The later Zoombinis release has Bink videos instead.

The audio codec is raw, signed, 16-bit data in Big Endian format. The video codec, however, is not standard. It has the FourCC 'QkBk' and has description "CDToons". Neither QuickTime nor mplayer/ffmpeg can play this codec and its format is unknown. Some videos still use Cinepak (like "The Chief" videos in Carmen Sandiego).

= Game Specific Information =

== James Discovers/Explores Math ==

=== Resources ===
==== tANM ====
Animation?

==== tMFO ====

== Logical Journey of the Zoombinis ==

=== Resources ===
==== \0SND ====
These are [[Mohawk Sounds]]. Note that they begin with a NULL character.

==== CURS ====
Cursor?

==== SCRB ====
==== SCRS ====
==== NODE ====
==== PATH ====
==== SHPL ====

== Maggie's Barnyard Adventure ==

=== Resources ===
==== tCUR ====
Cursor?

== In the 1st Degree ==
=== Resources ===
==== ASET ====
Unknown. Stands for asset (they are found in ASEETLI1.MHK and ASSETLI2.MHK).

==== ANSW ====
Answer?

==== CLIP ====
Video clip?

==== GADG ====
Gadget?

==== MBAR ====
Menu bar?

==== MENU ====
Menu?

==== MITM ====
==== QSET ====
Question set?

==== QUES ====
Question?

==== TAPE ====
==== THST ====
==== THTR ====
==== WITN ====
Witness?

== Common Resources ==

==== tBMP ====
Game bitmaps. However, they are not the same as [[Riven tBMP resources|Riven tBMP's]]! Here's what I figured out so far:

(Big Endian Order)

{| class="structure"
|unsigned long||u0
|-
|unsigned long||u1
|-
|unsigned long||u2
|-
|unsigned long||data_size
|-
|unsigned short||buffer_size
|}

Following this is ''data_size'' bytes. u0 and u1 are normally close. u2 and data_size are normally close. Following this seems to be LZSS compressed data using a buffer size of ''buffer_size'', perhaps similar to the encoding in [[Myst WDIB resources]].

This is the same in all non-Riven (and non-Myst) games.

==== tWAV ====
This is a [[Mohawk Sounds]] resource. (Found in all but ''Logical Journey of the Zoombinis'')

==== tPAL ====
This appears to be a palette. Here's what I've worked out so far. I believe this may be tied together with tBMH.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||color_count
|}

Following that is ''color_count'' RGBA quads.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''The Treehouse''.

==== tCNT ====
Unknown. The data size is always 4 and follows this format:

(Big Endian Order)

{| class="structure"
|unsigned short||resource_id
|-
|unsigned short||u0
|}

''resource_id'' appears to always equal the tCNT that this belongs to.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''James Discovers Math'', ''Green Eggs and Ham'', ''In the 1st Degree'', and ''James Explores Math''.

==== tSCR ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== STRL ====
This is a string list.

{| class="structure"
|byte||string_count
|}

Following that is ''string_count'' NULL-terminated strings. This seems reminiscent of Riven's [[Riven_NAME_resources|NAME resources]].

This is found in ''Logical Journey of the Zoombinis'', ''Where in the World is Carmen Sandiego?'', and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== tBMH ====
This appears to be identical to the tBMP resources found in these games. I believe this may be tied together with tPAL. I also think this may be sprites. The characters in Carmen Sandiego use different palettes on the same sprites to make the look of the person appear different. For example, the palette could change to change hair color, skin color, and clothing.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== tMID ====
This is a [[Mohawk MIDI]] resource.

This is found in ''Logical Journey of the Zoombinis'', ''James Discovers Math'', ''James Explores Math'', ''In the 1st Degree'', and ''The Treehouse''.

==== REGS ====
Unknown.

This is found in ''Logical Journey of the Zoombinis'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== BYTS ====
This appears to be able to hold multiple things. In DATABASE.MHK, it holds database entries (one large null-terminated string), but elsewhere it appears to be something else.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== INTS ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== BBOX ====
Some sort of boxes? It follows this format:

(Big Endian Order)

{| class="structure"
|byte||rect_count
|}

And then, it has ''rect_count'' rects:

{| class="structure"
|unsigned short||left
|-
|unsigned short||top
|-
|unsigned short||right
|-
|unsigned short||bottom
|}

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== ANI ====
Animation? (Note: Ends in a space character)

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== BITL ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SCRP ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SPR# ====
Sprites?
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== VRSN ====
Version?

In Green Eggs and Ham, it contains these two bytes:
<div align="center" style="color:#008; font-family:monospace; margin:1em">00 02</div>

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SHP# ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SYSX ====
This appears to be a list of Adlib MIDI commands. There are only two resources in Zoombini (which are found in MIDIMAP.DAT) and are 1 or 0xFFFF. They are identical. In the 1st Degree has several more in MIDIMAP.DAT.

Other Games

2009-01-22T21:01:03Z

Clone2727: some info on in the 1st degree

Myst and Riven aren't the only games to use the [[Mohawk archive format|Mohawk format]]. In fact, many Broderbund based games use it. Here is a (partial) list of games known to use it:

* Green Eggs and Ham
* In the 1st Degree
* James Discovers Math
* James Explores Math
* Logical Journey of the Zoombinis (aka Zoombinis Logical Journey)
* Maggie's Barnyard Adventure
* The Treehouse
* Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)
* Where in the World is Carmen Sandiego? (Windows/Mac version)

= Video =
All the videos of the original games are QuickTime movies. The later Zoombinis release has Bink videos instead.

The audio codec is raw, signed, 16-bit data in Big Endian format. The video codec, however, is not standard. It has the FourCC 'QkBk' and has description "CDToons". Neither QuickTime nor mplayer/ffmpeg can play this codec and its format is unknown. Some videos still use Cinepak (like "The Chief" videos in Carmen Sandiego).

= Game Specific Information =

== James Discovers/Explores Math ==

=== Resources ===
==== tANM ====
Animation?

==== tMFO ====

== Logical Journey of the Zoombinis ==

=== Resources ===
==== \0SND ====
These are [[Mohawk Sounds]]. Note that they begin with a NULL character.

==== CURS ====
Cursor?

==== SCRB ====
==== SCRS ====
==== NODE ====
==== PATH ====
==== SHPL ====
==== SYSX ====
This appears to be a list of Adlib MIDI commands. There are only two resources in the game (which are found in MIDIMAP.DAT) and are 1 or 0xFFFF. They are identical.

== Maggie's Barnyard Adventure ==

=== Resources ===
==== tCUR ====
Cursor?

== In the 1st Degree ==
=== Resources ===
==== ASET ====
Unknown. Stands for asset (they are found in assetli1.mhk and assetli2.mhk).

== Common Resources ==

==== tBMP ====
Game bitmaps. However, they are not the same as [[Riven tBMP resources|Riven tBMP's]]! Here's what I figured out so far:

(Big Endian Order)

{| class="structure"
|unsigned long||u0
|-
|unsigned long||u1
|-
|unsigned long||u2
|-
|unsigned long||data_size
|-
|unsigned short||buffer_size
|}

Following this is ''data_size'' bytes. u0 and u1 are normally close. u2 and data_size are normally close. Following this seems to be LZSS compressed data using a buffer size of ''buffer_size'', perhaps similar to the encoding in [[Myst WDIB resources]].

This is the same in all non-Riven (and non-Myst) games.

==== tWAV ====
This is a [[Mohawk Sounds]] resource. (Found in all but ''Logical Journey of the Zoombinis'')

==== tPAL ====
This appears to be a palette. Here's what I've worked out so far. I believe this may be tied together with tBMH.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||color_count
|}

Following that is ''color_count'' RGBA quads.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== tCNT ====
Unknown. The data size is always 4 and follows this format:

(Big Endian Order)

{| class="structure"
|unsigned short||resource_id
|-
|unsigned short||u0
|}

''resource_id'' appears to always equal the tCNT that this belongs to.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''James Discovers Math'', ''Green Eggs and Ham'', and ''James Explores Math''.

==== tSCR ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== STRL ====
This is a string list.

{| class="structure"
|byte||string_count
|}

Following that is ''string_count'' NULL-terminated strings. This seems reminiscent of Riven's [[Riven_NAME_resources|NAME resources]].

This is found in ''Logical Journey of the Zoombinis'', ''Where in the World is Carmen Sandiego?'', and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== tBMH ====
This appears to be identical to the tBMP resources found in these games. I believe this may be tied together with tPAL. I also think this may be sprites. The characters in Carmen Sandiego use different palettes on the same sprites to make the look of the person appear different. For example, the palette could change to change hair color, skin color, and clothing.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== tMID ====
This is a [[Mohawk MIDI]] resource.

This is found in ''Logical Journey of the Zoombinis'', ''James Discovers Math'', ''James Explores Math'', and ''The Treehouse''.

==== REGS ====
Unknown.

This is found in ''Logical Journey of the Zoombinis'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== BYTS ====
This appears to be able to hold multiple things. In DATABASE.MHK, it holds database entries (one large null-terminated string), but elsewhere it appears to be something else.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== INTS ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== BBOX ====
Some sort of boxes? It follows this format:

(Big Endian Order)

{| class="structure"
|byte||rect_count
|}

And then, it has ''rect_count'' rects:

{| class="structure"
|unsigned short||left
|-
|unsigned short||top
|-
|unsigned short||right
|-
|unsigned short||bottom
|}

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== ANI ====
Animation? (Note: Ends in a space character)

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== BITL ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SCRP ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SPR# ====
Sprites?
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== VRSN ====
Version?

In Green Eggs and Ham, it contains these two bytes:
<div align="center" style="color:#008; font-family:monospace; margin:1em">00 02</div>

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SHP# ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

Other Games

2009-01-17T03:49:56Z

Clone2727: /* VRSN */ add example

Myst and Riven aren't the only games to use the [[Mohawk archive format|Mohawk format]]. In fact, many Broderbund based games use it. Here is a (partial) list of games known to use it:

* Green Eggs and Ham
* James Discovers Math
* James Explores Math
* Logical Journey of the Zoombinis (aka Zoombinis Logical Journey)
* Maggie's Barnyard Adventure
* The Treehouse
* Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)
* Where in the World is Carmen Sandiego? (Windows/Mac version)

= Video =
All the videos of the original games are QuickTime movies. The later Zoombinis release has Bink videos instead.

The audio codec is raw, signed, 16-bit data in Big Endian format. The video codec, however, is not standard. It has the FourCC 'QkBk' and has description "CDToons". Neither QuickTime nor mplayer/ffmpeg can play this codec and its format is unknown. Some videos still use Cinepak (like "The Chief" videos in Carmen Sandiego).

= Game Specific Information =

== James Discovers/Explores Math ==

=== Resources ===
==== tANM ====
Animation?

==== tMFO ====

== Logical Journey of the Zoombinis ==

=== Resources ===
==== \0SND ====
These are [[Mohawk Sounds]]. Note that they begin with a NULL character.

==== CURS ====
Cursor?

==== SCRB ====
==== SCRS ====
==== NODE ====
==== PATH ====
==== SHPL ====
==== SYSX ====
This appears to be a list of Adlib MIDI commands. There are only two resources in the game (which are found in MIDIMAP.DAT) and are 1 or 0xFFFF. They are identical.

== Maggie's Barnyard Adventure ==

=== Resources ===
==== tCUR ====
Cursor?

== Common Resources ==

==== tBMP ====
Game bitmaps. However, they are not the same as [[Riven tBMP resources|Riven tBMP's]]! Here's what I figured out so far:

(Big Endian Order)

{| class="structure"
|unsigned long||u0
|-
|unsigned long||u1
|-
|unsigned long||u2
|-
|unsigned long||data_size
|-
|unsigned short||buffer_size
|}

Following this is ''data_size'' bytes. u0 and u1 are normally close. u2 and data_size are normally close. Following this seems to be LZSS compressed data using a buffer size of ''buffer_size'', perhaps similar to the encoding in [[Myst WDIB resources]].

This is the same in all non-Riven (and non-Myst) games.

==== tWAV ====
This is a [[Mohawk Sounds]] resource. (Found in all but ''Logical Journey of the Zoombinis'')

==== tPAL ====
This appears to be a palette. Here's what I've worked out so far. I believe this may be tied together with tBMH.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||color_count
|}

Following that is ''color_count'' RGBA quads.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== tCNT ====
Unknown. The data size is always 4 and follows this format:

(Big Endian Order)

{| class="structure"
|unsigned short||resource_id
|-
|unsigned short||u0
|}

''resource_id'' appears to always equal the tCNT that this belongs to.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''James Discovers Math'', ''Green Eggs and Ham'', and ''James Explores Math''.

==== tSCR ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== STRL ====
This is a string list.

{| class="structure"
|byte||string_count
|}

Following that is ''string_count'' NULL-terminated strings. This seems reminiscent of Riven's [[Riven_NAME_resources|NAME resources]].

This is found in ''Logical Journey of the Zoombinis'', ''Where in the World is Carmen Sandiego?'', and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== tBMH ====
This appears to be identical to the tBMP resources found in these games. I believe this may be tied together with tPAL. I also think this may be sprites. The characters in Carmen Sandiego use different palettes on the same sprites to make the look of the person appear different. For example, the palette could change to change hair color, skin color, and clothing.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== tMID ====
This is a [[Mohawk MIDI]] resource.

This is found in ''Logical Journey of the Zoombinis'', ''James Discovers Math'', ''James Explores Math'', and ''The Treehouse''.

==== REGS ====
Unknown.

This is found in ''Logical Journey of the Zoombinis'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== BYTS ====
This appears to be able to hold multiple things. In DATABASE.MHK, it holds database entries (one large null-terminated string), but elsewhere it appears to be something else.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== INTS ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== BBOX ====
Some sort of boxes? It follows this format:

(Big Endian Order)

{| class="structure"
|byte||rect_count
|}

And then, it has ''rect_count'' rects:

{| class="structure"
|unsigned short||left
|-
|unsigned short||top
|-
|unsigned short||right
|-
|unsigned short||bottom
|}

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== ANI ====
Animation? (Note: Ends in a space character)

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== BITL ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SCRP ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SPR# ====
Sprites?
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== VRSN ====
Version?

In Green Eggs and Ham, it contains these two bytes:
<div align="center" style="color:#008; font-family:monospace; margin:1em">00 02</div>

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SHP# ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

Other Games

2009-01-17T03:26:01Z

Clone2727: some more updates

Myst and Riven aren't the only games to use the [[Mohawk archive format|Mohawk format]]. In fact, many Broderbund based games use it. Here is a (partial) list of games known to use it:

* Green Eggs and Ham
* James Discovers Math
* James Explores Math
* Logical Journey of the Zoombinis (aka Zoombinis Logical Journey)
* Maggie's Barnyard Adventure
* The Treehouse
* Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)
* Where in the World is Carmen Sandiego? (Windows/Mac version)

= Video =
All the videos of the original games are QuickTime movies. The later Zoombinis release has Bink videos instead.

The audio codec is raw, signed, 16-bit data in Big Endian format. The video codec, however, is not standard. It has the FourCC 'QkBk' and has description "CDToons". Neither QuickTime nor mplayer/ffmpeg can play this codec and its format is unknown. Some videos still use Cinepak (like "The Chief" videos in Carmen Sandiego).

= Game Specific Information =

== James Discovers/Explores Math ==

=== Resources ===
==== tANM ====
Animation?

==== tMFO ====

== Logical Journey of the Zoombinis ==

=== Resources ===
==== \0SND ====
These are [[Mohawk Sounds]]. Note that they begin with a NULL character.

==== CURS ====
Cursor?

==== SCRB ====
==== SCRS ====
==== NODE ====
==== PATH ====
==== SHPL ====
==== SYSX ====
This appears to be a list of Adlib MIDI commands. There are only two resources in the game (which are found in MIDIMAP.DAT) and are 1 or 0xFFFF. They are identical.

== Maggie's Barnyard Adventure ==

=== Resources ===
==== tCUR ====
Cursor?

== Common Resources ==

==== tBMP ====
Game bitmaps. However, they are not the same as [[Riven tBMP resources|Riven tBMP's]]! Here's what I figured out so far:

(Big Endian Order)

{| class="structure"
|unsigned long||u0
|-
|unsigned long||u1
|-
|unsigned long||u2
|-
|unsigned long||data_size
|-
|unsigned short||buffer_size
|}

Following this is ''data_size'' bytes. u0 and u1 are normally close. u2 and data_size are normally close. Following this seems to be LZSS compressed data using a buffer size of ''buffer_size'', perhaps similar to the encoding in [[Myst WDIB resources]].

This is the same in all non-Riven (and non-Myst) games.

==== tWAV ====
This is a [[Mohawk Sounds]] resource. (Found in all but ''Logical Journey of the Zoombinis'')

==== tPAL ====
This appears to be a palette. Here's what I've worked out so far. I believe this may be tied together with tBMH.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||color_count
|}

Following that is ''color_count'' RGBA quads.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== tCNT ====
Unknown. The data size is always 4 and follows this format:

(Big Endian Order)

{| class="structure"
|unsigned short||resource_id
|-
|unsigned short||u0
|}

''resource_id'' appears to always equal the tCNT that this belongs to.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''James Discovers Math'', ''Green Eggs and Ham'', and ''James Explores Math''.

==== tSCR ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== STRL ====
This is a string list.

{| class="structure"
|byte||string_count
|}

Following that is ''string_count'' NULL-terminated strings. This seems reminiscent of Riven's [[Riven_NAME_resources|NAME resources]].

This is found in ''Logical Journey of the Zoombinis'', ''Where in the World is Carmen Sandiego?'', and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== tBMH ====
This appears to be identical to the tBMP resources found in these games. I believe this may be tied together with tPAL. I also think this may be sprites. The characters in Carmen Sandiego use different palettes on the same sprites to make the look of the person appear different. For example, the palette could change to change hair color, skin color, and clothing.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== tMID ====
This is a [[Mohawk MIDI]] resource.

This is found in ''Logical Journey of the Zoombinis'', ''James Discovers Math'', ''James Explores Math'', and ''The Treehouse''.

==== REGS ====
Unknown.

This is found in ''Logical Journey of the Zoombinis'', ''Green Eggs and Ham'', and ''The Treehouse''.

==== BYTS ====
This appears to be able to hold multiple things. In DATABASE.MHK, it holds database entries (one large null-terminated string), but elsewhere it appears to be something else.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== INTS ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== BBOX ====
Some sort of boxes? It follows this format:

(Big Endian Order)

{| class="structure"
|byte||rect_count
|}

And then, it has ''rect_count'' rects:

{| class="structure"
|unsigned short||left
|-
|unsigned short||top
|-
|unsigned short||right
|-
|unsigned short||bottom
|}

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== ANI ====
Animation? (Note: Ends in a space character)

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== BITL ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SCRP ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SPR# ====
Sprites?
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== VRSN ====
Version?
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SHP# ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

Other Games

2009-01-17T03:19:56Z

Clone2727: Green Eggs and Ham uses the archives, and update a bit. (Gasp! I'm alive! :P)

Myst and Riven aren't the only games to use the [[Mohawk archive format|Mohawk format]]. In fact, many Broderbund based games use it. Here is a (partial) list of games known to use it:

* Green Eggs and Ham
* James Discovers Math
* James Explores Math
* Logical Journey of the Zoombinis (aka Zoombinis Logical Journey)
* Maggie's Barnyard Adventure
* The Treehouse
* Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)
* Where in the World is Carmen Sandiego? (Windows/Mac version)

= Video =
All the videos of the original games are QuickTime movies. The later Zoombinis release has Bink videos instead.

The audio codec is raw, signed, 16-bit data in Big Endian format. The video codec, however, is not standard. It has the FourCC 'QkBk' and has description "CDToons". Neither QuickTime nor mplayer/ffmpeg can play this codec and its format is unknown. Some videos still use Cinepak (like "The Chief" videos in Carmen Sandiego).

= Game Specific Information =

== James Discovers/Explores Math ==

=== Resources ===
==== tANM ====
Animation?

==== tMFO ====

== Logical Journey of the Zoombinis ==

=== Resources ===
==== \0SND ====
These are [[Mohawk Sounds]]. Note that they begin with a NULL character.

==== CURS ====
Cursor?

==== SCRB ====
==== SCRS ====
==== NODE ====
==== PATH ====
==== SHPL ====
==== SYSX ====
This appears to be a list of Adlib MIDI commands. There are only two resources in the game (which are found in MIDIMAP.DAT) and are 1 or 0xFFFF. They are identical.

== Maggie's Barnyard Adventure ==

=== Resources ===
==== tCUR ====
Cursor?

== Common Resources ==

==== tBMP ====
Game bitmaps. However, they are not the same as [[Riven tBMP resources|Riven tBMP's]]! Here's what I figured out so far:

(Big Endian Order)

{| class="structure"
|unsigned long||u0
|-
|unsigned long||u1
|-
|unsigned long||u2
|-
|unsigned long||data_size
|-
|unsigned short||buffer_size
|}

Following this is ''data_size'' bytes. u0 and u1 are normally close. u2 and data_size are normally close. Following this seems to be LZSS compressed data using a buffer size of ''buffer_size'', perhaps similar to the encoding in [[Myst WDIB resources]].

This is the same in all non-Riven (and non-Myst) games.

==== tWAV ====
This is a [[Mohawk Sounds]] resource. (Found in all but ''Logical Journey of the Zoombinis'')

==== tPAL ====
This appears to be a palette. Here's what I've worked out so far. I believe this may be tied together with tBMH.

(Big Endian Order)

{| class="structure"
|unsigned short||u0
|-
|unsigned short||color_count
|}

Following that is ''color_count'' RGBA quads.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', and ''The Treehouse''.

==== tCNT ====
Unknown. The data size is always 4 and follows this format:

(Big Endian Order)

{| class="structure"
|unsigned short||resource_id
|-
|unsigned short||u0
|}

''resource_id'' appears to always equal the tCNT that this belongs to.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', ''James Discovers Math'', and ''James Explores Math''.

==== tSCR ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', and ''The Treehouse''.

==== STRL ====
This is a string list.

{| class="structure"
|byte||string_count
|}

Following that is ''string_count'' NULL-terminated strings. This seems reminiscent of Riven's [[Riven_NAME_resources|NAME resources]].

This is found in ''Logical Journey of the Zoombinis'', ''Where in the World is Carmen Sandiego?'', and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== tBMH ====
This appears to be identical to the tBMP resources found in these games. I believe this may be tied together with tPAL. I also think this may be sprites. The characters in Carmen Sandiego use different palettes on the same sprites to make the look of the person appear different. For example, the palette could change to change hair color, skin color, and clothing.

This is found in ''Where in the World is Carmen Sandiego?'', ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)'', and ''The Treehouse''.

==== tMID ====
This is a [[Mohawk MIDI]] resource.

This is found in ''Logical Journey of the Zoombinis'', ''James Discovers Math'', ''James Explores Math'', and ''The Treehouse''.

==== REGS ====
Unknown.

This is found in ''Logical Journey of the Zoombinis'', and ''The Treehouse''.

==== BYTS ====
This appears to be able to hold multiple things. In DATABASE.MHK, it holds database entries (one large null-terminated string), but elsewhere it appears to be something else.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== INTS ====
Unknown.

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== BBOX ====
Some sort of boxes? It follows this format:

(Big Endian Order)

{| class="structure"
|byte||rect_count
|}

And then, it has ''rect_count'' rects:

{| class="structure"
|unsigned short||left
|-
|unsigned short||top
|-
|unsigned short||right
|-
|unsigned short||bottom
|}

This is found in ''Where in the World is Carmen Sandiego?'' and ''Where in America is Carmen Sandiego? (The Great Amtrak Train Adventure)''.

==== ANI ====
Animation? (Note: Ends in a space character)

This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== BITL ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SCRP ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SPR# ====
Sprites?
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== VRSN ====
Version?
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

==== SHP# ====
This is found in ''Maggie's Barnyard Adventure'' and ''Green Eggs and Ham''.

Myst scripts

2008-10-22T23:18:51Z

Clone2727: replace some "node" usage with "card"

{{Myst}}
This page describes Myst scripts, command lists used in record types 5, 6, 7, 8, 10, 11, and 12. Scripts always start with an unsigned short representing the command count. Each command has this structure:
{| class="structure"
|unsigned short||opcode
|-
|unsigned short||var
|-
|unsigned short||arg_count
|-
|short||args[arg_count]
|}
When a variable is not given, ''var'' is set to 0. So when the key below says that the variable is ''optional'', that means that it has been found both with and without a variable being passed in. In some cases, the syntax of the arguments depends on whether a variable was passed in. In this case, the variable/arguments header is repeated for each form of the command.

==Commands 0-99==
These are suspected to be general-purpose commands.

===Command 0===
*'''Variable:''' Optional
*'''Arguments:''' None

In some cases it seems to toggle the associated variable between logical "0" and "1" (e.g. see the marker switches on MYST island). However, it's probably more complicated than this: for example, in Mechanical card 6267 it seems to ''increment'' the associated variable.

===Command 1===
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

Could mean "set variable to ''u0''". ''u0'' takes on any number between 0 and 7 (maybe a bit field?)

===Command 2: alternative destination===
*'''Variable:''' Yes
*'''Arguments:''' ''dest''

This command goes to ''dest'' instead of the regular destination if ''var'' is a certain (unknown) value. (Only used for SELEN 1240 and CHANNEL 3359)

===Command 3: change cursor===
*'''Variable:''' Yes
*'''Arguments:''' ''clrc_id''

This is used when picking up pages. Seems to check the associated variable and, depending on its value, set the appropriate cursor and alter the variable itself. ''clrc_id'' is always 800, 801, or 802, which match the cursors of the hand holding the white, red, and blue pages respectively.

===Command 4===
*'''Variable:''' Optional
*'''Arguments:''' None

===Command 6===
*'''Variable:''' Optional
*'''Arguments:''' None

===Command 7===
*'''Variable:''' Optional
*'''Arguments:''' None

===Command 8===
*'''Variable:''' Optional
*'''Arguments:''' None

===Command 9===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is always either ''FFFF'' or omitted.

===Command 12===
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

''Related to [[#Command 13|command 13]]''.

*''u0'' appears to be a nearby card.

This may have similar function to [[#Command 2|command 2]].

===Command 13===
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

''Related to [[#Command 12|command 12]]''.

*''u0'' appears to be a nearby card.

This may have similar function to [[#Command 2|command 2]].

===Command 14===
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

*''u0'' is always 0, 1, or 2.

===Command 15===
*'''Variable:''' Yes
*'''Arguments:''' [''u0'']

*''u0'' is always 0 or omitted.

===Command 16===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' appears to be a nearby card.
*''u1'' is always 0.

===Command 17===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' appears to be a nearby card.
*''u1'' is always 4, 5, or 6.

===Command 18===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is always 4, 5, or 6.

===Command 19: enable hotspots===
*'''Variable:''' No
*'''Arguments:''' ''count'' ''indexes''[''count'']

This seems to enable a list of hotspots, specified by ''indexes''.

===Command 20: disable hotspots===
*'''Variable:''' No
*'''Arguments:''' ''count'' ''indexes''[''count'']

This seems to disable a list of hotspots, specified by ''indexes''. These, unlike [[#Command 19|command 19]], can also be -1, which seems to disable the invoking hotspot.

===Command 21===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2'' ''u3'' ''u4'' ''u5''

There are this command is used 6 times.

*''u0'' is always 0, 74, 76, 117, or 198.
*''u1'' is always 0, 48, 213, or 226.
*''u2'' is always 327, 406, 429, 459, or 544.
*''u3'' is always 257, 332, or 333.
*''u4'' is always 0, 1, 5, 6, or 11.
*''u5'' is always 5 or 25.

===Command 22===
*'''Variable:''' No
*'''Arguments:''' None

===Command 23===
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

The ''u0'' numbers are all 0, 4, or 5. Guess: toggle enable status for a list of hotspots.

===Command 24: play sound, non-blocking===
*'''Variable:''' No
*'''Arguments:''' ''sound_id''

Start sound with ID ''sound_id''. Script execution resumes immediately and the sound plays in the background.

===Command 26===
*'''Variable:''' No
*'''Arguments:''' None

===Command 27: play sound, blocking===
*'''Variable:''' No
*'''Arguments:''' ''sound_id''

Play sound with ID ''sound_id'', blocking script execution until done.

===Command 28===
*'''Variable:''' No
*'''Arguments:''' (<''l t r b''>|''FFFF'')

Often used after command 29. <''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources. Guess: update screen rectangle? See Mechanical card 6009.

===Command 29: copy picture over the hotspot===
*'''Variable:''' No
*'''Arguments:''' ''pict_id'' <''l t r b''> ''u0'' ''u1''

*''pict_id'' appears to be a picture ID.
*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.
*''u0'' appears to be a variable number (it is sometimes 0).
*''u1'' may also be a variable number (it is sometimes 0, 1, or -1).

This command seems to copy picture ''pict_id'' over the hotspot, using <''l'' ''t'' ''r'' ''b''> as the source rect. Additional data is unknown.

===Command 30: start background sounds===
*'''Variable:''' No
*'''Arguments:''' variable

This seems to start a background sound combination. The arg list seems to follow the philosophy of the sounds section in VIEW resources. In most cases there are just 2 args, a positive ''msnd_id'' (background sound ID to play) and ''flags''. However, there is a single exception with 8 args (RLST ID 3225 in Channelwood) which can be correctly interpreted simply as a more complex sounds section.

===Command 31===
*'''Variable:''' Yes (only ever 30)
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is always 0.
*''u1'' looks like a card ID.

===Command 32===
*'''Variable:''' No
*'''Arguments:''' None

===Command 33: draw picture===
*'''Variable:''' No
*'''Arguments:''' ''id'' <''sl st sr sb''> <''dl'' ''dt''>

Draw a picture, given the ID and source rect, at position <''dl'',''dt''>.

===Command 34===
*'''Variable:''' No
*'''Arguments:''' ''card'' ''u1''

Seems to go to card ''card''. ''u1'' is always 0, 1, 4, 5, 6, 9, 10, or 11.

===Command 35===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2''

*''u0'' looks like a card ID.
*''u1'' looks like a card ID.
*''u2'' is always 0, 6, or 10.

===Command 36===
*'''Variable:''' No
*'''Arguments:''' ''u0''

This command is only used twice.

*''u0'' is 900 or 903.

===Command 37===
*'''Variable:''' No
*'''Arguments:''' None

Seems to form pairs with command 38, where it opens the script and command 38 ends it.

===Command 38===
*'''Variable:''' No
*'''Arguments:''' None

Seems to form pairs with command 37, where it closes the script while command 37 opens it.

===Command 39===
*'''Variable:''' No
*'''Arguments:''' ''u0''

''u0'' is 100, 200, 400, 500, 1000, or 1100. Guess: pause execution for ''u0'' milliseconds?

===Command 40: travel to destination age===
*'''Variable:''' No
*'''Arguments:''' ''dst_age_id'' ''src_msnd_id'' ''dst_msnd_id''

*''dst_age_id'' is one of 0 (selen), 1 (stone), 2 (myst), 3 (mechan), 4 (channel) or 6 (dunny).
*''src_msnd_id'' is a sound ID to play in source age.
*''dst_msnd_id'' is a sound ID to play in destination age.

===Command 41===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2'' ''count'' ''u3''[''count'']

*''u0'' looks like a card ID.
*''u1'' looks like a sound ID.
*''u2'' is always 5 or 10.
*''count'' is only ever 6 or 12.
*''u3'' may be divided into groups of sixes.

===Command 42===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''count'' ''u2''[''count'']

*''u0'' looks like a sound ID.
*''u1'' is always 5, 10, 15, or 20.
*''count'' is only ever 6 or 12.
*''u2'' may be divided into groups of sixes.

===Command 43===
*'''Variable:''' No
*'''Arguments:''' None

===Command 44===
*'''Variable:''' No
*'''Arguments:''' None

===Command 46===
*'''Variable:''' No
*'''Arguments:''' None

Often found after commands 29 and 33. Guess: update the whole screen?

==Commands 100-199==
These are suspected to be age-specific, as their syntax changes depending on the age.
===Command 100===
*'''Variable:''' Optional
*'''Arguments:''' [''u0'']

*''u0'' is always 4, 6, or omitted.

===Command 101===
*'''Variable:''' No
*'''Arguments:''' [''u0''|''u1''[6]]

*''u0'' is always 4225 or omitted.
*''u1'' is a series of 6 positive numbers.

===Command 102===
*'''Variable:''' No
*'''Arguments:''' [''u0'' ''u1'' [''u2'']]

*''u0'' looks like a card ID (or 0).
*''u1'' looks like a card ID.
*''u2'' looks like an (optional) bit field. (only 0x64 or 0)

===Command 103===
*'''Variable:''' Yes
*'''Arguments:''' ''bit''

This form of the command most likely negates bit ''bit'' of ''var''.

*''bit'' is a power of 2 (bit mask).

*'''Variable:''' No
*'''Arguments:''' ''u0'' [''u1'']

This form of the command likely makes specified hotspot drawable.

*''u0'' is a number between 13 and 18. It seems to refer to a hotspot index (see stone 2197).
*''u1'' is either 1 or omitted.

===Command 104===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

This command likely makes specified hotspot not drawable.

*''u0'' can be 0, 1, omitted, or 13 to 20. It seems to refer to a hotspot index (see stone 2004 and 2197).

===Command 105===
*'''Variable:''' Optional (set to 9 at one point, but usually not)
*'''Arguments:''' [''u0'']

*''u0'' looks like a sound ID.

===Command 106===
*'''Variable:''' 10
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

===Command 107===
*'''Variable:''' 11
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

===Command 108===
*'''Variable:''' 12
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

===Command 109===
*'''Variable:''' Optional
*'''Arguments:''' [''u0'']

*''u0'' is ''FFFF'', 1, omitted, or 2287 (looks like sound ID).

===Command 110===
*'''Variable:''' No
*'''Arguments:''' 1180 1179 12 203 78 345 167 6 10 203 166 345 306 5 10

This command is only used once.

===Command 111===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

This command likely makes specified hotspot not drawable.

*''u0'' is 14 to 20 or omitted. It seems to refer to a hotspot index (see stone 2004).

===Command 112===
*'''Variable:''' 29
*'''Arguments:''' ''u0'' ''u1'' ''u2''

This command is only used twice.

*''u0'' is 0 or 1800.
*''u1'' is 400 or 2000.
*''u2'' is 1.

===Command 113===
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 0 10

This command is only used once. 5143 is likely sound ID.

===Command 114===
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely sound ID.

===Command 115===
*'''Variable:''' Yes
*'''Arguments:''' ''u0''[3]

*The ''u0'' look like card ID's.

*'''Variable:''' No
*'''Arguments:''' 1139 1140 1140 10 6 204 64 343 279 6 50

This form of the command is only used once.

===Command 116===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is 0, 1, or 6006.

===Command 117===
*'''Variable:''' No
*'''Arguments:''' [''u0''|''u1'' ''u2'']

*''u0'' is 0, 1, 2, 3, or omitted.
*''u1'' and ''u2'' are 5698 and 6698 (only used once).

===Command 118===
*'''Variable:''' No
*'''Arguments:''' [4707 5707 6707 7707 4705]

This command is only used 3 times (once with values and twice omitted). Values are likely sound IDs.

===Command 119===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 0, 1, or omitted.

===Command 120===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 0, 1, 2, 3, or omitted.

===Command 121===
*'''Variable:''' Yes
*'''Arguments:''' None

*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is 0 or a card ID.
*''u1'' is a card ID.

===Command 122===
*'''Variable:''' No
*'''Arguments:''' None

===Command 123===
*'''Variable:''' No
*'''Arguments:''' ''u0'' [''u1'']

*''u0'' is 0, 1, or 960.
*''u1'' is 960, 1920, or omitted.

===Command 124===
*'''Variable:''' No
*'''Arguments:''' None

===Command 125===
*'''Variable:''' No
*'''Arguments:''' None

*'''Variable:''' 21
*'''Arguments:''' ''u0''

*''u0'' is 13 or 14.

===Command 126===
*'''Variable:''' No
*'''Arguments:''' None

===Command 127===
*'''Variable:''' no
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is 1, 2, or 3.
*''u1'' is 0 or 1.

===Command 129===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' looks like a sound ID.

===Command 133===
*'''Variable:''' No
*'''Arguments:''' 6500

This command is only used once. Value is a sound ID.

===Command 164===
*'''Variable:''' No
*'''Arguments:''' None

===Command 169===
*'''Variable:''' No
*'''Arguments:''' None

===Command 198===
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely a sound ID.

===Command 199===
*'''Variable:''' No
*'''Arguments:''' None

==Commands 200-299==
These are only seen in the [[Myst INIT resources|INIT]] scripts.
===Command 200===
*'''Variable:''' Optional
*'''Arguments:''' None
*'''Seen:''' DUNNY, INTRO, MECHAN, SELEN, STONE

*'''Variable:''' No
*'''Arguments:''' ''u0 u1''[3]
*'''Seen:''' MYST

*''u1'' appears to be three sound IDs.

===Command 201===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' CHANNEL, INTRO, SELEN, STONE

*'''Variable:''' No
*'''Arguments:''' ''u0''
*'''Seen:''' MYST
*''u0'' looks like a sound ID.

*'''Variable:''' No
*'''Arguments:''' 0 4 5
*'''Seen:''' MECHAN

===Command 202===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' MECHAN, SELEN, STONE

*'''Variable:''' Yes
*'''Arguments:''' None
*'''Seen:''' CHANNEL

*'''Variable:''' No
*'''Arguments:''' 13
*'''Seen:''' MYST

===Command 203===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' CHANNEL, MECHAN, MYST, SELEN

*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count''] ''u1''
*'''Seen:''' STONE

*''u0'' look like card IDs.
*''u1'' looks like a sound ID.

===Command 204===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' MYST, SELEN, STONE

*'''Variable:''' No
*'''Arguments:''' ''u0''
*'''Seen:''' MECHAN

*''u0'' looks like a sound ID.

===Command 205===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' MYST, SELEN

*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count''] ''u1''
*'''Seen:''' STONE

*''u0'' look like card IDs.
*''u1'' looks like a sound ID.

*'''Variable:''' No
*'''Arguments:''' ''u0''[4]
*'''Seen:''' MECHAN

*''u0'' look like sound IDs.

===Command 206===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' MYST, SELEN, STONE

*'''Variable:''' No
*'''Arguments:''' ''u0''[6]
*'''Seen:''' MECHAN

*''u0'' look like sound IDs.

===Command 207===
*'''Variable:''' No
*'''Arguments:''' STONE

===Command 208===
*'''Variable:''' Yes
*'''Arguments:''' None
*'''Seen:''' MYST

*'''Variable:''' No
*'''Arguments:''' ''u0''[3]
*'''Seen:''' STONE

===Command 209===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 210===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 211===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 212===
*'''Variable:''' No
*'''Arguments:''' None

===Command 213===
*'''Variable:''' No
*'''Arguments:''' None

===Command 214===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 215===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 216===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 217===
*'''Variable:''' No
*'''Arguments:''' None

===Command 218===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 219===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 220===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 221===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 222===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

==Commands 300-399==
These are only seen in the [[Myst EXIT resources|EXIT]] scripts.
===Command 300===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 301===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 302===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 303===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 304===
*'''Variable:''' No
*'''Arguments:''' None

===Command 305===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 306===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 307===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 308===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 309===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 312===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

Other Games

2008-10-16T10:54:22Z

Clone2727: /* tBMP */ more work on non-Riven tBMP's

Riven variables

2008-09-25T20:28:55Z

Clone2727: document jbridge* variables

{{Riven}}
This page is an attempt to discern the function of every variable in the game.

==a_Data==
====acathstate====
*p_Data var 15
====adoit====
*b_Data var 0, g_Data var 1, j_Data var 5, o_Data var 5, p_Data var 0, r_Data var 1, t_Data var 0
====agehn====
*o_Data var 2, r_Data var 0, t_Data var 7
====aova====
*b_Data var 25, g_Data var 28, j_Data var 12, o_Data var 6, t_Data var 14
====apower====
*b_Data var 45, g_Data var 16, j_Data var 32, t_Data var 31
State of the power provided by the fire-marbles in the huge golden dome. 0=no power, 1=power on. Makes the domes work when set to 1.

====araw====
*b_Data var 24, g_Data var 2, j_Data var 29, r_Data var 4, t_Data var 13, t_Data var 13
====atemp====
*j_Data var 26
====atrap====
*a_Data var 0
====atrapbook====
*a_Data var 1, o_Data var 3, p_Data var 14, r_Data var 3
====domecheck====
*b_Data var 46, g_Data var 17, j_Data var 35, p_Data var 22, t_Data var 37
Used in dome scope mechanisms. Apparently, *_domecheck() externals set this to let scripts know if the scope button was hit at the right time (0=no, 1=yes).

==b_Data==
====bbacklock====
*b_Data var 21
====bbait====
*b_Data var 39
====bbigbridge====
*b_Data var 6, t_Data var 41
====bbirds====
*b_Data var 36
====bblrarm====
*b_Data var 2
====bblrdoor====
*b_Data var 3
====bblrgrt====
*b_Data var 4
====bblrsw====
*b_Data var 34
====bblrvalve====
*b_Data var 32
====bblrwtr====
*b_Data var 5
Presence of water in the boiler. 0 = empty, 1 = filled.
====bbook====
*b_Data var 44, o_Data var 13
====bbrlever====
*b_Data var 9, t_Data var 40
====bcavedoor====
*b_Data var 16
====bcpipegr====
*b_Data var 26
====bcratergg====
*b_Data var 1
====bdome====
*b_Data var 43
====bdrwr====
*b_Data var 23
====bfans====
*b_Data var 15
====bfmdoor====
*b_Data var 42
====bidvlv====
*b_Data var 30
====blab====
*b_Data var 11
====blabbook====
*b_Data var 28
====blabeye====
*b_Data var 27
====blabfrontdr====
*b_Data var 17
====blabbackdr====
*b_Data var 20
====bfrontlock====
*b_Data var 18
====bheat====
*b_Data var 33
====bmagcar====
*b_Data var 12, g_Data var 7, j_Data var 44
====bpipdr====
*b_Data var 47, j_Data var 43
====bprs====
*b_Data var 37
====bstove====
*b_Data var 29
====btrap====
*b_Data var 35
====bvalve====
*b_Data var 31
Position of the steam valve located at the center of the lake (card 415). 0: steam to the ytram mechanism; 1: steam to the boiler controls; 2: steam to the chipper.

====bvise====
*b_Data var 19
====bytram====
*b_Data var 22
====bytramtime====
*b_Data var 40
====bytrap====
*b_Data var 38
====bytrapped====
*b_Data var 41

==g_Data==
====gbook====
*g_Data var 15, o_Data var 12
====gcathtime====
*g_Data var 26
====gcathstate====
*g_Data var 27
====gdome====
*g_Data var 10
====gemagcar====
*g_Data var 19, j_Data var 39
====gimagecurr====
*g_Data var 13
====gimagemax====
*g_Data var 14
====glkbtns====
*g_Data var 8
====glkbridge====
*g_Data var 9
====glview====
*g_Data var 25
====glviewpos====
*j_Data var 33
====gnmagrot====
*b_Data var 13, g_Data var 4
====gnmagcar====
*b_Data var 14, g_Data var 3
====gpinup====
*g_Data var 11
====gpinpos====
*g_Data var 12
====grview====
*g_Data var 21
====grviewpos====
*g_Data var 22
====gscribe====
*g_Data var 18
====gsubelev====
*g_Data var 0
====gsubdr====
*g_Data var 5
====gwhark====
*g_Data var 6
====gwharktime====
*g_Data var 24

==j_Data==
====jwmagcar====
*g_Data var 20
====jbeetle====
*j_Data var 1
====jbeetlepool====
*j_Data var 23
====jbook====
*j_Data var 31, o_Data var 11
====jbridge1====
*j_Data var 13
Status of the sub dock bridge beneath the village: 0=retracted, 1=extended

====jbridge2====
*j_Data var 14
Status of the sub dock bridge on the path to the village: 0=retracted, 1=extended

====jbridge3====
*j_Data var 15
Status of the sub dock bridge of the gallows: 0=retracted, 1=extended

====jbridge4====
*j_Data var 17
Status of the sub dock bridge of the dock controls: 0=retracted, 1=extended

====jbridge5====
*j_Data var 16
Status of the sub dock bridge of the schoolhouse: 0=retracted, 1=extended

====jccb====
*j_Data var 0
Controls when to play some background bird animations.

====jdome====
*j_Data var 3
====jdrain====
*j_Data var 27
====jgallows====
*j_Data var 9
State of the gallows floor: 0=closed, 1=open.

====jgate====
*j_Data var 2
====jgirl====
*j_Data var 37
====jladder====
*j_Data var 30
====jleftpos====
*j_Data var 47
====jpeek====
*j_Data var 34
====jplaybeetle====
*j_Data var 4
Seems managed by a set of equivalent external commands to control when to play the random beetle movies in the jungle (it is set to 1 in that case).

====jprebel====
*j_Data var 18
====jprisondr====
*j_Data var 11
====jprisonsecdr====
*j_Data var 19
====jrbook====
*j_Data var 22
====jrightpos====
*j_Data var 48
====jsouthpathdr====
*j_Data var 6
====jschooldr====
*j_Data var 42
====jsub====
*j_Data var 10
====jsubdir====
*j_Data var 24
====jsubhatch====
*j_Data var 25
====jsubsw====
*j_Data var 41
====jsunners====
*j_Data var 45, t_Data var 11
====jsunnertime====
*j_Data var 46
====jthronedr====
*j_Data var 7
====jtunneldr====
*j_Data var 21
====jtunnellamps====
*j_Data var 20
====jvillagepeople====
*j_Data var 40
====jwarning====
*j_Data var 8
====jwharkpos====
*j_Data var 49
====jwharkram====
*j_Data var 28
====jwmouth====
*j_Data var 36
State of the whark mouth in the jungle. 0=closed, 1=open.

====jwmagcar====
*j_Data var 38
Presence (1) or absence (0) of the maglev leading to gspit.

====jymagcar====
*j_Data var 50, t_Data var 10

==o_Data==
====oambient====
*o_Data var 1, p_Data var 4
====obutton====
*o_Data var 4
====ocage====
*o_Data var 0, p_Data var 3
====odeskbook====
*o_Data var 7
====omusicplayer====
*o_Data var 8
====ostanddrawer====
*o_Data var 16
====ostove====
*o_Data var 15

==p_Data==
====elevbtn1====
*p_Data var 19
====elevbtn2====
*p_Data var 20
====elevbtn3====
*p_Data var 21
====pbook====
*o_Data var 10, p_Data var 23
====pcage====
*o_Data var 9, p_Data var 2, t_Data var 12
====pcathtime====
*p_Data var 16
====pcathcheck====
*p_Data var 17
====pdome====
*p_Data var 1
====pelevcombo====
*p_Data var 18
====ptemp====
*g_Data var 23

==r_Data==
====rrebel====
*r_Data var 2

Tracks the evolution of events in the rebel age.

====rrebelview====
*r_Data var 5
====rvillagetime====
*r_Data var 6

==t_Data==
====tbars====
*t_Data var 2
====tbeetle====
*t_Data var 28
====tbook====
*o_Data var 14, t_Data var 38
====tbookvalve====
*t_Data var 33
====tcage====
*t_Data var 24
State of the prison at the beginning of the game. 0 = prison closed, 1 = open.

====tcovercombo====
*t_Data var 23
====tdl====
*t_Data var 16
====tdome====
*t_Data var 29
====tdomeelev====
*p_Data var 8, t_Data var 34
====tdomeelevbtn====
*t_Data var 42
====tgatebrhandle====
*t_Data var 36
====tgatebridge====
*t_Data var 17
====tgatestate====
*p_Data var 5, t_Data var 15
====tgridoor====
*p_Data var 12, t_Data var 26
====tgrodoor====
*p_Data var 11, t_Data var 27
====tgrmdoor====
*p_Data var 7, t_Data var 25
====tguard====
*t_Data var 9
====timagedoor====
*t_Data var 1
====tmagcar====
*j_Data var 51, p_Data var 6, t_Data var 3
Presence of the maglev on temple island. 0 = absent, 1 = present.

====tsecdoor====
*p_Data var 9, t_Data var 6
State of the door from the temple tunnel to the temple. 0 = closed, 1 = open.

====tsubbridge====
*p_Data var 13, t_Data var 32
====ttelecover====
*t_Data var 19
State of the star fissure window cover under the telescope. 0 = closed, 1 = open.

====ttelehandle====
*t_Data var 21
Position of the lever controlling telescope direction. 0 = up, 1 = down.

====ttelepin====
*t_Data var 22
State of the telescope safety lever. 0 = locked, 1 = unlocked.

====ttelescope====
*t_Data var 18
Position of the telescope. Seems to range from 1 to 5.

====ttelevalve====
*t_Data var 20
State of the valve feeding steam to the telescope. 0 = off, 1 = on.

====ttemple====
*t_Data var 8
====ttempledoor====
*p_Data var 10, t_Data var 4
State of the huge door from the temple to the maglev. 0 = closed, 1 = open.

====ttunneldoor====
*t_Data var 39
====tviewer====
*t_Data var 5
====twabrvalve====
*t_Data var 35
====twaffle====
*t_Data var 30

==Saved Game Variables==
====all_book====
====auservolume====
The volume set in the options.
====azip====
The state of zip mode. (0=off, 1=on)
====currentcardid====
Current card ID.
====currentstackid====
Current stack ID. See the [[Riven engine overview#Stack ID's in Saved Games|conversion table]].
====doingsetupscreens====
====newpos====
====playerhasbook====
====rivenambients====
====returncardid====
Card ID used to return to after viewing a book on aspit.
====returnstackid====
Stack ID used to return to after viewing a book on aspit. See the [[Riven engine overview#Stack ID's in Saved Games|conversion table]].
====stackvarsinitialized====
====tblue====
====tgreen====
====themarble====
====torange====
====transitionsenabled====
(0=transitions disabled, 1=transitions enabled)
====transitionmode====
Speed of the transitions.
====tred====
====tviolet====
====tyellow====
====waterenabled====
(0=water effects disabled, 1=water effects enabled)

Myst scripts

2008-09-23T21:36:56Z

Clone2727: 300+ are for EXIT, not INIT

{{Myst}}
This page contains, or will contain, a list of all known commands in Myst, as used in record types 5, 6, 7, 8, 10, 11, and 12. The script format always starts with an unsigned short representing the command count, and then per command has this structure:

{| class="structure"
|unsigned short||opcode
|-
|unsigned short||var
|-
|unsigned short||num_values
|-
|unsigned short||values[num_values]
|}

The way scripts are stored, they each contain a command number, a variable number, and any number of arguments. When a variable number is not given, a "0" is used. So when the key below says that the variable is "optional", that means that it has been found both with and without a variable being passed in. In some cases, the syntax of the arguments depends on whether a variable was passed in. In this case, the variable/arguments header is repeated for each form of the command.

==Commands 0-99==
These are suspected to be general-purpose commands.
===Command 0===
*'''Variable:''' Optional
*'''Arguments:''' None
Seems to toggle a variable between 0 and 1. For example, see the marker switches on MYST island.

===Command 1===
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

Could mean "set variable to ''u0''". ''u0'' takes on any number between 0 and 7 (maybe a bit field?)

===Command 2: alternative destination===
*'''Variable:''' Yes
*'''Arguments:''' ''dest''

This command goes to ''dest'' instead of the regular destination if ''var'' is a certain (unknown) value. (Only used for SELEN 1240 and CHANNEL 3359)

===Command 3: change cursor===
*'''Variable:''' Yes
*'''Arguments:''' ''clrc_id''

*''clrc_id'' is always 800, 801, or 802. (Only 5 different cases). These are the "animated" cursors of dropping the white, red, and blue pages, respectively.

This command seems to change cursor to ''clrc_id'' if var is a certain (unknown) value.

===Command 4===
*'''Variable:''' Optional
*'''Arguments:''' None

===Command 6===
*'''Variable:''' Optional
*'''Arguments:''' None

===Command 7===
*'''Variable:''' Optional
*'''Arguments:''' None

===Command 8===
*'''Variable:''' Optional
*'''Arguments:''' None

===Command 9===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is always either ''FFFF'' or omitted.

===Command 12===
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

''Related to [[#Command 13|command 13]]''.

*''u0'' appears to be a nearby card.

This may have similar function to [[#Command 2|command 2]].

===Command 13===
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

''Related to [[#Command 12|command 12]]''.

*''u0'' appears to be a nearby card.

This may have similar function to [[#Command 2|command 2]].

===Command 14===
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

*''u0'' is always 0, 1, or 2.

===Command 15===
*'''Variable:''' Yes
*'''Arguments:''' [''u0'']

*''u0'' is always 0 or omitted.

===Command 16===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' appears to be a nearby card.
*''u1'' is always 0.

===Command 17===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' appears to be a nearby card.
*''u1'' is always 4, 5, or 6.

===Command 18===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is always 4, 5, or 6.

===Command 19: enable hotspots===
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

This seems to enable a list of hotspots. All of the ''u0'' numbers are small (0-13, 21).

===Command 20: disable hotspots===
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

This seems to disable a list of hotspots. All of the ''u0'' numbers are small (0-13, 21). These, unlike [[#Command 19|command 19]], can also be -1, which seems to disable the invoking hotspot.

===Command 21===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2'' ''u3'' ''u4'' ''u5''

There are this command is used 6 times.

*''u0'' is always 0, 74, 76, 117, or 198.
*''u1'' is always 0, 48, 213, or 226.
*''u2'' is always 327, 406, 429, 459, or 544.
*''u3'' is always 257, 332, or 333.
*''u4'' is always 0, 1, 5, 6, or 11.
*''u5'' is always 5 or 25.

===Command 22===
*'''Variable:''' No
*'''Arguments:''' None

===Command 23===
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

*The ''u0'' numbers are all 0, 4, or 5.

===Command 24===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' appears to be a sound ID.

===Command 26===
*'''Variable:''' No
*'''Arguments:''' None

===Command 27===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' appears to be a sound ID.

===Command 28===
*'''Variable:''' No
*'''Arguments:''' (<''l t r b''>|''FFFF'')

*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.

===Command 29===
*'''Variable:''' No
*'''Arguments:''' ''pict_id'' <''l t r b''> ''u0'' ''u1''

*''pict_id'' appears to be a picture ID.
*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.
*''u0'' appears to be a variable number (it is sometimes 0).
*''u1'' may also be a variable number (it is sometimes 0, 1, or -1).

This command seems to copy picture ''pict_id'' over the hotspot, using <''l'' ''t'' ''r'' ''b''> as the source rect. Additional data is unknown.

===Command 30===
*'''Variable:''' No
*'''Arguments:''' <''msnd_id'' ''flags''> [...]

*''msnd_id'' looks like background sound ID to play.
*''flags'' looks like a bit field.

Normally there is only one pair of above values, with a single exception: CHANNEL.3225 has 4 pairs.

===Command 31===
*'''Variable:''' Yes (only ever 30)
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is always 0.
*''u1'' looks like a card ID.

===Command 32===
*'''Variable:''' No
*'''Arguments:''' None

===Command 33===
*'''Variable:''' No
*'''Arguments:''' ''card'' <''l t r b''> ''u0'' ''u1''

*''card'' appears to be a card ID.
*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.
*''u0'' appears to be a variable number (it is sometimes 0).
*''u1'' may also be a variable number (it is sometimes 0).

===Command 34===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' looks like a card ID.
*''u1'' is always 0, 1, 4, 5, 6, 9, 10, or 11.

===Command 35===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2''

*''u0'' looks like a card ID.
*''u1'' looks like a card ID.
*''u2'' is always 0, 6, or 10.

===Command 36===
*'''Variable:''' No
*'''Arguments:''' ''u0''

This command is only used twice.

*''u0'' is 900 or 903.

===Command 37===
*'''Variable:''' No
*'''Arguments:''' None

===Command 38===
*'''Variable:''' No
*'''Arguments:''' None

===Command 39===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is 100, 200, 400, 500, 1000, or 1100.

===Command 40: travel to destination age===
*'''Variable:''' No
*'''Arguments:''' ''dst_age_id'' ''src_msnd_id'' ''dst_msnd_id''

*''dst_age_id'' is one of 0 (selen), 1 (stone), 2 (myst), 3 (mechan), 4 (channel) or 6 (dunny).
*''src_msnd_id'' is a sound ID to play in source age.
*''dst_msnd_id'' is a sound ID to play in destination age.

===Command 41===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2'' ''count'' ''u3''[''count'']

*''u0'' looks like a card ID.
*''u1'' looks like a sound ID.
*''u2'' is always 5 or 10.
*''count'' is only ever 6 or 12.
*''u3'' may be divided into groups of sixes.

===Command 42===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''count'' ''u2''[''count'']

*''u0'' looks like a sound ID.
*''u1'' is always 5, 10, 15, or 20.
*''count'' is only ever 6 or 12.
*''u2'' may be divided into groups of sixes.

===Command 43===
*'''Variable:''' No
*'''Arguments:''' None

===Command 44===
*'''Variable:''' No
*'''Arguments:''' None

===Command 46===
*'''Variable:''' No
*'''Arguments:''' None

==Commands 100-199==
These are suspected to be age-specific, as their syntax changes depending on the age.
===Command 100===
*'''Variable:''' Optional
*'''Arguments:''' [''u0'']

*''u0'' is always 4, 6, or omitted.

===Command 101===
*'''Variable:''' No
*'''Arguments:''' [''u0''|''u1''[6]]

*''u0'' is always 4225 or omitted.
*''u1'' is a series of 6 positive numbers.

===Command 102===
*'''Variable:''' No
*'''Arguments:''' [''u0'' ''u1'' [''u2'']]

*''u0'' looks like a card ID (or 0).
*''u1'' looks like a card ID.
*''u2'' looks like an (optional) bit field. (only 0x64 or 0)

===Command 103===
*'''Variable:''' Yes
*'''Arguments:''' ''bit''

This form of the command most likely negates bit ''bit'' of ''var''.

*''bit'' is a power of 2 (bit mask).

*'''Variable:''' No
*'''Arguments:''' ''u0'' [''u1'']

This form of the command likely makes specified hotspot drawable.

*''u0'' is a number between 13 and 18. It seems to refer to a hotspot index (see stone 2197).
*''u1'' is either 1 or omitted.

===Command 104===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

This command likely makes specified hotspot not drawable.

*''u0'' can be 0, 1, omitted, or 13 to 20. It seems to refer to a hotspot index (see stone 2004 and 2197).

===Command 105===
*'''Variable:''' Optional (set to 9 at one point, but usually not)
*'''Arguments:''' [''u0'']

*''u0'' looks like a sound ID.

===Command 106===
*'''Variable:''' 10
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

===Command 107===
*'''Variable:''' 11
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

===Command 108===
*'''Variable:''' 12
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

===Command 109===
*'''Variable:''' Optional
*'''Arguments:''' [''u0'']

*''u0'' is ''FFFF'', 1, omitted, or 2287 (looks like sound ID).

===Command 110===
*'''Variable:''' No
*'''Arguments:''' 1180 1179 12 203 78 345 167 6 10 203 166 345 306 5 10

This command is only used once.

===Command 111===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

This command likely makes specified hotspot not drawable.

*''u0'' is 14 to 20 or omitted. It seems to refer to a hotspot index (see stone 2004).

===Command 112===
*'''Variable:''' 29
*'''Arguments:''' ''u0'' ''u1'' ''u2''

This command is only used twice.

*''u0'' is 0 or 1800.
*''u1'' is 400 or 2000.
*''u2'' is 1.

===Command 113===
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 0 10

This command is only used once. 5143 is likely sound ID.

===Command 114===
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely sound ID.

===Command 115===
*'''Variable:''' Yes
*'''Arguments:''' ''u0''[3]

*The ''u0'' look like card ID's.

*'''Variable:''' No
*'''Arguments:''' 1139 1140 1140 10 6 204 64 343 279 6 50

This form of the command is only used once.

===Command 116===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is 0, 1, or 6006.

===Command 117===
*'''Variable:''' No
*'''Arguments:''' [''u0''|''u1'' ''u2'']

*''u0'' is 0, 1, 2, 3, or omitted.
*''u1'' and ''u2'' are 5698 and 6698 (only used once).

===Command 118===
*'''Variable:''' No
*'''Arguments:''' [4707 5707 6707 7707 4705]

This command is only used 3 times (once with values and twice omitted). Values are likely sound IDs.

===Command 119===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 0, 1, or omitted.

===Command 120===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 0, 1, 2, 3, or omitted.

===Command 121===
*'''Variable:''' Yes
*'''Arguments:''' None

*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is 0 or a card ID.
*''u1'' is a card ID.

===Command 122===
*'''Variable:''' No
*'''Arguments:''' None

===Command 123===
*'''Variable:''' No
*'''Arguments:''' ''u0'' [''u1'']

*''u0'' is 0, 1, or 960.
*''u1'' is 960, 1920, or omitted.

===Command 124===
*'''Variable:''' No
*'''Arguments:''' None

===Command 125===
*'''Variable:''' No
*'''Arguments:''' None

*'''Variable:''' 21
*'''Arguments:''' ''u0''

*''u0'' is 13 or 14.

===Command 126===
*'''Variable:''' No
*'''Arguments:''' None

===Command 127===
*'''Variable:''' no
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is 1, 2, or 3.
*''u1'' is 0 or 1.

===Command 129===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' looks like a sound ID.

===Command 133===
*'''Variable:''' No
*'''Arguments:''' 6500

This command is only used once. Value is a sound ID.

===Command 164===
*'''Variable:''' No
*'''Arguments:''' None

===Command 169===
*'''Variable:''' No
*'''Arguments:''' None

===Command 198===
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely a sound ID.

===Command 199===
*'''Variable:''' No
*'''Arguments:''' None

==Commands 200-299==
These are only seen in the [[Myst INIT resources|INIT]] scripts.
===Command 200===
*'''Variable:''' Optional
*'''Arguments:''' None
*'''Seen:''' DUNNY, INTRO, MECHAN, SELEN, STONE

*'''Variable:''' No
*'''Arguments:''' ''u0 u1''[3]
*'''Seen:''' MYST

*''u1'' appears to be three sound IDs.

===Command 201===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' CHANNEL, INTRO, SELEN, STONE

*'''Variable:''' No
*'''Arguments:''' ''u0''
*'''Seen:''' MYST
*''u0'' looks like a sound ID.

*'''Variable:''' No
*'''Arguments:''' 0 4 5
*'''Seen:''' MECHAN

===Command 202===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' MECHAN, SELEN, STONE

*'''Variable:''' Yes
*'''Arguments:''' None
*'''Seen:''' CHANNEL

*'''Variable:''' No
*'''Arguments:''' 13
*'''Seen:''' MYST

===Command 203===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' CHANNEL, MECHAN, MYST, SELEN

*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count''] ''u1''
*'''Seen:''' STONE

*''u0'' look like node IDs.
*''u1'' looks like a sound ID.

===Command 204===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' MYST, SELEN, STONE

*'''Variable:''' No
*'''Arguments:''' ''u0''
*'''Seen:''' MECHAN

*''u0'' looks like a sound ID.

===Command 205===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' MYST, SELEN

*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count''] ''u1''
*'''Seen:''' STONE

*''u0'' look like node IDs.
*''u1'' looks like a sound ID.

*'''Variable:''' No
*'''Arguments:''' ''u0''[4]
*'''Seen:''' MECHAN

*''u0'' look like sound IDs.

===Command 206===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' MYST, SELEN, STONE

*'''Variable:''' No
*'''Arguments:''' ''u0''[6]
*'''Seen:''' MECHAN

*''u0'' look like sound IDs.

===Command 207===
*'''Variable:''' No
*'''Arguments:''' STONE

===Command 208===
*'''Variable:''' Yes
*'''Arguments:''' None
*'''Seen:''' MYST

*'''Variable:''' No
*'''Arguments:''' ''u0''[3]
*'''Seen:''' STONE

===Command 209===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 210===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 211===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 212===
*'''Variable:''' No
*'''Arguments:''' None

===Command 213===
*'''Variable:''' No
*'''Arguments:''' None

===Command 214===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 215===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 216===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 217===
*'''Variable:''' No
*'''Arguments:''' None

===Command 218===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 219===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 220===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 221===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 222===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

==Commands 300-399==
These are only seen in the [[Myst EXIT resources|EXIT]] scripts.
===Command 300===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 301===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 302===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 303===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 304===
*'''Variable:''' No
*'''Arguments:''' None

===Command 305===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 306===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 307===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 308===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 309===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 312===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

Myst scripts

2008-09-23T21:29:35Z

Clone2727: typo

{{Myst}}
This page contains, or will contain, a list of all known commands in Myst, as used in record types 5, 6, 7, 8, 10, 11, and 12. The script format always starts with an unsigned short representing the command count, and then per command has this structure:

{| class="structure"
|unsigned short||opcode
|-
|unsigned short||var
|-
|unsigned short||num_values
|-
|unsigned short||values[num_values]
|}

The way scripts are stored, they each contain a command number, a variable number, and any number of arguments. When a variable number is not given, a "0" is used. So when the key below says that the variable is "optional", that means that it has been found both with and without a variable being passed in. In some cases, the syntax of the arguments depends on whether a variable was passed in. In this case, the variable/arguments header is repeated for each form of the command.

==Commands 0-99==
These are suspected to be general-purpose commands.
===Command 0===
*'''Variable:''' Optional
*'''Arguments:''' None
Seems to toggle a variable between 0 and 1. For example, see the marker switches on MYST island.

===Command 1===
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

Could mean "set variable to ''u0''". ''u0'' takes on any number between 0 and 7 (maybe a bit field?)

===Command 2: alternative destination===
*'''Variable:''' Yes
*'''Arguments:''' ''dest''

This command goes to ''dest'' instead of the regular destination if ''var'' is a certain (unknown) value. (Only used for SELEN 1240 and CHANNEL 3359)

===Command 3: change cursor===
*'''Variable:''' Yes
*'''Arguments:''' ''clrc_id''

*''clrc_id'' is always 800, 801, or 802. (Only 5 different cases). These are the "animated" cursors of dropping the white, red, and blue pages, respectively.

This command seems to change cursor to ''clrc_id'' if var is a certain (unknown) value.

===Command 4===
*'''Variable:''' Optional
*'''Arguments:''' None

===Command 6===
*'''Variable:''' Optional
*'''Arguments:''' None

===Command 7===
*'''Variable:''' Optional
*'''Arguments:''' None

===Command 8===
*'''Variable:''' Optional
*'''Arguments:''' None

===Command 9===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is always either ''FFFF'' or omitted.

===Command 12===
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

''Related to [[#Command 13|command 13]]''.

*''u0'' appears to be a nearby card.

This may have similar function to [[#Command 2|command 2]].

===Command 13===
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

''Related to [[#Command 12|command 12]]''.

*''u0'' appears to be a nearby card.

This may have similar function to [[#Command 2|command 2]].

===Command 14===
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

*''u0'' is always 0, 1, or 2.

===Command 15===
*'''Variable:''' Yes
*'''Arguments:''' [''u0'']

*''u0'' is always 0 or omitted.

===Command 16===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' appears to be a nearby card.
*''u1'' is always 0.

===Command 17===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' appears to be a nearby card.
*''u1'' is always 4, 5, or 6.

===Command 18===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is always 4, 5, or 6.

===Command 19: enable hotspots===
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

This seems to enable a list of hotspots. All of the ''u0'' numbers are small (0-13, 21).

===Command 20: disable hotspots===
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

This seems to disable a list of hotspots. All of the ''u0'' numbers are small (0-13, 21). These, unlike [[#Command 19|command 19]], can also be -1, which seems to disable the invoking hotspot.

===Command 21===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2'' ''u3'' ''u4'' ''u5''

There are this command is used 6 times.

*''u0'' is always 0, 74, 76, 117, or 198.
*''u1'' is always 0, 48, 213, or 226.
*''u2'' is always 327, 406, 429, 459, or 544.
*''u3'' is always 257, 332, or 333.
*''u4'' is always 0, 1, 5, 6, or 11.
*''u5'' is always 5 or 25.

===Command 22===
*'''Variable:''' No
*'''Arguments:''' None

===Command 23===
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

*The ''u0'' numbers are all 0, 4, or 5.

===Command 24===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' appears to be a sound ID.

===Command 26===
*'''Variable:''' No
*'''Arguments:''' None

===Command 27===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' appears to be a sound ID.

===Command 28===
*'''Variable:''' No
*'''Arguments:''' (<''l t r b''>|''FFFF'')

*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.

===Command 29===
*'''Variable:''' No
*'''Arguments:''' ''pict_id'' <''l t r b''> ''u0'' ''u1''

*''pict_id'' appears to be a picture ID.
*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.
*''u0'' appears to be a variable number (it is sometimes 0).
*''u1'' may also be a variable number (it is sometimes 0, 1, or -1).

This command seems to copy picture ''pict_id'' over the hotspot, using <''l'' ''t'' ''r'' ''b''> as the source rect. Additional data is unknown.

===Command 30===
*'''Variable:''' No
*'''Arguments:''' <''msnd_id'' ''flags''> [...]

*''msnd_id'' looks like background sound ID to play.
*''flags'' looks like a bit field.

Normally there is only one pair of above values, with a single exception: CHANNEL.3225 has 4 pairs.

===Command 31===
*'''Variable:''' Yes (only ever 30)
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is always 0.
*''u1'' looks like a card ID.

===Command 32===
*'''Variable:''' No
*'''Arguments:''' None

===Command 33===
*'''Variable:''' No
*'''Arguments:''' ''card'' <''l t r b''> ''u0'' ''u1''

*''card'' appears to be a card ID.
*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.
*''u0'' appears to be a variable number (it is sometimes 0).
*''u1'' may also be a variable number (it is sometimes 0).

===Command 34===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' looks like a card ID.
*''u1'' is always 0, 1, 4, 5, 6, 9, 10, or 11.

===Command 35===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2''

*''u0'' looks like a card ID.
*''u1'' looks like a card ID.
*''u2'' is always 0, 6, or 10.

===Command 36===
*'''Variable:''' No
*'''Arguments:''' ''u0''

This command is only used twice.

*''u0'' is 900 or 903.

===Command 37===
*'''Variable:''' No
*'''Arguments:''' None

===Command 38===
*'''Variable:''' No
*'''Arguments:''' None

===Command 39===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is 100, 200, 400, 500, 1000, or 1100.

===Command 40: travel to destination age===
*'''Variable:''' No
*'''Arguments:''' ''dst_age_id'' ''src_msnd_id'' ''dst_msnd_id''

*''dst_age_id'' is one of 0 (selen), 1 (stone), 2 (myst), 3 (mechan), 4 (channel) or 6 (dunny).
*''src_msnd_id'' is a sound ID to play in source age.
*''dst_msnd_id'' is a sound ID to play in destination age.

===Command 41===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2'' ''count'' ''u3''[''count'']

*''u0'' looks like a card ID.
*''u1'' looks like a sound ID.
*''u2'' is always 5 or 10.
*''count'' is only ever 6 or 12.
*''u3'' may be divided into groups of sixes.

===Command 42===
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''count'' ''u2''[''count'']

*''u0'' looks like a sound ID.
*''u1'' is always 5, 10, 15, or 20.
*''count'' is only ever 6 or 12.
*''u2'' may be divided into groups of sixes.

===Command 43===
*'''Variable:''' No
*'''Arguments:''' None

===Command 44===
*'''Variable:''' No
*'''Arguments:''' None

===Command 46===
*'''Variable:''' No
*'''Arguments:''' None

==Commands 100-199==
These are suspected to be age-specific, as their syntax changes depending on the age.
===Command 100===
*'''Variable:''' Optional
*'''Arguments:''' [''u0'']

*''u0'' is always 4, 6, or omitted.

===Command 101===
*'''Variable:''' No
*'''Arguments:''' [''u0''|''u1''[6]]

*''u0'' is always 4225 or omitted.
*''u1'' is a series of 6 positive numbers.

===Command 102===
*'''Variable:''' No
*'''Arguments:''' [''u0'' ''u1'' [''u2'']]

*''u0'' looks like a card ID (or 0).
*''u1'' looks like a card ID.
*''u2'' looks like an (optional) bit field. (only 0x64 or 0)

===Command 103===
*'''Variable:''' Yes
*'''Arguments:''' ''bit''

This form of the command most likely negates bit ''bit'' of ''var''.

*''bit'' is a power of 2 (bit mask).

*'''Variable:''' No
*'''Arguments:''' ''u0'' [''u1'']

This form of the command likely makes specified hotspot drawable.

*''u0'' is a number between 13 and 18. It seems to refer to a hotspot index (see stone 2197).
*''u1'' is either 1 or omitted.

===Command 104===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

This command likely makes specified hotspot not drawable.

*''u0'' can be 0, 1, omitted, or 13 to 20. It seems to refer to a hotspot index (see stone 2004 and 2197).

===Command 105===
*'''Variable:''' Optional (set to 9 at one point, but usually not)
*'''Arguments:''' [''u0'']

*''u0'' looks like a sound ID.

===Command 106===
*'''Variable:''' 10
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

===Command 107===
*'''Variable:''' 11
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

===Command 108===
*'''Variable:''' 12
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

===Command 109===
*'''Variable:''' Optional
*'''Arguments:''' [''u0'']

*''u0'' is ''FFFF'', 1, omitted, or 2287 (looks like sound ID).

===Command 110===
*'''Variable:''' No
*'''Arguments:''' 1180 1179 12 203 78 345 167 6 10 203 166 345 306 5 10

This command is only used once.

===Command 111===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

This command likely makes specified hotspot not drawable.

*''u0'' is 14 to 20 or omitted. It seems to refer to a hotspot index (see stone 2004).

===Command 112===
*'''Variable:''' 29
*'''Arguments:''' ''u0'' ''u1'' ''u2''

This command is only used twice.

*''u0'' is 0 or 1800.
*''u1'' is 400 or 2000.
*''u2'' is 1.

===Command 113===
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 0 10

This command is only used once. 5143 is likely sound ID.

===Command 114===
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely sound ID.

===Command 115===
*'''Variable:''' Yes
*'''Arguments:''' ''u0''[3]

*The ''u0'' look like card ID's.

*'''Variable:''' No
*'''Arguments:''' 1139 1140 1140 10 6 204 64 343 279 6 50

This form of the command is only used once.

===Command 116===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is 0, 1, or 6006.

===Command 117===
*'''Variable:''' No
*'''Arguments:''' [''u0''|''u1'' ''u2'']

*''u0'' is 0, 1, 2, 3, or omitted.
*''u1'' and ''u2'' are 5698 and 6698 (only used once).

===Command 118===
*'''Variable:''' No
*'''Arguments:''' [4707 5707 6707 7707 4705]

This command is only used 3 times (once with values and twice omitted). Values are likely sound IDs.

===Command 119===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 0, 1, or omitted.

===Command 120===
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 0, 1, 2, 3, or omitted.

===Command 121===
*'''Variable:''' Yes
*'''Arguments:''' None

*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is 0 or a card ID.
*''u1'' is a card ID.

===Command 122===
*'''Variable:''' No
*'''Arguments:''' None

===Command 123===
*'''Variable:''' No
*'''Arguments:''' ''u0'' [''u1'']

*''u0'' is 0, 1, or 960.
*''u1'' is 960, 1920, or omitted.

===Command 124===
*'''Variable:''' No
*'''Arguments:''' None

===Command 125===
*'''Variable:''' No
*'''Arguments:''' None

*'''Variable:''' 21
*'''Arguments:''' ''u0''

*''u0'' is 13 or 14.

===Command 126===
*'''Variable:''' No
*'''Arguments:''' None

===Command 127===
*'''Variable:''' no
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is 1, 2, or 3.
*''u1'' is 0 or 1.

===Command 129===
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' looks like a sound ID.

===Command 133===
*'''Variable:''' No
*'''Arguments:''' 6500

This command is only used once. Value is a sound ID.

===Command 164===
*'''Variable:''' No
*'''Arguments:''' None

===Command 169===
*'''Variable:''' No
*'''Arguments:''' None

===Command 198===
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely a sound ID.

===Command 199===
*'''Variable:''' No
*'''Arguments:''' None

==Commands 200-299==
These are only seen in the [[Myst INIT resources|INIT]] scripts.
===Command 200===
*'''Variable:''' Optional
*'''Arguments:''' None
*'''Seen:''' DUNNY, INTRO, MECHAN, SELEN, STONE

*'''Variable:''' No
*'''Arguments:''' ''u0 u1''[3]
*'''Seen:''' MYST

*''u1'' appears to be three sound IDs.

===Command 201===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' CHANNEL, INTRO, SELEN, STONE

*'''Variable:''' No
*'''Arguments:''' ''u0''
*'''Seen:''' MYST
*''u0'' looks like a sound ID.

*'''Variable:''' No
*'''Arguments:''' 0 4 5
*'''Seen:''' MECHAN

===Command 202===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' MECHAN, SELEN, STONE

*'''Variable:''' Yes
*'''Arguments:''' None
*'''Seen:''' CHANNEL

*'''Variable:''' No
*'''Arguments:''' 13
*'''Seen:''' MYST

===Command 203===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' CHANNEL, MECHAN, MYST, SELEN

*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count''] ''u1''
*'''Seen:''' STONE

*''u0'' look like node IDs.
*''u1'' looks like a sound ID.

===Command 204===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' MYST, SELEN, STONE

*'''Variable:''' No
*'''Arguments:''' ''u0''
*'''Seen:''' MECHAN

*''u0'' looks like a sound ID.

===Command 205===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' MYST, SELEN

*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count''] ''u1''
*'''Seen:''' STONE

*''u0'' look like node IDs.
*''u1'' looks like a sound ID.

*'''Variable:''' No
*'''Arguments:''' ''u0''[4]
*'''Seen:''' MECHAN

*''u0'' look like sound IDs.

===Command 206===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:''' MYST, SELEN, STONE

*'''Variable:''' No
*'''Arguments:''' ''u0''[6]
*'''Seen:''' MECHAN

*''u0'' look like sound IDs.

===Command 207===
*'''Variable:''' No
*'''Arguments:''' STONE

===Command 208===
*'''Variable:''' Yes
*'''Arguments:''' None
*'''Seen:''' MYST

*'''Variable:''' No
*'''Arguments:''' ''u0''[3]
*'''Seen:''' STONE

===Command 209===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 210===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 211===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 212===
*'''Variable:''' No
*'''Arguments:''' None

===Command 213===
*'''Variable:''' No
*'''Arguments:''' None

===Command 214===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 215===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 216===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 217===
*'''Variable:''' No
*'''Arguments:''' None

===Command 218===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 219===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 220===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 221===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 222===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

==Commands 300-399==
These are only seen in the [[Myst INIT resources|INIT]] scripts.
===Command 300===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 301===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 302===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 303===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 304===
*'''Variable:''' No
*'''Arguments:''' None

===Command 305===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 306===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 307===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 308===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 309===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

===Command 312===
*'''Variable:''' No
*'''Arguments:''' None
*'''Seen:'''

Myst INIT resources

2008-09-18T19:19:59Z

Clone2727: updating and removing the old case studies

{{Myst}}

Each INIT resource contains a [[Myst scripts|script]] used when entering a card.

== Format ==
{|class="structure"
|unsigned short||u0
|-
|[[Myst scripts|Myst Script]]||script
|}

*''u0'' is usually 0-9.
*''script'' is the script ran when entering the card.

Myst EXIT resources

2008-09-18T19:18:09Z

Clone2727: updating and removing old case studies

{{Myst}}

Each EXIT resource contains a [[Myst scripts|script]] used when leaving a card.

== Format ==
{|class="structure"
|unsigned short||u0
|-
|[[Myst scripts|Myst Script]]||script
|-
|unsigned short||u1
|}

*''u0'' is usually 0-9.
*''script'' is the script used when exiting the card.
*''u1'' is always 1.

Mohawk MIDI

2008-09-17T22:03:59Z

Clone2727: /* The Header */ oops!

This is the Mohawk MIDI format. It resembles the [[Mohawk archive format]] and [[Mohawk Sounds]] format. And, it's just a wrapper around the [http://faydoc.tripod.com/formats/mid.htm standard MIDI format]. It is in Big Endian order.

== The Header ==
{| class="structure"
|4 bytes||mhwk_magic
|-
|unsigned long||size
|-
|4 bytes||midi_magic
|}

*''mhwk_magic'' is the string 'MHWK'. It's equal to the [[Mohawk archive format#IFF header|Mohawk format signature]]!
*''size'' is the effective resource size.
*''midi_magic'' is the string 'MIDI'.

After this header come the chunks. Until now, 3 chunk types have been identified: '[[#The MThd Chunk|MThd]]', '[[#The Prg.23 Chunk|Prg#]]' and '[[#The MTrk Chunk|MTrk]]'.

== The MThd Chunk ==
See [http://faydoc.tripod.com/formats/mid.htm here] for information on this chunk.

== The Prg# Chunk ==
''(MIDI Programs?)''

{| class="structure"
|unsigned long||chunk_size
|-
|unsigned short||u0
|-
|unsigned short||u1
|-
|unsigned short||u2
|}

== The MTrk Chunk ==
See [http://faydoc.tripod.com/formats/mid.htm here] for information on this chunk.

Mohawk MIDI

2008-09-17T22:03:36Z

Clone2727: documenting the rest of the format (it's really the standard MIDI format...)

This is the Mohawk MIDI format. It resembles the [[Mohawk archive format]] and [[Mohawk Sounds]] format. And, it's just a wrapper around the [http://faydoc.tripod.com/formats/mid.htm standard MIDI format]. It is in Big Endian order.

== The Header ==
{| class="structure"
|4 bytes||mhwk_magic
|-
|unsigned long||size
|-
|4 bytes||midi_magic
|}

*''mhwk_magic'' is the string 'MHWK'. It's equal to the [[Mohawk archive format#IFF header|Mohawk format signature]]!
*''size'' is the effective resource size, minus the ADPC chunk size, minus 2.
*''midi_magic'' is the string 'MIDI'.

After this header come the chunks. Until now, 3 chunk types have been identified: '[[#The MThd Chunk|MThd]]', '[[#The Prg.23 Chunk|Prg#]]' and '[[#The MTrk Chunk|MTrk]]'.

== The MThd Chunk ==
See [http://faydoc.tripod.com/formats/mid.htm here] for information on this chunk.

== The Prg# Chunk ==
''(MIDI Programs?)''

{| class="structure"
|unsigned long||chunk_size
|-
|unsigned short||u0
|-
|unsigned short||u1
|-
|unsigned short||u2
|}

== The MTrk Chunk ==
See [http://faydoc.tripod.com/formats/mid.htm here] for information on this chunk.

Myst EXIT resources

2008-09-17T10:49:37Z

Clone2727: exit resources also contain scripts

{{Myst}}

Each EXIT resource contains a [[Myst scripts|script]] used when leaving a card.

==Case studies (all of them)==
Note: these are presented as ''resource_index''.''length short...'' where the data is broken into shorts and displayed in decimal.
====CHANNEL====
*0.12 1 0 300 0 0 1
====DUNNY====
*0.22 2 0 300 0 0 1 0 100 0 0 1
====INTRO====
*0.22 2 0 300 0 0 1 0 38 0 0 1
*1.12 1 0 38 0 0 1
====MECHAN====
*0.24 2 0 27 0 1 7044 1 0 4 0 0 1
*1.12 1 0 300 0 0 1
*2.12 1 0 32 0 0 1
====MYST====
*0.12 1 0 301 0 0 1
*1.12 1 0 301 0 0 1
*2.12 1 0 301 0 0 1
*3.12 1 0 301 0 0 1
*4.12 1 0 301 0 0 1
*5.12 1 1 306 0 0 1
*6.12 1 1 306 0 0 1
*7.12 1 0 302 0 0 1
*8.12 1 0 303 0 0 1
*9.12 1 0 303 0 0 1
*10.36 3 [0 1 302 1 1 1] [0 309 0 0 1 0] [1 309 1 0 1]
*11.12 1 0 307 0 0 1
*12.24 2 [0 300 100 0 2 0] [1 309 1 0 1]
*13.24 2 [0 300 101 0 2 0] [1 309 1 0 1]
*14.12 1 [0 303 0 0 1]
*15.14 1 0 308 0 0 1 0
*16.12 1 [0 304 0 0 1]
*17.12 1 [0 304 0 0 1]
*18.22 2 [0 304 0 0 1] [0 305 0 0 1]
*19.12 1 [1 304 0 0 1]
*20.22 2 [0 304 0 0 1] [0 305 0 0 1]
*21.12 1 [0 304 0 0 1]
*22.22 2 [0 304 0 0 1] [0 305 0 0 1]
*23.12 1 [0 304 0 0 1]
*24.12 1 [0 312 0 0 1]
*25.66
3 0 29 0 7 8708 0 0 152 165 198 107
1 0 42 0 9 8707 10 6 216 129 368 294
5 50 1 0 24 0 1 9707 1
====STONE====
*0.14 1 0 125 21 1 14 1
*1.14 1 0 125 21 1 13 1
*2.12 1 0 300 0 0 1

Myst INIT resources

2008-09-17T10:48:27Z

Clone2727: init resources contain scripts

{{Myst}}

Each INIT resource contains a [[Myst scripts|script]] used when entering a card.

==Old Case Studies==
====CHANNEL====
*0.12 1 0 1 30 1 0
*1.10 1 6 201 0 0
====DUNNY====
*1.18 2 0 26 0 0 0 200 0 0
====MYST====
*2.30 2 1 209 0 0 0 206 0 6 6044 7044 8044 9044 10044 11044
*4.18 1 0 205 0 4 6156 7156 8156 9156
*5.16 1 0 201 0 3 0 4 5
*6.12 1 0 204 0 1 6180

Myst RLST resources

2008-09-17T01:52:30Z

Clone2727: /* Hotspot types */ move script structure to the scripts page

{{Myst}}

These contain Myst's hotspot descriptions.

The data is a list of records, each record describing one of the hotspots:
{| class="structure"
|short||record_count
|-
|variable||records
|}

The record length is variable, depending on the hotspot type. The record structure is:
{| class="structure"
|unsigned short||type
|-
|unsigned short||flags
|-
|short||left
|-
|short||top
|-
|short||right
|-
|short||bottom
|-
|unsigned short||destination
|-
|variable||additional data
|}
*''type'' seems to specify the hotspot action in a wide sense. Every value between 0 and 14 except for 9 has been observed. See below for the meaning.
*''flags'' seems to be a bit field. Observed values are 0, 1, 2, 3, 5, 6, 8 and 10. The value seems related to when the hotspot actions should be executed. For example, regular clickable hotspots usually have ''flags'' = 2 while hotspots that run background movies (e.g. the Channelwood windmill) have ''flags'' = 0. Bit 3 is suspected to flag Zip Mode hotspots.
*The following 4 fields define the hotspot rectangle. Note that "weird" rectangles are found, like (-32000, -32000, 32000, 32000).
*''destination'' contains a destination card ID for hotspots that change card, or zero.
*Additional data follows when ''type'' > 3 (complex hotspots), clearly representing lists of actions to perform. We have yet to figure out how to calculate the length of those complex records.

==Hotspot types==
Types from 0 to 4 are associated with "simple" hotspots that usually just change card. In these cases, ''type'' indicates the movement direction: forward, left, right, down and up respectively. There is no additional data in the hotspot record for these simple cases.

Type 5 hotspots have a script attached to them. See the [[Myst_scripts|page about scripts]] for the structure of scripts.

Type 6 hotspots play a video when activated. The record starts with a full type 5 record. Then comes a zero-terminated string (C string) which defines the path to the video file without extension. Note that after the string is read, input stream position should be padded to the next 2-byte boundary. Finally come 7 shorts whose purpose is still unknown.

Type 7 record serves as some kind of switch statement, executing one of several action lists (or cases) indexed by the value of a variable:

(var_index} {num_cases} [record_type <record_data>]

Each case itself begins with a record type, followed by additional record contents (without common prefix). Only type 5 and 6 records used in a switch statement have been observed.

Type 8 record is like type 7, but additionally it specifies a list of subimages to draw over main WDIB. The particular subimage is chosen depending on the value of variable. This record includes the type 7 record at start.

<type_7_record> (var_index) {num_subs} [wdib_id <rectangle>]

Here, each subimage record defines a source WDIB ID and a source rectangle inside this WDIB. Rectangle is defined in the usual (''left'', ''top'', ''right'', ''bottom'') format, with one exception: empty rectangle is defined as the single short -1. This is probably the case when source rectangle equals destination rectangle. Also, ''wdib_id'' itself can be -1, this probably means original WDIB for this card should be used as source WDIB.

The remaining types are being investigated.

==Case studies==
Note: these are simply the data in little-endian shorts and line-broken where patterns are found. <l t b r> is the hotspot rect. count [entry]... are guesses at when there are lists of entries. The number in parentheses before the data is the card number (not the resource number).

The following hotspots replace part of the image (in this case <417 260 544 333>) with part of another image (in this case 3004 <0 0 127 73>) based on a variable (103 2 plays in here somewhere):
8 1 < 31 276 163 333> 0 FFFF 0 103 2 3006 <0 0 132 57> 3005 FFFF
8 1 <417 260 544 333> 0 FFFF 0 103 2 3004 <0 0 127 73> 3003 FFFF

Case studies from Channelwood:
(CHANNEL 3001) 2
1 2 <1 0 110 332> 3002
2 2 <455 2 544 332> 3003

(CHANNEL 3002) 2
1 2 <0 1 100 332> 3005
2 2 <431 0 544 332> 3001

(CHANNEL 3003) 4
5 2 <213 90 343 290> 3494 2 [6 0 0] [24 0 1 {3494}] (the door)
1 2 <0 0 81 332> 3001 (left)
2 2 <463 0 544 332> 3005 (right)
8 1 <417 260 544 333> 0 FFFF 0 103 2 [3004 <0 0 127 73>] [3003 <FFFF>]

(CHANNEL 3005) 4
0 2 <76 152 196 330> 3012
1 2 <0 0 106 332> 3003
2 2 <438 0 544 332> 3002
8 1 <31 276 163 333> 0 FFFF 0 103 2 [3006 <0 0 132 57>] [3005 <FFFF>]

(CHANNEL 3012) 8
8 3 <101 243 214 343> 0 FFFF 1 5 (1 [3 103 1 {802}]) 103 2 [3013 <0 0 113 100>] [3012 <FFFF>]
5 2 <255 193 269 208> 0 1 [117 0 1 {0}]
5 2 <268 193 282 208> 0 1 [117 0 1 {1}]
5 2 <281 193 295 208> 0 1 [117 0 1 {2}]
5 2 <294 193 308 208> 0 1 [117 0 1 {3}]
8 1 <252 190 310 210> 0 FFFF 0 17 4 [3008 <0 0 58 20>] [3009 <0 0 58 20>] [3010 <0 0 58 20>] [3011 <0 0 58 20>]
0 4 <180 31 379 305> 0
5 2 <0 0 544 332> 0 1 [34 0 2 {3005 0}]

(MYST 4368) 3
8 3 <305 148 375 238> 0 FFFF 1 5 (1 [3 103 1 {802}]) 103 2 [FFFF <FFFF>] [4369 <0 0 70 90>]
7 2 <216 110 304 235> 0 106 5
5 (1 [115 101 3 {4741 4370 4368}])
5 (1 [115 101 3 {4741 4370 4368}])
5 (1 [115 101 3 {4741 4370 4368}])
5 (1 [115 101 3 {4741 4370 4368}])
5 (0)
0 2 <0 0 544 332> 4345

==== Intro Case Study ====
(INTRO 1) 1
0 2 <-32000 -32000 32000 32000> 5

INTRO 1 is supposed to be the card which shows the opening movies and then switches to card 2.

(INTRO 2) 1
5 2 <245 202 304 253> 4 2 [37 0 0] [34 0 2 {3 11}]

INTRO 2 is the first interactive part of the game, the part where you can pick up the Myst book. The rect correctly corresponds to where the book is on screen. But, look at the "destination" -- 4. There is no VIEW/RLST 4! However, there is a WDIB 4 and it is the open book with the water. Where this ''should'' go is to card 3 and show the Myst book cover before showing image 4 and then playing the video. And, there is a 3 in this chunk, but I'm not sure if that's the purpose. I have no idea what commands 37/34 could be. There is a WDIB 11, but it's of D'ni, so I doubt it's that. ;)

(INTRO 3) 2
0 2 <-32000 -32000 32000 32000> 5
6 0 <312 70 441 159> 0 0 "\qtw\intro\intro2" 0x2848 0x2756 0 1 0 0 0

Note that this one has a string for the video (null-terminated). This obviously calls that video which is the Myst fly-by for the linking book. And, that rect perfectly matches where the video should be displayed on screen. However, this also clearly breaks the format specified above for "type 2 hotspots".

WDIB 3 is the cover of the Myst linking book. But, this doesn't match up with the video mentioned here which should be for WDIB 4 (or 10, they are identical)(the open linking book with the water image) and eventually ending at WDIB 12 (the open linking book with the dock image). The 5 after the very large numbers is the target card for the open linking book which seems correct. 0x2848 is 10,312 and 0x2756 is 10,070. The rate of the audio is 11,025. Not sure if this has any correlation.

Myst scripts

2008-09-17T01:50:59Z

Clone2727: document the opcode structure on this page

{{Myst}}
This page contains, or will contain, a list of all known commands in Myst, as used in record types 5, 6, 7, 8, 10, 11, and 12. The script format always starts with an unsigned short representing the command count, and then per command has this structure:

{| class="structure"
|unsigned short||opcode
|-
|unsigned short||var
|-
|unsigned short||num_values
|-
|unsigned short||values[num_values]
|}

The way scripts are stored, they each contain a command number, a variable number, and any number of arguments. When a variable number is not given, a "0" is used. So when the key below says that the variable is "optional", that means that it has been found both with and without a variable being passed in. In some cases, the syntax of the arguments depends on whether a variable was passed in. In this case, the variable/arguments header is repeated for each form of the command.

==Command 0==
*'''Variable:''' Optional
*'''Arguments:''' None
Seems to toggle a variable between 0 and 1. For example, see the marker switches on MYST island.

==Command 1==
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

Could mean "set variable to ''u0''". ''u0'' takes on any number between 0 and 7 (maybe a bit field?)

==Command 2: alternative destination==
*'''Variable:''' Yes
*'''Arguments:''' ''dest''

This command goes to ''dest'' instead of the regular destination if ''var'' is a certain (unknown) value. (Only used for SELEN 1240 and CHANNEL 3359)

==Command 3: change cursor==
*'''Variable:''' Yes
*'''Arguments:''' ''clrc_id''

*''clrc_id'' is always 800, 801, or 802. (Only 5 different cases). These are the "animated" cursors of dropping the white, red, and blue pages, respectively.

This command seems to change cursor to ''clrc_id'' if var is a certain (unknown) value.

==Command 4==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 6==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 7==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 8==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 9==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is always either ''FFFF'' or omitted.

==Command 12==
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

''Related to [[#Command 13|command 13]]''.

*''u0'' appears to be a nearby card.

This may have similar function to [[#Command 2|command 2]].

==Command 13==
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

''Related to [[#Command 12|command 12]]''.

*''u0'' appears to be a nearby card.

This may have similar function to [[#Command 2|command 2]].

==Command 14==
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

*''u0'' is always 0, 1, or 2.

==Command 15==
*'''Variable:''' Yes
*'''Arguments:''' [''u0'']

*''u0'' is always 0 or omitted.

==Command 16==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' appears to be a nearby card.
*''u1'' is always 0.

==Command 17==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' appears to be a nearby card.
*''u1'' is always 4, 5, or 6.

==Command 18==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is always 4, 5, or 6.

==Command 19: enable hotspots==
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

This seems to enable a list of hotspots. All of the ''u0'' numbers are small (0-13, 21).

==Command 20: disable hotspots==
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

This seems to disable a list of hotspots. All of the ''u0'' numbers are small (0-13, 21). These, unlike [[#Command 19|command 19]], can also be -1, which seems to disable the invoking hotspot.

==Command 21==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2'' ''u3'' ''u4'' ''u5''

There are this command is used 6 times.

*''u0'' is always 0, 74, 76, 117, or 198.
*''u1'' is always 0, 48, 213, or 226.
*''u2'' is always 327, 406, 429, 459, or 544.
*''u3'' is always 257, 332, or 333.
*''u4'' is always 0, 1, 5, 6, or 11.
*''u5'' is always 5 or 25.

==Command 22==
*'''Variable:''' No
*'''Arguments:''' None

==Command 23==
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

*The ''u0'' numbers are all 0, 4, or 5.

==Command 24==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' appears to be a sound ID.

==Command 26==
*'''Variable:''' No
*'''Arguments:''' None

==Command 27==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' appears to be a sound ID.

==Command 28==
*'''Variable:''' No
*'''Arguments:''' (<''l t r b''>|''FFFF'')

*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.

==Command 29==
*'''Variable:''' No
*'''Arguments:''' ''pict_id'' <''l t r b''> ''u0'' ''u1''

*''pict_id'' appears to be a picture ID.
*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.
*''u0'' appears to be a variable number (it is sometimes 0).
*''u1'' may also be a variable number (it is sometimes 0, 1, or -1).

This command seems to copy picture ''pict_id'' over the hotspot, using <''l'' ''t'' ''r'' ''b''> as the source rect. Additional data is unknown.

==Command 30==
*'''Variable:''' No
*'''Arguments:''' <''msnd_id'' ''flags''> [...]

*''msnd_id'' looks like background sound ID to play.
*''flags'' looks like a bit field.

Normally there is only one pair of above values, with a single exception: CHANNEL.3225 has 4 pairs.

==Command 31==
*'''Variable:''' Yes (only ever 30)
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is always 0.
*''u1'' looks like a card ID.

==Command 32==
*'''Variable:''' No
*'''Arguments:''' None

==Command 33==
*'''Variable:''' No
*'''Arguments:''' ''card'' <''l t r b''> ''u0'' ''u1''

*''card'' appears to be a card ID.
*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.
*''u0'' appears to be a variable number (it is sometimes 0).
*''u1'' may also be a variable number (it is sometimes 0).

==Command 34==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' looks like a card ID.
*''u1'' is always 0, 1, 4, 5, 6, 9, 10, or 11.

==Command 35==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2''

*''u0'' looks like a card ID.
*''u1'' looks like a card ID.
*''u2'' is always 0, 6, or 10.

==Command 36==
*'''Variable:''' No
*'''Arguments:''' ''u0''

This command is only used twice.

*''u0'' is 900 or 903.

==Command 37==
*'''Variable:''' No
*'''Arguments:''' None

==Command 38==
*'''Variable:''' No
*'''Arguments:''' None

==Command 39==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is 100, 200, 400, 500, 1000, or 1100.

==Command 40: travel to destination age==
*'''Variable:''' No
*'''Arguments:''' ''dst_age_id'' ''src_msnd_id'' ''dst_msnd_id''

*''dst_age_id'' is one of 0 (selen), 1 (stone), 2 (myst), 3 (mechan), 4 (channel) or 6 (dunny).
*''src_msnd_id'' is a sound ID to play in source age.
*''dst_msnd_id'' is a sound ID to play in destination age.

==Command 41==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2'' ''count'' ''u3''[''count'']

*''u0'' looks like a card ID.
*''u1'' looks like a sound ID.
*''u2'' is always 5 or 10.
*''count'' is only ever 6 or 12.
*''u3'' may be divided into groups of sixes.

==Command 42==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''count'' ''u2''[''count'']

*''u0'' looks like a sound ID.
*''u1'' is always 5, 10, 15, or 20.
*''count'' is only ever 6 or 12.
*''u2'' may be divided into groups of sixes.

==Command 43==
*'''Variable:''' No
*'''Arguments:''' None

==Command 44==
*'''Variable:''' No
*'''Arguments:''' None

==Command 46==
*'''Variable:''' No
*'''Arguments:''' None

==Command 100==
*'''Variable:''' Optional
*'''Arguments:''' [''u0'']

*''u0'' is always 4, 6, or omitted.

==Command 101==
*'''Variable:''' No
*'''Arguments:''' [''u0''|''u1''[6]]

*''u0'' is always 4225 or omitted.
*''u1'' is a series of 6 positive numbers.

==Command 102==
*'''Variable:''' No
*'''Arguments:''' [''u0'' ''u1'' [''u2'']]

*''u0'' looks like a card ID (or 0).
*''u1'' looks like a card ID.
*''u2'' looks like an (optional) bit field. (only 0x64 or 0)

==Command 103==
*'''Variable:''' Yes
*'''Arguments:''' ''bit''

This form of the command most likely negates bit ''bit'' of ''var''.

*''bit'' is a power of 2 (bit mask).

*'''Variable:''' No
*'''Arguments:''' ''u0'' [''u1'']

This form of the command is unknown.

*''u0'' is a number between 13 and 18.
*''u1'' is either 1 or omitted.

==Command 104==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' can be 0, 1, omitted, or 13 to 20. It seems to refer to a hotspot index (see stone 2004).

==Command 105==
*'''Variable:''' Optional (set to 9 at one point, but usually not)
*'''Arguments:''' [''u0'']

*''u0'' looks like a sound ID.

==Command 106==
*'''Variable:''' 10
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

==Command 107==
*'''Variable:''' 11
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

==Command 108==
*'''Variable:''' 12
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

==Command 109==
*'''Variable:''' Optional
*'''Arguments:''' [''u0'']

*''u0'' is ''FFFF'', 1, omitted, or 2287 (looks like sound ID).

==Command 110==
*'''Variable:''' No
*'''Arguments:''' 1180 1179 12 203 78 345 167 6 10 203 166 345 306 5 10

This command is only used once.

==Command 111==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 14 to 20 or omitted. It seems to refer to a hotspot index (see stone 2004).

==Command 112==
*'''Variable:''' 29
*'''Arguments:''' ''u0'' ''u1'' ''u2''

This command is only used twice.

*''u0'' is 0 or 1800.
*''u1'' is 400 or 2000.
*''u2'' is 1.

==Command 113==
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 0 10

This command is only used once. 5143 is likely sound ID.

==Command 114==
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely sound ID.

==Command 115==
*'''Variable:''' Yes
*'''Arguments:''' ''u0''[3]

*The ''u0'' look like card ID's.

*'''Variable:''' No
*'''Arguments:''' 1139 1140 1140 10 6 204 64 343 279 6 50

This form of the command is only used once.

==Command 116==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is 0, 1, or 6006.

==Command 117==
*'''Variable:''' No
*'''Arguments:''' [''u0''|''u1'' ''u2'']

*''u0'' is 0, 1, 2, 3, or omitted.
*''u1'' and ''u2'' are 5698 and 6698 (only used once).

==Command 118==
*'''Variable:''' No
*'''Arguments:''' [4707 5707 6707 7707 4705]

This command is only used 3 times (once with values and twice omitted). Values are likely sound IDs.

==Command 119==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 0, 1, or omitted.

==Command 120==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 0, 1, 2, 3, or omitted.

==Command 121==
*'''Variable:''' Yes
*'''Arguments:''' None

*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is 0 or a card ID.
*''u1'' is a card ID.

==Command 122==
*'''Variable:''' No
*'''Arguments:''' None

==Command 123==
*'''Variable:''' No
*'''Arguments:''' ''u0'' [''u1'']

*''u0'' is 0, 1, or 960.
*''u1'' is 960, 1920, or omitted.

==Command 124==
*'''Variable:''' No
*'''Arguments:''' None

==Command 125==
*'''Variable:''' No
*'''Arguments:''' None

*'''Variable:''' 21
*'''Arguments:''' ''u0''

*''u0'' is 13 or 14.

==Command 126==
*'''Variable:''' No
*'''Arguments:''' None

==Command 127==
*'''Variable:''' no
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is 1, 2, or 3.
*''u1'' is 0 or 1.

==Command 129==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' looks like a sound ID.

==Command 133==
*'''Variable:''' No
*'''Arguments:''' 6500

This command is only used once. Value is a sound ID.

==Command 164==
*'''Variable:''' No
*'''Arguments:''' None

==Command 169==
*'''Variable:''' No
*'''Arguments:''' None

==Command 198==
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely a sound ID.

==Command 199==
*'''Variable:''' No
*'''Arguments:''' None

Myst scripts

2008-09-10T20:17:46Z

Clone2727: use the term "card" instead of "node"

{{Myst}}
This page contains, or will contain, a list of all known commands in Myst, as used in record types 5, 6, 7, 8, 10, 11, and 12. Specifics on the format itself can be found at [[Myst RLST resources]]. The way scripts are stored, they each contain a command number, a variable number, and any number of arguments. When a variable number is not given, a "0" is used. So when the key below says that the variable is "optional", that means that it has been found both with and without a variable being passed in. In some cases, the syntax of the arguments depends on whether a variable was passed in. In this case, the variable/arguments header is repeated for each form of the command.

==Command 0==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 1==
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

*''u0'' takes on any number between 0 and 7 (maybe a bit field?)

==Command 2: alternative destination==
*'''Variable:''' Yes
*'''Arguments:''' ''dest''

This command goes to ''dest'' instead of the regular destination if ''var'' is a certain (unknown) value. (Only used for SELEN 1240 and CHANNEL 3359)

==Command 3: change cursor==
*'''Variable:''' Yes
*'''Arguments:''' ''clrc_id''

*''clrc_id'' is always 800, 801, or 802. (Only 5 different cases). These are the "animated" cursors of dropping the white, red, and blue pages, respectively.

This command seems to change cursor to ''clrc_id'' if var is a certain (unknown) value.

==Command 4==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 6==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 7==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 8==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 9==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is always either ''FFFF'' or omitted.

==Command 12==
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

''Related to [[#Command 13|command 13]]''.

*''u0'' appears to be a nearby card.

This may have similar function to [[#Command 2|command 2]].

==Command 13==
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

''Related to [[#Command 12|command 12]]''.

*''u0'' appears to be a nearby card.

This may have similar function to [[#Command 2|command 2]].

==Command 14==
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

*''u0'' is always 0, 1, or 2.

==Command 15==
*'''Variable:''' Yes
*'''Arguments:''' [''u0'']

*''u0'' is always 0 or omitted.

==Command 16==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' appears to be a nearby card.
*''u1'' is always 0.

==Command 17==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' appears to be a nearby card.
*''u1'' is always 4, 5, or 6.

==Command 18==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is always 4, 5, or 6.

==Command 19==
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

*All of the ''u0'' numbers are small (0-13, 21).

==Command 20==
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

*All of the ''u0'' numbers are small (0-13, 21). These, unlike [[#Command 19|command 19]], can also be ''FFFF''.

==Command 21==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2'' ''u3'' ''u4'' ''u5''

There are this command is used 6 times.

*''u0'' is always 0, 74, 76, 117, or 198.
*''u1'' is always 0, 48, 213, or 226.
*''u2'' is always 327, 406, 429, 459, or 544.
*''u3'' is always 257, 332, or 333.
*''u4'' is always 0, 1, 5, 6, or 11.
*''u5'' is always 5 or 25.

==Command 22==
*'''Variable:''' No
*'''Arguments:''' None

==Command 23==
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

*The ''u0'' numbers are all 0, 4, or 5.

==Command 24==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' appears to be a sound ID.

==Command 26==
*'''Variable:''' No
*'''Arguments:''' None

==Command 27==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' appears to be a sound ID.

==Command 28==
*'''Variable:''' No
*'''Arguments:''' (<''l t r b''>|''FFFF'')

*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.

==Command 29==
*'''Variable:''' No
*'''Arguments:''' ''card'' <''l t r b''> ''u0'' ''u1''

*''card'' appears to be a card ID.
*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.
*''u0'' appears to be a variable number (it is sometimes 0).
*''u1'' may also be a variable number (it is sometimes 0, 1, or ''FFFF'').

==Command 30==
*'''Variable:''' No
*'''Arguments:''' <''msnd_id'' ''flags''> [...]

*''msnd_id'' looks like background sound ID to play.
*''flags'' looks like a bit field.

Normally there is only one pair of above values, with a single exception: CHANNEL.3225 has 4 pairs.

==Command 31==
*'''Variable:''' Yes (only ever 30)
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is always 0.
*''u1'' looks like a card ID.

==Command 32==
*'''Variable:''' No
*'''Arguments:''' None

==Command 33==
*'''Variable:''' No
*'''Arguments:''' ''card'' <''l t r b''> ''u0'' ''u1''

*''card'' appears to be a card ID.
*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.
*''u0'' appears to be a variable number (it is sometimes 0).
*''u1'' may also be a variable number (it is sometimes 0).

==Command 34==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' looks like a card ID.
*''u1'' is always 0, 1, 4, 5, 6, 9, 10, or 11.

==Command 35==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2''

*''u0'' looks like a card ID.
*''u1'' looks like a card ID.
*''u2'' is always 0, 6, or 10.

==Command 36==
*'''Variable:''' No
*'''Arguments:''' ''u0''

This command is only used twice.

*''u0'' is 900 or 903.

==Command 37==
*'''Variable:''' No
*'''Arguments:''' None

==Command 38==
*'''Variable:''' No
*'''Arguments:''' None

==Command 39==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is 100, 200, 400, 500, 1000, or 1100.

==Command 40: travel to destination age==
*'''Variable:''' No
*'''Arguments:''' ''dst_age_id'' ''src_msnd_id'' ''dst_msnd_id''

*''dst_age_id'' is one of 0 (selen), 1 (stone), 2 (myst), 3 (mechan), 4 (channel) or 6 (dunny).
*''src_msnd_id'' is a sound ID to play in source age.
*''dst_msnd_id'' is a sound ID to play in destination age.

==Command 41==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2'' ''count'' ''u3''[''count'']

*''u0'' looks like a card ID.
*''u1'' looks like a sound ID.
*''u2'' is always 5 or 10.
*''count'' is only ever 6 or 12.
*''u3'' may be divided into groups of sixes.

==Command 42==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''count'' ''u2''[''count'']

*''u0'' looks like a sound ID.
*''u1'' is always 5, 10, 15, or 20.
*''count'' is only ever 6 or 12.
*''u2'' may be divided into groups of sixes.

==Command 43==
*'''Variable:''' No
*'''Arguments:''' None

==Command 44==
*'''Variable:''' No
*'''Arguments:''' None

==Command 46==
*'''Variable:''' No
*'''Arguments:''' None

==Command 100==
*'''Variable:''' Optional
*'''Arguments:''' [''u0'']

*''u0'' is always 4, 6, or omitted.

==Command 101==
*'''Variable:''' No
*'''Arguments:''' [''u0''|''u1''[6]]

*''u0'' is always 4225 or omitted.
*''u1'' is a series of 6 positive numbers.

==Command 102==
*'''Variable:''' No
*'''Arguments:''' [''u0'' ''u1'' [''u2'']]

*''u0'' looks like a card ID (or 0).
*''u1'' looks like a card ID.
*''u2'' looks like an (optional) bit field. (only 0x64 or 0)

==Command 103==
*'''Variable:''' Yes
*'''Arguments:''' ''bit''

This form of the command most likely negates bit ''bit'' of ''var''.

*''bit'' is a power of 2 (bit mask).

*'''Variable:''' No
*'''Arguments:''' ''u0'' [''u1'']

This form of the command is unknown.

*''u0'' is a number between 13 and 18.
*''u1'' is either 1 or omitted.

==Command 104==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' can be 0, 1, omitted, or 13 to 20.

==Command 105==
*'''Variable:''' Optional (set to 9 at one point, but usually not)
*'''Arguments:''' [''u0'']

*''u0'' looks like a sound ID.

==Command 106==
*'''Variable:''' 10
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

==Command 107==
*'''Variable:''' 11
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

==Command 108==
*'''Variable:''' 12
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

==Command 109==
*'''Variable:''' Optional
*'''Arguments:''' [''u0'']

*''u0'' is ''FFFF'', 1, omitted, or 2287 (looks like sound ID).

==Command 110==
*'''Variable:''' No
*'''Arguments:''' 1180 1179 12 203 78 345 167 6 10 203 166 345 306 5 10

This command is only used once.

==Command 111==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 14 to 20 or omitted.

==Command 112==
*'''Variable:''' 29
*'''Arguments:''' ''u0'' ''u1'' ''u2''

This command is only used twice.

*''u0'' is 0 or 1800.
*''u1'' is 400 or 2000.
*''u2'' is 1.

==Command 113==
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 0 10

This command is only used once. 5143 is likely sound ID.

==Command 114==
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely sound ID.

==Command 115==
*'''Variable:''' Yes
*'''Arguments:''' ''u0''[3]

*The ''u0'' look like card ID's.

*'''Variable:''' No
*'''Arguments:''' 1139 1140 1140 10 6 204 64 343 279 6 50

This form of the command is only used once.

==Command 116==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is 0, 1, or 6006.

==Command 117==
*'''Variable:''' No
*'''Arguments:''' [''u0''|''u1'' ''u2'']

*''u0'' is 0, 1, 2, 3, or omitted.
*''u1'' and ''u2'' are 5698 and 6698 (only used once).

==Command 118==
*'''Variable:''' No
*'''Arguments:''' [4707 5707 6707 7707 4705]

This command is only used 3 times (once with values and twice omitted). Values are likely sound IDs.

==Command 119==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 0, 1, or omitted.

==Command 120==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 0, 1, 2, 3, or omitted.

==Command 121==
*'''Variable:''' Yes
*'''Arguments:''' None

*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is 0 or a card ID.
*''u1'' is a card ID.

==Command 122==
*'''Variable:''' No
*'''Arguments:''' None

==Command 123==
*'''Variable:''' No
*'''Arguments:''' ''u0'' [''u1'']

*''u0'' is 0, 1, or 960.
*''u1'' is 960, 1920, or omitted.

==Command 124==
*'''Variable:''' No
*'''Arguments:''' None

==Command 125==
*'''Variable:''' No
*'''Arguments:''' None

*'''Variable:''' 21
*'''Arguments:''' ''u0''

*''u0'' is 13 or 14.

==Command 126==
*'''Variable:''' No
*'''Arguments:''' None

==Command 127==
*'''Variable:''' no
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is 1, 2, or 3.
*''u1'' is 0 or 1.

==Command 129==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' looks like a sound ID.

==Command 133==
*'''Variable:''' No
*'''Arguments:''' 6500

This command is only used once. Value is a sound ID.

==Command 164==
*'''Variable:''' No
*'''Arguments:''' None

==Command 169==
*'''Variable:''' No
*'''Arguments:''' None

==Command 198==
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely a sound ID.

==Command 199==
*'''Variable:''' No
*'''Arguments:''' None

Myst scripts

2008-09-10T20:09:57Z

Clone2727: /* Command 30 */ typo

{{Myst}}
This page contains, or will contain, a list of all known commands in Myst, as used in record types 5, 6, 7, 8, 10, 11, and 12. Specifics on the format itself can be found at [[Myst RLST resources]]. The way scripts are stored, they each contain a command number, a variable number, and any number of arguments. When a variable number is not given, a "0" is used. So when the key below says that the variable is "optional", that means that it has been found both with and without a variable being passed in. In some cases, the syntax of the arguments depends on whether a variable was passed in. In this case, the variable/arguments header is repeated for each form of the command.

==Command 0==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 1==
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

*''u0'' takes on any number between 0 and 7 (maybe a bit field?)

==Command 2: alternative destination==
*'''Variable:''' Yes
*'''Arguments:''' ''dest''

This command goes to ''dest'' instead of the regular destination if ''var'' is a certain (unknown) value. (Only used for SELEN 1240 and CHANNEL 3359)

==Command 3: change cursor==
*'''Variable:''' Yes
*'''Arguments:''' ''clrc_id''

*''clrc_id'' is always 800, 801, or 802. (Only 5 different cases). These are the "animated" cursors of dropping the white, red, and blue pages, respectively.

This command seems to change cursor to ''clrc_id'' if var is a certain (unknown) value.

==Command 4==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 6==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 7==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 8==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 9==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is always either ''FFFF'' or omitted.

==Command 12==
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

''Related to [[#Command 13|command 13]]''.

*''u0'' appears to be a nearby node.

This may have similar function to [[#Command 2|command 2]].

==Command 13==
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

''Related to [[#Command 12|command 12]]''.

*''u0'' appears to be a nearby node.

This may have similar function to [[#Command 2|command 2]].

==Command 14==
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

*''u0'' is always 0, 1, or 2.

==Command 15==
*'''Variable:''' Yes
*'''Arguments:''' [''u0'']

*''u0'' is always 0 or omitted.

==Command 16==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' appears to be a nearby node.
*''u1'' is always 0.

==Command 17==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' appears to be a nearby node.
*''u1'' is always 4, 5, or 6.

==Command 18==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is always 4, 5, or 6.

==Command 19==
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

*All of the ''u0'' numbers are small (0-13, 21).

==Command 20==
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

*All of the ''u0'' numbers are small (0-13, 21). These, unlike [[#Command 19|command 19]], can also be ''FFFF''.

==Command 21==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2'' ''u3'' ''u4'' ''u5''

There are this command is used 6 times.

*''u0'' is always 0, 74, 76, 117, or 198.
*''u1'' is always 0, 48, 213, or 226.
*''u2'' is always 327, 406, 429, 459, or 544.
*''u3'' is always 257, 332, or 333.
*''u4'' is always 0, 1, 5, 6, or 11.
*''u5'' is always 5 or 25.

==Command 22==
*'''Variable:''' No
*'''Arguments:''' None

==Command 23==
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

*The ''u0'' numbers are all 0, 4, or 5.

==Command 24==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' appears to be a sound ID.

==Command 26==
*'''Variable:''' No
*'''Arguments:''' None

==Command 27==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' appears to be a sound ID.

==Command 28==
*'''Variable:''' No
*'''Arguments:''' (<''l t r b''>|''FFFF'')

*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.

==Command 29==
*'''Variable:''' No
*'''Arguments:''' ''node'' <''l t r b''> ''u0'' ''u1''

*''node'' appears to be a node number.
*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.
*''u0'' appears to be a variable number (it is sometimes 0).
*''u1'' may also be a variable number (it is sometimes 0, 1, or ''FFFF'').

==Command 30==
*'''Variable:''' No
*'''Arguments:''' <''msnd_id'' ''flags''> [...]

*''msnd_id'' looks like background sound ID to play.
*''flags'' looks like a bit field.

Normally there is only one pair of above values, with a single exception: CHANNEL.3225 has 4 pairs.

==Command 31==
*'''Variable:''' Yes (only ever 30)
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is always 0.
*''u1'' looks like a node number.

==Command 32==
*'''Variable:''' No
*'''Arguments:''' None

==Command 33==
*'''Variable:''' No
*'''Arguments:''' ''node'' <''l t r b''> ''u0'' ''u1''

*''node'' appears to be a node number.
*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.
*''u0'' appears to be a variable number (it is sometimes 0).
*''u1'' may also be a variable number (it is sometimes 0).

==Command 34==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' looks like a node number.
*''u1'' is always 0, 1, 4, 5, 6, 9, 10, or 11.

==Command 35==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2''

*''u0'' looks like a node number.
*''u1'' looks like a node number.
*''u2'' is always 0, 6, or 10.

==Command 36==
*'''Variable:''' No
*'''Arguments:''' ''u0''

This command is only used twice.

*''u0'' is 900 or 903.

==Command 37==
*'''Variable:''' No
*'''Arguments:''' None

==Command 38==
*'''Variable:''' No
*'''Arguments:''' None

==Command 39==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is 100, 200, 400, 500, 1000, or 1100.

==Command 40: travel to destination age==
*'''Variable:''' No
*'''Arguments:''' ''dst_age_id'' ''src_msnd_id'' ''dst_msnd_id''

*''dst_age_id'' is one of 0 (selen), 1 (stone), 2 (myst), 3 (mechan), 4 (channel) or 6 (dunny).
*''src_msnd_id'' is a sound ID to play in source age.
*''dst_msnd_id'' is a sound ID to play in destination age.

==Command 41==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2'' ''count'' ''u3''[''count'']

*''u0'' looks like a node number.
*''u1'' looks like a sound ID.
*''u2'' is always 5 or 10.
*''count'' is only ever 6 or 12.
*''u3'' may be divided into groups of sixes.

==Command 42==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''count'' ''u2''[''count'']

*''u0'' looks like a sound ID.
*''u1'' is always 5, 10, 15, or 20.
*''count'' is only ever 6 or 12.
*''u2'' may be divided into groups of sixes.

==Command 43==
*'''Variable:''' No
*'''Arguments:''' None

==Command 44==
*'''Variable:''' No
*'''Arguments:''' None

==Command 46==
*'''Variable:''' No
*'''Arguments:''' None

==Command 100==
*'''Variable:''' Optional
*'''Arguments:''' [''u0'']

*''u0'' is always 4, 6, or omitted.

==Command 101==
*'''Variable:''' No
*'''Arguments:''' [''u0''|''u1''[6]]

*''u0'' is always 4225 or omitted.
*''u1'' is a series of 6 positive numbers.

==Command 102==
*'''Variable:''' No
*'''Arguments:''' [''u0'' ''u1'' [''u2'']]

*''u0'' looks like a node number (or 0).
*''u1'' looks like a node number.
*''u2'' looks like an (optional) bit field. (only 0x64 or 0)

==Command 103==
*'''Variable:''' Yes
*'''Arguments:''' ''bit''

This form of the command most likely negates bit ''bit'' of ''var''.

*''bit'' is a power of 2 (bit mask).

*'''Variable:''' No
*'''Arguments:''' ''u0'' [''u1'']

This form of the command is unknown.

*''u0'' is a number between 13 and 18.
*''u1'' is either 1 or omitted.

==Command 104==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' can be 0, 1, omitted, or 13 to 20.

==Command 105==
*'''Variable:''' Optional (set to 9 at one point, but usually not)
*'''Arguments:''' [''u0'']

*''u0'' looks like a sound ID.

==Command 106==
*'''Variable:''' 10
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

==Command 107==
*'''Variable:''' 11
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

==Command 108==
*'''Variable:''' 12
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

==Command 109==
*'''Variable:''' Optional
*'''Arguments:''' [''u0'']

*''u0'' is ''FFFF'', 1, omitted, or 2287 (looks like sound ID).

==Command 110==
*'''Variable:''' No
*'''Arguments:''' 1180 1179 12 203 78 345 167 6 10 203 166 345 306 5 10

This command is only used once.

==Command 111==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 14 to 20 or omitted.

==Command 112==
*'''Variable:''' 29
*'''Arguments:''' ''u0'' ''u1'' ''u2''

This command is only used twice.

*''u0'' is 0 or 1800.
*''u1'' is 400 or 2000.
*''u2'' is 1.

==Command 113==
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 0 10

This command is only used once. 5143 is likely sound ID.

==Command 114==
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely sound ID.

==Command 115==
*'''Variable:''' Yes
*'''Arguments:''' ''u0''[3]

*The ''u0'' look like node numbers.

*'''Variable:''' No
*'''Arguments:''' 1139 1140 1140 10 6 204 64 343 279 6 50

This form of the command is only used once.

==Command 116==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is 0, 1, or 6006.

==Command 117==
*'''Variable:''' No
*'''Arguments:''' [''u0''|''u1'' ''u2'']

*''u0'' is 0, 1, 2, 3, or omitted.
*''u1'' and ''u2'' are 5698 and 6698 (only used once).

==Command 118==
*'''Variable:''' No
*'''Arguments:''' [4707 5707 6707 7707 4705]

This command is only used 3 times (once with values and twice omitted). Values are likely sound IDs.

==Command 119==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 0, 1, or omitted.

==Command 120==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 0, 1, 2, 3, or omitted.

==Command 121==
*'''Variable:''' Yes
*'''Arguments:''' None

*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is 0 or a node number.
*''u1'' is a node number.

==Command 122==
*'''Variable:''' No
*'''Arguments:''' None

==Command 123==
*'''Variable:''' No
*'''Arguments:''' ''u0'' [''u1'']

*''u0'' is 0, 1, or 960.
*''u1'' is 960, 1920, or omitted.

==Command 124==
*'''Variable:''' No
*'''Arguments:''' None

==Command 125==
*'''Variable:''' No
*'''Arguments:''' None

*'''Variable:''' 21
*'''Arguments:''' ''u0''

*''u0'' is 13 or 14.

==Command 126==
*'''Variable:''' No
*'''Arguments:''' None

==Command 127==
*'''Variable:''' no
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is 1, 2, or 3.
*''u1'' is 0 or 1.

==Command 129==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' looks like a sound ID.

==Command 133==
*'''Variable:''' No
*'''Arguments:''' 6500

This command is only used once. Value is a sound ID.

==Command 164==
*'''Variable:''' No
*'''Arguments:''' None

==Command 169==
*'''Variable:''' No
*'''Arguments:''' None

==Command 198==
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely a sound ID.

==Command 199==
*'''Variable:''' No
*'''Arguments:''' None

Talk:Myst scripts

2008-09-10T20:07:08Z

Clone2727: comment on command 40

== Command 40 ==
The Age ID makes sense, but what about the destination card? Perhaps that second MSND id is really the card id. -[[User:Clone2727|Clone2727]] 22:07, 10 September 2008 (CEST)

Myst scripts

2008-09-10T19:55:54Z

Clone2727: mention about the cursors being "animated" cursors

{{Myst}}
This page contains, or will contain, a list of all known commands in Myst, as used in record types 5, 6, 7, 8, 10, 11, and 12. Specifics on the format itself can be found at [[Myst RLST resources]]. The way scripts are stored, they each contain a command number, a variable number, and any number of arguments. When a variable number is not given, a "0" is used. So when the key below says that the variable is "optional", that means that it has been found both with and without a variable being passed in. In some cases, the syntax of the arguments depends on whether a variable was passed in. In this case, the variable/arguments header is repeated for each form of the command.

==Command 0==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 1==
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

*''u0'' takes on any number between 0 and 7 (maybe a bit field?)

==Command 2: alternative destination==
*'''Variable:''' Yes
*'''Arguments:''' ''dest''

This command goes to ''dest'' instead of the regular destination if ''var'' is a certain (unknown) value. (Only used for SELEN 1240 and CHANNEL 3359)

==Command 3: change cursor==
*'''Variable:''' Yes
*'''Arguments:''' ''clrc_id''

*''clrc_id'' is always 800, 801, or 802. (Only 5 different cases). These are the "animated" cursors of dropping the white, red, and blue pages, respectively.

This command seems to change cursor to ''clrc_id'' if var is a certain (unknown) value.

==Command 4==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 6==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 7==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 8==
*'''Variable:''' Optional
*'''Arguments:''' None

==Command 9==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is always either ''FFFF'' or omitted.

==Command 12==
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

''Related to [[#Command 13|command 13]]''.

*''u0'' appears to be a nearby node.

This may have similar function to [[#Command 2|command 2]].

==Command 13==
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

''Related to [[#Command 12|command 12]]''.

*''u0'' appears to be a nearby node.

This may have similar function to [[#Command 2|command 2]].

==Command 14==
*'''Variable:''' Optional
*'''Arguments:''' ''u0''

*''u0'' is always 0, 1, or 2.

==Command 15==
*'''Variable:''' Yes
*'''Arguments:''' [''u0'']

*''u0'' is always 0 or omitted.

==Command 16==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' appears to be a nearby node.
*''u1'' is always 0.

==Command 17==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' appears to be a nearby node.
*''u1'' is always 4, 5, or 6.

==Command 18==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is always 4, 5, or 6.

==Command 19==
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

*All of the ''u0'' numbers are small (0-13, 21).

==Command 20==
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

*All of the ''u0'' numbers are small (0-13, 21). These, unlike [[#Command 19|command 19]], can also be ''FFFF''.

==Command 21==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2'' ''u3'' ''u4'' ''u5''

There are this command is used 6 times.

*''u0'' is always 0, 74, 76, 117, or 198.
*''u1'' is always 0, 48, 213, or 226.
*''u2'' is always 327, 406, 429, 459, or 544.
*''u3'' is always 257, 332, or 333.
*''u4'' is always 0, 1, 5, 6, or 11.
*''u5'' is always 5 or 25.

==Command 22==
*'''Variable:''' No
*'''Arguments:''' None

==Command 23==
*'''Variable:''' No
*'''Arguments:''' ''count'' ''u0''[''count'']

*The ''u0'' numbers are all 0, 4, or 5.

==Command 24==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' appears to be a sound ID.

==Command 26==
*'''Variable:''' No
*'''Arguments:''' None

==Command 27==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' appears to be a sound ID.

==Command 28==
*'''Variable:''' No
*'''Arguments:''' (<''l t r b''>|''FFFF'')

*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.

==Command 29==
*'''Variable:''' No
*'''Arguments:''' ''node'' <''l t r b''> ''u0'' ''u1''

*''node'' appears to be a node number.
*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.
*''u0'' appears to be a variable number (it is sometimes 0).
*''u1'' may also be a variable number (it is sometimes 0, 1, or ''FFFF'').

==Command 30==
*'''Variable:''' No
*'''Arguments:''' <''msnd_id'' ''flags''> [...]

*''msnd_id'' looks like background sound ID to play.
*''flags'' looks like a bit field.

Normally the is only one pair of above values, with a single exception: CHANNEL.3225 has 4 pairs.

==Command 31==
*'''Variable:''' Yes (only ever 30)
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is always 0.
*''u1'' looks like a node number.

==Command 32==
*'''Variable:''' No
*'''Arguments:''' None

==Command 33==
*'''Variable:''' No
*'''Arguments:''' ''node'' <''l t r b''> ''u0'' ''u1''

*''node'' appears to be a node number.
*<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.
*''u0'' appears to be a variable number (it is sometimes 0).
*''u1'' may also be a variable number (it is sometimes 0).

==Command 34==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' looks like a node number.
*''u1'' is always 0, 1, 4, 5, 6, 9, 10, or 11.

==Command 35==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2''

*''u0'' looks like a node number.
*''u1'' looks like a node number.
*''u2'' is always 0, 6, or 10.

==Command 36==
*'''Variable:''' No
*'''Arguments:''' ''u0''

This command is only used twice.

*''u0'' is 900 or 903.

==Command 37==
*'''Variable:''' No
*'''Arguments:''' None

==Command 38==
*'''Variable:''' No
*'''Arguments:''' None

==Command 39==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is 100, 200, 400, 500, 1000, or 1100.

==Command 40: travel to destination age==
*'''Variable:''' No
*'''Arguments:''' ''dst_age_id'' ''src_msnd_id'' ''dst_msnd_id''

*''dst_age_id'' is one of 0 (selen), 1 (stone), 2 (myst), 3 (mechan), 4 (channel) or 6 (dunny).
*''src_msnd_id'' is a sound ID to play in source age.
*''dst_msnd_id'' is a sound ID to play in destination age.

==Command 41==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''u2'' ''count'' ''u3''[''count'']

*''u0'' looks like a node number.
*''u1'' looks like a sound ID.
*''u2'' is always 5 or 10.
*''count'' is only ever 6 or 12.
*''u3'' may be divided into groups of sixes.

==Command 42==
*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1'' ''count'' ''u2''[''count'']

*''u0'' looks like a sound ID.
*''u1'' is always 5, 10, 15, or 20.
*''count'' is only ever 6 or 12.
*''u2'' may be divided into groups of sixes.

==Command 43==
*'''Variable:''' No
*'''Arguments:''' None

==Command 44==
*'''Variable:''' No
*'''Arguments:''' None

==Command 46==
*'''Variable:''' No
*'''Arguments:''' None

==Command 100==
*'''Variable:''' Optional
*'''Arguments:''' [''u0'']

*''u0'' is always 4, 6, or omitted.

==Command 101==
*'''Variable:''' No
*'''Arguments:''' [''u0''|''u1''[6]]

*''u0'' is always 4225 or omitted.
*''u1'' is a series of 6 positive numbers.

==Command 102==
*'''Variable:''' No
*'''Arguments:''' [''u0'' ''u1'' [''u2'']]

*''u0'' looks like a node number (or 0).
*''u1'' looks like a node number.
*''u2'' looks like an (optional) bit field. (only 0x64 or 0)

==Command 103==
*'''Variable:''' Yes
*'''Arguments:''' ''bit''

This form of the command most likely negates bit ''bit'' of ''var''.

*''bit'' is a power of 2 (bit mask).

*'''Variable:''' No
*'''Arguments:''' ''u0'' [''u1'']

This form of the command is unknown.

*''u0'' is a number between 13 and 18.
*''u1'' is either 1 or omitted.

==Command 104==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' can be 0, 1, omitted, or 13 to 20.

==Command 105==
*'''Variable:''' Optional (set to 9 at one point, but usually not)
*'''Arguments:''' [''u0'']

*''u0'' looks like a sound ID.

==Command 106==
*'''Variable:''' 10
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

==Command 107==
*'''Variable:''' 11
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

==Command 108==
*'''Variable:''' 12
*'''Arguments:''' 2287 (looks like sound ID)

This command is only used once.

==Command 109==
*'''Variable:''' Optional
*'''Arguments:''' [''u0'']

*''u0'' is ''FFFF'', 1, omitted, or 2287 (looks like sound ID).

==Command 110==
*'''Variable:''' No
*'''Arguments:''' 1180 1179 12 203 78 345 167 6 10 203 166 345 306 5 10

This command is only used once.

==Command 111==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 14 to 20 or omitted.

==Command 112==
*'''Variable:''' 29
*'''Arguments:''' ''u0'' ''u1'' ''u2''

This command is only used twice.

*''u0'' is 0 or 1800.
*''u1'' is 400 or 2000.
*''u2'' is 1.

==Command 113==
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 0 10

This command is only used once. 5143 is likely sound ID.

==Command 114==
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely sound ID.

==Command 115==
*'''Variable:''' Yes
*'''Arguments:''' ''u0''[3]

*The ''u0'' look like node numbers.

*'''Variable:''' No
*'''Arguments:''' 1139 1140 1140 10 6 204 64 343 279 6 50

This form of the command is only used once.

==Command 116==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' is 0, 1, or 6006.

==Command 117==
*'''Variable:''' No
*'''Arguments:''' [''u0''|''u1'' ''u2'']

*''u0'' is 0, 1, 2, 3, or omitted.
*''u1'' and ''u2'' are 5698 and 6698 (only used once).

==Command 118==
*'''Variable:''' No
*'''Arguments:''' [4707 5707 6707 7707 4705]

This command is only used 3 times (once with values and twice omitted). Values are likely sound IDs.

==Command 119==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 0, 1, or omitted.

==Command 120==
*'''Variable:''' No
*'''Arguments:''' [''u0'']

*''u0'' is 0, 1, 2, 3, or omitted.

==Command 121==
*'''Variable:''' Yes
*'''Arguments:''' None

*'''Variable:''' No
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is 0 or a node number.
*''u1'' is a node number.

==Command 122==
*'''Variable:''' No
*'''Arguments:''' None

==Command 123==
*'''Variable:''' No
*'''Arguments:''' ''u0'' [''u1'']

*''u0'' is 0, 1, or 960.
*''u1'' is 960, 1920, or omitted.

==Command 124==
*'''Variable:''' No
*'''Arguments:''' None

==Command 125==
*'''Variable:''' No
*'''Arguments:''' None

*'''Variable:''' 21
*'''Arguments:''' ''u0''

*''u0'' is 13 or 14.

==Command 126==
*'''Variable:''' No
*'''Arguments:''' None

==Command 127==
*'''Variable:''' no
*'''Arguments:''' ''u0'' ''u1''

*''u0'' is 1, 2, or 3.
*''u1'' is 0 or 1.

==Command 129==
*'''Variable:''' No
*'''Arguments:''' ''u0''

*''u0'' looks like a sound ID.

==Command 133==
*'''Variable:''' No
*'''Arguments:''' 6500

This command is only used once. Value is a sound ID.

==Command 164==
*'''Variable:''' No
*'''Arguments:''' None

==Command 169==
*'''Variable:''' No
*'''Arguments:''' None

==Command 198==
*'''Variable:''' No
*'''Arguments:''' 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely a sound ID.

==Command 199==
*'''Variable:''' No
*'''Arguments:''' None

Myst RLST resources

2008-09-10T19:53:19Z

Clone2727: /* Hotspot types */ typo

{{Myst}}

These contain Myst's hotspot descriptions.

The data is a list of records, each record describing one of the hotspots:
{| class="structure"
|short||record_count
|-
|variable||records
|}

The record length is variable, depending on the hotspot type. The record structure is:
{| class="structure"
|unsigned short||type
|-
|unsigned short||flags
|-
|short||left
|-
|short||top
|-
|short||right
|-
|short||bottom
|-
|unsigned short||destination
|-
|variable||additional data
|}
*''type'' seems to specify the hotspot action in a wide sense. Every value between 0 and 14 except for 9 has been observed. See below for the meaning.
*''flags'' seems to be a bit field. Observed values are 0, 1, 2, 3, 5, 6 and 8. Bit 3 is suspected to flag Zip Mode hotspots.
*The following 4 fields define the hotspot rectangle. Note that "weird" rectangles are found, like (-32000, -32000, 32000, 32000).
*''destination'' contains a destination card ID for hotspots that change card, or zero.
*Additional data follows when ''type'' > 3 (complex hotspots), clearly representing lists of actions to perform. We have yet to figure out how to calculate the length of those complex records.

==Hotspot types==
Types from 0 to 4 are associated with "simple" hotspots that usually just change card. In these cases, ''type'' indicates the movement direction: forward, left, right, down and up respectively. There is no additional data in the hotspot record for these simple cases.

Type 5 hotspots seems to define some sort of action list to execute when the hotspot is clicked. The additional data takes this form:

{num_actions} [opcode (var_index) {num_values} [values]]

See the [[Myst_scripts|page about scripts]] for more info.

Type 6 hotspots play a video when activated. The record starts with a full type 5 record. Then comes a zero-terminated string (C string) which defines the path to the video file without extension. Note that after the string is read, input stream position should be padded to the next 2-byte boundary. Finally come 7 shorts whose purpose is still unknown.

Type 7 record serves as some kind of switch statement, executing one of several action lists (or cases) indexed by the value of a variable:

(var_index} {num_cases} [record_type <record_data>]

Each case itself begins with a record type, followed by additional record contents (without common prefix). Only type 5 and 6 records used in a switch statement have been observed.

Type 8 record specifies a list of subimages to draw over main WDIB. Particular subimage is chosen depending on the value of variable. This record also includes type 7 record at start (which in turn includes type 5 record and more).

<type_7_record> (var_index) {num_subs} [wdib_id <rectangle>]

Here, each subimage record defines a source WDIB ID and a source rectangle inside this WDIB. Rectangle is defined in the usual (''left'', ''top'', ''right'', ''bottom'') format, with one exception: empty rectangle is defined as the single short -1. This is probably the case when source rectangle equals destination rectangle. Also, ''wdib_id'' itself can be -1, this probably means original WDIB for this card should be used as source WDIB.

The remaining types are being investigated.

==Case studies==
Note: these are simply the data in little-endian shorts and line-broken where patterns are found. <l t b r> is the hotspot rect. count [entry]... are guesses at when there are lists of entries. The number in parentheses before the data is the card number (not the resource number).

The following hotspots replace part of the image (in this case <417 260 544 333>) with part of another image (in this case 3004 <0 0 127 73>) based on a variable (103 2 plays in here somewhere):
8 1 < 31 276 163 333> 0 FFFF 0 103 2 3006 <0 0 132 57> 3005 FFFF
8 1 <417 260 544 333> 0 FFFF 0 103 2 3004 <0 0 127 73> 3003 FFFF

Case studies from Channelwood:
(CHANNEL 3001) 2
1 2 <1 0 110 332> 3002
2 2 <455 2 544 332> 3003

(CHANNEL 3002) 2
1 2 <0 1 100 332> 3005
2 2 <431 0 544 332> 3001

(CHANNEL 3003) 4
5 2 <213 90 343 290> 3494 2 [6 0 0] [24 0 1 {3494}] (the door)
1 2 <0 0 81 332> 3001 (left)
2 2 <463 0 544 332> 3005 (right)
8 1 <417 260 544 333> 0 FFFF 0 103 2 [3004 <0 0 127 73>] [3003 <FFFF>]

(CHANNEL 3005) 4
0 2 <76 152 196 330> 3012
1 2 <0 0 106 332> 3003
2 2 <438 0 544 332> 3002
8 1 <31 276 163 333> 0 FFFF 0 103 2 [3006 <0 0 132 57>] [3005 <FFFF>]

(CHANNEL 3012) 8
8 3 <101 243 214 343> 0 FFFF 1 5 (1 [3 103 1 {802}]) 103 2 [3013 <0 0 113 100>] [3012 <FFFF>]
5 2 <255 193 269 208> 0 1 [117 0 1 {0}]
5 2 <268 193 282 208> 0 1 [117 0 1 {1}]
5 2 <281 193 295 208> 0 1 [117 0 1 {2}]
5 2 <294 193 308 208> 0 1 [117 0 1 {3}]
8 1 <252 190 310 210> 0 FFFF 0 17 4 [3008 <0 0 58 20>] [3009 <0 0 58 20>] [3010 <0 0 58 20>] [3011 <0 0 58 20>]
0 4 <180 31 379 305> 0
5 2 <0 0 544 332> 0 1 [34 0 2 {3005 0}]

(MYST 4368) 3
8 3 <305 148 375 238> 0 FFFF 1 5 (1 [3 103 1 {802}]) 103 2 [FFFF <FFFF>] [4369 <0 0 70 90>]
7 2 <216 110 304 235> 0 106 5
5 (1 [115 101 3 {4741 4370 4368}])
5 (1 [115 101 3 {4741 4370 4368}])
5 (1 [115 101 3 {4741 4370 4368}])
5 (1 [115 101 3 {4741 4370 4368}])
5 (0)
0 2 <0 0 544 332> 4345

==== Intro Case Study ====
See a bit below for where the game starts, INTRO 0. Here's INTRO 1, because it's more deciphered than that.

(INTRO 1) 1
5 2 <245 202 304 253> 4 2 [37 0 0] [34 0 2 {3 11}]

INTRO 1 is the first interactive part of the game, the part where you can pick up the Myst book. The rect correctly corresponds to where the book is on screen. But, look at the "destination" -- 4. There is no VIEW/RLST 4! However, there is a WDIB 4 and it is the open book with the water. Where this ''should'' go is to card 3 and show the Myst book cover before showing image 4 and then playing the video. And, there is a 3 in this chunk, but I'm not sure if that's the purpose. I have no idea what commands 37/34 could be. There is a WDIB 11, but it's of D'ni, so I doubt it's that. ;)

(INTRO 2) 2
0 2 <-32000 -32000 32000 32000> 5
6 0 <312 70 441 159> 0 0 "\qtw\intro\intro2" 0x2848 0x2756 0 1 0 0 0

Note that this one has a string for the video (null-terminated). This obviously calls that video which is the Myst fly-by for the linking book. And, that rect perfectly matches where the video should be displayed on screen. However, this also clearly breaks the format specified above for "type 2 hotspots".

WDIB 3 is the cover of the Myst linking book. But, this doesn't match up with the video mentioned here which should be for WDIB 4 (or 10, they are identical)(the open linking book with the water image) and eventually ending at WDIB 12 (the open linking book with the dock image). The 5 after the very large numbers is the target card for the open linking book which seems correct. 0x2848 is 10,312 and 0x2756 is 10,070. The rate of the audio is 11,025. Not sure if this has any correlation.

(INTRO 0) 1
0 2 <-32000 -32000 32000 32000> 5

This is the same as the first record of INTRO 2. My guess is that this is some sort of call to an external command. INTRO 0 is supposed to be the card which shows the opening movies and then switches to card 2.